@teemill/[email protected]

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)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @teemill/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to https://localhost:8080

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- ProjectsApi | archiveTasks | POST /v1/projects/{project}/tasks/archive | Archive all done tasks ProjectsApi | bulkUpdateTasks | PATCH /v1/projects/{project}/tasks | Bulk update tasks 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 | createUserGroup | POST /v1/projects/{project}/user-groups | Create group 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 | deleteUserGroup | DELETE /v1/projects/{project}/user-groups/{userGroup} | Delete group ProjectsApi | exportOkrs | GET /v1/projects/{project}/okrs/export | Export all OKRs ProjectsApi | exportTasks | GET /v1/projects/{project}/tasks/export | Export all tasks ProjectsApi | generateBrandContext | POST /v1/projects/{project}/brand-context/generate | Generate or update brand context ProjectsApi | getAuth | GET /v1/projects/{project}/auth | List auth tokens ProjectsApi | getClients | GET /v1/projects/{project}/users/{user}/clients | List clients 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 | getLogs | GET /v1/projects/{project}/users/{user}/logs | List logs ProjectsApi | getOkrSummary | GET /v1/projects/{project}/okrs/summary | Get OKR summary 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 | getUserGroup | GET /v1/projects/{project}/user-groups/{userGroup} | Get group ProjectsApi | getUserInvite | GET /v1/projects/{project}/users/{user}/invite | Get invite 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 | listUserGroups | GET /v1/projects/{project}/user-groups | List groups ProjectsApi | reset2FA | POST /v1/projects/{project}/users/{user}/reset-2fa | Reset 2FA 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 ProjectsApi | updateUser | PATCH /v1/projects/{project}/users/{user} | Update a user ProjectsApi | updateUserGroup | PATCH /v1/projects/{project}/user-groups/{userGroup} | Update group

Documentation For Models

• ApiError
• ArchiveTasksRequest
• Auth
• AuthResponse
• Bookmark
• BookmarkData
• BookmarkRoute
• BookmarkRouteRoute
• BookmarkTab
• BookmarkTabs
• BookmarkUrl
• Bookmarks
• BulkUpdateTasksRequest
• BulkUpdateTasksRequestTasksInner
• CreateBookmarkRequest
• CreateInviteRequest
• CreateProjectRequest
• CreateTaskRequest
• CreateTaskRequestSource
• CreateUserGroupRequest
• ExportTasks202Response
• GenerateBrandContextRequest
• GenerateBrandContextResponse
• GetClients200Response
• GetLogs200Response
• Icon
• InstallTemplateRequest
• Integration
• IntegrationsResponse
• LegacyProjectLogo
• ListTasksResponse
• ListUserGroupsResponse
• NullableIcon
• OkrLevel
• OkrSummary
• Project
• ProjectBanner
• ProjectCurrency
• ProjectInvite
• ProjectInvites
• ProjectLogo
• ProjectManager
• ProjectPlatform
• ProjectUser
• ProjectUserAvatar
• ProjectUsers
• ProjectsResponse
• SetupMethod
• Task
• TaskClientTask
• TaskPlatformTask
• TaskRelatedTasksInner
• TaskStatus
• Template
• TemplateCode
• TemplatesResponse
• TwoFactorAuthentication
• UpdateBookmarkRequest
• UpdateBookmarkTabsRequest
• UpdateBookmarkTabsRequestTabsInner
• UpdateIntegrationRequest
• UpdateProjectRequest
• UpdateTaskRequest
• UpdateUserGroupRequest
• UpdateUserRequest
• UserClient
• UserGroup
• UserInvite
• UserLog

Documentation For Authorization

Authentication schemes defined for the API:

api-key

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

session-oauth

• Type: OAuth
• Flow: password
• Authorization URL:
• Scopes: N/A