/** * ClickUp 2.0 * Let\'s make people more productive, together. Please use our [feedback board](https://clickup.canny.io) to report bugs, feature requests, and collaborate with the community. If you\'d like to import our entire API library, click [here](https://t333.s.clickup-attachments.com/t333/3bf59291-47c0-4f1a-ae91-5d9f26a8daca/ClickUp%20API%20V2.postman_collection.json) to download the file needed to import through Postman. ## Authentication There are two ways to authenticate with ClickUp API 2.0, with a personal token or creating an application and authenticating with an OAuth2 flow. Once you receive one of those two tokens, use that in the `Authorization` header of your API requests. **IMPORTANT** - _If you are creating an application for others to use, it is highly recommended that you use the OAuth2 flow._ ### Personal Token If you are using the API for personal use, it is safe to use the personal API token. You can find this token in your user settings, under the `Apps` section. At the top of the page you have the option to generate a personal token. These tokens will always begin with `pk_`. ![personal_token](https://attachments3.clickup.com/343f245e-7d27-411d-96d0-9ad3a6f2f8a7/personal_token.png) If your token becomes compromised, you can regenerate it. However, be aware that any applications that were using the old token will lose access once it has been regenerated. ### OAuth2 Flow When you want to develop an application that others can use, you must go through the OAuth2 flow so that every user that uses your application gets assigned an individualized token. This way each user of your application is able to access their own ClickUp resources. If you are unfamiliar with OAuth2, Digital Ocean has put together a great [guide](https://www.digitalocean.com/community/tutorials/an-introduction-to-oauth-2) that should get you started. ***Note:** ClickUp uses the authorization code grant type.* #### How To Use the ClickUp OAuth2 Flow 1. **Create An OAuth App** - As an admin, navigate to your team settings and click on the `Integrations` section. Once there, click on the icon that is labeled \"ClickUp API\" and create a new app. When you create an app, you will be prompted to enter a name, and at least one redirect url. When your app is created, you will be provided with a `client_id` and a `secret`. 2. **Authorization Code** - You must first retrieve an authorization code from your user before you can get an access token for their account. - To start this process, redirect the user to `https://app.clickup.com/api?client_id={client_id}&redirect_uri={redirect_uri}` with the redirect query parameter set to a redirect uri that you specified when creating the oauth app. The host of the redirect uri must match one of those redirect uris or the request will fail. The protocol will default to https if not provided, and non-ssl redirect uris may not be supported in the future. - Once the user has accepted or rejected the authorization request, they will be redirected back to the `redirect_uri` with the necessary query parameters for getting an access token. 3. **Access Token** - Once you have retrieved the authorization code in the previous step, you can then use the route `POST /api/v2/oauth/token` with the parameters `client_id`, `client_secret` , and `code` to get the user access token. This is the token that is used in the `Authorization` header for all requests in the ClickUp API. Skip to the authorization section below for more information on this route. 4. **Token Teams** - When you redirect your user in step 2 of this flow, they will be prompted which teams (Workspaces) they want to grant you access to. Therefore in order to access a specific Workspace for the user, you need to ensure that they have given you access. You can use the route `GET /api/v2/team` to see which Workspaces they have authorized you to access. If they have not given you access to the appropriate Workspaces, you can redirect them to the authorization code URL from step 2 at any time to reauthorize your app. Below is a screenshot of what the user sees when they visit this URL. ![token_teams](https://attachments3.clickup.com/49988c04-bf0f-42a5-96cc-82ce213b7f5e/token_teams.png) ## Rate Limiting The API is rate limited per OAuth and personal token. You will receive a 429 HTTP status code if you exceed the rate limit. The rate limit varies based on [plan](https://clickup.com/expandplans): - **Free Forever**, **Unlimited**, and **Business Plan**: 100 requests per minute per token - **Business Plus Plan**: 1,000 requests per minute per token - **Enterprise Plan**: 10,000 requests per minute per token Learn more about our [ClickUp Plans](https://clickup.com/pricing). ## Error Handling Errors responses will return a non-200 status code and a json err message and error code. Common errors include: **`Team not authorized`**: This error is thrown when a team was not authorized by the user for a particular access token. Refer to the `Token Teams` section of the OAuth instructions for more information on how to fix this error. Error codes that are associated with this message include `OAUTH_023`, `OAUTH_026`, `OAUTH_027`, and `OAUTH_029` to `OAUTH_045` **`Token not found`**: This error is thrown if authorization is revoked by the user, as described in the \"Personal Token\" section. Error codes that are associated with this message include `OAUTH_019`, `OAUTH_021`, `OAUTH_025`, and `OAUTH_077` **`Authorization Header Required`**: The authorization token was missing in the `Authorization` http header. `OAUTH_017` **`Client Not Found`**: The client application was not created correctly. `OAUTH_010` **`Redirect URI not passed`**: The redirect URI was not present during the OAuth authentication flow. Refer to the section \"Create An OAuth App\" to resolve this error. `OAUTH_017` **`Redirect URI does not match the redirect uris of this application`**: The redirect URI must be registered with your client application. Refer to the section \"Create An OAuth App\" to resolve this error. `OAUTH_007` ## FAQ > What is `team` in reference to? Teams is the legacy term for what are now called Workspaces in ClickUp. For compatibility, the term `team` is still used in this API to refer to Workspaces. In our API documentation, `team_id` refers to the id of a Workspace, and `group_id` refers to the id of a user group. > What `Content-Type` should I use? When formatting your requests to ClickUp, please always use the content type `application/json`. Using form encoded data is not fully supported and can result in unexpected consequences. > How are projects and Folders related? Projects are what we used to call Folders in ClickUp V1. If you use the first version of the API, the items that are returned to you as projects are the same as Folders in the second version of the API. You must use the correct nomenclature depending on the version of the API you are using (`project` for V1 and `folder` for V2) and cannot interchange them. > Does the access token returned from `POST /api/v2/oauth/token` expire? The access token does not expire at this time. > Is it possible to move a task between lists using the API? It is not possible to move a task between lists at this time. This is a complicated process, however we hope to implement this on the public API in the near future. > Will tasks created via API generate notifications? Yes, all actions you take with the public api will trigger all of the same process that would occur through the UI. This includes notifications, websocket messages, webhooks, etc. > How do I tell who has access to a particular task? To get a list of team members that have access to a particular task or list, use the routes `GET /api/v2/task/{{task_id}}/member` and `GET /api/v2/list/{{list_id}}/member` under the \"Members\" section of this documentation. > How are dates formatted in ClickUp? ClickUp will always display dates in [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds. You can use a website like [Epoch Converter](https://epochconverter.com) to convert dates between Unix and human readable date formats. > What timezone does your API use for timestamps? Our API always returns timestamps in [UTC (Coordinated Universal Time)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). > How are subtasks represented in the API? Subtasks are identical to tasks in every way. Therefore, you can manipulate subtasks the same way you would update any task with the API. To check if a task object is a subtask or not, locate the `parent` property. If this value is `null` then it is not a subtask, otherwise it will contain the task ID of the subtask\'s parent. To create a subtask, use `POST /api/v2/list/:list_id/task` and make sure to set the `parent` property in the body of the request. Similarly, to update or delete existing subtasks, use the routes `PUT /api/v2/task/:task_id` and `DELETE /api/v2/task/:task_id` respectively. To fetch subtasks, get the parent task and add the subtask query param (`GET /api/v2/task/:parent_id?include_subtasks=true`) or use the search team route with that same query param (`GET /api/v2/team/:team_id/task?subtasks=true`). > The code examples shown here aren\'t working Our code examples are automatically generated and may require customization for specific coding languages and implementation. They are included for reference purposes only. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import http from "http"; import { InlineObject } from "../model/inlineObject"; import { InlineObject1 } from "../model/inlineObject1"; import { InlineObject10 } from "../model/inlineObject10"; import { InlineObject11 } from "../model/inlineObject11"; import { InlineObject12 } from "../model/inlineObject12"; import { InlineObject13 } from "../model/inlineObject13"; import { InlineObject14 } from "../model/inlineObject14"; import { InlineObject15 } from "../model/inlineObject15"; import { InlineObject16 } from "../model/inlineObject16"; import { InlineObject17 } from "../model/inlineObject17"; import { InlineObject18 } from "../model/inlineObject18"; import { InlineObject19 } from "../model/inlineObject19"; import { InlineObject2 } from "../model/inlineObject2"; import { InlineObject20 } from "../model/inlineObject20"; import { InlineObject21 } from "../model/inlineObject21"; import { InlineObject22 } from "../model/inlineObject22"; import { InlineObject23 } from "../model/inlineObject23"; import { InlineObject24 } from "../model/inlineObject24"; import { InlineObject25 } from "../model/inlineObject25"; import { InlineObject26 } from "../model/inlineObject26"; import { InlineObject27 } from "../model/inlineObject27"; import { InlineObject28 } from "../model/inlineObject28"; import { InlineObject29 } from "../model/inlineObject29"; import { InlineObject3 } from "../model/inlineObject3"; import { InlineObject30 } from "../model/inlineObject30"; import { InlineObject31 } from "../model/inlineObject31"; import { InlineObject32 } from "../model/inlineObject32"; import { InlineObject33 } from "../model/inlineObject33"; import { InlineObject34 } from "../model/inlineObject34"; import { InlineObject35 } from "../model/inlineObject35"; import { InlineObject36 } from "../model/inlineObject36"; import { InlineObject37 } from "../model/inlineObject37"; import { InlineObject38 } from "../model/inlineObject38"; import { InlineObject39 } from "../model/inlineObject39"; import { InlineObject4 } from "../model/inlineObject4"; import { InlineObject40 } from "../model/inlineObject40"; import { InlineObject41 } from "../model/inlineObject41"; import { InlineObject42 } from "../model/inlineObject42"; import { InlineObject43 } from "../model/inlineObject43"; import { InlineObject44 } from "../model/inlineObject44"; import { InlineObject5 } from "../model/inlineObject5"; import { InlineObject6 } from "../model/inlineObject6"; import { InlineObject7 } from "../model/inlineObject7"; import { InlineObject8 } from "../model/inlineObject8"; import { InlineObject9 } from "../model/inlineObject9"; import { Authentication, Interceptor } from "../model/models"; export declare enum DefaultApiApiKeys { } export declare class DefaultApi { protected _basePath: string; protected _defaultHeaders: any; protected _useQuerystring: boolean; protected authentications: { default: Authentication; }; protected interceptors: Interceptor[]; constructor(basePath?: string); set useQuerystring(value: boolean); set basePath(basePath: string); set defaultHeaders(defaultHeaders: any); get defaultHeaders(): any; get basePath(): string; setDefaultAuthentication(auth: Authentication): void; setApiKey(key: DefaultApiApiKeys, value: string): void; addInterceptor(interceptor: Interceptor): void; /** * * @summary Add Dependency * @param taskId * @param customTaskIds If you want to reference a task by it\'s custom task id, this value must be `true` * @param teamId Only used when the parameter is set to `custom_task_ids=true` + Example: `custom_task_ids=true&team_id=123` */ addDependency(taskId: string, customTaskIds?: string, teamId?: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Add Guest To Folder * @param folderId * @param guestId * @param inlineObject4 */ addGuestToFolder(folderId: number, guestId: number, inlineObject4?: InlineObject4, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Add Guest To List * @param listId * @param guestId * @param inlineObject12 */ addGuestToList(listId: number, guestId: number, inlineObject12?: InlineObject12, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Add Guest To Task * @param taskId * @param guestId * @param customTaskIds If you want to reference a task by it\'s custom task id, this value must be `true` * @param teamId Only used when the parameter is set to `custom_task_ids=true` + Example: `custom_task_ids=true&team_id=123` * @param inlineObject26 */ addGuestToTask(taskId: string, guestId: number, customTaskIds?: string, teamId?: number, inlineObject26?: InlineObject26, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Add Tag To Task * @param taskId * @param tagName * @param customTaskIds If you want to reference a task by it\'s custom task id, this value must be `true` * @param teamId Only used when the parameter is set to `custom_task_ids=true` + Example: `custom_task_ids=true&team_id=123` */ addTagToTask(taskId: string, tagName: string, customTaskIds?: string, teamId?: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Add tags from time entries * @param teamId Team ID (Workspace) * @param inlineObject36 */ addTagsFromTimeEntries(teamId: number, inlineObject36?: InlineObject36, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Add Task Link * @param taskId * @param linksTo * @param customTaskIds If you want to reference a task by it\'s custom task id, this value must be `true` * @param teamId Only used when the parameter is set to `custom_task_ids=true` + Example: `custom_task_ids=true&team_id=123` */ addTaskLink(taskId: string, linksTo: string, customTaskIds?: string, teamId?: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Add Task To List * @param listId * @param taskId */ addTaskToList(listId: number, taskId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Change tag names from time entries * @param teamId Team ID (Workspace) * @param inlineObject35 */ changeTagNamesFromTimeEntries(teamId: number, inlineObject35?: InlineObject35, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Create a time entry * @param teamId Team ID (Workspace) * @param customTaskIds If you want to reference a task by it\'s custom task id, this value must be `true` * @param teamId2 Only used when the parameter is set to `custom_task_ids=true` + Example: `custom_task_ids=true&team_id=123` * @param inlineObject29 */ createATimeEntry(teamId: number, customTaskIds?: string, teamId2?: number, inlineObject29?: InlineObject29, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Create Chat View Comment * @param viewId 105 (string) * @param inlineObject43 */ createChatViewComment(viewId: string, inlineObject43?: InlineObject43, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Create Checklist * @param taskId * @param customTaskIds If you want to reference a task by it\'s custom task id, this value must be `true` * @param teamId Only used when the parameter is set to `custom_task_ids=true` + Example: `custom_task_ids=true&team_id=123` * @param inlineObject23 */ createChecklist(taskId: string, customTaskIds?: string, teamId?: number, inlineObject23?: InlineObject23, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Create Checklist Item * @param checklistId b8a8-48d8-a0c6-b4200788a683 (uuid) * @param inlineObject1 */ createChecklistItem(checklistId: string, inlineObject1?: InlineObject1, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Create Folder * @param spaceId * @param inlineObject17 */ createFolder(spaceId: number, inlineObject17?: InlineObject17, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Create Folder View * @param folderId * @param inlineObject6 */ createFolderView(folderId: number, inlineObject6?: InlineObject6, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Create Folderless List * @param spaceId * @param inlineObject18 */ createFolderlessList(spaceId: number, inlineObject18?: InlineObject18, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Create Goal * @param teamId Team ID (Workspace) * @param inlineObject31 */ createGoal(teamId: number, inlineObject31?: InlineObject31, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Create Key Result * @param goalId 900e-462d-a849-4a216b06d930 (uuid) * @param authoriation e.g. \"access_token\" * @param inlineObject7 */ createKeyResult(goalId: string, authoriation?: string, inlineObject7?: InlineObject7, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Create List * @param folderId * @param inlineObject5 */ createList(folderId: number, inlineObject5?: InlineObject5, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Create List Comment * @param listId * @param inlineObject11 */ createListComment(listId: number, inlineObject11?: InlineObject11, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Create List View * @param listId * @param inlineObject15 */ createListView(listId: number, inlineObject15?: InlineObject15, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Create Space * @param teamId Team ID (Workspace) * @param inlineObject34 */ createSpace(teamId: number, inlineObject34?: InlineObject34, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Create Space Tag * @param spaceId * @param inlineObject19 */ createSpaceTag(spaceId: number, inlineObject19?: InlineObject19, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Create Space View * @param spaceId * @param inlineObject21 */ createSpaceView(spaceId: number, inlineObject21?: InlineObject21, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Create Task * @param listId * @param inlineObject13 */ createTask(listId: number, inlineObject13?: InlineObject13, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Create Task Attachment * @param taskId * @param customTaskIds If you want to reference a task by it\'s custom task id, this value must be `true` * @param teamId Only used when the parameter is set to `custom_task_ids=true` + Example: `custom_task_ids=true&team_id=123` */ createTaskAttachment(taskId: string, customTaskIds?: string, teamId?: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Create Task Comment * @param taskId * @param customTaskIds If you want to reference a task by it\'s custom task id, this value must be `true` * @param teamId Only used when the parameter is set to `custom_task_ids=true` + Example: `custom_task_ids=true&team_id=123` * @param inlineObject24 */ createTaskComment(taskId: string, customTaskIds?: string, teamId?: number, inlineObject24?: InlineObject24, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Create Task From Template * @param listId * @param templateId * @param inlineObject14 */ createTaskFromTemplate(listId: number, templateId: string, inlineObject14?: InlineObject14, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Create Team * @param teamId Team ID (Workspace) */ createTeam(teamId: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Create Team View * @param teamId Team ID (Workspace) * @param inlineObject40 */ createTeamView(teamId: number, inlineObject40?: InlineObject40, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Create Webhook * @param teamId Team ID (Workspace) * @param inlineObject41 */ createWebhook(teamId: number, inlineObject41?: InlineObject41, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Delete a time Entry * @param teamId Team ID (Workspace) * @param timerId List of timer ids to delete separated by commas */ deleteATimeEntry(teamId: number, timerId: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Delete Checklist * @param checklistId b8a8-48d8-a0c6-b4200788a683 (uuid) */ deleteChecklist(checklistId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Delete Checklist Item * @param checklistId b8a8-48d8-a0c6-b4200788a683 (uuid) * @param checklistItemId e491-47f5-9fd8-d1dc4cedcc6f (uuid) */ deleteChecklistItem(checklistId: string, checklistItemId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Delete Comment * @param commentId */ deleteComment(commentId: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Delete Dependency * @param taskId * @param dependsOn * @param dependencyOf * @param customTaskIds If you want to reference a task by it\'s custom task id, this value must be `true` * @param teamId Only used when the parameter is set to `custom_task_ids=true` + Example: `custom_task_ids=true&team_id=123` */ deleteDependency(taskId: string, dependsOn: string, dependencyOf: string, customTaskIds?: string, teamId?: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Delete Folder * @param folderId */ deleteFolder(folderId: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Delete Goal * @param goalId 900e-462d-a849-4a216b06d930 (uuid) */ deleteGoal(goalId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Delete Key Result * @param keyResultId 8480-49bc-8c57-e569747efe93 (uuid) */ deleteKeyResult(keyResultId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Delete List * @param listId */ deleteList(listId: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Delete Space * @param spaceId */ deleteSpace(spaceId: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Delete Space Tag * @param spaceId * @param tagName * @param inlineObject20 */ deleteSpaceTag(spaceId: number, tagName: string, inlineObject20?: InlineObject20, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Delete Task * @param taskId * @param customTaskIds If you want to reference a task by it\'s custom task id, this value must be `true` * @param teamId Only used when the parameter is set to `custom_task_ids=true` + Example: `custom_task_ids=true&team_id=123` */ deleteTask(taskId: string, customTaskIds?: string, teamId?: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Delete Task Link * @param taskId * @param linksTo * @param customTaskIds If you want to reference a task by it\'s custom task id, this value must be `true` * @param teamId Only used when the parameter is set to `custom_task_ids=true` + Example: `custom_task_ids=true&team_id=123` */ deleteTaskLink(taskId: string, linksTo: string, customTaskIds?: string, teamId?: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Delete Team * @param groupId 7C73-4002-A6A9-310014852858 (string) - Team ID (user group) */ deleteTeam(groupId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Delete time tracked * @param taskId * @param intervalId * @param customTaskIds If you want to reference a task by it\'s custom task id, this value must be `true` * @param teamId Only used when the parameter is set to `custom_task_ids=true` + Example: `custom_task_ids=true&team_id=123` */ deleteTimeTracked(taskId: string, intervalId: string, customTaskIds?: string, teamId?: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Delete View * @param viewId 105 (string) */ deleteView(viewId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Delete Webhook * @param webhookId e506-4a29-9d42-26e504e3435e (uuid) */ deleteWebhook(webhookId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Edit Checklist * @param checklistId b8a8-48d8-a0c6-b4200788a683 (uuid) * @param inlineObject */ editChecklist(checklistId: string, inlineObject?: InlineObject, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Edit Checklist Item * @param checklistId b8a8-48d8-a0c6-b4200788a683 (uuid) * @param checklistItemId e491-47f5-9fd8-d1dc4cedcc6f (uuid) * @param inlineObject2 */ editChecklistItem(checklistId: string, checklistItemId: string, inlineObject2?: InlineObject2, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Edit Guest On Workspace * @param teamId Team ID (Workspace) * @param guestId * @param inlineObject33 */ editGuestOnWorkspace(teamId: number, guestId: number, inlineObject33?: InlineObject33, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Edit Key Result * @param keyResultId 8480-49bc-8c57-e569747efe93 (uuid) * @param inlineObject9 */ editKeyResult(keyResultId: string, inlineObject9?: InlineObject9, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Edit Space Tag * @param spaceId * @param tagName */ editSpaceTag(spaceId: number, tagName: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Edit time tracked * @param taskId * @param intervalId * @param customTaskIds If you want to reference a task by it\'s custom task id, this value must be `true` * @param teamId Only used when the parameter is set to `custom_task_ids=true` + Example: `custom_task_ids=true&team_id=123` * @param inlineObject28 */ editTimeTracked(taskId: string, intervalId: string, customTaskIds?: string, teamId?: number, inlineObject28?: InlineObject28, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Edit User On Workspace * @param teamId Team ID (Workspace) * @param userId * @param inlineObject39 */ editUserOnWorkspace(teamId: number, userId: number, inlineObject39?: InlineObject39, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get Access Token * @param clientId Oauth app client id * @param clientSecret Oauth app client secret * @param code Code given in redirect url */ getAccessToken(clientId: string, clientSecret: string, code: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get Accessible Custom Fields * @param listId */ getAccessibleCustomFields(listId: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get all tags from time entries * @param teamId Team ID (Workspace) */ getAllTagsFromTimeEntries(teamId: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get Authorized User */ getAuthorizedUser(options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get Bulk Tasks\' Time in Status * @param taskIds Pass in multiple `task_ids` parameters with different task ids to query for multiple tasks\' time in status + Example: `task_ids=3cuh&task_ids=g4fs& ...` * @param customTaskIds If you want to reference a task by it\'s custom task id, this value must be `true` * @param teamId Only used when the parameter is set to `custom_task_ids=true` + Example: `custom_task_ids=true&team_id=123` */ getBulkTasksTimeInStatus(taskIds: string, customTaskIds?: string, teamId?: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get Chat View Comments * @param viewId 105 (string) * @param start Enter the `date` of a Chat view comment using Unix time in milliseconds * @param startId Enter the Comment `id` of a Chat view comment */ getChatViewComments(viewId: string, start?: number, startId?: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get Filtered Team Tasks * @param teamId Team ID (Workspace) * @param page Page to fetch * @param orderBy Order by field, defaults to created Options: id, created, updated, due_date * @param reverse Reverse order * @param subtasks Include subtasks, default false * @param spaceIds5B5D Spaces to query * @param projectIds5B5D Folders to query * @param listIds5B5D Lists to query * @param statuses5B5D Statuses to query * @param includeClosed By default, this call does not include closed tasks. Set this to true and dont send a status filter to include closed tasks. * @param assignees5B5D Assignees to query * @param tags5B5D Tag names to query * @param dueDateGt Filter due date greater than Unix time in milliseconds * @param dueDateLt Filter due date less than Unix time in milliseconds * @param dateCreatedGt Filter date created greater than Unix time in milliseconds * @param dateCreatedLt Filter date created less than Unix time in milliseconds * @param dateUpdatedGt Filter date updated greater than Unix time in milliseconds * @param dateUpdatedLt Filter date updated less than Unix time in milliseconds * @param customFields5B5D Filter by Custom Fields. Must be a stringified JSON array of objects that must include `field_id`, `operator`, and `value`. + See the **Custom Fields** reference page for additional information on valid input for fields `value` and `field_id` for different types of Custom Fields. The example below includes a Number Custom Field and a Users Custom Field. + Accepted Values for `operator`: `=`, `<`, `<=`, `>`, `>=`, `!=`, `IS NULL` ,`IS NOT NULL` ,`RANGE`, `ANY`, `ALL`, `NOT ANY`, `NOT ALL` + Example: `?custom_fields=[{\"field_id\":\"de761538-8ae0-42e8-91d9-f1a0cdfbd8b5\",\"operator\":\">\",\"value\":2},{\"field_id\":\"bd12538-4cf0-51f3-13h1-a1c0bedae3f7\",\"operator\":\"ANY\",\"value\":[123456,765432]},{...}]` * @param customTaskIds If you want to reference a task by it\'s custom task id, this value must be `true` * @param teamId2 Only used when the parameter is set to `custom_task_ids=true` + Example: `custom_task_ids=true&team_id=123` */ getFilteredTeamTasks(teamId: number, page?: number, orderBy?: string, reverse?: boolean, subtasks?: boolean, spaceIds5B5D?: Array, projectIds5B5D?: Array, listIds5B5D?: Array, statuses5B5D?: Array, includeClosed?: boolean, assignees5B5D?: Array, tags5B5D?: Array, dueDateGt?: number, dueDateLt?: number, dateCreatedGt?: number, dateCreatedLt?: number, dateUpdatedGt?: number, dateUpdatedLt?: number, customFields5B5D?: string, customTaskIds?: string, teamId2?: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get Folder * @param folderId */ getFolder(folderId: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get Folder Views * @param folderId */ getFolderViews(folderId: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get Folderless Lists * @param spaceId * @param archived */ getFolderlessLists(spaceId: number, archived?: boolean, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get Folders * @param spaceId * @param archived */ getFolders(spaceId: number, archived?: boolean, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get Goal * @param goalId 900e-462d-a849-4a216b06d930 (uuid) */ getGoal(goalId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get Goals * @param teamId Team ID (Workspace) * @param includeCompleted */ getGoals(teamId: number, includeCompleted?: boolean, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get Guest * @param teamId Team ID (Workspace) * @param guestId */ getGuest(teamId: number, guestId: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get List * @param listId */ getList(listId: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get List Comments * @param listId * @param start Enter the `date` of a List info comment using Unix time in milliseconds * @param startId Enter the Comment `id` of a List info comment */ getListComments(listId: number, start?: number, startId?: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get List Members * @param listId */ getListMembers(listId: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get List Views * @param listId */ getListViews(listId: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get Lists * @param folderId * @param archived */ getLists(folderId: number, archived?: boolean, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get running time entry * @param teamId Team ID (Workspace) * @param assignee user id */ getRunningTimeEntry(teamId: number, assignee?: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get singular time entry * @param teamId Team ID (Workspace) * @param timerId * @param includeTaskTags Include task tags in the response for time entries associated with tasks. * @param includeLocationNames Include the names of the List, Folder, and Space along with `list_id`,`folder_id`, and `space_id`. */ getSingularTimeEntry(teamId: number, timerId: string, includeTaskTags?: boolean, includeLocationNames?: boolean, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get Space * @param spaceId */ getSpace(spaceId: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get Space Tags * @param spaceId */ getSpaceTags(spaceId: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get Space Views * @param spaceId */ getSpaceViews(spaceId: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get Spaces * @param teamId Team ID (Workspace) * @param archived */ getSpaces(teamId: number, archived?: boolean, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get Task * @param taskId * @param customTaskIds If you want to reference a task by it\'s custom task id, this value must be `true` * @param teamId Only used when the parameter is set to `custom_task_ids=true` + Example: `custom_task_ids=true&team_id=123` * @param includeSubtasks Include subtasks, default false */ getTask(taskId: string, customTaskIds?: string, teamId?: number, includeSubtasks?: boolean, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get Task Comments * @param taskId * @param customTaskIds If you want to reference a task by it\'s custom task id, this value must be `true` * @param teamId Only used when the parameter is set to `custom_task_ids=true` + Example: `custom_task_ids=true&team_id=123` * @param start Enter the `date` of a task comment using Unix time in milliseconds * @param startId Enter the Comment `id` of a task comment */ getTaskComments(taskId: string, customTaskIds?: string, teamId?: number, start?: number, startId?: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get Task Members * @param taskId */ getTaskMembers(taskId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get Task Templates * @param teamId Team ID (Workspace) * @param page */ getTaskTemplates(teamId: number, page: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get Tasks * @param listId * @param archived * @param page Page to fetch (starts at 0) * @param orderBy Order by field, defaults to created Options: id, created, updated, due_date * @param reverse Reverse order * @param subtasks Include subtasks, default false * @param statuses5B5D Statuses to query * @param includeClosed By default, the api does not include closed tasks. Set this to true and dont send a status filter to include closed tasks. * @param assignees5B5D Assignees to query * @param dueDateGt Filter due date greater than Unix time in milliseconds * @param dueDateLt Filter due date less than Unix time in milliseconds * @param dateCreatedGt Filter date created greater than Unix time in milliseconds * @param dateCreatedLt Filter date created less than Unix time in milliseconds * @param dateUpdatedGt Filter date updated greater than Unix time in milliseconds * @param dateUpdatedLt Filter date updated less than Unix time in milliseconds * @param customFields5B5D Filter by Custom Fields. Must be a stringified JSON array of objects that must include fields `field_id`, `value`, `operator`. + See the **Custom Fields** reference page on the lefthand side for additional information on valid input for fields `value` and `field_id` for different _types_ of Custom Fields + Accepted Values for `operator`: `=`, `<`, `<=`, `>`, `>=`, `!=`, `IS NULL` ,`IS NOT NULL` ,`RANGE`, `ANY`, `ALL`, `NOT ANY`, `NOT ALL` + Example: `?custom_fields=[{\"field_id\":\"de761538-8ae0-42e8-91d9-f1a0cdfbd8b5\",\"operator\":\">\",\"value\":2},{...}]` */ getTasks(listId: number, archived?: boolean, page?: number, orderBy?: string, reverse?: boolean, subtasks?: boolean, statuses5B5D?: Array, includeClosed?: boolean, assignees5B5D?: Array, dueDateGt?: number, dueDateLt?: number, dateCreatedGt?: number, dateCreatedLt?: number, dateUpdatedGt?: number, dateUpdatedLt?: number, customFields5B5D?: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get Task\'s Time in Status * @param taskId * @param customTaskIds If you want to reference a task by it\'s custom task id, this value must be `true` * @param teamId Only used when the parameter is set to `custom_task_ids=true` + Example: `custom_task_ids=true&team_id=123` */ getTasksTimeInStatus(taskId: string, customTaskIds?: string, teamId?: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get Team Views * @param teamId Team ID (Workspace) */ getTeamViews(teamId: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get Teams * @param teamId Team ID (Workspace) * @param groupIds Enter one or more Team ids (user groups) to retrieve information about specific Teams. */ getTeams(teamId?: number, groupIds?: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get Teams */ getTeams_1(options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get time entries within a date range * @param teamId Team ID (Workspace) * @param startDate Unix time in milliseconds * @param endDate Unix time in milliseconds * @param assignee User ids to filter by separated by commas. + ***Note:** Only Workspace Owners/Admins have access to do this.* * @param includeTaskTags Include task tags in the response for time entries associated with tasks. * @param includeLocationNames Include the names of the List, Folder, and Space along with `list_id`,`folder_id`, and `space_id`. * @param spaceId Only include time entries associated with tasks in a specific Space * @param folderId Only include time entries associated with tasks in a specific Folder * @param listId Only include time entries associated with tasks in a specific List * @param taskId Only include time entries associated with a specific task * @param customTaskIds If you want to reference a task by it\'s custom task id, this value must be `true` * @param teamId2 Only used when the parameter is set to `custom_task_ids=true` + Example: `custom_task_ids=true&team_id=123` */ getTimeEntriesWithinADateRange(teamId: number, startDate?: number, endDate?: number, assignee?: number, includeTaskTags?: boolean, includeLocationNames?: boolean, spaceId?: number, folderId?: number, listId?: number, taskId?: number, customTaskIds?: string, teamId2?: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get time entry history * @param teamId Team ID (Workspace) * @param timerId */ getTimeEntryHistory(teamId: number, timerId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get tracked time * @param taskId * @param customTaskIds If you want to reference a task by it\'s custom task id, this value must be `true` * @param teamId Only used when the parameter is set to `custom_task_ids=true` + Example: `custom_task_ids=true&team_id=123` */ getTrackedTime(taskId: string, customTaskIds?: string, teamId?: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get User * @param teamId Team ID (Workspace) * @param userId */ getUser(teamId: number, userId: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get View * @param viewId 105 (string) */ getView(viewId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get View Tasks * @param viewId 105 (string) * @param page */ getViewTasks(viewId: string, page: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Get Webhooks * @param teamId Team ID (Workspace) */ getWebhooks(teamId: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Invite Guest To Workspace * @param teamId Team ID (Workspace) * @param inlineObject32 */ inviteGuestToWorkspace(teamId: number, inlineObject32?: InlineObject32, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Invite User To Workspace * @param teamId Team ID (Workspace) * @param inlineObject38 */ inviteUserToWorkspace(teamId: number, inlineObject38?: InlineObject38, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Remove Custom Field Value * @param taskId * @param fieldId b8a8-48d8-a0c6-b4200788a683 (uuid) * @param customTaskIds If you want to reference a task by it\'s custom task id, this value must be `true` * @param teamId Only used when the parameter is set to `custom_task_ids=true` + Example: `custom_task_ids=true&team_id=123` */ removeCustomFieldValue(taskId: string, fieldId: string, customTaskIds?: string, teamId?: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Remove Guest From Folder * @param folderId * @param guestId */ removeGuestFromFolder(folderId: number, guestId: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Remove Guest From List * @param listId * @param guestId */ removeGuestFromList(listId: number, guestId: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Remove Guest From Task * @param taskId * @param guestId * @param customTaskIds If you want to reference a task by it\'s custom task id, this value must be `true` * @param teamId Only used when the parameter is set to `custom_task_ids=true` + Example: `custom_task_ids=true&team_id=123` */ removeGuestFromTask(taskId: string, guestId: number, customTaskIds?: string, teamId?: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Remove Guest From Workspace * @param teamId Team ID (Workspace) * @param guestId */ removeGuestFromWorkspace(teamId: number, guestId: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Remove Tag From Task * @param taskId * @param tagName * @param customTaskIds If you want to reference a task by it\'s custom task id, this value must be `true` * @param teamId Only used when the parameter is set to `custom_task_ids=true` + Example: `custom_task_ids=true&team_id=123` */ removeTagFromTask(taskId: string, tagName: string, customTaskIds?: string, teamId?: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Remove tags from time entries * @param teamId Team ID (Workspace) * @param inlineObject37 */ removeTagsFromTimeEntries(teamId: number, inlineObject37?: InlineObject37, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Remove Task From List * @param listId * @param taskId */ removeTaskFromList(listId: number, taskId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Remove User From Workspace * @param teamId Team ID (Workspace) * @param userId */ removeUserFromWorkspace(teamId: number, userId: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Set Custom Field Value * @param taskId * @param fieldId b8a8-48d8-a0c6-b4200788a683 (uuid) * @param customTaskIds If you want to reference a task by it\'s custom task id, this value must be `true` * @param teamId Only used when the parameter is set to `custom_task_ids=true` + Example: `custom_task_ids=true&team_id=123` * @param inlineObject25 */ setCustomFieldValue(taskId: string, fieldId: string, customTaskIds?: string, teamId?: number, inlineObject25?: InlineObject25, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Shared Hierarchy * @param teamId Team ID (Workspace) */ sharedHierarchy(teamId: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Start a time Entry * @param teamId Team ID (Workspace) * @param timerId * @param customTaskIds If you want to reference a task by it\'s custom task id, this value must be `true` * @param teamId2 Only used when the parameter is set to `custom_task_ids=true` + Example: `custom_task_ids=true&team_id=123` */ startATimeEntry(teamId: number, timerId: number, customTaskIds?: string, teamId2?: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Stop a time Entry * @param teamId Team ID (Workspace) */ stopATimeEntry(teamId: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Track time * @param taskId * @param customTaskIds If you want to reference a task by it\'s custom task id, this value must be `true` * @param teamId Only used when the parameter is set to `custom_task_ids=true` + Example: `custom_task_ids=true&team_id=123` * @param inlineObject27 */ trackTime(taskId: string, customTaskIds?: string, teamId?: number, inlineObject27?: InlineObject27, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Update a time Entry * @param teamId Team ID (Workspace) * @param timerId * @param customTaskIds If you want to reference a task by it\'s custom task id, this value must be `true` * @param teamId2 Only used when the parameter is set to `custom_task_ids=true` + Example: `custom_task_ids=true&team_id=123` * @param inlineObject30 */ updateATimeEntry(teamId: number, timerId: number, customTaskIds?: string, teamId2?: number, inlineObject30?: InlineObject30, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Update Comment * @param commentId */ updateComment(commentId: number, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Update Folder * @param folderId * @param inlineObject3 */ updateFolder(folderId: number, inlineObject3?: InlineObject3, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Update Goal * @param goalId 900e-462d-a849-4a216b06d930 (uuid) */ updateGoal(goalId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Update List * @param listId * @param inlineObject10 */ updateList(listId: string, inlineObject10?: InlineObject10, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Update Space * @param spaceId * @param inlineObject16 */ updateSpace(spaceId: number, inlineObject16?: InlineObject16, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Update Task * @param taskId * @param customTaskIds If you want to reference a task by it\'s custom task id, this value must be `true` * @param teamId Only used when the parameter is set to `custom_task_ids=true` + Example: `custom_task_ids=true&team_id=123` * @param inlineObject22 */ updateTask(taskId: string, customTaskIds?: string, teamId?: number, inlineObject22?: InlineObject22, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Update Team * @param groupId 7C73-4002-A6A9-310014852858 (string) - Team ID (user group) * @param inlineObject8 */ updateTeam(groupId: string, inlineObject8?: InlineObject8, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Update View * @param viewId 105 (string) * @param inlineObject42 */ updateView(viewId: string, inlineObject42?: InlineObject42, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; /** * * @summary Update Webhook * @param webhookId e506-4a29-9d42-26e504e3435e (uuid) * @param inlineObject44 */ updateWebhook(webhookId: string, inlineObject44?: InlineObject44, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body?: any; }>; }