@managed-api/monday-v2025-07-core 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +199 -0
- package/builders/errorStrategy.d.ts +10 -0
- package/builders/errorStrategy.d.ts.map +1 -0
- package/builders/errorStrategy.js +13 -0
- package/common.d.ts +27 -0
- package/common.d.ts.map +1 -0
- package/common.js +150 -0
- package/definitions/account.d.ts +113 -0
- package/definitions/account.d.ts.map +1 -0
- package/definitions/account.js +0 -0
- package/definitions/accountProduct.d.ts +25 -0
- package/definitions/accountProduct.d.ts.map +1 -0
- package/definitions/accountProduct.js +0 -0
- package/definitions/accountRole.d.ts +33 -0
- package/definitions/accountRole.d.ts.map +1 -0
- package/definitions/accountRole.js +0 -0
- package/definitions/activityLogType.d.ts +29 -0
- package/definitions/activityLogType.d.ts.map +1 -0
- package/definitions/activityLogType.js +0 -0
- package/definitions/asset.d.ts +93 -0
- package/definitions/asset.d.ts.map +1 -0
- package/definitions/asset.js +0 -0
- package/definitions/board.d.ts +407 -0
- package/definitions/board.d.ts.map +1 -0
- package/definitions/board.js +3 -0
- package/definitions/boardDuplication.d.ts +31 -0
- package/definitions/boardDuplication.d.ts.map +1 -0
- package/definitions/boardDuplication.js +3 -0
- package/definitions/boardView.d.ts +52 -0
- package/definitions/boardView.d.ts.map +1 -0
- package/definitions/boardView.js +3 -0
- package/definitions/boardViews.d.ts +25 -0
- package/definitions/boardViews.d.ts.map +1 -0
- package/definitions/boardViews.js +3 -0
- package/definitions/column.d.ts +67 -0
- package/definitions/column.d.ts.map +1 -0
- package/definitions/column.js +0 -0
- package/definitions/columnValue.d.ts +52 -0
- package/definitions/columnValue.d.ts.map +1 -0
- package/definitions/columnValue.js +0 -0
- package/definitions/columnValueFragments/boardRelationValue.d.ts +48 -0
- package/definitions/columnValueFragments/boardRelationValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/boardRelationValue.js +3 -0
- package/definitions/columnValueFragments/buttonValue.d.ts +29 -0
- package/definitions/columnValueFragments/buttonValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/buttonValue.js +3 -0
- package/definitions/columnValueFragments/checkboxValue.d.ts +29 -0
- package/definitions/columnValueFragments/checkboxValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/checkboxValue.js +3 -0
- package/definitions/columnValueFragments/colorPickerValue.d.ts +29 -0
- package/definitions/columnValueFragments/colorPickerValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/colorPickerValue.js +3 -0
- package/definitions/columnValueFragments/countryValue.d.ts +55 -0
- package/definitions/columnValueFragments/countryValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/countryValue.js +3 -0
- package/definitions/columnValueFragments/creationLogValue.d.ts +40 -0
- package/definitions/columnValueFragments/creationLogValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/creationLogValue.js +3 -0
- package/definitions/columnValueFragments/dateValue.d.ts +45 -0
- package/definitions/columnValueFragments/dateValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/dateValue.js +3 -0
- package/definitions/columnValueFragments/dependencyValue.d.ts +48 -0
- package/definitions/columnValueFragments/dependencyValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/dependencyValue.js +3 -0
- package/definitions/columnValueFragments/docValue.d.ts +24 -0
- package/definitions/columnValueFragments/docValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/docValue.js +3 -0
- package/definitions/columnValueFragments/dropdownValue.d.ts +47 -0
- package/definitions/columnValueFragments/dropdownValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/dropdownValue.js +3 -0
- package/definitions/columnValueFragments/emailValue.d.ts +37 -0
- package/definitions/columnValueFragments/emailValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/emailValue.js +3 -0
- package/definitions/columnValueFragments/fileValue.d.ts +245 -0
- package/definitions/columnValueFragments/fileValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/fileValue.js +3 -0
- package/definitions/columnValueFragments/formulaValue.d.ts +13 -0
- package/definitions/columnValueFragments/formulaValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/formulaValue.js +3 -0
- package/definitions/columnValueFragments/hourValue.d.ts +37 -0
- package/definitions/columnValueFragments/hourValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/hourValue.js +3 -0
- package/definitions/columnValueFragments/itemIdValue.d.ts +29 -0
- package/definitions/columnValueFragments/itemIdValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/itemIdValue.js +3 -0
- package/definitions/columnValueFragments/lastUpdatedValue.d.ts +40 -0
- package/definitions/columnValueFragments/lastUpdatedValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/lastUpdatedValue.js +3 -0
- package/definitions/columnValueFragments/linkValue.d.ts +37 -0
- package/definitions/columnValueFragments/linkValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/linkValue.js +3 -0
- package/definitions/columnValueFragments/locationValue.d.ts +117 -0
- package/definitions/columnValueFragments/locationValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/locationValue.js +3 -0
- package/definitions/columnValueFragments/longTextValue.d.ts +21 -0
- package/definitions/columnValueFragments/longTextValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/longTextValue.js +3 -0
- package/definitions/columnValueFragments/mirrorValue.d.ts +69 -0
- package/definitions/columnValueFragments/mirrorValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/mirrorValue.js +3 -0
- package/definitions/columnValueFragments/numbersValue.d.ts +37 -0
- package/definitions/columnValueFragments/numbersValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/numbersValue.js +3 -0
- package/definitions/columnValueFragments/peopleValue.d.ts +55 -0
- package/definitions/columnValueFragments/peopleValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/peopleValue.js +3 -0
- package/definitions/columnValueFragments/phoneValue.d.ts +37 -0
- package/definitions/columnValueFragments/phoneValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/phoneValue.js +3 -0
- package/definitions/columnValueFragments/ratingValue.d.ts +29 -0
- package/definitions/columnValueFragments/ratingValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/ratingValue.js +3 -0
- package/definitions/columnValueFragments/statusValue.d.ts +80 -0
- package/definitions/columnValueFragments/statusValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/statusValue.js +3 -0
- package/definitions/columnValueFragments/tagsValue.d.ts +21 -0
- package/definitions/columnValueFragments/tagsValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/tagsValue.js +3 -0
- package/definitions/columnValueFragments/textValue.d.ts +13 -0
- package/definitions/columnValueFragments/textValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/textValue.js +3 -0
- package/definitions/columnValueFragments/timeTrackingValue.d.ts +159 -0
- package/definitions/columnValueFragments/timeTrackingValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/timeTrackingValue.js +3 -0
- package/definitions/columnValueFragments/timelineValue.d.ts +45 -0
- package/definitions/columnValueFragments/timelineValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/timelineValue.js +3 -0
- package/definitions/columnValueFragments/voteValue.d.ts +48 -0
- package/definitions/columnValueFragments/voteValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/voteValue.js +3 -0
- package/definitions/columnValueFragments/weekValue.d.ts +29 -0
- package/definitions/columnValueFragments/weekValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/weekValue.js +3 -0
- package/definitions/columnValueFragments/worldClockValue.d.ts +29 -0
- package/definitions/columnValueFragments/worldClockValue.d.ts.map +1 -0
- package/definitions/columnValueFragments/worldClockValue.js +3 -0
- package/definitions/complexity.d.ts +47 -0
- package/definitions/complexity.d.ts.map +1 -0
- package/definitions/complexity.js +3 -0
- package/definitions/customFieldMetas.d.ts +73 -0
- package/definitions/customFieldMetas.d.ts.map +1 -0
- package/definitions/customFieldMetas.js +1 -0
- package/definitions/customFieldValues.d.ts +25 -0
- package/definitions/customFieldValues.d.ts.map +1 -0
- package/definitions/customFieldValues.js +1 -0
- package/definitions/doc.d.ts +136 -0
- package/definitions/doc.d.ts.map +1 -0
- package/definitions/doc.js +3 -0
- package/definitions/docBlock.d.ts +103 -0
- package/definitions/docBlock.d.ts.map +1 -0
- package/definitions/docBlock.js +3 -0
- package/definitions/folder.d.ts +85 -0
- package/definitions/folder.d.ts.map +1 -0
- package/definitions/folder.js +3 -0
- package/definitions/group.d.ts +94 -0
- package/definitions/group.d.ts.map +1 -0
- package/definitions/group.js +22 -0
- package/definitions/groups.d.ts +21 -0
- package/definitions/groups.d.ts.map +1 -0
- package/definitions/groups.js +3 -0
- package/definitions/item.d.ts +384 -0
- package/definitions/item.d.ts.map +1 -0
- package/definitions/item.js +0 -0
- package/definitions/itemDescription.d.ts +29 -0
- package/definitions/itemDescription.d.ts.map +1 -0
- package/definitions/itemDescription.js +0 -0
- package/definitions/itemsPage.d.ts +116 -0
- package/definitions/itemsPage.d.ts.map +1 -0
- package/definitions/itemsPage.js +4 -0
- package/definitions/like.d.ts +25 -0
- package/definitions/like.d.ts.map +1 -0
- package/definitions/like.js +0 -0
- package/definitions/notification.d.ts +12 -0
- package/definitions/notification.d.ts.map +1 -0
- package/definitions/notification.js +0 -0
- package/definitions/outOfOffice.d.ts +49 -0
- package/definitions/outOfOffice.d.ts.map +1 -0
- package/definitions/outOfOffice.js +0 -0
- package/definitions/plan.d.ts +41 -0
- package/definitions/plan.d.ts.map +1 -0
- package/definitions/plan.js +0 -0
- package/definitions/reply.d.ts +79 -0
- package/definitions/reply.d.ts.map +1 -0
- package/definitions/reply.js +0 -0
- package/definitions/state.d.ts +2 -0
- package/definitions/state.d.ts.map +1 -0
- package/definitions/state.js +0 -0
- package/definitions/subitem.d.ts +14 -0
- package/definitions/subitem.d.ts.map +1 -0
- package/definitions/subitem.js +3 -0
- package/definitions/tag.d.ts +38 -0
- package/definitions/tag.d.ts.map +1 -0
- package/definitions/tag.js +0 -0
- package/definitions/team.d.ts +127 -0
- package/definitions/team.d.ts.map +1 -0
- package/definitions/team.js +0 -0
- package/definitions/typeOptions.d.ts +39 -0
- package/definitions/typeOptions.d.ts.map +1 -0
- package/definitions/typeOptions.js +777 -0
- package/definitions/update.d.ts +162 -0
- package/definitions/update.d.ts.map +1 -0
- package/definitions/update.js +0 -0
- package/definitions/updateBoard.d.ts +5 -0
- package/definitions/updateBoard.d.ts.map +1 -0
- package/definitions/updateBoard.js +3 -0
- package/definitions/updatePin.d.ts +12 -0
- package/definitions/updatePin.d.ts.map +1 -0
- package/definitions/updatePin.js +0 -0
- package/definitions/user.d.ts +298 -0
- package/definitions/user.d.ts.map +1 -0
- package/definitions/user.js +0 -0
- package/definitions/version.d.ts +37 -0
- package/definitions/version.d.ts.map +1 -0
- package/definitions/version.js +3 -0
- package/definitions/viewer.d.ts +38 -0
- package/definitions/viewer.d.ts.map +1 -0
- package/definitions/viewer.js +0 -0
- package/definitions/webhook.d.ts +42 -0
- package/definitions/webhook.d.ts.map +1 -0
- package/definitions/webhook.js +0 -0
- package/definitions/workspace.d.ts +177 -0
- package/definitions/workspace.d.ts.map +1 -0
- package/definitions/workspace.js +0 -0
- package/definitions/workspaceIcon.d.ts +27 -0
- package/definitions/workspaceIcon.d.ts.map +1 -0
- package/definitions/workspaceIcon.js +0 -0
- package/definitions/workspaceSettings.d.ts +21 -0
- package/definitions/workspaceSettings.d.ts.map +1 -0
- package/definitions/workspaceSettings.js +0 -0
- package/errorStrategy.d.ts +31 -0
- package/errorStrategy.d.ts.map +1 -0
- package/errorStrategy.js +27 -0
- package/index.d.ts +1459 -0
- package/index.d.ts.map +1 -0
- package/index.js +1850 -0
- package/package.json +41 -0
- package/types/account.d.ts +24 -0
- package/types/account.d.ts.map +1 -0
- package/types/account.js +3 -0
- package/types/assets.d.ts +93 -0
- package/types/assets.d.ts.map +1 -0
- package/types/assets.js +3 -0
- package/types/board.d.ts +461 -0
- package/types/board.d.ts.map +1 -0
- package/types/board.js +3 -0
- package/types/column.d.ts +256 -0
- package/types/column.d.ts.map +1 -0
- package/types/column.js +3 -0
- package/types/doc.d.ts +114 -0
- package/types/doc.d.ts.map +1 -0
- package/types/doc.js +3 -0
- package/types/docBlock.d.ts +137 -0
- package/types/docBlock.d.ts.map +1 -0
- package/types/docBlock.js +3 -0
- package/types/folder.d.ts +133 -0
- package/types/folder.d.ts.map +1 -0
- package/types/folder.js +3 -0
- package/types/id.d.ts +5 -0
- package/types/id.d.ts.map +1 -0
- package/types/id.js +3 -0
- package/types/item.d.ts +276 -0
- package/types/item.d.ts.map +1 -0
- package/types/item.js +14 -0
- package/types/itemsPage.d.ts +198 -0
- package/types/itemsPage.d.ts.map +1 -0
- package/types/itemsPage.js +3 -0
- package/types/me.d.ts +24 -0
- package/types/me.d.ts.map +1 -0
- package/types/me.js +3 -0
- package/types/notification.d.ts +44 -0
- package/types/notification.d.ts.map +1 -0
- package/types/notification.js +0 -0
- package/types/subitem.d.ts +61 -0
- package/types/subitem.d.ts.map +1 -0
- package/types/subitem.js +3 -0
- package/types/tag.d.ts +102 -0
- package/types/tag.d.ts.map +1 -0
- package/types/tag.js +0 -0
- package/types/team.d.ts +327 -0
- package/types/team.d.ts.map +1 -0
- package/types/team.js +0 -0
- package/types/update.d.ts +204 -0
- package/types/update.d.ts.map +1 -0
- package/types/update.js +3 -0
- package/types/user.d.ts +400 -0
- package/types/user.d.ts.map +1 -0
- package/types/user.js +3 -0
- package/types/version.d.ts +40 -0
- package/types/version.d.ts.map +1 -0
- package/types/version.js +3 -0
- package/types/webhook.d.ts +85 -0
- package/types/webhook.d.ts.map +1 -0
- package/types/webhook.js +0 -0
- package/types/workspace.d.ts +147 -0
- package/types/workspace.d.ts.map +1 -0
- package/types/workspace.js +3 -0
package/index.d.ts
ADDED
|
@@ -0,0 +1,1459 @@
|
|
|
1
|
+
/*!
|
|
2
|
+
* Copyright Adaptavist 2023 (c) All rights reserved
|
|
3
|
+
*/
|
|
4
|
+
import { BaseApiCore, Headers, Response, ErrorStrategyOptionType, PlatformImplementation } from '@managed-api/commons-core';
|
|
5
|
+
import { CommonError, AdditionalErrorTypes, ErrorStrategyHandlers, ErrorStrategyOption } from './errorStrategy';
|
|
6
|
+
import { ErrorStrategyBuilder } from './builders/errorStrategy';
|
|
7
|
+
import { ArchiveBoardFullResponseOK, ArchiveBoardRequest, ArchiveBoardResponseOK, CreateBoardFullResponseOK, CreateBoardRequest, CreateBoardResponseOK, DeleteBoardFullResponseOK, DeleteBoardRequest, DeleteBoardResponseOK, DeleteSubscribersBoardFullResponseOK, DeleteSubscribersBoardRequest, DeleteSubscribersBoardResponseOK, DuplicateBoardFullResponseOK, DuplicateBoardRequest, DuplicateBoardResponseOK, GetBoardViewsFullResponseOK, GetBoardViewsRequest, GetBoardViewsResponseOK, GetBoardsFullResponseOK, GetBoardsRequest, GetBoardsResponseOK, UpdateBoardFullResponseOK, UpdateBoardRequest, UpdateBoardResponseOK, GetBoardGroupsFullResponseOK, GetBoardGroupsRequest, GetBoardGroupsResponseOK, CreateBoardGroupFullResponseOK, CreateBoardGroupRequest, CreateBoardGroupResponseOK, DeleteBoardGroupResponseOK, DeleteBoardGroupFullResponseOK, DeleteBoardGroupRequest, ArchiveBoardGroupFullResponseOK, ArchiveBoardGroupRequest, ArchiveBoardGroupResponseOK, DuplicateBoardGroupFullResponseOK, DuplicateBoardGroupRequest, DuplicateBoardGroupResponseOK, UpdateBoardGroupFullResponseOK, UpdateBoardGroupRequest, UpdateBoardGroupResponseOK } from './types/board';
|
|
8
|
+
import { ArchiveItemFullResponseOK, ArchiveItemRequest, ArchiveItemResponseOK, ClearItemUpdatesFullResponseOK, ClearItemUpdatesRequest, ClearItemUpdatesResponseOK, CreateItemFullResponseOK, CreateItemRequest, CreateItemResponseOK, DeleteItemFullResponseOK, DeleteItemRequest, DeleteItemResponseOK, DuplicateItemFullResponseOK, DuplicateItemRequest, DuplicateItemResponseOK, GetItemsFullResponseOK, GetItemsRequest, GetItemsResponseOK, MoveItemToBoardFullResponseOK, MoveItemToBoardRequest, MoveItemToBoardResponseOK, MoveItemToGroupFullResponseOK, MoveItemToGroupRequest, MoveItemToGroupResponseOK } from './types/item';
|
|
9
|
+
import { GetUserDetailsFullResponseOK, GetUserDetailsRequest, GetUserDetailsResponseOK } from './types/me';
|
|
10
|
+
import { CreateSubitemFullResponseOK, CreateSubitemRequest, CreateSubitemResponseOK, GetSubitemsFullResponseOK, GetSubitemsRequest, GetSubitemsResponseOK } from './types/subitem';
|
|
11
|
+
import { AddUsersToBoardFullResponseOK, AddUsersToBoardRequest, AddUsersToBoardResponseOK, AddUsersToWorkspaceFullResponseOK, AddUsersToWorkspaceRequest, AddUsersToWorkspaceResponseOK, DeleteUsersFromWorkspaceFullResponseOK, DeleteUsersFromWorkspaceRequest, DeleteUsersFromWorkspaceResponseOK, GetUsersFullResponseOK, GetUsersRequest, GetUsersResponseOK, DeactivateUsersFullResponseOK, DeactivateUsersRequest, DeactivateUsersResponseOK, ActivateUsersFullResponseOK, ActivateUsersRequest, ActivateUsersResponseOK, UpdateUsersRoleFullResponseOK, UpdateUsersRoleRequest, UpdateUsersRoleResponseOK, UpdateUsersEmailDomainFullResponseOK, UpdateUsersEmailDomainRequest, UpdateUsersEmailDomainResponseOK, InviteUsersFullResponseOK, InviteUsersRequest, InviteUsersResponseOK, UpdateUsersAttributesFullResponseOK, UpdateUsersAttributesRequest, UpdateUsersAttributesResponseOK } from './types/user';
|
|
12
|
+
import { AddFileToColumnFullResponseOK, AddFileToColumnRequest, AddFileToColumnResponseOK, AddFileToUpdateFullResponseOK, AddFileToUpdateRequest, AddFileToUpdateResponseOK, GetAssetsFullResponseOK, GetAssetsRequest, GetAssetsResponseOK } from './types/assets';
|
|
13
|
+
import { ChangeColumnMetadataFullResponseOK, ChangeColumnMetadataRequest, ChangeColumnMetadataResponseOK, ChangeColumnTitleFullResponseOK, ChangeColumnTitleRequest, ChangeColumnTitleResponseOK, ChangeColumnValueFullResponseOK, ChangeColumnValueRequest, ChangeColumnValueResponseOK, ChangeMultipleColumnValuesFullResponseOK, ChangeMultipleColumnValuesRequest, ChangeMultipleColumnValuesResponseOK, ChangeSimpleColumnValueFullResponseOK, ChangeSimpleColumnValueRequest, ChangeSimpleColumnValueResponseOK, CreateColumnFullResponseOK, CreateColumnRequest, CreateColumnResponseOK, DeleteColumnFullResponseOK, DeleteColumnRequest, DeleteColumnResponseOK } from './types/column';
|
|
14
|
+
import { CreateNotificationFullResponseOK, CreateNotificationRequest, CreateNotificationResponseOK } from './types/notification';
|
|
15
|
+
import { CreateWorkspaceFullResponseOK, CreateWorkspaceRequest, CreateWorkspaceResponseOK, DeleteWorkspaceFullResponseOK, DeleteWorkspaceRequest, DeleteWorkspaceResponseOK, GetWorkspacesFullResponseOK, GetWorkspacesRequest, GetWorkspacesResponseOK, UpdateWorkspaceFullResponseOK, UpdateWorkspaceRequest, UpdateWorkspaceResponseOK } from './types/workspace';
|
|
16
|
+
import { AddTeamsToBoardFullResponseOK, AddTeamsToBoardRequest, AddTeamsToBoardResponseOK, AddTeamsToWorkspaceFullResponseOK, AddTeamsToWorkspaceRequest, AddTeamsToWorkspaceResponseOK, AddUsersToTeamFullResponseOK, AddUsersToTeamRequest, AddUsersToTeamResponseOK, AssignTeamOwnersFullResponseOK, AssignTeamOwnersRequest, AssignTeamOwnersResponseOK, CreateTeamFullResponseOK, CreateTeamRequest, CreateTeamResponseOK, DeleteTeamFullResponseOK, DeleteTeamRequest, DeleteTeamResponseOK, DeleteTeamsFromBoardFullResponseOK, DeleteTeamsFromBoardRequest, DeleteTeamsFromBoardResponseOK, DeleteTeamsFromWorkspaceFullResponseOK, DeleteTeamsFromWorkspaceRequest, DeleteTeamsFromWorkspaceResponseOK, GetTeamsFullResponseOK, GetTeamsRequest, GetTeamsResponseOK, RemoveTeamOwnersFullResponseOK, RemoveTeamOwnersRequest, RemoveTeamOwnersResponseOK, RemoveUsersFromTeamFullResponseOK, RemoveUsersFromTeamRequest, RemoveUsersFromTeamResponseOK } from './types/team';
|
|
17
|
+
import { CreateUpdateFullResponseOK, CreateUpdateRequest, CreateUpdateResponseOK, DeleteUpdateFullResponseOK, DeleteUpdateRequest, DeleteUpdateResponseOK, EditUpdateFullResponseOK, EditUpdateRequest, EditUpdateResponseOK, GetUpdatesFullResponseOK, GetUpdatesRequest, GetUpdatesResponseOK, LikeUpdateFullResponseOK, LikeUpdateRequest, LikeUpdateResponseOK, PinUpdateFullResponseOK, PinUpdateRequest, PinUpdateResponseOK, UnlikeUpdateFullResponseOK, UnlikeUpdateRequest, UnlikeUpdateResponseOK, UnpinUpdateFullResponseOK, UnpinUpdateRequest, UnpinUpdateResponseOK } from './types/update';
|
|
18
|
+
import { GetItemsPageByColumnValuesFullResponseOK, GetItemsPageByColumnValuesRequest, GetItemsPageByColumnValuesResponseOK, GetItemsPageFullResponseOK, GetItemsPageRequest, GetItemsPageResponseOK, GetNextItemsPageFullResponseOK, GetNextItemsPageRequest, GetNextItemsPageResponseOK } from './types/itemsPage';
|
|
19
|
+
import { CreateDocFullResponseOK, CreateDocRequest, CreateDocResponseOK, GetDocsFullResponseOK, GetDocsRequest, GetDocsResponseOK } from './types/doc';
|
|
20
|
+
import { CreateDocBlockFullResponseOK, CreateDocBlockRequest, CreateDocBlockResponseOK, DeleteDocBlockFullResponseOK, DeleteDocBlockRequest, DeleteDocBlockResponseOK, GetDocBlocksFullResponseOK, GetDocBlocksRequest, GetDocBlocksResponseOK, UpdateDocBlockFullResponseOK, UpdateDocBlockRequest, UpdateDocBlockResponseOK } from './types/docBlock';
|
|
21
|
+
import { CreateOrGetTagFullResponseOK, CreateOrGetTagRequest, CreateOrGetTagResponseOK, GetBoardTagsFullResponseOK, GetBoardTagsRequest, GetBoardTagsResponseOK, GetTagsFullResponseOK, GetTagsRequest, GetTagsResponseOK } from './types/tag';
|
|
22
|
+
import { GetVersionFullResponseOK, GetVersionRequest, GetVersionResponseOK, GetVersionsFullResponseOK, GetVersionsRequest, GetVersionsResponseOK } from './types/version';
|
|
23
|
+
import { CreateWebhookRequest, CreateWebhookResponseOK, CreateWebhooksFullResponseOK, DeleteWebhookRequest, DeleteWebhookResponseOK, DeleteWebhooksFullResponseOK, GetWebhooksFullResponseOK, GetWebhooksRequest, GetWebhooksResponseOK } from './types/webhook';
|
|
24
|
+
import { GetFoldersFullResponseOK, GetFoldersRequest, GetFoldersResponseOK, CreateFolderFullResponseOK, CreateFolderRequest, CreateFolderResponseOK, UpdateFolderFullResponseOK, UpdateFolderRequest, UpdateFolderResponseOK, DeleteFolderFullResponseOK, DeleteFolderRequest, DeleteFolderResponseOK } from './types/folder';
|
|
25
|
+
import { GetAccountRolesFullResponseOK, GetAccountRolesRequest, GetAccountRolesResponseOK } from './types/account';
|
|
26
|
+
export interface MondayApiCoreOptions extends ErrorStrategyOption {
|
|
27
|
+
}
|
|
28
|
+
export declare type GetGlobalErrorStrategy = () => ErrorStrategyOptionType<CommonError, AdditionalErrorTypes, ErrorStrategyHandlers, ErrorStrategyBuilder> | undefined;
|
|
29
|
+
export declare abstract class MondayApiCore extends BaseApiCore {
|
|
30
|
+
private options?;
|
|
31
|
+
Account: AccountGroup;
|
|
32
|
+
Board: BoardGroup;
|
|
33
|
+
Item: ItemGroup;
|
|
34
|
+
Me: MeGroup;
|
|
35
|
+
User: UserGroup;
|
|
36
|
+
File: FileGroup;
|
|
37
|
+
Column: ColumnGroup;
|
|
38
|
+
Notification: NotificationGroup;
|
|
39
|
+
Workspace: WorkspaceGroup;
|
|
40
|
+
Folder: FolderGroup;
|
|
41
|
+
Update: UpdateGroup;
|
|
42
|
+
Team: TeamGroup;
|
|
43
|
+
ItemsPage: ItemsPageGroup;
|
|
44
|
+
Doc: DocGroup;
|
|
45
|
+
Tag: TagGroup;
|
|
46
|
+
Version: VersionGroup;
|
|
47
|
+
Webhook: WebhookGroup;
|
|
48
|
+
All: AllGroup;
|
|
49
|
+
constructor(options?: MondayApiCoreOptions | undefined);
|
|
50
|
+
setGlobalErrorStrategy(errorStrategy: ErrorStrategyOptionType<CommonError, AdditionalErrorTypes, ErrorStrategyHandlers, ErrorStrategyBuilder>): void;
|
|
51
|
+
protected buildResponse(url: string, status: number, statusText: string, headers: Headers, body?: string | ArrayBuffer): Response<any>;
|
|
52
|
+
private getGlobalErrorStrategy;
|
|
53
|
+
}
|
|
54
|
+
declare class AllGroup {
|
|
55
|
+
private Account;
|
|
56
|
+
private Board;
|
|
57
|
+
private Item;
|
|
58
|
+
private Me;
|
|
59
|
+
private User;
|
|
60
|
+
private File;
|
|
61
|
+
private Column;
|
|
62
|
+
private Notification;
|
|
63
|
+
private Workspace;
|
|
64
|
+
private Folder;
|
|
65
|
+
private Update;
|
|
66
|
+
private Team;
|
|
67
|
+
private ItemsPage;
|
|
68
|
+
private Doc;
|
|
69
|
+
private Tag;
|
|
70
|
+
private Version;
|
|
71
|
+
private Webhook;
|
|
72
|
+
constructor(Account: AccountGroup, Board: BoardGroup, Item: ItemGroup, Me: MeGroup, User: UserGroup, File: FileGroup, Column: ColumnGroup, Notification: NotificationGroup, Workspace: WorkspaceGroup, Folder: FolderGroup, Update: UpdateGroup, Team: TeamGroup, ItemsPage: ItemsPageGroup, Doc: DocGroup, Tag: TagGroup, Version: VersionGroup, Webhook: WebhookGroup);
|
|
73
|
+
/**
|
|
74
|
+
* The create_column mutation allows you to create a new column on a board within the account via the API.
|
|
75
|
+
* The create_column mutation also allows you to create a new status or dropdown column with custom labels via the API.
|
|
76
|
+
* Alternative usage: Column.createColumn
|
|
77
|
+
* Documentation: https://developer.monday.com/api-reference/docs/columns#create-a-column
|
|
78
|
+
* @param options Request options.
|
|
79
|
+
*/
|
|
80
|
+
createColumn<T = CreateColumnFullResponseOK, S extends CreateColumnRequest = CreateColumnRequest>(options: S): Promise<T extends CreateColumnFullResponseOK ? CreateColumnResponseOK<S> : T>;
|
|
81
|
+
/**
|
|
82
|
+
* The change_column_value mutation allows you to change the value of a column in a specific item.
|
|
83
|
+
* Alternative usage: Column.changeColumnValue
|
|
84
|
+
* Documentation: https://developer.monday.com/api-reference/docs/columns#change-a-column-value
|
|
85
|
+
* @param options Request options.
|
|
86
|
+
*/
|
|
87
|
+
changeColumnValue<T = ChangeColumnValueFullResponseOK, S extends ChangeColumnValueRequest = ChangeColumnValueRequest>(options: S): Promise<T extends ChangeColumnValueFullResponseOK ? ChangeColumnValueResponseOK<S> : T>;
|
|
88
|
+
/**
|
|
89
|
+
* The change_column_value mutation allows you to change the value of a column in a specific item with a string value.
|
|
90
|
+
* Alternative usage: Column.changeSimpleColumnValue
|
|
91
|
+
* Documentation: https://developer.monday.com/api-reference/docs/columns#change-a-simple-column-value
|
|
92
|
+
* @param options Request options.
|
|
93
|
+
*/
|
|
94
|
+
changeSimpleColumnValue<T = ChangeSimpleColumnValueFullResponseOK, S extends ChangeSimpleColumnValueRequest = ChangeSimpleColumnValueRequest>(options: S): Promise<T extends ChangeSimpleColumnValueFullResponseOK ? ChangeSimpleColumnValueResponseOK<S> : T>;
|
|
95
|
+
/**
|
|
96
|
+
* The change_multiple_column_values mutation allows you to change multiple column values of a specific item.
|
|
97
|
+
* Alternative usage: Column.changeMultipleColumnValues
|
|
98
|
+
* Documentation: https://developer.monday.com/api-reference/docs/columns#change-multiple-column-values
|
|
99
|
+
* @param options Request options.
|
|
100
|
+
*/
|
|
101
|
+
changeMultipleColumnValues<T = ChangeMultipleColumnValuesFullResponseOK, S extends ChangeMultipleColumnValuesRequest = ChangeMultipleColumnValuesRequest>(options: S): Promise<T extends ChangeMultipleColumnValuesFullResponseOK ? ChangeMultipleColumnValuesResponseOK<S> : T>;
|
|
102
|
+
/**
|
|
103
|
+
* The change_column_title mutation allows you to change the title of an existing column via the API.
|
|
104
|
+
* Alternative usage: Column.changeColumnTitle
|
|
105
|
+
* Documentation: https://developer.monday.com/api-reference/docs/columns#change-a-column-title
|
|
106
|
+
* @param options Request options.
|
|
107
|
+
*/
|
|
108
|
+
changeColumnTitle<T = ChangeColumnTitleFullResponseOK, S extends ChangeColumnTitleRequest = ChangeColumnTitleRequest>(options: S): Promise<T extends ChangeColumnTitleFullResponseOK ? ChangeColumnTitleResponseOK<S> : T>;
|
|
109
|
+
/**
|
|
110
|
+
* The change_column_metadata mutation allows you to update the metadata of an existing column.
|
|
111
|
+
* Currently, we support updating both the title and description.
|
|
112
|
+
* Alternative usage: Column.changeColumnMetadata
|
|
113
|
+
* Documentation: https://developer.monday.com/api-reference/docs/columns#change-column-metadata
|
|
114
|
+
* @param options Request options.
|
|
115
|
+
*/
|
|
116
|
+
changeColumnMetadata<T = ChangeColumnMetadataFullResponseOK, S extends ChangeColumnMetadataRequest = ChangeColumnMetadataRequest>(options: S): Promise<T extends ChangeColumnMetadataFullResponseOK ? ChangeColumnMetadataResponseOK<S> : T>;
|
|
117
|
+
/**
|
|
118
|
+
* The delete_column mutation allows you to delete a single column from a board via the API.
|
|
119
|
+
* Alternative usage: Column.deleteColumn
|
|
120
|
+
* Documentation: https://developer.monday.com/api-reference/docs/columns#delete-a-column
|
|
121
|
+
* @param options Request options.
|
|
122
|
+
*/
|
|
123
|
+
deleteColumn<T = DeleteColumnFullResponseOK, S extends DeleteColumnRequest = DeleteColumnRequest>(options: S): Promise<T extends DeleteColumnFullResponseOK ? DeleteColumnResponseOK<S> : T>;
|
|
124
|
+
/**
|
|
125
|
+
* Querying boards will return metadata about one or a collection of boards. This method accepts various arguments and returns an array.
|
|
126
|
+
* Alternative usage: Board.getBoards
|
|
127
|
+
* Documentation: https://developer.monday.com/api-reference/docs/boards#queries
|
|
128
|
+
* @param options Request options.
|
|
129
|
+
*/
|
|
130
|
+
getBoards<T = GetBoardsFullResponseOK, S extends GetBoardsRequest = GetBoardsRequest>(options: S): Promise<T extends GetBoardsFullResponseOK ? GetBoardsResponseOK<S> : T>;
|
|
131
|
+
/**
|
|
132
|
+
* The create_board mutation allows you to create a new board via the API.
|
|
133
|
+
* You can also specify what fields to query back from the new board when you run the mutation.
|
|
134
|
+
* Please note that the user that creates the board via the API will automatically be added as the board's owner when creating a private or shareable board or if the board_owners_ids argument is missing.
|
|
135
|
+
* Alternative usage: Board.createBoard
|
|
136
|
+
* Documentation: https://developer.monday.com/api-reference/docs/boards#create-a-board
|
|
137
|
+
* @param options Request options.
|
|
138
|
+
*/
|
|
139
|
+
createBoard<T = CreateBoardFullResponseOK, S extends CreateBoardRequest = CreateBoardRequest>(options: S): Promise<T extends CreateBoardFullResponseOK ? CreateBoardResponseOK<S> : T>;
|
|
140
|
+
/**
|
|
141
|
+
* The duplicate_board mutation allows you to duplicate a board with all of its items and groups to a specific workspace or folder of your choice via the API.
|
|
142
|
+
* Alternative usage: Board.duplicateBoard
|
|
143
|
+
* Documentation: https://developer.monday.com/api-reference/docs/boards#duplicate-a-board
|
|
144
|
+
* @param options Request options.
|
|
145
|
+
*/
|
|
146
|
+
duplicateBoard<T = DuplicateBoardFullResponseOK, S extends DuplicateBoardRequest = DuplicateBoardRequest>(options: S): Promise<T extends DuplicateBoardFullResponseOK ? DuplicateBoardResponseOK<S> : T>;
|
|
147
|
+
/**
|
|
148
|
+
* The update_board mutation allows you to update a board via the API.
|
|
149
|
+
* Alternative usage: Board.updateBoard
|
|
150
|
+
* Documentation: https://developer.monday.com/api-reference/docs/boards#update-a-board
|
|
151
|
+
* @param options Request options.
|
|
152
|
+
*/
|
|
153
|
+
updateBoard<T = UpdateBoardFullResponseOK>(options: UpdateBoardRequest): Promise<UpdateBoardResponseOK | T>;
|
|
154
|
+
/**
|
|
155
|
+
* The archive_board mutation allows you to archive a board via the API. You can also specify what fields to query back from the archived board when you run the mutation.
|
|
156
|
+
* Alternative usage: Board.archiveBoard
|
|
157
|
+
* Documentation: https://developer.monday.com/api-reference/docs/boards#archive-a-board
|
|
158
|
+
* @param options Request options.
|
|
159
|
+
*/
|
|
160
|
+
archiveBoard<T = ArchiveBoardFullResponseOK, S extends ArchiveBoardRequest = ArchiveBoardRequest>(options: S): Promise<T extends ArchiveBoardFullResponseOK ? ArchiveBoardResponseOK<S> : T>;
|
|
161
|
+
/**
|
|
162
|
+
* The delete_board mutation allows you to delete a board via the API. You can also specify what fields to query back from the deleted board when you run the mutation.
|
|
163
|
+
* Alternative usage: Board.deleteBoard
|
|
164
|
+
* Documentation: https://developer.monday.com/api-reference/docs/boards#delete-a-board
|
|
165
|
+
* @param options Request options.
|
|
166
|
+
*/
|
|
167
|
+
deleteBoard<T = DeleteBoardFullResponseOK, S extends DeleteBoardRequest = DeleteBoardRequest>(options: S): Promise<T extends DeleteBoardFullResponseOK ? DeleteBoardResponseOK<S> : T>;
|
|
168
|
+
/**
|
|
169
|
+
* The delete_subscribers_from_board mutation allows you to delete subscribers from a board via the API. You can also specify what fields to query back from the subscribers you delete from the board when you run the mutation.
|
|
170
|
+
* Alternative usage: Board.deleteSubscribersFromBoard
|
|
171
|
+
* Documentation: https://developer.monday.com/api-reference/docs/boards#delete-subscribers-from-a-board
|
|
172
|
+
* @param options Request options.
|
|
173
|
+
*/
|
|
174
|
+
deleteSubscribersFromBoard<T = DeleteSubscribersBoardFullResponseOK, S extends DeleteSubscribersBoardRequest = DeleteSubscribersBoardRequest>(options: S): Promise<T extends DeleteSubscribersBoardFullResponseOK ? DeleteSubscribersBoardResponseOK<S> : T>;
|
|
175
|
+
/**
|
|
176
|
+
* Querying items_page will return items filtered by the specified criteria. This method accepts various arguments and returns an object.
|
|
177
|
+
* Alternative usage: Board.ItemsPage.getItemsPage
|
|
178
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items_page#queries
|
|
179
|
+
* @param options Request options.
|
|
180
|
+
*/
|
|
181
|
+
getItemsPage<T = GetItemsPageFullResponseOK, S extends GetItemsPageRequest = GetItemsPageRequest>(options: S): Promise<T extends GetItemsPageFullResponseOK ? GetItemsPageResponseOK<S> : T>;
|
|
182
|
+
/**
|
|
183
|
+
* Querying next_items_page will return the next set of items that correspond with the provided cursor. This method accepts various arguments and returns an object.
|
|
184
|
+
* Alternative usage: ItemsPage.getNextItemsPage
|
|
185
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items_page#cursor-based-pagination-using-next_items_page
|
|
186
|
+
* @param options Request options.
|
|
187
|
+
*/
|
|
188
|
+
getNextItemsPage<T = GetNextItemsPageFullResponseOK, S extends GetNextItemsPageRequest = GetNextItemsPageRequest>(options: S): Promise<T extends GetNextItemsPageFullResponseOK ? GetNextItemsPageResponseOK<S> : T>;
|
|
189
|
+
/**
|
|
190
|
+
* Querying items_page_by_column_values will search for items based on predefined column values and return metadata about these specific items. This method accepts various arguments and returns an array.
|
|
191
|
+
* Alternative usage: ItemsPage.getItemsPageByColumnValues
|
|
192
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items-page-by-column-values
|
|
193
|
+
* @param options Request options.
|
|
194
|
+
*/
|
|
195
|
+
getItemsPageByColumnValues<T = GetItemsPageByColumnValuesFullResponseOK, S extends GetItemsPageByColumnValuesRequest = GetItemsPageByColumnValuesRequest>(options: S): Promise<T extends GetItemsPageByColumnValuesFullResponseOK ? GetItemsPageByColumnValuesResponseOK<S> : T>;
|
|
196
|
+
/**
|
|
197
|
+
* Querying views will return a collection of board views from a specific board. This method accepts various arguments and returns an array.
|
|
198
|
+
* You can only query views by nesting it within a boards query, so it can't be used at the root.
|
|
199
|
+
* Alternative usage: Board.View.getViews
|
|
200
|
+
* Documentation: https://developer.monday.com/api-reference/docs/board-view-queries#queries
|
|
201
|
+
* @param options Request options.
|
|
202
|
+
*/
|
|
203
|
+
getBoardViews<T = GetBoardViewsFullResponseOK, S extends GetBoardViewsRequest = GetBoardViewsRequest>(options: S): Promise<T extends GetBoardViewsFullResponseOK ? GetBoardViewsResponseOK<S> : T>;
|
|
204
|
+
/**
|
|
205
|
+
* Querying groups will return metadata about one or a collection of groups on a specific board. This method accepts one argument and returns an array. *
|
|
206
|
+
* You can only query groups by nesting it within another query, so it can't be used at the root.
|
|
207
|
+
* Alternative usage: Board.Group.getGroups
|
|
208
|
+
* Documentation: https://developer.monday.com/api-reference/docs/groups#queries
|
|
209
|
+
* @param options Request options.
|
|
210
|
+
*/
|
|
211
|
+
getBoardGroups<T = GetBoardGroupsFullResponseOK, S extends GetBoardGroupsRequest = GetBoardGroupsRequest>(options: S): Promise<T extends GetBoardGroupsFullResponseOK ? GetBoardGroupsResponseOK<S> : T>;
|
|
212
|
+
/**
|
|
213
|
+
* The create_group mutation allows you to create a new empty group via the API. You can also specify what fields to query back from the new group when you run the mutation.
|
|
214
|
+
* Alternative usage: Board.Group.createGroup
|
|
215
|
+
* Documentation: https://developer.monday.com/api-reference/docs/groups#create-a-group
|
|
216
|
+
* @param options
|
|
217
|
+
*/
|
|
218
|
+
createGroup<T = CreateBoardGroupFullResponseOK, S extends CreateBoardGroupRequest = CreateBoardGroupRequest>(options: S): Promise<T extends CreateBoardGroupFullResponseOK ? CreateBoardGroupResponseOK<S> : T>;
|
|
219
|
+
/**
|
|
220
|
+
* The update_group mutation allows you to update an existing group via the API. You can also specify what fields to query back from the updated group when you run the mutation.
|
|
221
|
+
* Alternative usage: Board.Group.updateGroup
|
|
222
|
+
* Documentation: https://developer.monday.com/api-reference/docs/groups#update-a-group
|
|
223
|
+
* @param options
|
|
224
|
+
*/
|
|
225
|
+
updateGroup<T = UpdateBoardGroupFullResponseOK, S extends UpdateBoardGroupRequest = UpdateBoardGroupRequest>(options: S): Promise<T extends UpdateBoardGroupFullResponseOK ? UpdateBoardGroupResponseOK<S> : T>;
|
|
226
|
+
/**
|
|
227
|
+
* The duplicate_group mutation allows you to duplicate a group with all of its items via the API. You can also specify what fields to query back from the duplicated group when you run the mutation.
|
|
228
|
+
* Alternative usage: Board.Group.duplicateGroup
|
|
229
|
+
* Documentation: https://developer.monday.com/api-reference/docs/groups#duplicate-group
|
|
230
|
+
* (!) Mutation-specific rate limit:
|
|
231
|
+
* The duplicate_group mutation has an additional rate limit of 40 mutations per minute. If you exceed this limit, you will receive a response with a 429 status code, and the following error message: "Call limit exceeded for DuplicateGroup".
|
|
232
|
+
* @param options
|
|
233
|
+
*/
|
|
234
|
+
duplicateGroup<T = DuplicateBoardGroupFullResponseOK, S extends DuplicateBoardGroupRequest = DuplicateBoardGroupRequest>(options: S): Promise<T extends DuplicateBoardGroupFullResponseOK ? DuplicateBoardGroupResponseOK<S> : T>;
|
|
235
|
+
/**
|
|
236
|
+
* The archive_group mutation allows you to archive a group with all of its items via the API. You can also specify what fields to query back from the archived group when you run the mutation.
|
|
237
|
+
* Alternative usage: Board.Group.archiveGroup
|
|
238
|
+
* Documentation: https://developer.monday.com/api-reference/docs/groups#archive-a-group
|
|
239
|
+
* @param options
|
|
240
|
+
*/
|
|
241
|
+
archiveGroup<T = ArchiveBoardGroupFullResponseOK, S extends ArchiveBoardGroupRequest = ArchiveBoardGroupRequest>(options: S): Promise<T extends ArchiveBoardGroupFullResponseOK ? ArchiveBoardGroupResponseOK<S> : T>;
|
|
242
|
+
/**
|
|
243
|
+
* The delete_group mutation allows you to delete a group with all of its items via the API. You can also specify what fields to query back from the deleted group when you run the mutation.
|
|
244
|
+
* Alternative usage: Board.Group.deleteGroup
|
|
245
|
+
* Documentation: https://developer.monday.com/api-reference/docs/groups#delete-a-group
|
|
246
|
+
* @param options
|
|
247
|
+
*/
|
|
248
|
+
deleteGroup<T = DeleteBoardGroupFullResponseOK, S extends DeleteBoardGroupRequest = DeleteBoardGroupRequest>(options: S): Promise<T extends DeleteBoardGroupFullResponseOK ? DeleteBoardGroupResponseOK<S> : T>;
|
|
249
|
+
/**
|
|
250
|
+
* Querying items will return metadata about one or a collection of items. This method accepts various arguments and returns an array.
|
|
251
|
+
* Alternative usage: Item.getItems
|
|
252
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#queries
|
|
253
|
+
* @param options Request options.
|
|
254
|
+
*/
|
|
255
|
+
getItems<T = GetItemsFullResponseOK, S extends GetItemsRequest = GetItemsRequest>(options: S): Promise<T extends GetItemsFullResponseOK ? GetItemsResponseOK<S> : T>;
|
|
256
|
+
/**
|
|
257
|
+
* The create_item mutation allows you to create a new item via the API. You can also specify what fields to query back from the new item when you run the mutation.
|
|
258
|
+
* Alternative usage: Item.createItem
|
|
259
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#create-an-item
|
|
260
|
+
* @param options Request options.
|
|
261
|
+
*/
|
|
262
|
+
createItem<T = CreateItemFullResponseOK, S extends CreateItemRequest = CreateItemRequest>(options: S): Promise<T extends CreateItemFullResponseOK ? CreateItemResponseOK<S> : T>;
|
|
263
|
+
/**
|
|
264
|
+
* The duplicate_item mutation allows you to duplicate a single item via the API. You can also specify what fields to query back from the duplicated item when you run the mutation.
|
|
265
|
+
* Alternative usage: Item.duplicateItem
|
|
266
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#duplicate-an-item
|
|
267
|
+
* @param options Request options.
|
|
268
|
+
*/
|
|
269
|
+
duplicateItem<T = DuplicateItemFullResponseOK, S extends DuplicateItemRequest = DuplicateItemRequest>(options: S): Promise<T extends DuplicateItemFullResponseOK ? DuplicateItemResponseOK<S> : T>;
|
|
270
|
+
/**
|
|
271
|
+
* The move_item_to_group mutation allows you to move an item between groups on the same board via the API. You can also specify what fields to query back from the item when you run the mutation.
|
|
272
|
+
* Alternative usage: Item.moveItemToGroup
|
|
273
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#move-item-to-group
|
|
274
|
+
* @param options Request options.
|
|
275
|
+
*/
|
|
276
|
+
moveItemToGroup<T = MoveItemToGroupFullResponseOK, S extends MoveItemToGroupRequest = MoveItemToGroupRequest>(options: S): Promise<T extends MoveItemToGroupFullResponseOK ? MoveItemToGroupResponseOK<S> : T>;
|
|
277
|
+
/**
|
|
278
|
+
* The move_item_to_board mutation allows you to move an item to another board via the API. You can also specify what fields to query back from the item moved when you run the mutation.
|
|
279
|
+
* Alternative usage: Item.moveItemToBoard
|
|
280
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#move-item-to-board
|
|
281
|
+
* @param options Request options.
|
|
282
|
+
*/
|
|
283
|
+
moveItemToBoard<T = MoveItemToBoardFullResponseOK, S extends MoveItemToBoardRequest = MoveItemToBoardRequest>(options: S): Promise<T extends MoveItemToBoardFullResponseOK ? MoveItemToBoardResponseOK<S> : T>;
|
|
284
|
+
/**
|
|
285
|
+
* The archive_item mutation allows you to archive a single item via the API. You can also specify what fields to query back from the archived item when you run the mutation.
|
|
286
|
+
* Alternative usage: Item.archiveItem
|
|
287
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#archive-an-item
|
|
288
|
+
* @param options Request options.
|
|
289
|
+
*/
|
|
290
|
+
archiveItem<T = ArchiveItemFullResponseOK, S extends ArchiveItemRequest = ArchiveItemRequest>(options: S): Promise<T extends ArchiveItemFullResponseOK ? ArchiveItemResponseOK<S> : T>;
|
|
291
|
+
/**
|
|
292
|
+
* The delete_item mutation allows you to delete a single item via the API. You can also specify what fields to query back from the deleted item when you run the mutation.
|
|
293
|
+
* Alternative usage: Item.deleteItem
|
|
294
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#delete-an-item
|
|
295
|
+
* @param options Request options.
|
|
296
|
+
*/
|
|
297
|
+
deleteItem<T = DeleteItemFullResponseOK, S extends DeleteItemRequest = DeleteItemRequest>(options: S): Promise<T extends DeleteItemFullResponseOK ? DeleteItemResponseOK<S> : T>;
|
|
298
|
+
/**
|
|
299
|
+
* The clear_item_updates mutation allows you to clear all updates on a specific item, including replies and likes. You can also specify what fields to query back from the item when you run the mutation.
|
|
300
|
+
* Alternative usage: Item.clearUpdates
|
|
301
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#clear-an-items-updates
|
|
302
|
+
* @param options Request options.
|
|
303
|
+
*/
|
|
304
|
+
clearItemUpdates<T = ClearItemUpdatesFullResponseOK, S extends ClearItemUpdatesRequest = ClearItemUpdatesRequest>(options: S): Promise<T extends ClearItemUpdatesFullResponseOK ? ClearItemUpdatesResponseOK<S> : T>;
|
|
305
|
+
/**
|
|
306
|
+
* Querying subitems will return metadata about one or a collection of subitems. This method does not accept any arguments and returns an array.
|
|
307
|
+
* You can only query subitems by nesting it within another query, so it can't be used at the root.
|
|
308
|
+
* Alternative usage: Item.Subitem.getSubitems
|
|
309
|
+
* Documentation: https://developer.monday.com/api-reference/docs/subitems#queries
|
|
310
|
+
* @param options Request options.
|
|
311
|
+
*/
|
|
312
|
+
getSubitems<T = GetSubitemsFullResponseOK, S extends GetSubitemsRequest = GetSubitemsRequest>(options: S): Promise<T extends GetSubitemsFullResponseOK ? GetSubitemsResponseOK<S> : T>;
|
|
313
|
+
/**
|
|
314
|
+
* The create_subitem mutation allows you to create a new subitem via the API. You can also specify what fields to query back from the new subitem when you run the mutation.
|
|
315
|
+
* Alternative usage: Item.Subitem.createSubitem
|
|
316
|
+
* Documentation: https://developer.monday.com/api-reference/docs/subitems#create-a-subitem
|
|
317
|
+
* @param options Request options.
|
|
318
|
+
*/
|
|
319
|
+
createSubitem<T = CreateSubitemFullResponseOK, S extends CreateSubitemRequest = CreateSubitemRequest>(options: S): Promise<T extends CreateSubitemFullResponseOK ? CreateSubitemResponseOK<S> : T>;
|
|
320
|
+
/**
|
|
321
|
+
* Querying me will return metadata about the user whose API key is being used. This method does not accept any arguments and returns an object.
|
|
322
|
+
* You can only query me directly at the root, so it can't be nested within another query.
|
|
323
|
+
* Alternative usage: Me.getUserDetails
|
|
324
|
+
* Documentation: https://developer.monday.com/api-reference/docs/me#queries
|
|
325
|
+
* @param options Request options.
|
|
326
|
+
*/
|
|
327
|
+
getUserDetails<T = GetUserDetailsFullResponseOK, S extends GetUserDetailsRequest = GetUserDetailsRequest>(options: S): Promise<T extends GetUserDetailsFullResponseOK ? GetUserDetailsResponseOK<S> : T>;
|
|
328
|
+
/**
|
|
329
|
+
* Querying users will return metadata about one or multiple users. This method accepts various arguments and returns an array.
|
|
330
|
+
* Alternative usage: User.getUsers
|
|
331
|
+
* Documentation: https://developer.monday.com/api-reference/docs/users#queries
|
|
332
|
+
* @param options Request options.
|
|
333
|
+
*/
|
|
334
|
+
getUsers<T = GetUsersFullResponseOK, S extends GetUsersRequest = GetUsersRequest>(options: S): Promise<T extends GetUsersFullResponseOK ? GetUsersResponseOK<S> : T>;
|
|
335
|
+
/**
|
|
336
|
+
* The add_users_to_board mutation allows you to add users to a board via the API. You can also specify what fields to query back from the user when you run the mutation.
|
|
337
|
+
* Alternative usage: User.addUsersToBoard
|
|
338
|
+
* Documentation: https://developer.monday.com/api-reference/docs/users#add-users-to-a-board
|
|
339
|
+
* @param options Request options.
|
|
340
|
+
*/
|
|
341
|
+
addUsersToBoard<T = AddUsersToBoardFullResponseOK, S extends AddUsersToBoardRequest = AddUsersToBoardRequest>(options: S): Promise<T extends AddUsersToBoardFullResponseOK ? AddUsersToBoardResponseOK<S> : T>;
|
|
342
|
+
/**
|
|
343
|
+
* The add_users_to_workspace mutation allows you to add users to a workspace via the API. You can also specify what fields to query back from the user when you run the mutation.
|
|
344
|
+
* Alternative usage: User.addUsersToWorkspace
|
|
345
|
+
* Documentation: https://developer.monday.com/api-reference/docs/users#add-users-to-a-workspace
|
|
346
|
+
* @param options Request options.
|
|
347
|
+
*/
|
|
348
|
+
addUsersToWorkspace<T = AddUsersToWorkspaceFullResponseOK, S extends AddUsersToWorkspaceRequest = AddUsersToWorkspaceRequest>(options: S): Promise<T extends AddUsersToWorkspaceFullResponseOK ? AddUsersToWorkspaceResponseOK<S> : T>;
|
|
349
|
+
/**
|
|
350
|
+
* The delete_users_from_workspace mutation allows you to delete users from a workspace via the API. You can also specify what fields to query back from the user when you run the mutation.
|
|
351
|
+
* Alternative usage: User.deleteUsersFromWorkspace
|
|
352
|
+
* Documentation: https://developer.monday.com/api-reference/docs/users#delete-users-from-a-workspace
|
|
353
|
+
* @param options Request options.
|
|
354
|
+
*/
|
|
355
|
+
deleteUsersFromWorkspace<T = DeleteUsersFromWorkspaceFullResponseOK, S extends DeleteUsersFromWorkspaceRequest = DeleteUsersFromWorkspaceRequest>(options: S): Promise<T extends DeleteUsersFromWorkspaceFullResponseOK ? DeleteUsersFromWorkspaceResponseOK<S> : T>;
|
|
356
|
+
/**
|
|
357
|
+
* This mutation deactivates users from a monday.com account. It returns the DeactivateUsersResult type which supports a set of fields that you can query back when you run it.
|
|
358
|
+
* Alternative usage: User.deactivateUsers
|
|
359
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#deactivate-users
|
|
360
|
+
* @param options Request options.
|
|
361
|
+
*/
|
|
362
|
+
deactivateUsers<T = DeactivateUsersFullResponseOK, S extends DeactivateUsersRequest = DeactivateUsersRequest>(options: S): Promise<T extends DeactivateUsersFullResponseOK ? DeactivateUsersResponseOK<S> : T>;
|
|
363
|
+
/**
|
|
364
|
+
* This mutation activates or re-activates users in a monday.com account. It returns the ActivateUsersResult type which allows you to specify what fields to query back when you run it.
|
|
365
|
+
* Alternative usage: User.activateUsers
|
|
366
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#activate-users
|
|
367
|
+
* @param options Request options.
|
|
368
|
+
*/
|
|
369
|
+
activateUsers<T = ActivateUsersFullResponseOK, S extends ActivateUsersRequest = ActivateUsersRequest>(options: S): Promise<T extends ActivateUsersFullResponseOK ? ActivateUsersResponseOK<S> : T>;
|
|
370
|
+
/**
|
|
371
|
+
* This mutation updates a user's role (accepts both custom or default roles). It returns the UpdateUsersRoleResult type which allows you to specify what fields to query back when you run it.
|
|
372
|
+
* Alternative usage: User.updateUsersRole
|
|
373
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#activate-users
|
|
374
|
+
* @param options Request options.
|
|
375
|
+
*/
|
|
376
|
+
updateUsersRole<T = UpdateUsersRoleFullResponseOK, S extends UpdateUsersRoleRequest = UpdateUsersRoleRequest>(options: S): Promise<T extends UpdateUsersRoleFullResponseOK ? UpdateUsersRoleResponseOK<S> : T>;
|
|
377
|
+
/**
|
|
378
|
+
* This mutation updates a user's email domain. It returns the UpdateEmailDomainResult type which allows you to specify what fields to query back when you run it.
|
|
379
|
+
* Alternative usage: User.updateUsersEmailDomain
|
|
380
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#update-a-users-email-domain
|
|
381
|
+
* @param options Request options.
|
|
382
|
+
*/
|
|
383
|
+
updateUsersEmailDomain<T = UpdateUsersEmailDomainFullResponseOK, S extends UpdateUsersEmailDomainRequest = UpdateUsersEmailDomainRequest>(options: S): Promise<T extends UpdateUsersEmailDomainFullResponseOK ? UpdateUsersEmailDomainResponseOK<S> : T>;
|
|
384
|
+
/**
|
|
385
|
+
* This mutation invites users to join a monday.com account. They will be in a pending status until the invitation is accepted.
|
|
386
|
+
* Alternative usage: User.inviteUsers
|
|
387
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#invite-users
|
|
388
|
+
* @param options Request options.
|
|
389
|
+
*/
|
|
390
|
+
inviteUsers<T = InviteUsersFullResponseOK, S extends InviteUsersRequest = InviteUsersRequest>(options: S): Promise<T extends InviteUsersFullResponseOK ? InviteUsersResponseOK<S> : T>;
|
|
391
|
+
/**
|
|
392
|
+
* The update_multiple_users mutation updates one or multiple users' attributes. It returns the UpdateUserAttributesResult type which supports a set of fields you can query back.
|
|
393
|
+
* Alternative usage: User.updateUsersAttributes
|
|
394
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#update-users-attributes
|
|
395
|
+
* @param options Request options.
|
|
396
|
+
*/
|
|
397
|
+
updateUsersAttributes<T = UpdateUsersAttributesFullResponseOK, S extends UpdateUsersAttributesRequest = UpdateUsersAttributesRequest>(options: S): Promise<T extends UpdateUsersAttributesFullResponseOK ? UpdateUsersAttributesResponseOK<S> : T>;
|
|
398
|
+
/**
|
|
399
|
+
* Returns an object containing metadata about all user roles in an account (both default and custom).
|
|
400
|
+
* Alternative usage: Account.Role.getAccountRoles
|
|
401
|
+
* Documentation: https://developer.monday.com/api-reference/reference/account-roles#queries
|
|
402
|
+
* @param options Request options.
|
|
403
|
+
*/
|
|
404
|
+
getAccountRoles<T = GetAccountRolesFullResponseOK, S extends GetAccountRolesRequest = GetAccountRolesRequest>(options: S): Promise<T extends GetAccountRolesFullResponseOK ? GetAccountRolesResponseOK<S> : T>;
|
|
405
|
+
/**
|
|
406
|
+
* Querying assets will return one or a collection of assets. This method accepts various arguments and returns an array.
|
|
407
|
+
* Alternative usage: File.getAssets
|
|
408
|
+
* Documentation: https://developer.monday.com/api-reference/docs/files#queries
|
|
409
|
+
* @param options Request options.
|
|
410
|
+
*/
|
|
411
|
+
getAssets<T = GetAssetsFullResponseOK, S extends GetAssetsRequest = GetAssetsRequest>(options: S): Promise<T extends GetAssetsFullResponseOK ? GetAssetsResponseOK<S> : T>;
|
|
412
|
+
/**
|
|
413
|
+
* The add_file_to_update mutation allows you to add a file to an update via the API. You can also specify what fields to query back when you run the mutation. Please note that the file will be added to the bottom of the update.
|
|
414
|
+
* Alternative usage: File.addFileToUpdate
|
|
415
|
+
* Documentation: https://developer.monday.com/api-reference/docs/files#add-a-file-to-an-update
|
|
416
|
+
* @param options Request options.
|
|
417
|
+
*/
|
|
418
|
+
addFileToUpdate<T = AddFileToUpdateFullResponseOK, S extends AddFileToUpdateRequest = AddFileToUpdateRequest>(options: S): Promise<T extends AddFileToUpdateFullResponseOK ? AddFileToUpdateResponseOK<S> : T>;
|
|
419
|
+
/**
|
|
420
|
+
* The add_file_to_column mutation will add a file to the file column of a specific item. You can also specify what fields to query back when you run the mutation.
|
|
421
|
+
* Alternative usage: File.addFileToColumn
|
|
422
|
+
* Documentation: https://developer.monday.com/api-reference/docs/files#add-file-to-the-file-column
|
|
423
|
+
* @param options Request options.
|
|
424
|
+
*/
|
|
425
|
+
addFileToColumn<T = AddFileToColumnFullResponseOK, S extends AddFileToColumnRequest = AddFileToColumnRequest>(options: S): Promise<T extends AddFileToColumnFullResponseOK ? AddFileToColumnResponseOK<S> : T>;
|
|
426
|
+
/**
|
|
427
|
+
* The create_notification mutation allows you to send a notification to the bell icon via the API. Doing so may also send an email if the recipient's email preferences are set up accordingly.
|
|
428
|
+
* Please note that this mutation only sends the notification; you can't query back the notification ID when running the mutation, as notifications are asynchronous.
|
|
429
|
+
* Alternative usage: Notification.createNotification
|
|
430
|
+
* Documentation: https://developer.monday.com/api-reference/docs/notification#create-a-notification
|
|
431
|
+
* @param options Request options.
|
|
432
|
+
*/
|
|
433
|
+
createNotification<T = CreateNotificationFullResponseOK, S extends CreateNotificationRequest = CreateNotificationRequest>(options: S): Promise<T extends CreateNotificationFullResponseOK ? CreateNotificationResponseOK<S> : T>;
|
|
434
|
+
/**
|
|
435
|
+
* Querying workspaces will return metadata about one or a collection of workspaces. This method accepts various arguments and returns an array.
|
|
436
|
+
* Alternative usage: Workspace.getWorkspaces
|
|
437
|
+
* Documentation: https://developer.monday.com/api-reference/docs/workspaces#queries
|
|
438
|
+
* @param options Request options.
|
|
439
|
+
*/
|
|
440
|
+
getWorkspaces<T = GetWorkspacesFullResponseOK, S extends GetWorkspacesRequest = GetWorkspacesRequest>(options: S): Promise<T extends GetWorkspacesFullResponseOK ? GetWorkspacesResponseOK<S> : T>;
|
|
441
|
+
/**
|
|
442
|
+
* The create_workspace mutation allows you to create a new workspace via the API.
|
|
443
|
+
* You can also specify what fields to query back from the new workspace when you run the mutation.
|
|
444
|
+
* Alternative usage: Workspace.createWorkspace
|
|
445
|
+
* Documentation: https://developer.monday.com/api-reference/docs/workspaces#create-a-workspace
|
|
446
|
+
* @param options Request options.
|
|
447
|
+
*/
|
|
448
|
+
createWorkspace<T = CreateWorkspaceFullResponseOK, S extends CreateWorkspaceRequest = CreateWorkspaceRequest>(options: S): Promise<T extends CreateWorkspaceFullResponseOK ? CreateWorkspaceResponseOK<S> : T>;
|
|
449
|
+
/**
|
|
450
|
+
* The update_workspace mutation allows you to update a workspace via the API.
|
|
451
|
+
* You can also specify what fields to query back from the deleted workspace when you run the mutation.
|
|
452
|
+
* Alternative usage: Workspace.updateWorkspace
|
|
453
|
+
* Documentation: https://developer.monday.com/api-reference/reference/workspaces#update-a-workspace
|
|
454
|
+
* @param options Request options.
|
|
455
|
+
*/
|
|
456
|
+
updateWorkspace<T = UpdateWorkspaceFullResponseOK, S extends UpdateWorkspaceRequest = UpdateWorkspaceRequest>(options: S): Promise<T extends UpdateWorkspaceFullResponseOK ? UpdateWorkspaceResponseOK<S> : T>;
|
|
457
|
+
/**
|
|
458
|
+
* The delete_workspace mutation allows you to delete a workspace via the API.
|
|
459
|
+
* You can also specify what fields to query back from the deleted workspace when you run the mutation.
|
|
460
|
+
* Alternative usage: Workspace.deleteWorkspace
|
|
461
|
+
* Documentation: https://developer.monday.com/api-reference/docs/workspaces#delete-a-workspace
|
|
462
|
+
* @param options Request options.
|
|
463
|
+
*/
|
|
464
|
+
deleteWorkspace<T = DeleteWorkspaceFullResponseOK, S extends DeleteWorkspaceRequest = DeleteWorkspaceRequest>(options: S): Promise<T extends DeleteWorkspaceFullResponseOK ? DeleteWorkspaceResponseOK<S> : T>;
|
|
465
|
+
/**
|
|
466
|
+
* Querying updates will return metadata about one or a collection of updates.
|
|
467
|
+
* This method accepts various arguments and returns an array.
|
|
468
|
+
* Alternative usage: Update.getUpdates
|
|
469
|
+
* Documentation: https://developer.monday.com/api-reference/docs/updates#queries
|
|
470
|
+
* @param options Request options.
|
|
471
|
+
*/
|
|
472
|
+
getUpdates<T = GetUpdatesFullResponseOK, S extends GetUpdatesRequest = GetUpdatesRequest>(options: S): Promise<T extends GetUpdatesFullResponseOK ? GetUpdatesResponseOK<S> : T>;
|
|
473
|
+
/**
|
|
474
|
+
* The create_update mutation allows you to add an update to an item via the API.
|
|
475
|
+
* You can also specify what fields to query back from the new update when you run the mutation.
|
|
476
|
+
* Alternative usage: Update.createUpdate
|
|
477
|
+
* Documentation: https://developer.monday.com/api-reference/docs/updates#create-an-update
|
|
478
|
+
* @param options Request options.
|
|
479
|
+
*/
|
|
480
|
+
createUpdate<T = CreateUpdateFullResponseOK, S extends CreateUpdateRequest = CreateUpdateRequest>(options: S): Promise<T extends CreateUpdateFullResponseOK ? CreateUpdateResponseOK<S> : T>;
|
|
481
|
+
/**
|
|
482
|
+
* The edit_update mutation allows you to edit an update via the API.
|
|
483
|
+
* You can also specify what fields to query back from the update when you run the mutation.
|
|
484
|
+
* Alternative usage: Update.editUpdate
|
|
485
|
+
* Documentation: https://developer.monday.com/api-reference/reference/updates#edit-an-update
|
|
486
|
+
* @param options Request options.
|
|
487
|
+
*/
|
|
488
|
+
editUpdate<T = EditUpdateFullResponseOK, S extends EditUpdateRequest = EditUpdateRequest>(options: S): Promise<T extends EditUpdateFullResponseOK ? EditUpdateResponseOK<S> : T>;
|
|
489
|
+
/**
|
|
490
|
+
* The delete_update mutation allows you to delete an item's update via the API.
|
|
491
|
+
* You can also specify what fields to query back from the update when you run the mutation.
|
|
492
|
+
* Alternative usage: Update.deleteUpdate
|
|
493
|
+
* Documentation: https://developer.monday.com/api-reference/docs/updates#delete-an-update
|
|
494
|
+
* @param options Request options.
|
|
495
|
+
*/
|
|
496
|
+
deleteUpdate<T = DeleteUpdateFullResponseOK, S extends DeleteUpdateRequest = DeleteUpdateRequest>(options: S): Promise<T extends DeleteUpdateFullResponseOK ? DeleteUpdateResponseOK<S> : T>;
|
|
497
|
+
/**
|
|
498
|
+
* The like_update mutation allows you to like an update via the API.
|
|
499
|
+
* You can also specify what fields to query back from the update when you run the mutation.
|
|
500
|
+
* Alternative usage: Update.likeUpdate
|
|
501
|
+
* Documentation: https://developer.monday.com/api-reference/docs/updates#like-an-update
|
|
502
|
+
* @param options Request options.
|
|
503
|
+
*/
|
|
504
|
+
likeUpdate<T = LikeUpdateFullResponseOK, S extends LikeUpdateRequest = LikeUpdateRequest>(options: S): Promise<T extends LikeUpdateFullResponseOK ? LikeUpdateResponseOK<S> : T>;
|
|
505
|
+
/**
|
|
506
|
+
* The unlike_update mutation allows you to unlike an update via the API.
|
|
507
|
+
* You can also specify what fields to query back from the update when you run the mutation.
|
|
508
|
+
* Alternative usage: Update.unlikeUpdate
|
|
509
|
+
* Documentation: https://developer.monday.com/api-reference/reference/updates#unlike-an-update
|
|
510
|
+
* @param options Request options.
|
|
511
|
+
*/
|
|
512
|
+
unlikeUpdate<T = UnlikeUpdateFullResponseOK, S extends UnlikeUpdateRequest = UnlikeUpdateRequest>(options: S): Promise<T extends UnlikeUpdateFullResponseOK ? UnlikeUpdateResponseOK<S> : T>;
|
|
513
|
+
/**
|
|
514
|
+
* The pin_to_top mutation allows you to pin an update to the top of an item via the API.
|
|
515
|
+
* You can also specify what fields to query back from the update when you run the mutation.
|
|
516
|
+
* Alternative usage: Update.pinUpdate
|
|
517
|
+
* Documentation: https://developer.monday.com/api-reference/reference/updates#pin-an-update
|
|
518
|
+
* @param options Request options.
|
|
519
|
+
*/
|
|
520
|
+
pinUpdate<T = PinUpdateFullResponseOK, S extends PinUpdateRequest = PinUpdateRequest>(options: S): Promise<T extends PinUpdateFullResponseOK ? PinUpdateResponseOK<S> : T>;
|
|
521
|
+
/**
|
|
522
|
+
* The unpin_from_top mutation allows you to unpin an update from the top of an item via the API.
|
|
523
|
+
* You can also specify what fields to query back from the update when you run the mutation.
|
|
524
|
+
* Alternative usage: Update.unpinUpdate
|
|
525
|
+
* Documentation: https://developer.monday.com/api-reference/reference/updates#unpin-an-update
|
|
526
|
+
* @param options Request options.
|
|
527
|
+
*/
|
|
528
|
+
unpinUpdate<T = UnpinUpdateFullResponseOK, S extends UnpinUpdateRequest = UnpinUpdateRequest>(options: S): Promise<T extends UnpinUpdateFullResponseOK ? UnpinUpdateResponseOK<S> : T>;
|
|
529
|
+
/**
|
|
530
|
+
* Querying teams will return metadata about one or several teams. This method accepts one argument and returns an array.
|
|
531
|
+
* You can query teams directly at the root, or you can nest it within a users query to return the teams a specific user is part of. Please note that nesting your query will increase its complexity.
|
|
532
|
+
* Alternative: Team.getTeam
|
|
533
|
+
* Documentation: https://developer.monday.com/api-reference/docs/teams#queries
|
|
534
|
+
* @param options
|
|
535
|
+
*/
|
|
536
|
+
getTeams<T = GetTeamsFullResponseOK, S extends GetTeamsRequest = GetTeamsRequest>(options: S): Promise<T extends GetTeamsFullResponseOK ? GetTeamsResponseOK<S> : T>;
|
|
537
|
+
/**
|
|
538
|
+
* The add_teams_to_board mutation allows you to add teams to a board via the API. You can also specify what fields to query back when you run the mutation.
|
|
539
|
+
* Alternative: Team.addTeamsToBoard
|
|
540
|
+
* Documentation: https://developer.monday.com/api-reference/docs/teams#add-teams-to-a-board
|
|
541
|
+
* @param options
|
|
542
|
+
*/
|
|
543
|
+
addTeamsToBoard<T = AddTeamsToBoardFullResponseOK, S extends AddTeamsToBoardRequest = AddTeamsToBoardRequest>(options: S): Promise<T extends AddTeamsToBoardFullResponseOK ? AddTeamsToBoardResponseOK<S> : T>;
|
|
544
|
+
/**
|
|
545
|
+
* The add_teams_to_workspace mutation allows you to add teams to a workspace via the API. You can also specify what fields to query back when you run the mutation.
|
|
546
|
+
* Alternative: Team.addTeamsToWorkspace
|
|
547
|
+
* Documentation: https://developer.monday.com/api-reference/docs/teams#add-teams-to-a-workspace
|
|
548
|
+
* @param options
|
|
549
|
+
*/
|
|
550
|
+
addTeamsToWorkspace<T = AddTeamsToWorkspaceFullResponseOK, S extends AddTeamsToWorkspaceRequest = AddTeamsToWorkspaceRequest>(options: S): Promise<T extends AddTeamsToWorkspaceFullResponseOK ? AddTeamsToWorkspaceResponseOK<S> : T>;
|
|
551
|
+
/**
|
|
552
|
+
* The delete_teams_from_workspace mutation allows you to delete teams from a workspace via the API.
|
|
553
|
+
* You can also specify what fields to query back when you run the mutation.
|
|
554
|
+
* Alternative: Team.deleteTeamsFromWorkspace
|
|
555
|
+
* Documentation: https://developer.monday.com/api-reference/docs/teams#delete-teams-from-a-workspace
|
|
556
|
+
* @param options
|
|
557
|
+
*/
|
|
558
|
+
deleteTeamsFromWorkspace<T = DeleteTeamsFromWorkspaceFullResponseOK, S extends DeleteTeamsFromWorkspaceRequest = DeleteTeamsFromWorkspaceRequest>(options: S): Promise<T extends DeleteTeamsFromWorkspaceFullResponseOK ? DeleteTeamsFromWorkspaceResponseOK<S> : T>;
|
|
559
|
+
/**
|
|
560
|
+
* The delete_teams_from_board mutation allows you to delete teams from a board via the API.
|
|
561
|
+
* You can also specify what fields to query back when you run the mutation.
|
|
562
|
+
* Alternative: Team.deleteTeamsFromBoard
|
|
563
|
+
* Documentation: https://developer.monday.com/api-reference/docs/teams#delete-teams-from-a-board
|
|
564
|
+
* @param options
|
|
565
|
+
*/
|
|
566
|
+
deleteTeamsFromBoard<T = DeleteTeamsFromBoardFullResponseOK, S extends DeleteTeamsFromBoardRequest = DeleteTeamsFromBoardRequest>(options: S): Promise<T extends DeleteTeamsFromBoardFullResponseOK ? DeleteTeamsFromBoardResponseOK<S> : T>;
|
|
567
|
+
/**
|
|
568
|
+
* The add_users_to_team mutation allows you to add users to a team via the API. This mutation returns the ChangeTeamMembershipResult type which allows you to specify what fields to query back when you run the mutation.
|
|
569
|
+
* Alternative: Team.addUsersToTeam
|
|
570
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#add-users-to-a-team
|
|
571
|
+
* @param options
|
|
572
|
+
*/
|
|
573
|
+
addUsersToTeam<T = AddUsersToTeamFullResponseOK, S extends AddUsersToTeamRequest = AddUsersToTeamRequest>(options: S): Promise<T extends AddUsersToTeamFullResponseOK ? AddUsersToTeamResponseOK<S> : T>;
|
|
574
|
+
/**
|
|
575
|
+
* The remove_users_from_team mutation allows you to remove users from a team via the API. This mutation returns the ChangeTeamMembershipResult type which allows you to specify what fields to query back when you run the mutation.
|
|
576
|
+
* Alternative: Team.removeUsersFromTeam
|
|
577
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#remove-users-from-a-team
|
|
578
|
+
* @param options
|
|
579
|
+
*/
|
|
580
|
+
removeUsersFromTeam<T = RemoveUsersFromTeamFullResponseOK, S extends RemoveUsersFromTeamRequest = RemoveUsersFromTeamRequest>(options: S): Promise<T extends RemoveUsersFromTeamFullResponseOK ? RemoveUsersFromTeamResponseOK<S> : T>;
|
|
581
|
+
/**
|
|
582
|
+
* The create_team mutation allows you to create a team via the API. You can also specify what fields to query back when you run the mutation.
|
|
583
|
+
* Alternative: Team.createTeam
|
|
584
|
+
* Documentation: https://developer.monday.com/api-reference/reference/teams#create-team
|
|
585
|
+
* @param options
|
|
586
|
+
*/
|
|
587
|
+
createTeam<T = CreateTeamFullResponseOK, S extends CreateTeamRequest = CreateTeamRequest>(options: S): Promise<T extends CreateTeamFullResponseOK ? CreateTeamResponseOK<S> : T>;
|
|
588
|
+
/**
|
|
589
|
+
* The delete_team mutation allows you to delete a team via the API. You can also specify what fields to query back when you run the mutation.
|
|
590
|
+
* Alternative: Team.deleteTeam
|
|
591
|
+
* Documentation: https://developer.monday.com/api-reference/reference/teams#delete-team
|
|
592
|
+
* @param options
|
|
593
|
+
*/
|
|
594
|
+
deleteTeam<T = DeleteTeamFullResponseOK, S extends DeleteTeamRequest = DeleteTeamRequest>(options: S): Promise<T extends DeleteTeamFullResponseOK ? DeleteTeamResponseOK<S> : T>;
|
|
595
|
+
/**
|
|
596
|
+
* This mutation allows you to assign owners to a team. It returns the AssignTeamOwnersResut type which supports a set of fields that you can query back when you run the mutation.
|
|
597
|
+
* Alternative usage: Team.assignTeamOwners
|
|
598
|
+
* Documentation: https://developer.monday.com/api-reference/reference/teams#assign-team-owners
|
|
599
|
+
* @param options Request options.
|
|
600
|
+
*/
|
|
601
|
+
assignTeamOwners<T = AssignTeamOwnersFullResponseOK, S extends AssignTeamOwnersRequest = AssignTeamOwnersRequest>(options: S): Promise<T extends AssignTeamOwnersFullResponseOK ? AssignTeamOwnersResponseOK<S> : T>;
|
|
602
|
+
/**
|
|
603
|
+
* This mutation allows you to remove owners from a team. It returns the RemoveTeamOwnersResult type which supports a set of fields that you can query back when you run the mutation.
|
|
604
|
+
* * Alternative usage: Team.removeTeamOwners
|
|
605
|
+
* Documentation: https://developer.monday.com/api-reference/reference/teams#remove-team-owners
|
|
606
|
+
* @param options Request options.
|
|
607
|
+
*/
|
|
608
|
+
removeTeamOwners<T = RemoveTeamOwnersFullResponseOK, S extends RemoveTeamOwnersRequest = RemoveTeamOwnersRequest>(options: S): Promise<T extends RemoveTeamOwnersFullResponseOK ? RemoveTeamOwnersResponseOK<S> : T>;
|
|
609
|
+
/**
|
|
610
|
+
* Querying docs will return metadata about a collection of docs. This method accepts various arguments and returns an array.
|
|
611
|
+
* Documentation: https://developer.monday.com/api-reference/docs/docs#queries
|
|
612
|
+
* Alternative: Doc.getDocs
|
|
613
|
+
* @param options Request options.
|
|
614
|
+
*/
|
|
615
|
+
getDocs<T = GetDocsFullResponseOK, S extends GetDocsRequest = GetDocsRequest>(options: S): Promise<T extends GetDocsFullResponseOK ? GetDocsResponseOK<S> : T>;
|
|
616
|
+
/**
|
|
617
|
+
* The create_doc mutation allows you to create a new doc in a document column or workspace via the API. You can also specify what fields to query back from the new doc when you run the mutation.
|
|
618
|
+
* Documentation: https://developer.monday.com/api-reference/docs/docs#create-a-doc
|
|
619
|
+
* Alternative: Doc.createDoc
|
|
620
|
+
* @param options Request options.
|
|
621
|
+
*/
|
|
622
|
+
createDoc<T = CreateDocFullResponseOK, S extends CreateDocRequest = CreateDocRequest>(options: S): Promise<T extends CreateDocFullResponseOK ? CreateDocResponseOK<S> : T>;
|
|
623
|
+
/**
|
|
624
|
+
* Querying blocks will return metadata about one or a collection of blocks. The method accepts various arguments and returns an array.
|
|
625
|
+
* Documentation: https://developer.monday.com/api-reference/docs/blocks#queries
|
|
626
|
+
* Alternative: Doc.DocBlock.getDocBlocks
|
|
627
|
+
* @param options Request options.
|
|
628
|
+
*/
|
|
629
|
+
getDocBlocks<T = GetDocBlocksFullResponseOK, S extends GetDocBlocksRequest = GetDocBlocksRequest>(options: S): Promise<T extends GetDocBlocksFullResponseOK ? GetDocBlocksResponseOK<S> : T>;
|
|
630
|
+
/**
|
|
631
|
+
* The create_doc_block mutation allows you to create a new doc block via the API. You can also specify what fields to query back from the new doc block when you run the mutation.
|
|
632
|
+
* Documentation: https://developer.monday.com/api-reference/docs/blocks#create-document-block
|
|
633
|
+
* Alternative: Doc.DocBlock.createDocBlock
|
|
634
|
+
* @param options Request options.
|
|
635
|
+
*/
|
|
636
|
+
createDocBlock<T = CreateDocBlockFullResponseOK, S extends CreateDocBlockRequest = CreateDocBlockRequest>(options: S): Promise<T extends CreateDocBlockFullResponseOK ? CreateDocBlockResponseOK<S> : T>;
|
|
637
|
+
/**
|
|
638
|
+
* The update_doc_block mutation allows you to update a doc block via the API. You can also specify what fields to query back from the updated doc block when you run the mutation.
|
|
639
|
+
* Documentation: https://developer.monday.com/api-reference/docs/blocks#update-document-block
|
|
640
|
+
* Alternative: Doc.DocBlock.updateDocBlock
|
|
641
|
+
* @param options Request options.
|
|
642
|
+
*/
|
|
643
|
+
updateDocBlock<T = UpdateDocBlockFullResponseOK, S extends UpdateDocBlockRequest = UpdateDocBlockRequest>(options: S): Promise<T extends UpdateDocBlockFullResponseOK ? UpdateDocBlockResponseOK<S> : T>;
|
|
644
|
+
/**
|
|
645
|
+
* The delete_doc_block mutation allows you to delete a doc block via the API. You can also specify what fields to query back from the deleted doc block when you run the mutation.
|
|
646
|
+
* Documentation: https://developer.monday.com/api-reference/docs/blocks#delete-document-block
|
|
647
|
+
* Alternative: Doc.DocBlock.deleteDocBlock
|
|
648
|
+
* @param options Request options.
|
|
649
|
+
*/
|
|
650
|
+
deleteDocBlock<T = DeleteDocBlockFullResponseOK, S extends DeleteDocBlockRequest = DeleteDocBlockRequest>(options: S): Promise<T extends DeleteDocBlockFullResponseOK ? DeleteDocBlockResponseOK<S> : T>;
|
|
651
|
+
/**
|
|
652
|
+
* Querying tags will return metadata about one or a collection of the account's public tags. Public tags appear on main boards and are accessible to all member
|
|
653
|
+
* and viewer-level users by default, while private tags only appear on private or shareable boards. This method accepts one argument and returns an array.
|
|
654
|
+
* You can query tags directly at the root to return public tags. If you do so and use the ids argument of a private tag, you will get an empty result.
|
|
655
|
+
* To return tags stored on private or shareable boards, you can nest tags within a boards query.
|
|
656
|
+
* Alternative: Tag.getTags
|
|
657
|
+
* Documentation: https://developer.monday.com/api-reference/docs/tags-queries#queries
|
|
658
|
+
* @param options Request options.
|
|
659
|
+
*/
|
|
660
|
+
getTags<T = GetTagsFullResponseOK, S extends GetTagsRequest = GetTagsRequest>(options: S): Promise<T extends GetTagsFullResponseOK ? GetTagsResponseOK<S> : T>;
|
|
661
|
+
/**
|
|
662
|
+
* The create_or_get_tag mutation allows you to create new tags or receive their data if they already exist via the API.
|
|
663
|
+
* You can also specify what fields to query back from the tag when you run the mutation.
|
|
664
|
+
* Alternative: Tag.createOrGetTag
|
|
665
|
+
* Documentation: https://developer.monday.com/api-reference/docs/tags-queries#create-or-get-a-tag
|
|
666
|
+
* @param options Request options.
|
|
667
|
+
*/
|
|
668
|
+
createOrGetTag<T = CreateOrGetTagFullResponseOK, S extends CreateOrGetTagRequest = CreateOrGetTagRequest>(options: S): Promise<T extends CreateOrGetTagFullResponseOK ? CreateOrGetTagResponseOK<S> : T>;
|
|
669
|
+
/**
|
|
670
|
+
* Querying version will return metadata about the API version used to make a request. This method does not accept any arguments and returns an object.
|
|
671
|
+
* Documentation: https://developer.monday.com/api-reference/docs/version#queries
|
|
672
|
+
* Alternative: Version.getVersion
|
|
673
|
+
* @param options Request options.
|
|
674
|
+
*/
|
|
675
|
+
getVersion<T = GetVersionFullResponseOK, S extends GetVersionRequest = GetVersionRequest>(options: S): Promise<T extends GetVersionFullResponseOK ? GetVersionResponseOK<S> : T>;
|
|
676
|
+
/**
|
|
677
|
+
* Querying versions will return metadata about all available API versions. This method does not accept any arguments and returns an array.
|
|
678
|
+
* Documentation: https://developer.monday.com/api-reference/docs/versions#queries
|
|
679
|
+
* Alternative: Version.getVersions
|
|
680
|
+
* @param options Request options.
|
|
681
|
+
*/
|
|
682
|
+
getVersions<T = GetVersionsFullResponseOK, S extends GetVersionsRequest = GetVersionsRequest>(options: S): Promise<T extends GetVersionsFullResponseOK ? GetVersionsResponseOK<S> : T>;
|
|
683
|
+
/**
|
|
684
|
+
* Querying webhooks will return one or a collection of webhooks. This method accepts various arguments and returns an array.
|
|
685
|
+
* You can only query webhooks directly at the root, so it can't be nested within another query.
|
|
686
|
+
* Documentation: https://developer.monday.com/api-reference/docs/webhooks#queries
|
|
687
|
+
* Alternative: Webhook.getWebhooks
|
|
688
|
+
* @param options
|
|
689
|
+
*/
|
|
690
|
+
getWebhooks<T = GetWebhooksFullResponseOK, S extends GetWebhooksRequest = GetWebhooksRequest>(options: S): Promise<T extends GetWebhooksFullResponseOK ? GetWebhooksResponseOK<S> : T>;
|
|
691
|
+
/**
|
|
692
|
+
* The create_webhook mutation allows you to create a new webhook via the API. You can also specify what fields to query back when you run the mutation.
|
|
693
|
+
* After the mutation runs, a webhook subscription will be created based on a specific event, so the webhook will send data to the subscribed URL every time the event happens on your board.
|
|
694
|
+
*
|
|
695
|
+
* You can add a query param to your webhook URL if you want to differentiate between subitem and main item events.
|
|
696
|
+
* The URL must pass a verification test where we will send a JSON POST body request containing a challenge field.
|
|
697
|
+
* Monday.com expects your provided URL to return the token as a challenge field in your response JSON body to that request.
|
|
698
|
+
*
|
|
699
|
+
* Documentation: https://developer.monday.com/api-reference/docs/webhooks#create-a-webhook
|
|
700
|
+
* Alternative: Webhook.createWebhook
|
|
701
|
+
* @param options
|
|
702
|
+
*/
|
|
703
|
+
createWebhook<T = CreateWebhooksFullResponseOK, S extends CreateWebhookRequest = CreateWebhookRequest>(options: S): Promise<T extends CreateWebhooksFullResponseOK ? CreateWebhookResponseOK<S> : T>;
|
|
704
|
+
/**
|
|
705
|
+
* The delete_webhook mutation allows you to delete a webhook via the API.
|
|
706
|
+
* You can also specify what fields to query back when you run the mutation.
|
|
707
|
+
* After the mutation runs, it will no longer report events to the URL given.
|
|
708
|
+
* Documentation: https://developer.monday.com/api-reference/docs/webhooks#delete-a-webhook
|
|
709
|
+
* Alternative: Webhook.deleteWebhook
|
|
710
|
+
* @param options
|
|
711
|
+
*/
|
|
712
|
+
deleteWebhook<T = DeleteWebhooksFullResponseOK, S extends DeleteWebhookRequest = DeleteWebhookRequest>(options: S): Promise<T extends DeleteWebhooksFullResponseOK ? DeleteWebhookResponseOK<S> : T>;
|
|
713
|
+
/**
|
|
714
|
+
* Querying folders will return metadata about one or a collection of folders. This method accepts various arguments and returns an array.
|
|
715
|
+
* Documentation: https://developer.monday.com/api-reference/docs/folders#queries
|
|
716
|
+
* Alternative: Folder.getFolders
|
|
717
|
+
* @param options Request options.
|
|
718
|
+
*/
|
|
719
|
+
getFolders<T = GetFoldersFullResponseOK, S extends GetFoldersRequest = GetFoldersRequest>(options: S): Promise<T extends GetFoldersFullResponseOK ? GetFoldersResponseOK<S> : T>;
|
|
720
|
+
/**
|
|
721
|
+
* The create_folder mutation allows you to create a new folder in a workspace via the API. You can also specify what fields to query back from the new folder when you run the mutation.
|
|
722
|
+
* Documentation: https://developer.monday.com/api-reference/docs/folders#create-a-folder
|
|
723
|
+
* Alternative: Folder.createFolder
|
|
724
|
+
* @param options Request options.
|
|
725
|
+
*/
|
|
726
|
+
createFolder<T = CreateFolderFullResponseOK, S extends CreateFolderRequest = CreateFolderRequest>(options: S): Promise<T extends CreateFolderFullResponseOK ? CreateFolderResponseOK<S> : T>;
|
|
727
|
+
/**
|
|
728
|
+
* The update_folder mutation allows you to update a folder's color, name, or parent folder via the API. You can also specify what fields to query back from the updated folder when you run the mutation.
|
|
729
|
+
* Documentation: https://developer.monday.com/api-reference/docs/folders#update-a-folder
|
|
730
|
+
* Alternative: Folder.updateFolder
|
|
731
|
+
* @param options Request options.
|
|
732
|
+
*/
|
|
733
|
+
updateFolder<T = UpdateFolderFullResponseOK, S extends UpdateFolderRequest = UpdateFolderRequest>(options: S): Promise<T extends UpdateFolderFullResponseOK ? UpdateFolderResponseOK<S> : T>;
|
|
734
|
+
/**
|
|
735
|
+
* The delete_folder mutation allows you to delete and folder and all its contents via the API. You can also specify what fields to query back from the deleted folder when you run the mutation.
|
|
736
|
+
* Documentation: https://developer.monday.com/api-reference/docs/folders#delete-a-folder
|
|
737
|
+
* Alternative: Folder.deleteFolder
|
|
738
|
+
* @param options Request options.
|
|
739
|
+
*/
|
|
740
|
+
deleteFolder<T = DeleteFolderFullResponseOK, S extends DeleteFolderRequest = DeleteFolderRequest>(options: S): Promise<T extends DeleteFolderFullResponseOK ? DeleteFolderResponseOK<S> : T>;
|
|
741
|
+
}
|
|
742
|
+
declare class NotificationGroup {
|
|
743
|
+
private implementation;
|
|
744
|
+
private getGlobalErrorStrategy;
|
|
745
|
+
constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy);
|
|
746
|
+
/**
|
|
747
|
+
* The create_notification mutation allows you to send a notification to the bell icon via the API. Doing so may also send an email if the recipient's email preferences are set up accordingly.
|
|
748
|
+
* Please note that this mutation only sends the notification; you can't query back the notification ID when running the mutation, as notifications are asynchronous.
|
|
749
|
+
* Documentation: https://developer.monday.com/api-reference/docs/notification#create-a-notification
|
|
750
|
+
* @param options Request options.
|
|
751
|
+
*/
|
|
752
|
+
createNotification<T = CreateNotificationFullResponseOK, S extends CreateNotificationRequest = CreateNotificationRequest>(options: S): Promise<T extends CreateNotificationFullResponseOK ? CreateNotificationResponseOK<S> : T>;
|
|
753
|
+
}
|
|
754
|
+
declare class TeamGroup {
|
|
755
|
+
private implementation;
|
|
756
|
+
private getGlobalErrorStrategy;
|
|
757
|
+
constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy);
|
|
758
|
+
/**
|
|
759
|
+
* The delete_teams_from_workspace mutation allows you to delete teams from a workspace via the API.
|
|
760
|
+
* You can also specify what fields to query back when you run the mutation.
|
|
761
|
+
* Documentation: https://developer.monday.com/api-reference/docs/teams#delete-teams-from-a-workspace
|
|
762
|
+
* @param options
|
|
763
|
+
*/
|
|
764
|
+
deleteTeamsFromWorkspace<T = DeleteTeamsFromWorkspaceFullResponseOK, S extends DeleteTeamsFromWorkspaceRequest = DeleteTeamsFromWorkspaceRequest>(options: S): Promise<T extends DeleteTeamsFromWorkspaceFullResponseOK ? DeleteTeamsFromWorkspaceResponseOK<S> : T>;
|
|
765
|
+
/**
|
|
766
|
+
* The delete_teams_from_board mutation allows you to delete teams from a board via the API.
|
|
767
|
+
* You can also specify what fields to query back when you run the mutation.
|
|
768
|
+
* Documentation: https://developer.monday.com/api-reference/docs/teams#delete-teams-from-a-board
|
|
769
|
+
* @param options
|
|
770
|
+
*/
|
|
771
|
+
deleteTeamsFromBoard<T = DeleteTeamsFromBoardFullResponseOK, S extends DeleteTeamsFromBoardRequest = DeleteTeamsFromBoardRequest>(options: S): Promise<T extends DeleteTeamsFromBoardFullResponseOK ? DeleteTeamsFromBoardResponseOK<S> : T>;
|
|
772
|
+
/**
|
|
773
|
+
* The add_teams_to_workspace mutation allows you to add teams to a workspace via the API. You can also specify what fields to query back when you run the mutation.
|
|
774
|
+
* Documentation: https://developer.monday.com/api-reference/docs/teams#add-teams-to-a-workspace
|
|
775
|
+
* @param options
|
|
776
|
+
*/
|
|
777
|
+
addTeamsToWorkspace<T = AddTeamsToWorkspaceFullResponseOK, S extends AddTeamsToWorkspaceRequest = AddTeamsToWorkspaceRequest>(options: S): Promise<T extends AddTeamsToWorkspaceFullResponseOK ? AddTeamsToWorkspaceResponseOK<S> : T>;
|
|
778
|
+
/**
|
|
779
|
+
* The add_teams_to_board mutation allows you to add teams to a board via the API. You can also specify what fields to query back when you run the mutation.
|
|
780
|
+
* Documentation: https://developer.monday.com/api-reference/docs/teams#add-teams-to-a-board
|
|
781
|
+
* @param options
|
|
782
|
+
*/
|
|
783
|
+
addTeamsToBoard<T = AddTeamsToBoardFullResponseOK, S extends AddTeamsToBoardRequest = AddTeamsToBoardRequest>(options: S): Promise<T extends AddTeamsToBoardFullResponseOK ? AddTeamsToBoardResponseOK<S> : T>;
|
|
784
|
+
/**
|
|
785
|
+
* Querying teams will return metadata about one or several teams. This method accepts one argument and returns an array.
|
|
786
|
+
*
|
|
787
|
+
* You can query teams directly at the root, or you can nest it within a users query to return the teams a specific user is part of. Please note that nesting your query will increase its complexity.
|
|
788
|
+
* Documentation: https://developer.monday.com/api-reference/docs/teams#queries
|
|
789
|
+
* @param options
|
|
790
|
+
*/
|
|
791
|
+
getTeams<T = GetTeamsFullResponseOK, S extends GetTeamsRequest = GetTeamsRequest>(options: S): Promise<T extends GetTeamsFullResponseOK ? GetTeamsResponseOK<S> : T>;
|
|
792
|
+
/**
|
|
793
|
+
* The add_users_to_team mutation allows you to add users to a team via the API. This mutation returns the ChangeTeamMembershipResult type which allows you to specify what fields to query back when you run the mutation.
|
|
794
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#add-users-to-a-team
|
|
795
|
+
* @param options
|
|
796
|
+
*/
|
|
797
|
+
addUsersToTeam<T = AddUsersToTeamFullResponseOK, S extends AddUsersToTeamRequest = AddUsersToTeamRequest>(options: S): Promise<T extends AddUsersToTeamFullResponseOK ? AddUsersToTeamResponseOK<S> : T>;
|
|
798
|
+
/**
|
|
799
|
+
* The remove_users_from_team mutation allows you to remove users from a team via the API. This mutation returns the ChangeTeamMembershipResult type which allows you to specify what fields to query back when you run the mutation.
|
|
800
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#remove-users-from-a-team
|
|
801
|
+
* @param options
|
|
802
|
+
*/
|
|
803
|
+
removeUsersFromTeam<T = RemoveUsersFromTeamFullResponseOK, S extends RemoveUsersFromTeamRequest = RemoveUsersFromTeamRequest>(options: S): Promise<T extends RemoveUsersFromTeamFullResponseOK ? RemoveUsersFromTeamResponseOK<S> : T>;
|
|
804
|
+
/**
|
|
805
|
+
* The create_team mutation allows you to create a team via the API. You can also specify what fields to query back when you run the mutation.
|
|
806
|
+
* Documentation: https://developer.monday.com/api-reference/reference/teams#create-team
|
|
807
|
+
* @param options
|
|
808
|
+
*/
|
|
809
|
+
createTeam<T = CreateTeamFullResponseOK, S extends CreateTeamRequest = CreateTeamRequest>(options: S): Promise<T extends CreateTeamFullResponseOK ? CreateTeamResponseOK<S> : T>;
|
|
810
|
+
/**
|
|
811
|
+
* The delete_team mutation allows you to delete a team via the API. You can also specify what fields to query back when you run the mutation.
|
|
812
|
+
* Documentation: https://developer.monday.com/api-reference/reference/teams#delete-team
|
|
813
|
+
* @param options
|
|
814
|
+
*/
|
|
815
|
+
deleteTeam<T = DeleteTeamFullResponseOK, S extends DeleteTeamRequest = DeleteTeamRequest>(options: S): Promise<T extends DeleteTeamFullResponseOK ? DeleteTeamResponseOK<S> : T>;
|
|
816
|
+
/**
|
|
817
|
+
* This mutation allows you to assign owners to a team. It returns the AssignTeamOwnersResut type which supports a set of fields that you can query back when you run the mutation.
|
|
818
|
+
* Documentation: https://developer.monday.com/api-reference/reference/teams#assign-team-owners
|
|
819
|
+
* @param options Request options.
|
|
820
|
+
*/
|
|
821
|
+
assignTeamOwners<T = AssignTeamOwnersFullResponseOK, S extends AssignTeamOwnersRequest = AssignTeamOwnersRequest>(options: S): Promise<T extends AssignTeamOwnersFullResponseOK ? AssignTeamOwnersResponseOK<S> : T>;
|
|
822
|
+
/**
|
|
823
|
+
* This mutation allows you to remove owners from a team. It returns the RemoveTeamOwnersResult type which supports a set of fields that you can query back when you run the mutation.
|
|
824
|
+
* Documentation: https://developer.monday.com/api-reference/reference/teams#remove-team-owners
|
|
825
|
+
* @param options Request options.
|
|
826
|
+
*/
|
|
827
|
+
removeTeamOwners<T = RemoveTeamOwnersFullResponseOK, S extends RemoveTeamOwnersRequest = RemoveTeamOwnersRequest>(options: S): Promise<T extends RemoveTeamOwnersFullResponseOK ? RemoveTeamOwnersResponseOK<S> : T>;
|
|
828
|
+
}
|
|
829
|
+
declare class AccountGroup {
|
|
830
|
+
private implementation;
|
|
831
|
+
private getGlobalErrorStrategy;
|
|
832
|
+
Role: AccountRoleGroup;
|
|
833
|
+
constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy);
|
|
834
|
+
}
|
|
835
|
+
declare class AccountRoleGroup {
|
|
836
|
+
private implementation;
|
|
837
|
+
private getGlobalErrorStrategy;
|
|
838
|
+
constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy);
|
|
839
|
+
/**
|
|
840
|
+
* Returns an object containing metadata about all user roles in an account (both default and custom).
|
|
841
|
+
* Documentation: https://developer.monday.com/api-reference/reference/account-roles#queries
|
|
842
|
+
* @param options Request options.
|
|
843
|
+
*/
|
|
844
|
+
getAccountRoles<T = GetAccountRolesFullResponseOK, S extends GetAccountRolesRequest = GetAccountRolesRequest>(options: S): Promise<T extends GetAccountRolesFullResponseOK ? GetAccountRolesResponseOK<S> : T>;
|
|
845
|
+
}
|
|
846
|
+
declare class BoardGroup {
|
|
847
|
+
private implementation;
|
|
848
|
+
private getGlobalErrorStrategy;
|
|
849
|
+
View: BoardViewGroup;
|
|
850
|
+
Group: BoardGroupGroup;
|
|
851
|
+
ItemsPage: BoardItemsPageGroup;
|
|
852
|
+
Tag: BoardTagGroup;
|
|
853
|
+
constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy);
|
|
854
|
+
/**
|
|
855
|
+
* Querying boards will return metadata about one or a collection of boards. This method accepts various arguments and returns an array.
|
|
856
|
+
* Documentation: https://developer.monday.com/api-reference/docs/boards#queries
|
|
857
|
+
* @param options Request options.
|
|
858
|
+
*/
|
|
859
|
+
getBoards<T = GetBoardsFullResponseOK, S extends GetBoardsRequest = GetBoardsRequest>(options: S): Promise<T extends GetBoardsFullResponseOK ? GetBoardsResponseOK<S> : T>;
|
|
860
|
+
/**
|
|
861
|
+
* The create_board mutation allows you to create a new board via the API.
|
|
862
|
+
* You can also specify what fields to query back from the new board when you run the mutation.
|
|
863
|
+
* Please note that the user that creates the board via the API will automatically be added as the board's owner when creating a private or shareable board or if the board_owners_ids argument is missing.
|
|
864
|
+
* Documentation: https://developer.monday.com/api-reference/docs/boards#create-a-board
|
|
865
|
+
* @param options Request options.
|
|
866
|
+
*/
|
|
867
|
+
createBoard<T = CreateBoardFullResponseOK, S extends CreateBoardRequest = CreateBoardRequest>(options: S): Promise<T extends CreateBoardFullResponseOK ? CreateBoardResponseOK<S> : T>;
|
|
868
|
+
/**
|
|
869
|
+
* The duplicate_board mutation allows you to duplicate a board with all of its items and groups to a specific workspace or folder of your choice via the API.
|
|
870
|
+
* Documentation: https://developer.monday.com/api-reference/docs/boards#duplicate-a-board
|
|
871
|
+
* @param options Request options.
|
|
872
|
+
*/
|
|
873
|
+
duplicateBoard<T = DuplicateBoardFullResponseOK, S extends DuplicateBoardRequest = DuplicateBoardRequest>(options: S): Promise<T extends DuplicateBoardFullResponseOK ? DuplicateBoardResponseOK<S> : T>;
|
|
874
|
+
/**
|
|
875
|
+
* The update_board mutation allows you to update a board via the API.
|
|
876
|
+
* Documentation: https://developer.monday.com/api-reference/docs/boards#update-a-board
|
|
877
|
+
* @param options Request options.
|
|
878
|
+
*/
|
|
879
|
+
updateBoard<T = UpdateBoardFullResponseOK>(options: UpdateBoardRequest): Promise<UpdateBoardResponseOK | T>;
|
|
880
|
+
/**
|
|
881
|
+
* The archive_board mutation allows you to archive a board via the API. You can also specify what fields to query back from the archived board when you run the mutation.
|
|
882
|
+
* Documentation: https://developer.monday.com/api-reference/docs/boards#archive-a-board
|
|
883
|
+
* @param options Request options.
|
|
884
|
+
*/
|
|
885
|
+
archiveBoard<T = ArchiveBoardFullResponseOK, S extends ArchiveBoardRequest = ArchiveBoardRequest>(options: S): Promise<T extends ArchiveBoardFullResponseOK ? ArchiveBoardResponseOK<S> : T>;
|
|
886
|
+
/**
|
|
887
|
+
* The delete_board mutation allows you to delete a board via the API. You can also specify what fields to query back from the deleted board when you run the mutation.
|
|
888
|
+
* Documentation: https://developer.monday.com/api-reference/docs/boards#delete-a-board
|
|
889
|
+
* @param options Request options.
|
|
890
|
+
*/
|
|
891
|
+
deleteBoard<T = DeleteBoardFullResponseOK, S extends DeleteBoardRequest = DeleteBoardRequest>(options: S): Promise<T extends DeleteBoardFullResponseOK ? DeleteBoardResponseOK<S> : T>;
|
|
892
|
+
/**
|
|
893
|
+
* The delete_subscribers_from_board mutation allows you to delete subscribers from a board via the API. You can also specify what fields to query back from the subscribers you delete from the board when you run the mutation.
|
|
894
|
+
* Documentation: https://developer.monday.com/api-reference/docs/boards#delete-subscribers-from-a-board
|
|
895
|
+
* @param options Request options.
|
|
896
|
+
*/
|
|
897
|
+
deleteSubscribersFromBoard<T = DeleteSubscribersBoardFullResponseOK, S extends DeleteSubscribersBoardRequest = DeleteSubscribersBoardRequest>(options: S): Promise<T extends DeleteSubscribersBoardFullResponseOK ? DeleteSubscribersBoardResponseOK<S> : T>;
|
|
898
|
+
}
|
|
899
|
+
declare class BoardGroupGroup {
|
|
900
|
+
private implementation;
|
|
901
|
+
private getGlobalErrorStrategy;
|
|
902
|
+
constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy);
|
|
903
|
+
/**
|
|
904
|
+
* The update_group mutation allows you to update an existing group via the API. You can also specify what fields to query back from the updated group when you run the mutation.
|
|
905
|
+
* Documentation: https://developer.monday.com/api-reference/docs/groups#update-a-group
|
|
906
|
+
* @param options
|
|
907
|
+
*/
|
|
908
|
+
updateGroup<T = UpdateBoardGroupFullResponseOK, S extends UpdateBoardGroupRequest = UpdateBoardGroupRequest>(options: S): Promise<T extends UpdateBoardGroupFullResponseOK ? UpdateBoardGroupResponseOK<S> : T>;
|
|
909
|
+
/**
|
|
910
|
+
* The duplicate_group mutation allows you to duplicate a group with all of its items via the API. You can also specify what fields to query back from the duplicated group when you run the mutation.
|
|
911
|
+
* Documentation: https://developer.monday.com/api-reference/docs/groups#duplicate-group
|
|
912
|
+
* (!) Mutation-specific rate limit:
|
|
913
|
+
* The duplicate_group mutation has an additional rate limit of 40 mutations per minute. If you exceed this limit, you will receive a response with a 429 status code, and the following error message: "Call limit exceeded for DuplicateGroup".
|
|
914
|
+
* @param options
|
|
915
|
+
*/
|
|
916
|
+
duplicateGroup<T = DuplicateBoardGroupFullResponseOK, S extends DuplicateBoardGroupRequest = DuplicateBoardGroupRequest>(options: S): Promise<T extends DuplicateBoardGroupFullResponseOK ? DuplicateBoardGroupResponseOK<S> : T>;
|
|
917
|
+
/**
|
|
918
|
+
* The archive_group mutation allows you to archive a group with all of its items via the API. You can also specify what fields to query back from the archived group when you run the mutation.
|
|
919
|
+
* Documentation: https://developer.monday.com/api-reference/docs/groups#archive-a-group
|
|
920
|
+
* @param options
|
|
921
|
+
*/
|
|
922
|
+
archiveGroup<T = ArchiveBoardGroupFullResponseOK, S extends ArchiveBoardGroupRequest = ArchiveBoardGroupRequest>(options: S): Promise<T extends ArchiveBoardGroupFullResponseOK ? ArchiveBoardGroupResponseOK<S> : T>;
|
|
923
|
+
/**
|
|
924
|
+
* The delete_group mutation allows you to delete a group with all of its items via the API. You can also specify what fields to query back from the deleted group when you run the mutation.
|
|
925
|
+
* Documentation: https://developer.monday.com/api-reference/docs/groups#delete-a-group
|
|
926
|
+
* @param options
|
|
927
|
+
*/
|
|
928
|
+
deleteGroup<T = DeleteBoardGroupFullResponseOK, S extends DeleteBoardGroupRequest = DeleteBoardGroupRequest>(options: S): Promise<T extends DeleteBoardGroupFullResponseOK ? DeleteBoardGroupResponseOK<S> : T>;
|
|
929
|
+
/**
|
|
930
|
+
* The create_group mutation allows you to create a new empty group via the API. You can also specify what fields to query back from the new group when you run the mutation.
|
|
931
|
+
* Documentation: https://developer.monday.com/api-reference/docs/groups#create-a-group
|
|
932
|
+
* @param options
|
|
933
|
+
*/
|
|
934
|
+
createGroup<T = CreateBoardGroupFullResponseOK, S extends CreateBoardGroupRequest = CreateBoardGroupRequest>(options: S): Promise<T extends CreateBoardGroupFullResponseOK ? CreateBoardGroupResponseOK<S> : T>;
|
|
935
|
+
/**
|
|
936
|
+
* Querying groups will return metadata about one or a collection of groups on a specific board. This method accepts one argument and returns an array. *
|
|
937
|
+
* You can only query groups by nesting it within another query, so it can't be used at the root.
|
|
938
|
+
* Documentation: https://developer.monday.com/api-reference/docs/groups#queries
|
|
939
|
+
* @param options Request options.
|
|
940
|
+
*/
|
|
941
|
+
getGroups<T = GetBoardGroupsFullResponseOK, S extends GetBoardGroupsRequest = GetBoardGroupsRequest>(options: S): Promise<T extends GetBoardGroupsFullResponseOK ? GetBoardGroupsResponseOK<S> : T>;
|
|
942
|
+
}
|
|
943
|
+
declare class BoardViewGroup {
|
|
944
|
+
private implementation;
|
|
945
|
+
private getGlobalErrorStrategy;
|
|
946
|
+
constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy);
|
|
947
|
+
/**
|
|
948
|
+
* Querying views will return a collection of board views from a specific board. This method accepts various arguments and returns an array.
|
|
949
|
+
* You can only query views by nesting it within a boards query, so it can't be used at the root.
|
|
950
|
+
* Documentation: https://developer.monday.com/api-reference/docs/board-view-queries#queries
|
|
951
|
+
* @param options Request options.
|
|
952
|
+
*/
|
|
953
|
+
getViews<T = GetBoardViewsFullResponseOK, S extends GetBoardViewsRequest = GetBoardViewsRequest>(options: S): Promise<T extends GetBoardViewsFullResponseOK ? GetBoardViewsResponseOK<S> : T>;
|
|
954
|
+
}
|
|
955
|
+
declare class ItemGroup {
|
|
956
|
+
private implementation;
|
|
957
|
+
private getGlobalErrorStrategy;
|
|
958
|
+
Subitem: ItemSubitemGroup;
|
|
959
|
+
constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy);
|
|
960
|
+
/**
|
|
961
|
+
* Querying items will return metadata about one or a collection of items. This method accepts various arguments and returns an array.
|
|
962
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#queries
|
|
963
|
+
* @param options Request options.
|
|
964
|
+
*/
|
|
965
|
+
getItems<T = GetItemsFullResponseOK, S extends GetItemsRequest = GetItemsRequest>(options: S): Promise<T extends GetItemsFullResponseOK ? GetItemsResponseOK<S> : T>;
|
|
966
|
+
/**
|
|
967
|
+
* The create_item mutation allows you to create a new item via the API. You can also specify what fields to query back from the new item when you run the mutation.
|
|
968
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#create-an-item
|
|
969
|
+
* @param options Request options.
|
|
970
|
+
*/
|
|
971
|
+
createItem<T = CreateItemFullResponseOK, S extends CreateItemRequest = CreateItemRequest>(options: S): Promise<T extends CreateItemFullResponseOK ? CreateItemResponseOK<S> : T>;
|
|
972
|
+
/**
|
|
973
|
+
* The duplicate_item mutation allows you to duplicate a single item via the API. You can also specify what fields to query back from the duplicated item when you run the mutation.
|
|
974
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#duplicate-an-item
|
|
975
|
+
* @param options Request options.
|
|
976
|
+
*/
|
|
977
|
+
duplicateItem<T = DuplicateItemFullResponseOK, S extends DuplicateItemRequest = DuplicateItemRequest>(options: S): Promise<T extends DuplicateItemFullResponseOK ? DuplicateItemResponseOK<S> : T>;
|
|
978
|
+
/**
|
|
979
|
+
* The move_item_to_group mutation allows you to move an item between groups on the same board via the API. You can also specify what fields to query back from the item when you run the mutation.
|
|
980
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#move-item-to-group
|
|
981
|
+
* @param options Request options.
|
|
982
|
+
*/
|
|
983
|
+
moveItemToGroup<T = MoveItemToGroupFullResponseOK, S extends MoveItemToGroupRequest = MoveItemToGroupRequest>(options: S): Promise<T extends MoveItemToGroupFullResponseOK ? MoveItemToGroupResponseOK<S> : T>;
|
|
984
|
+
/**
|
|
985
|
+
* The move_item_to_board mutation allows you to move an item to another board via the API. You can also specify what fields to query back from the item moved when you run the mutation.
|
|
986
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#move-item-to-board
|
|
987
|
+
* @param options Request options.
|
|
988
|
+
*/
|
|
989
|
+
moveItemToBoard<T = MoveItemToBoardFullResponseOK, S extends MoveItemToBoardRequest = MoveItemToBoardRequest>(options: S): Promise<T extends MoveItemToBoardFullResponseOK ? MoveItemToBoardResponseOK<S> : T>;
|
|
990
|
+
/**
|
|
991
|
+
* The archive_item mutation allows you to archive a single item via the API. You can also specify what fields to query back from the archived item when you run the mutation.
|
|
992
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#archive-an-item
|
|
993
|
+
* @param options Request options.
|
|
994
|
+
*/
|
|
995
|
+
archiveItem<T = ArchiveItemFullResponseOK, S extends ArchiveItemRequest = ArchiveItemRequest>(options: S): Promise<T extends ArchiveItemFullResponseOK ? ArchiveItemResponseOK<S> : T>;
|
|
996
|
+
/**
|
|
997
|
+
* The delete_item mutation allows you to delete a single item via the API. You can also specify what fields to query back from the deleted item when you run the mutation.
|
|
998
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#delete-an-item
|
|
999
|
+
* @param options Request options.
|
|
1000
|
+
*/
|
|
1001
|
+
deleteItem<T = DeleteItemFullResponseOK, S extends DeleteItemRequest = DeleteItemRequest>(options: S): Promise<T extends DeleteItemFullResponseOK ? DeleteItemResponseOK<S> : T>;
|
|
1002
|
+
/**
|
|
1003
|
+
* The clear_item_updates mutation allows you to clear all updates on a specific item, including replies and likes. You can also specify what fields to query back from the item when you run the mutation.
|
|
1004
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#clear-an-items-updates
|
|
1005
|
+
* @param options Request options.
|
|
1006
|
+
*/
|
|
1007
|
+
clearUpdates<T = ClearItemUpdatesFullResponseOK, S extends ClearItemUpdatesRequest = ClearItemUpdatesRequest>(options: S): Promise<T extends ClearItemUpdatesFullResponseOK ? ClearItemUpdatesResponseOK<S> : T>;
|
|
1008
|
+
}
|
|
1009
|
+
declare class BoardItemsPageGroup {
|
|
1010
|
+
private implementation;
|
|
1011
|
+
private getGlobalErrorStrategy;
|
|
1012
|
+
constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy);
|
|
1013
|
+
/**
|
|
1014
|
+
* Querying items_page will return items filtered by the specified criteria. This method accepts various arguments and returns an object.
|
|
1015
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items_page#queries
|
|
1016
|
+
* @param options Request options.
|
|
1017
|
+
*/
|
|
1018
|
+
getItemsPage<T = GetItemsPageFullResponseOK, S extends GetItemsPageRequest = GetItemsPageRequest>(options: S): Promise<T extends GetItemsPageFullResponseOK ? GetItemsPageResponseOK<S> : T>;
|
|
1019
|
+
}
|
|
1020
|
+
declare class BoardTagGroup {
|
|
1021
|
+
private implementation;
|
|
1022
|
+
private getGlobalErrorStrategy;
|
|
1023
|
+
constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy);
|
|
1024
|
+
/**
|
|
1025
|
+
* Querying tags will return metadata about one or a collection of the account's public tags. Public tags appear on main boards and are accessible to all member
|
|
1026
|
+
* and viewer-level users by default, while private tags only appear on private or shareable boards. This method accepts no arguments and returns an array.
|
|
1027
|
+
* You can query tags directly at the root to return public tags. If you do so and use the ids argument of a private tag, you will get an empty result.
|
|
1028
|
+
* To return tags stored on private or shareable boards, you can use this managed API, which is nested within a boards query.
|
|
1029
|
+
* Documentation: https://developer.monday.com/api-reference/docs/tags-queries#queries
|
|
1030
|
+
* @param options Request options.
|
|
1031
|
+
*/
|
|
1032
|
+
getTags<T = GetBoardTagsFullResponseOK, S extends GetBoardTagsRequest = GetBoardTagsRequest>(options: S): Promise<T extends GetBoardTagsFullResponseOK ? GetBoardTagsResponseOK<S> : T>;
|
|
1033
|
+
}
|
|
1034
|
+
declare class ItemsPageGroup {
|
|
1035
|
+
private implementation;
|
|
1036
|
+
private getGlobalErrorStrategy;
|
|
1037
|
+
constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy);
|
|
1038
|
+
/**
|
|
1039
|
+
* Querying next_items_page will return the next set of items that correspond with the provided cursor. This method accepts various arguments and returns an object.
|
|
1040
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items_page#cursor-based-pagination-using-next_items_page
|
|
1041
|
+
* @param options Request options.
|
|
1042
|
+
*/
|
|
1043
|
+
getNextItemsPage<T = GetNextItemsPageFullResponseOK, S extends GetNextItemsPageRequest = GetNextItemsPageRequest>(options: S): Promise<T extends GetNextItemsPageFullResponseOK ? GetNextItemsPageResponseOK<S> : T>;
|
|
1044
|
+
/**
|
|
1045
|
+
* Querying items_page_by_column_values will search for items based on predefined column values and return metadata about these specific items. This method accepts various arguments and returns an array.
|
|
1046
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items-page-by-column-values
|
|
1047
|
+
* @param options Request options.
|
|
1048
|
+
*/
|
|
1049
|
+
getItemsPageByColumnValues<T = GetItemsPageByColumnValuesFullResponseOK, S extends GetItemsPageByColumnValuesRequest = GetItemsPageByColumnValuesRequest>(options: S): Promise<T extends GetItemsPageByColumnValuesFullResponseOK ? GetItemsPageByColumnValuesResponseOK<S> : T>;
|
|
1050
|
+
}
|
|
1051
|
+
declare class ItemSubitemGroup {
|
|
1052
|
+
private implementation;
|
|
1053
|
+
private getGlobalErrorStrategy;
|
|
1054
|
+
constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy);
|
|
1055
|
+
/**
|
|
1056
|
+
* Querying subitems will return metadata about one or a collection of subitems. This method does not accept any arguments and returns an array.
|
|
1057
|
+
* You can only query subitems by nesting it within another query, so it can't be used at the root.
|
|
1058
|
+
* Documentation: https://developer.monday.com/api-reference/docs/subitems#queries
|
|
1059
|
+
* @param options Request options.
|
|
1060
|
+
*/
|
|
1061
|
+
getSubitems<T = GetSubitemsFullResponseOK, S extends GetSubitemsRequest = GetSubitemsRequest>(options: S): Promise<T extends GetSubitemsFullResponseOK ? GetSubitemsResponseOK<S> : T>;
|
|
1062
|
+
/**
|
|
1063
|
+
* The create_subitem mutation allows you to create a new subitem via the API. You can also specify what fields to query back from the new subitem when you run the mutation.
|
|
1064
|
+
* Documentation: https://developer.monday.com/api-reference/docs/subitems#create-a-subitem
|
|
1065
|
+
* @param options Request options.
|
|
1066
|
+
*/
|
|
1067
|
+
createSubitem<T = CreateSubitemFullResponseOK, S extends CreateSubitemRequest = CreateSubitemRequest>(options: S): Promise<T extends CreateSubitemFullResponseOK ? CreateSubitemResponseOK<S> : T>;
|
|
1068
|
+
}
|
|
1069
|
+
declare class MeGroup {
|
|
1070
|
+
private implementation;
|
|
1071
|
+
private getGlobalErrorStrategy;
|
|
1072
|
+
constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy);
|
|
1073
|
+
/**
|
|
1074
|
+
* Querying me will return metadata about the user whose API key is being used. This method does not accept any arguments and returns an object.
|
|
1075
|
+
* You can only query me directly at the root, so it can't be nested within another query.
|
|
1076
|
+
* Documentation: https://developer.monday.com/api-reference/docs/me#queries
|
|
1077
|
+
* @param options Request options.
|
|
1078
|
+
*/
|
|
1079
|
+
getUserDetails<T = GetUserDetailsFullResponseOK, S extends GetUserDetailsRequest = GetUserDetailsRequest>(options: S): Promise<T extends GetUserDetailsFullResponseOK ? GetUserDetailsResponseOK<S> : T>;
|
|
1080
|
+
}
|
|
1081
|
+
declare class UserGroup {
|
|
1082
|
+
private implementation;
|
|
1083
|
+
private getGlobalErrorStrategy;
|
|
1084
|
+
constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy);
|
|
1085
|
+
/**
|
|
1086
|
+
* Querying users will return metadata about one or multiple users. This method accepts various arguments and returns an array.
|
|
1087
|
+
* Documentation: https://developer.monday.com/api-reference/docs/users#queries
|
|
1088
|
+
* @param options Request options.
|
|
1089
|
+
*/
|
|
1090
|
+
getUsers<T = GetUsersFullResponseOK, S extends GetUsersRequest = GetUsersRequest>(options: S): Promise<T extends GetUsersFullResponseOK ? GetUsersResponseOK<S> : T>;
|
|
1091
|
+
/**
|
|
1092
|
+
* The add_users_to_board mutation allows you to add users to a board via the API. You can also specify what fields to query back from the user when you run the mutation.
|
|
1093
|
+
* Documentation: https://developer.monday.com/api-reference/docs/users#add-users-to-a-board
|
|
1094
|
+
* @param options Request options.
|
|
1095
|
+
*/
|
|
1096
|
+
addUsersToBoard<T = AddUsersToBoardFullResponseOK, S extends AddUsersToBoardRequest = AddUsersToBoardRequest>(options: S): Promise<T extends AddUsersToBoardFullResponseOK ? AddUsersToBoardResponseOK<S> : T>;
|
|
1097
|
+
/**
|
|
1098
|
+
* The add_users_to_workspace mutation allows you to add users to a workspace via the API. You can also specify what fields to query back from the user when you run the mutation.
|
|
1099
|
+
* Documentation: https://developer.monday.com/api-reference/docs/users#add-users-to-a-workspace
|
|
1100
|
+
* @param options Request options.
|
|
1101
|
+
*/
|
|
1102
|
+
addUsersToWorkspace<T = AddUsersToWorkspaceFullResponseOK, S extends AddUsersToWorkspaceRequest = AddUsersToWorkspaceRequest>(options: S): Promise<T extends AddUsersToWorkspaceFullResponseOK ? AddUsersToWorkspaceResponseOK<S> : T>;
|
|
1103
|
+
/**
|
|
1104
|
+
* The delete_users_from_workspace mutation allows you to delete users from a workspace via the API. You can also specify what fields to query back from the user when you run the mutation.
|
|
1105
|
+
* Documentation: https://developer.monday.com/api-reference/docs/users#delete-users-from-a-workspace
|
|
1106
|
+
* @param options Request options.
|
|
1107
|
+
*/
|
|
1108
|
+
deleteUsersFromWorkspace<T = DeleteUsersFromWorkspaceFullResponseOK, S extends DeleteUsersFromWorkspaceRequest = DeleteUsersFromWorkspaceRequest>(options: S): Promise<T extends DeleteUsersFromWorkspaceFullResponseOK ? DeleteUsersFromWorkspaceResponseOK<S> : T>;
|
|
1109
|
+
/**
|
|
1110
|
+
* This mutation deactivates users from a monday.com account. It returns the DeactivateUsersResult type which supports a set of fields that you can query back when you run it.
|
|
1111
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#deactivate-users
|
|
1112
|
+
* @param options Request options.
|
|
1113
|
+
*/
|
|
1114
|
+
deactivateUsers<T = DeactivateUsersFullResponseOK, S extends DeactivateUsersRequest = DeactivateUsersRequest>(options: S): Promise<T extends DeactivateUsersFullResponseOK ? DeactivateUsersResponseOK<S> : T>;
|
|
1115
|
+
/**
|
|
1116
|
+
* This mutation activates or re-activates users in a monday.com account. It returns the ActivateUsersResult type which allows you to specify what fields to query back when you run it.
|
|
1117
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#activate-users
|
|
1118
|
+
* @param options Request options.
|
|
1119
|
+
*/
|
|
1120
|
+
activateUsers<T = ActivateUsersFullResponseOK, S extends ActivateUsersRequest = ActivateUsersRequest>(options: S): Promise<T extends ActivateUsersFullResponseOK ? ActivateUsersResponseOK<S> : T>;
|
|
1121
|
+
/**
|
|
1122
|
+
* This mutation updates a user's role (accepts both custom or default roles). It returns the UpdateUsersRoleResult type which allows you to specify what fields to query back when you run it.
|
|
1123
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#update-a-users-role
|
|
1124
|
+
* @param options Request options.
|
|
1125
|
+
*/
|
|
1126
|
+
updateUsersRole<T = UpdateUsersRoleFullResponseOK, S extends UpdateUsersRoleRequest = UpdateUsersRoleRequest>(options: S): Promise<T extends UpdateUsersRoleFullResponseOK ? UpdateUsersRoleResponseOK<S> : T>;
|
|
1127
|
+
/**
|
|
1128
|
+
* This mutation updates a user's email domain. It returns the UpdateEmailDomainResult type which allows you to specify what fields to query back when you run it.
|
|
1129
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#update-a-users-email-domain
|
|
1130
|
+
* @param options Request options.
|
|
1131
|
+
*/
|
|
1132
|
+
updateUsersEmailDomain<T = UpdateUsersEmailDomainFullResponseOK, S extends UpdateUsersEmailDomainRequest = UpdateUsersEmailDomainRequest>(options: S): Promise<T extends UpdateUsersEmailDomainFullResponseOK ? UpdateUsersEmailDomainResponseOK<S> : T>;
|
|
1133
|
+
/**
|
|
1134
|
+
* This mutation invites users to join a monday.com account. They will be in a pending status until the invitation is accepted.
|
|
1135
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#invite-users
|
|
1136
|
+
* @param options Request options.
|
|
1137
|
+
*/
|
|
1138
|
+
inviteUsers<T = InviteUsersFullResponseOK, S extends InviteUsersRequest = InviteUsersRequest>(options: S): Promise<T extends InviteUsersFullResponseOK ? InviteUsersResponseOK<S> : T>;
|
|
1139
|
+
/**
|
|
1140
|
+
* The update_multiple_users mutation updates one or multiple users' attributes. It returns the UpdateUserAttributesResult type which supports a set of fields you can query back.
|
|
1141
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#update-users-attributes
|
|
1142
|
+
* @param options Request options.
|
|
1143
|
+
*/
|
|
1144
|
+
updateUsersAttributes<T = UpdateUsersAttributesFullResponseOK, S extends UpdateUsersAttributesRequest = UpdateUsersAttributesRequest>(options: S): Promise<T extends UpdateUsersAttributesFullResponseOK ? UpdateUsersAttributesResponseOK<S> : T>;
|
|
1145
|
+
}
|
|
1146
|
+
declare class FileGroup {
|
|
1147
|
+
private implementation;
|
|
1148
|
+
private getGlobalErrorStrategy;
|
|
1149
|
+
constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy);
|
|
1150
|
+
/**
|
|
1151
|
+
* Querying assets will return one or a collection of assets. This method accepts various arguments and returns an array.
|
|
1152
|
+
* Documentation: https://developer.monday.com/api-reference/docs/files#queries
|
|
1153
|
+
* @param options Request options.
|
|
1154
|
+
*/
|
|
1155
|
+
getAssets<T = GetAssetsFullResponseOK, S extends GetAssetsRequest = GetAssetsRequest>(options: S): Promise<T extends GetAssetsFullResponseOK ? GetAssetsResponseOK<S> : T>;
|
|
1156
|
+
/**
|
|
1157
|
+
* The add_file_to_update mutation allows you to add a file to an update via the API. You can also specify what fields to query back when you run the mutation. Please note that the file will be added to the bottom of the update.
|
|
1158
|
+
* Documentation: https://developer.monday.com/api-reference/docs/files#add-a-file-to-an-update
|
|
1159
|
+
* @param options Request options.
|
|
1160
|
+
*/
|
|
1161
|
+
addFileToUpdate<T = AddFileToUpdateFullResponseOK, S extends AddFileToUpdateRequest = AddFileToUpdateRequest>(options: S): Promise<T extends AddFileToUpdateFullResponseOK ? AddFileToUpdateResponseOK<S> : T>;
|
|
1162
|
+
/**
|
|
1163
|
+
* The add_file_to_column mutation will add a file to the file column of a specific item. You can also specify what fields to query back when you run the mutation.
|
|
1164
|
+
* Documentation: https://developer.monday.com/api-reference/docs/files#add-file-to-the-file-column
|
|
1165
|
+
* @param options Request options.
|
|
1166
|
+
*/
|
|
1167
|
+
addFileToColumn<T = AddFileToColumnFullResponseOK, S extends AddFileToColumnRequest = AddFileToColumnRequest>(options: S): Promise<T extends AddFileToColumnFullResponseOK ? AddFileToColumnResponseOK<S> : T>;
|
|
1168
|
+
}
|
|
1169
|
+
declare class ColumnGroup {
|
|
1170
|
+
private implementation;
|
|
1171
|
+
private getGlobalErrorStrategy;
|
|
1172
|
+
constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy);
|
|
1173
|
+
/**
|
|
1174
|
+
* The create_column mutation allows you to create a new column on a board within the account via the API.
|
|
1175
|
+
* The create_column mutation also allows you to create a new status or dropdown column with custom labels via the API.
|
|
1176
|
+
* Documentation: https://developer.monday.com/api-reference/docs/columns#create-a-column
|
|
1177
|
+
* @param options Request options.
|
|
1178
|
+
*/
|
|
1179
|
+
createColumn<T = CreateColumnFullResponseOK, S extends CreateColumnRequest = CreateColumnRequest>(options: S): Promise<T extends CreateColumnFullResponseOK ? CreateColumnResponseOK<S> : T>;
|
|
1180
|
+
/**
|
|
1181
|
+
* The change_column_value mutation allows you to change the value of a column in a specific item.
|
|
1182
|
+
* Documentation: https://developer.monday.com/api-reference/docs/columns#change-a-column-value
|
|
1183
|
+
* @param options Request options.
|
|
1184
|
+
*/
|
|
1185
|
+
changeColumnValue<T = ChangeColumnValueFullResponseOK, S extends ChangeColumnValueRequest = ChangeColumnValueRequest>(options: S): Promise<T extends ChangeColumnValueFullResponseOK ? ChangeColumnValueResponseOK<S> : T>;
|
|
1186
|
+
/**
|
|
1187
|
+
* The change_column_value mutation allows you to change the value of a column in a specific item with a string value.
|
|
1188
|
+
* Documentation: https://developer.monday.com/api-reference/docs/columns#change-a-simple-column-value
|
|
1189
|
+
* @param options Request options.
|
|
1190
|
+
*/
|
|
1191
|
+
changeSimpleColumnValue<T = ChangeSimpleColumnValueFullResponseOK, S extends ChangeSimpleColumnValueRequest = ChangeSimpleColumnValueRequest>(options: S): Promise<T extends ChangeSimpleColumnValueFullResponseOK ? ChangeSimpleColumnValueResponseOK<S> : T>;
|
|
1192
|
+
/**
|
|
1193
|
+
* The change_multiple_column_values mutation allows you to change multiple column values of a specific item.
|
|
1194
|
+
* Documentation: https://developer.monday.com/api-reference/docs/columns#change-multiple-column-values
|
|
1195
|
+
* @param options Request options.
|
|
1196
|
+
*/
|
|
1197
|
+
changeMultipleColumnValues<T = ChangeMultipleColumnValuesFullResponseOK, S extends ChangeMultipleColumnValuesRequest = ChangeMultipleColumnValuesRequest>(options: S): Promise<T extends ChangeMultipleColumnValuesFullResponseOK ? ChangeMultipleColumnValuesResponseOK<S> : T>;
|
|
1198
|
+
/**
|
|
1199
|
+
* The change_column_title mutation allows you to change the title of an existing column via the API.
|
|
1200
|
+
* Documentation: https://developer.monday.com/api-reference/docs/columns#change-a-column-title
|
|
1201
|
+
* @param options Request options.
|
|
1202
|
+
*/
|
|
1203
|
+
changeColumnTitle<T = ChangeColumnTitleFullResponseOK, S extends ChangeColumnTitleRequest = ChangeColumnTitleRequest>(options: S): Promise<T extends ChangeColumnTitleFullResponseOK ? ChangeColumnTitleResponseOK<S> : T>;
|
|
1204
|
+
/**
|
|
1205
|
+
* The change_column_metadata mutation allows you to update the metadata of an existing column.
|
|
1206
|
+
* Currently, we support updating both the title and description.
|
|
1207
|
+
* Documentation: https://developer.monday.com/api-reference/docs/columns#change-column-metadata
|
|
1208
|
+
* @param options Request options.
|
|
1209
|
+
*/
|
|
1210
|
+
changeColumnMetadata<T = ChangeColumnMetadataFullResponseOK, S extends ChangeColumnMetadataRequest = ChangeColumnMetadataRequest>(options: S): Promise<T extends ChangeColumnMetadataFullResponseOK ? ChangeColumnMetadataResponseOK<S> : T>;
|
|
1211
|
+
/**
|
|
1212
|
+
* The delete_column mutation allows you to delete a single column from a board via the API.
|
|
1213
|
+
* Documentation: https://developer.monday.com/api-reference/docs/columns#delete-a-column
|
|
1214
|
+
* @param options Request options.
|
|
1215
|
+
*/
|
|
1216
|
+
deleteColumn<T = DeleteColumnFullResponseOK, S extends DeleteColumnRequest = DeleteColumnRequest>(options: S): Promise<T extends DeleteColumnFullResponseOK ? DeleteColumnResponseOK<S> : T>;
|
|
1217
|
+
}
|
|
1218
|
+
declare class WorkspaceGroup {
|
|
1219
|
+
private implementation;
|
|
1220
|
+
private getGlobalErrorStrategy;
|
|
1221
|
+
constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy);
|
|
1222
|
+
/**
|
|
1223
|
+
* Querying workspaces will return metadata about one or a collection of workspaces.
|
|
1224
|
+
* This method accepts various arguments and returns an array.
|
|
1225
|
+
* Documentation: https://developer.monday.com/api-reference/docs/workspaces#queries
|
|
1226
|
+
* @param options Request options.
|
|
1227
|
+
*/
|
|
1228
|
+
getWorkspaces<T = GetWorkspacesFullResponseOK, S extends GetWorkspacesRequest = GetWorkspacesRequest>(options: S): Promise<T extends GetWorkspacesFullResponseOK ? GetWorkspacesResponseOK<S> : T>;
|
|
1229
|
+
/**
|
|
1230
|
+
* The create_workspace mutation allows you to create a new workspace via the API.
|
|
1231
|
+
* You can also specify what fields to query back from the new workspace when you run the mutation.
|
|
1232
|
+
* Documentation: https://developer.monday.com/api-reference/docs/workspaces#create-a-workspace
|
|
1233
|
+
* @param options Request options.
|
|
1234
|
+
*/
|
|
1235
|
+
createWorkspace<T = CreateWorkspaceFullResponseOK, S extends CreateWorkspaceRequest = CreateWorkspaceRequest>(options: S): Promise<T extends CreateWorkspaceFullResponseOK ? CreateWorkspaceResponseOK<S> : T>;
|
|
1236
|
+
/**
|
|
1237
|
+
* The update_workspace mutation allows you to update a workspace via the API.
|
|
1238
|
+
* You can also specify what fields to query back from the deleted workspace when you run the mutation.
|
|
1239
|
+
* Documentation: https://developer.monday.com/api-reference/reference/workspaces#update-a-workspace
|
|
1240
|
+
* @param options Request options.
|
|
1241
|
+
*/
|
|
1242
|
+
updateWorkspace<T = UpdateWorkspaceFullResponseOK, S extends UpdateWorkspaceRequest = UpdateWorkspaceRequest>(options: S): Promise<T extends UpdateWorkspaceFullResponseOK ? UpdateWorkspaceResponseOK<S> : T>;
|
|
1243
|
+
/**
|
|
1244
|
+
* The delete_workspace mutation allows you to delete a workspace via the API.
|
|
1245
|
+
* You can also specify what fields to query back from the deleted workspace when you run the mutation.
|
|
1246
|
+
* Documentation: https://developer.monday.com/api-reference/docs/columns#delete-a-column
|
|
1247
|
+
* @param options Request options.
|
|
1248
|
+
*/
|
|
1249
|
+
deleteWorkspace<T = DeleteWorkspaceFullResponseOK, S extends DeleteWorkspaceRequest = DeleteWorkspaceRequest>(options: S): Promise<T extends DeleteWorkspaceFullResponseOK ? DeleteWorkspaceResponseOK<S> : T>;
|
|
1250
|
+
}
|
|
1251
|
+
declare class FolderGroup {
|
|
1252
|
+
private implementation;
|
|
1253
|
+
private getGlobalErrorStrategy;
|
|
1254
|
+
constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy);
|
|
1255
|
+
/**
|
|
1256
|
+
* Querying folders will return metadata about one or a collection of folders. This method accepts various arguments and returns an array.
|
|
1257
|
+
* Documentation: https://developer.monday.com/api-reference/docs/folders#queries
|
|
1258
|
+
* @param options Request options.
|
|
1259
|
+
*/
|
|
1260
|
+
getFolders<T = GetFoldersFullResponseOK, S extends GetFoldersRequest = GetFoldersRequest>(options: S): Promise<T extends GetFoldersFullResponseOK ? GetFoldersResponseOK<S> : T>;
|
|
1261
|
+
/**
|
|
1262
|
+
* The create_folder mutation allows you to create a new folder in a workspace via the API. You can also specify what fields to query back from the new folder when you run the mutation.
|
|
1263
|
+
* Documentation: https://developer.monday.com/api-reference/docs/folders#create-a-folder
|
|
1264
|
+
* @param options Request options.
|
|
1265
|
+
*/
|
|
1266
|
+
createFolder<T = CreateFolderFullResponseOK, S extends CreateFolderRequest = CreateFolderRequest>(options: S): Promise<T extends CreateFolderFullResponseOK ? CreateFolderResponseOK<S> : T>;
|
|
1267
|
+
/**
|
|
1268
|
+
* The update_folder mutation allows you to update a folder's color, name, or parent folder via the API. You can also specify what fields to query back from the updated folder when you run the mutation.
|
|
1269
|
+
* Documentation: https://developer.monday.com/api-reference/docs/folders#update-a-folder
|
|
1270
|
+
* @param options Request options.
|
|
1271
|
+
*/
|
|
1272
|
+
updateFolder<T = UpdateFolderFullResponseOK, S extends UpdateFolderRequest = UpdateFolderRequest>(options: S): Promise<T extends UpdateFolderFullResponseOK ? UpdateFolderResponseOK<S> : T>;
|
|
1273
|
+
/**
|
|
1274
|
+
* The delete_folder mutation allows you to delete and folder and all its contents via the API. You can also specify what fields to query back from the deleted folder when you run the mutation.
|
|
1275
|
+
* Documentation: https://developer.monday.com/api-reference/docs/folders#delete-a-folder
|
|
1276
|
+
* @param options Request options.
|
|
1277
|
+
*/
|
|
1278
|
+
deleteFolder<T = DeleteFolderFullResponseOK, S extends DeleteFolderRequest = DeleteFolderRequest>(options: S): Promise<T extends DeleteFolderFullResponseOK ? DeleteFolderResponseOK<S> : T>;
|
|
1279
|
+
}
|
|
1280
|
+
declare class UpdateGroup {
|
|
1281
|
+
private implementation;
|
|
1282
|
+
private getGlobalErrorStrategy;
|
|
1283
|
+
constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy);
|
|
1284
|
+
/**
|
|
1285
|
+
* Querying updates will return metadata about one or a collection of updates.
|
|
1286
|
+
* This method accepts various arguments and returns an array.
|
|
1287
|
+
* Documentation: https://developer.monday.com/api-reference/docs/updates#queries
|
|
1288
|
+
* @param options Request options.
|
|
1289
|
+
*/
|
|
1290
|
+
getUpdates<T = GetUpdatesFullResponseOK, S extends GetUpdatesRequest = GetUpdatesRequest>(options: S): Promise<T extends GetUpdatesFullResponseOK ? GetUpdatesResponseOK<S> : T>;
|
|
1291
|
+
/**
|
|
1292
|
+
* The create_update mutation allows you to add an update to an item via the API.
|
|
1293
|
+
* You can also specify what fields to query back from the new update when you run the mutation.
|
|
1294
|
+
* Documentation: https://developer.monday.com/api-reference/docs/updates#create-an-update
|
|
1295
|
+
* @param options Request options.
|
|
1296
|
+
*/
|
|
1297
|
+
createUpdate<T = CreateUpdateFullResponseOK, S extends CreateUpdateRequest = CreateUpdateRequest>(options: S): Promise<T extends CreateUpdateFullResponseOK ? CreateUpdateResponseOK<S> : T>;
|
|
1298
|
+
/**
|
|
1299
|
+
* The delete_update mutation allows you to delete an item's update via the API.
|
|
1300
|
+
* You can also specify what fields to query back from the update when you run the mutation.
|
|
1301
|
+
* Documentation: https://developer.monday.com/api-reference/docs/updates#delete-an-update
|
|
1302
|
+
* @param options Request options.
|
|
1303
|
+
*/
|
|
1304
|
+
deleteUpdate<T = DeleteUpdateFullResponseOK, S extends DeleteUpdateRequest = DeleteUpdateRequest>(options: S): Promise<T extends DeleteUpdateFullResponseOK ? DeleteUpdateResponseOK<S> : T>;
|
|
1305
|
+
/**
|
|
1306
|
+
* The like_update mutation allows you to like an update via the API.
|
|
1307
|
+
* You can also specify what fields to query back from the update when you run the mutation.
|
|
1308
|
+
* Documentation: https://developer.monday.com/api-reference/docs/updates#like-an-update
|
|
1309
|
+
* @param options Request options.
|
|
1310
|
+
*/
|
|
1311
|
+
likeUpdate<T = LikeUpdateFullResponseOK, S extends LikeUpdateRequest = LikeUpdateRequest>(options: S): Promise<T extends LikeUpdateFullResponseOK ? LikeUpdateResponseOK<S> : T>;
|
|
1312
|
+
/**
|
|
1313
|
+
* The unlike_update mutation allows you to unlike an update via the API.
|
|
1314
|
+
* You can also specify what fields to query back from the update when you run the mutation.
|
|
1315
|
+
* Documentation: https://developer.monday.com/api-reference/reference/updates#unlike-an-update
|
|
1316
|
+
* @param options Request options.
|
|
1317
|
+
*/
|
|
1318
|
+
unlikeUpdate<T = UnlikeUpdateFullResponseOK, S extends UnlikeUpdateRequest = UnlikeUpdateRequest>(options: S): Promise<T extends UnlikeUpdateFullResponseOK ? UnlikeUpdateResponseOK<S> : T>;
|
|
1319
|
+
/**
|
|
1320
|
+
* The edit_update mutation allows you to edit an update via the API.
|
|
1321
|
+
* You can also specify what fields to query back from the update when you run the mutation.
|
|
1322
|
+
* Documentation: https://developer.monday.com/api-reference/reference/updates#edit-an-update
|
|
1323
|
+
* @param options Request options.
|
|
1324
|
+
*/
|
|
1325
|
+
editUpdate<T = EditUpdateFullResponseOK, S extends EditUpdateRequest = EditUpdateRequest>(options: S): Promise<T extends EditUpdateFullResponseOK ? EditUpdateResponseOK<S> : T>;
|
|
1326
|
+
/**
|
|
1327
|
+
* The pin_to_top mutation allows you to pin an update to the top of an item via the API.
|
|
1328
|
+
* You can also specify what fields to query back from the update when you run the mutation.
|
|
1329
|
+
* Documentation: https://developer.monday.com/api-reference/reference/updates#pin-an-update
|
|
1330
|
+
* @param options Request options.
|
|
1331
|
+
*/
|
|
1332
|
+
pinUpdate<T = PinUpdateFullResponseOK, S extends PinUpdateRequest = PinUpdateRequest>(options: S): Promise<T extends PinUpdateFullResponseOK ? PinUpdateResponseOK<S> : T>;
|
|
1333
|
+
/**
|
|
1334
|
+
* The unpin_from_top mutation allows you to unpin an update from the top of an item via the API.
|
|
1335
|
+
* You can also specify what fields to query back from the update when you run the mutation.
|
|
1336
|
+
* Documentation: https://developer.monday.com/api-reference/reference/updates#unpin-an-update
|
|
1337
|
+
* @param options Request options.
|
|
1338
|
+
*/
|
|
1339
|
+
unpinUpdate<T = UnpinUpdateFullResponseOK, S extends UnpinUpdateRequest = UnpinUpdateRequest>(options: S): Promise<T extends UnpinUpdateFullResponseOK ? UnpinUpdateResponseOK<S> : T>;
|
|
1340
|
+
}
|
|
1341
|
+
declare class DocGroup {
|
|
1342
|
+
private implementation;
|
|
1343
|
+
private getGlobalErrorStrategy;
|
|
1344
|
+
DocBlock: DocBlockGroup;
|
|
1345
|
+
constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy);
|
|
1346
|
+
/**
|
|
1347
|
+
* Querying docs will return metadata about a collection of docs. This method accepts various arguments and returns an array.
|
|
1348
|
+
* Documentation: https://developer.monday.com/api-reference/docs/docs#queries
|
|
1349
|
+
* @param options Request options.
|
|
1350
|
+
*/
|
|
1351
|
+
getDocs<T = GetDocsFullResponseOK, S extends GetDocsRequest = GetDocsRequest>(options: S): Promise<T extends GetDocsFullResponseOK ? GetDocsResponseOK<S> : T>;
|
|
1352
|
+
/**
|
|
1353
|
+
* The create_doc mutation allows you to create a new doc in a document column or workspace via the API. You can also specify what fields to query back from the new doc when you run the mutation.
|
|
1354
|
+
* Documentation: https://developer.monday.com/api-reference/docs/docs#create-a-doc
|
|
1355
|
+
* @param options Request options.
|
|
1356
|
+
*/
|
|
1357
|
+
createDoc<T = CreateDocFullResponseOK, S extends CreateDocRequest = CreateDocRequest>(options: S): Promise<T extends CreateDocFullResponseOK ? CreateDocResponseOK<S> : T>;
|
|
1358
|
+
}
|
|
1359
|
+
declare class DocBlockGroup {
|
|
1360
|
+
private implementation;
|
|
1361
|
+
private getGlobalErrorStrategy;
|
|
1362
|
+
constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy);
|
|
1363
|
+
/**
|
|
1364
|
+
* Querying blocks will return metadata about one or a collection of blocks. The method accepts various arguments and returns an array.
|
|
1365
|
+
* Documentation: https://developer.monday.com/api-reference/docs/blocks#queries
|
|
1366
|
+
* @param options Request options.
|
|
1367
|
+
*/
|
|
1368
|
+
getDocBlocks<T = GetDocBlocksFullResponseOK, S extends GetDocBlocksRequest = GetDocBlocksRequest>(options: S): Promise<T extends GetDocBlocksFullResponseOK ? GetDocBlocksResponseOK<S> : T>;
|
|
1369
|
+
/**
|
|
1370
|
+
* The create_doc_block mutation allows you to create a new doc block via the API. You can also specify what fields to query back from the new doc block when you run the mutation.
|
|
1371
|
+
* Documentation: https://developer.monday.com/api-reference/docs/blocks#create-document-block
|
|
1372
|
+
* @param options Request options.
|
|
1373
|
+
*/
|
|
1374
|
+
createDocBlock<T = CreateDocBlockFullResponseOK, S extends CreateDocBlockRequest = CreateDocBlockRequest>(options: S): Promise<T extends CreateDocBlockFullResponseOK ? CreateDocBlockResponseOK<S> : T>;
|
|
1375
|
+
/**
|
|
1376
|
+
* The update_doc_block mutation allows you to update a doc block via the API. You can also specify what fields to query back from the updated doc block when you run the mutation.
|
|
1377
|
+
* Documentation: https://developer.monday.com/api-reference/docs/blocks#update-document-block
|
|
1378
|
+
* @param options Request options.
|
|
1379
|
+
*/
|
|
1380
|
+
updateDocBlock<T = UpdateDocBlockFullResponseOK, S extends UpdateDocBlockRequest = UpdateDocBlockRequest>(options: S): Promise<T extends UpdateDocBlockFullResponseOK ? UpdateDocBlockResponseOK<S> : T>;
|
|
1381
|
+
/**
|
|
1382
|
+
* The delete_doc_block mutation allows you to delete a doc block via the API. You can also specify what fields to query back from the deleted doc block when you run the mutation.
|
|
1383
|
+
* Documentation: https://developer.monday.com/api-reference/docs/blocks#delete-document-block
|
|
1384
|
+
* @param options Request options.
|
|
1385
|
+
*/
|
|
1386
|
+
deleteDocBlock<T = DeleteDocBlockFullResponseOK, S extends DeleteDocBlockRequest = DeleteDocBlockRequest>(options: S): Promise<T extends DeleteDocBlockFullResponseOK ? DeleteDocBlockResponseOK<S> : T>;
|
|
1387
|
+
}
|
|
1388
|
+
declare class TagGroup {
|
|
1389
|
+
private implementation;
|
|
1390
|
+
private getGlobalErrorStrategy;
|
|
1391
|
+
constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy);
|
|
1392
|
+
/**
|
|
1393
|
+
* Querying tags will return metadata about one or a collection of the account's public tags. Public tags appear on main boards and are accessible to all member
|
|
1394
|
+
* and viewer-level users by default, while private tags only appear on private or shareable boards. This method accepts one argument and returns an array.
|
|
1395
|
+
* You can query tags directly at the root to return public tags. If you do so and use the ids argument of a private tag, you will get an empty result.
|
|
1396
|
+
* To return tags stored on private or shareable boards, you can nest tags within a boards query.
|
|
1397
|
+
* Documentation: https://developer.monday.com/api-reference/docs/tags-queries#queries
|
|
1398
|
+
* @param options Request options.
|
|
1399
|
+
*/
|
|
1400
|
+
getTags<T = GetTagsFullResponseOK, S extends GetTagsRequest = GetTagsRequest>(options: S): Promise<T extends GetTagsFullResponseOK ? GetTagsResponseOK<S> : T>;
|
|
1401
|
+
/**
|
|
1402
|
+
* The create_or_get_tag mutation allows you to create new tags or receive their data if they already exist via the API.
|
|
1403
|
+
* You can also specify what fields to query back from the tag when you run the mutation.
|
|
1404
|
+
* Documentation: https://developer.monday.com/api-reference/docs/tags-queries#create-or-get-a-tag
|
|
1405
|
+
* @param options Request options.
|
|
1406
|
+
*/
|
|
1407
|
+
createOrGetTag<T = CreateOrGetTagResponseOK, S extends CreateOrGetTagRequest = CreateOrGetTagRequest>(options: S): Promise<T extends CreateOrGetTagFullResponseOK ? CreateOrGetTagResponseOK<S> : T>;
|
|
1408
|
+
}
|
|
1409
|
+
declare class VersionGroup {
|
|
1410
|
+
private implementation;
|
|
1411
|
+
private getGlobalErrorStrategy;
|
|
1412
|
+
constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy);
|
|
1413
|
+
/**
|
|
1414
|
+
* Querying version will return metadata about the API version used to make a request. This method does not accept any arguments and returns an object.
|
|
1415
|
+
* Documentation: https://developer.monday.com/api-reference/docs/version#queries
|
|
1416
|
+
* @param options Request options.
|
|
1417
|
+
*/
|
|
1418
|
+
getVersion<T = GetVersionFullResponseOK, S extends GetVersionRequest = GetVersionRequest>(options: S): Promise<T extends GetVersionFullResponseOK ? GetVersionResponseOK<S> : T>;
|
|
1419
|
+
/**
|
|
1420
|
+
* Querying versions will return metadata about all available API versions. This method does not accept any arguments and returns an array.
|
|
1421
|
+
* Documentation: https://developer.monday.com/api-reference/docs/versions#queries
|
|
1422
|
+
* @param options Request options.
|
|
1423
|
+
*/
|
|
1424
|
+
getVersions<T = GetVersionsFullResponseOK, S extends GetVersionsRequest = GetVersionsRequest>(options: S): Promise<T extends GetVersionsFullResponseOK ? GetVersionsResponseOK<S> : T>;
|
|
1425
|
+
}
|
|
1426
|
+
declare class WebhookGroup {
|
|
1427
|
+
private implementation;
|
|
1428
|
+
private getGlobalErrorStrategy;
|
|
1429
|
+
constructor(implementation: PlatformImplementation, getGlobalErrorStrategy: GetGlobalErrorStrategy);
|
|
1430
|
+
/**
|
|
1431
|
+
* Querying webhooks will return one or a collection of webhooks. This method accepts various arguments and returns an array.
|
|
1432
|
+
* You can only query webhooks directly at the root, so it can't be nested within another query.
|
|
1433
|
+
* Documentation: https://developer.monday.com/api-reference/docs/webhooks#queries
|
|
1434
|
+
* @param options
|
|
1435
|
+
*/
|
|
1436
|
+
getWebhooks<T = GetWebhooksFullResponseOK, S extends GetWebhooksRequest = GetWebhooksRequest>(options: S): Promise<T extends GetWebhooksFullResponseOK ? GetWebhooksResponseOK<S> : T>;
|
|
1437
|
+
/**
|
|
1438
|
+
* The create_webhook mutation allows you to create a new webhook via the API. You can also specify what fields to query back when you run the mutation.
|
|
1439
|
+
* After the mutation runs, a webhook subscription will be created based on a specific event, so the webhook will send data to the subscribed URL every time the event happens on your board.
|
|
1440
|
+
*
|
|
1441
|
+
* You can add a query param to your webhook URL if you want to differentiate between subitem and main item events.
|
|
1442
|
+
* The URL must pass a verification test where we will send a JSON POST body request containing a challenge field.
|
|
1443
|
+
* Monday.com expects your provided URL to return the token as a challenge field in your response JSON body to that request.
|
|
1444
|
+
*
|
|
1445
|
+
* Documentation: https://developer.monday.com/api-reference/docs/webhooks#create-a-webhook
|
|
1446
|
+
* @param options
|
|
1447
|
+
*/
|
|
1448
|
+
createWebhook<T = CreateWebhooksFullResponseOK, S extends CreateWebhookRequest = CreateWebhookRequest>(options: S): Promise<T extends CreateWebhooksFullResponseOK ? CreateWebhookResponseOK<S> : T>;
|
|
1449
|
+
/**
|
|
1450
|
+
* The delete_webhook mutation allows you to delete a webhook via the API.
|
|
1451
|
+
* You can also specify what fields to query back when you run the mutation.
|
|
1452
|
+
* After the mutation runs, it will no longer report events to the URL given.
|
|
1453
|
+
* Documentation: https://developer.monday.com/api-reference/docs/webhooks#delete-a-webhook
|
|
1454
|
+
* @param options
|
|
1455
|
+
*/
|
|
1456
|
+
deleteWebhook<T = DeleteWebhooksFullResponseOK, S extends DeleteWebhookRequest = DeleteWebhookRequest>(options: S): Promise<T extends DeleteWebhooksFullResponseOK ? DeleteWebhookResponseOK<S> : T>;
|
|
1457
|
+
}
|
|
1458
|
+
export {};
|
|
1459
|
+
//# sourceMappingURL=index.d.ts.map
|