This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:
Environment
- Node.js
- Webpack
- Browserify
Language level
- ES5 - you must have a Promises/A+ library installed
- ES6
Module system
- CommonJS
- ES6 module system
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)
To build and compile the typescript sources to javascript use:
npm install
npm run build
First build the package then run npm publish
navigate to the folder of your consuming project and run one of the following commands.
published:
npm install @teemill/projects@1.39.0 --save
unPublished (not recommended):
npm install PATH_TO_GENERATED_PACKAGE --save
All URIs are relative to https://localhost:8080
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ProjectsApi | createAuth | POST /v1/projects/{project}/auth | Create auth token |
| ProjectsApi | createBookmark | POST /v1/projects/{project}/bookmarks | Create bookmark |
| ProjectsApi | createInvite | POST /v1/projects/{project}/invites | Creates an invite |
| ProjectsApi | createProject | POST /v1/projects | Create project |
| ProjectsApi | createTask | POST /v1/projects/{project}/tasks | Create Task |
| ProjectsApi | deleteAuth | DELETE /v1/projects/{project}/auth/{auth} | Delete auth token |
| ProjectsApi | deleteBookmark | DELETE /v1/projects/{project}/bookmarks/{id} | Delete bookmark |
| ProjectsApi | deleteInvite | DELETE /v1/projects/{project}/invites/{invite} | Deletes an invite |
| ProjectsApi | deleteProject | DELETE /v1/projects/{project} | Delete project |
| ProjectsApi | deleteTask | DELETE /v1/projects/{project}/tasks/{id} | Delete Task |
| ProjectsApi | deleteUser | DELETE /v1/projects/{project}/users/{user} | Delete a user by ID |
| ProjectsApi | exportOkrs | GET /v1/projects/{project}/okrs/export | Export all OKRs |
| ProjectsApi | exportTasks | GET /v1/projects/{project}/tasks/export | Export all tasks |
| ProjectsApi | getAuth | GET /v1/projects/{project}/auth | List auth tokens |
| ProjectsApi | getIntegration | GET /v1/projects/{project}/integrations/{integration} | Get integration |
| ProjectsApi | getIntegrations | GET /v1/projects/{project}/integrations | List integrations |
| ProjectsApi | getInvites | GET /v1/projects/{project}/invites | List Invites |
| ProjectsApi | getProject | GET /v1/projects/{project} | Get project |
| ProjectsApi | getProjects | GET /v1/projects | List projects |
| ProjectsApi | getTask | GET /v1/projects/{project}/tasks/{id} | Get Task |
| ProjectsApi | getTemplates | GET /v1/projects/templates | List templates |
| ProjectsApi | getUser | GET /v1/projects/{project}/users/{user} | Get a user |
| ProjectsApi | getUsers | GET /v1/projects/{project}/users | List project users |
| ProjectsApi | installIntegration | POST /v1/projects/{project}/integrations/{integration} | Install integration |
| ProjectsApi | installTemplate | POST /v1/projects/{project}/templates/{template} | Install integration template |
| ProjectsApi | listBookmarks | GET /v1/projects/{project}/bookmarks | List bookmarks |
| ProjectsApi | listBookmarktabs | GET /v1/projects/{project}/bookmarktabs | List bookmark tabs |
| ProjectsApi | listTasks | GET /v1/projects/{project}/tasks | List Tasks |
| ProjectsApi | setupIntegration | POST /v1/projects/{project}/integrations/{integration}/setup | Setup integration |
| ProjectsApi | uninstallIntegration | DELETE /v1/projects/{project}/integrations/{integration} | Uninstall integration |
| ProjectsApi | updateBookmark | PATCH /v1/projects/{project}/bookmarks/{id} | Update bookmark |
| ProjectsApi | updateBookmarkTabs | PUT /v1/projects/{project}/bookmarktabs | Update bookmark tabs |
| ProjectsApi | updateIntegration | PATCH /v1/projects/{project}/integrations/{integration} | Update integration |
| ProjectsApi | updateProject | PATCH /v1/projects/{project} | Update project |
| ProjectsApi | updateTask | PATCH /v1/projects/{project}/tasks/{id} | Update Task |
- ApiError
- Auth
- AuthResponse
- Bookmark
- BookmarkData
- BookmarkRoute
- BookmarkRouteRoute
- BookmarkTab
- BookmarkTabs
- BookmarkUrl
- Bookmarks
- CreateBookmarkRequest
- CreateInviteRequest
- CreateProjectRequest
- CreateTaskRequest
- ExportTasks202Response
- Icon
- InstallTemplateRequest
- Integration
- IntegrationsResponse
- LegacyProjectLogo
- ListTasksResponse
- NullableIcon
- OkrLevel
- Project
- ProjectCurrency
- ProjectInvite
- ProjectInvites
- ProjectLogo
- ProjectManager
- ProjectPlatform
- ProjectUser
- ProjectUserAvatar
- ProjectUsers
- ProjectsResponse
- Task
- TaskStatus
- TaskSummary
- Template
- TemplateCode
- TemplatesResponse
- UpdateBookmarkRequest
- UpdateBookmarkTabsRequest
- UpdateBookmarkTabsRequestTabsInner
- UpdateIntegrationRequest
- UpdateProjectRequest
- UpdateTaskRequest
Authentication schemes defined for the API:
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
- Type: OAuth
- Flow: password
- Authorization URL:
- Scopes: N/A