@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.js
ADDED
|
@@ -0,0 +1,1850 @@
|
|
|
1
|
+
/*!
|
|
2
|
+
* Copyright Adaptavist 2023 (c) All rights reserved
|
|
3
|
+
*/
|
|
4
|
+
import { BaseApiCore, constructHeaders, executeHttpCall, Request, Response } from '@managed-api/commons-core';
|
|
5
|
+
import { constructUploadFilePayload, createMutation, createQuery, errorMessageBuilder } from './common';
|
|
6
|
+
import { customErrorHandlers, errorStrategyBuilderConstructor } from './errorStrategy';
|
|
7
|
+
;
|
|
8
|
+
export class MondayApiCore extends BaseApiCore {
|
|
9
|
+
constructor(options) {
|
|
10
|
+
var _a, _b;
|
|
11
|
+
super();
|
|
12
|
+
this.options = options;
|
|
13
|
+
if (!((_a = this.options) === null || _a === void 0 ? void 0 : _a.errorStrategy) && ((_b = this.options) === null || _b === void 0 ? void 0 : _b.errorStrategy) !== null) {
|
|
14
|
+
this.setGlobalErrorStrategy((builder) => builder.retryOnRateLimiting(-1));
|
|
15
|
+
}
|
|
16
|
+
this.Account = new AccountGroup(this.implementation, () => this.getGlobalErrorStrategy());
|
|
17
|
+
this.Board = new BoardGroup(this.implementation, () => this.getGlobalErrorStrategy());
|
|
18
|
+
this.Item = new ItemGroup(this.implementation, () => this.getGlobalErrorStrategy());
|
|
19
|
+
this.Me = new MeGroup(this.implementation, () => this.getGlobalErrorStrategy());
|
|
20
|
+
this.User = new UserGroup(this.implementation, () => this.getGlobalErrorStrategy());
|
|
21
|
+
this.File = new FileGroup(this.implementation, () => this.getGlobalErrorStrategy());
|
|
22
|
+
this.Column = new ColumnGroup(this.implementation, () => this.getGlobalErrorStrategy());
|
|
23
|
+
this.Notification = new NotificationGroup(this.implementation, () => this.getGlobalErrorStrategy());
|
|
24
|
+
this.Workspace = new WorkspaceGroup(this.implementation, () => this.getGlobalErrorStrategy());
|
|
25
|
+
this.Folder = new FolderGroup(this.implementation, () => this.getGlobalErrorStrategy());
|
|
26
|
+
this.Update = new UpdateGroup(this.implementation, () => this.getGlobalErrorStrategy());
|
|
27
|
+
this.Team = new TeamGroup(this.implementation, () => this.getGlobalErrorStrategy());
|
|
28
|
+
this.ItemsPage = new ItemsPageGroup(this.implementation, () => this.getGlobalErrorStrategy());
|
|
29
|
+
this.Doc = new DocGroup(this.implementation, () => this.getGlobalErrorStrategy());
|
|
30
|
+
this.Tag = new TagGroup(this.implementation, () => this.getGlobalErrorStrategy());
|
|
31
|
+
this.Version = new VersionGroup(this.implementation, () => this.getGlobalErrorStrategy());
|
|
32
|
+
this.Webhook = new WebhookGroup(this.implementation, () => this.getGlobalErrorStrategy());
|
|
33
|
+
this.All = new AllGroup(this.Account, this.Board, this.Item, this.Me, this.User, this.File, this.Column, this.Notification, this.Workspace, this.Folder, this.Update, this.Team, this.ItemsPage, this.Doc, this.Tag, this.Version, this.Webhook);
|
|
34
|
+
}
|
|
35
|
+
setGlobalErrorStrategy(errorStrategy) {
|
|
36
|
+
var _a;
|
|
37
|
+
this.options = {
|
|
38
|
+
...(_a = this.options) !== null && _a !== void 0 ? _a : {},
|
|
39
|
+
errorStrategy
|
|
40
|
+
};
|
|
41
|
+
}
|
|
42
|
+
buildResponse(url, status, statusText, headers, body) {
|
|
43
|
+
const response = new Response(url, status, statusText, headers, body);
|
|
44
|
+
response.setBufferImplementation(this.implementation);
|
|
45
|
+
return response;
|
|
46
|
+
}
|
|
47
|
+
getGlobalErrorStrategy() {
|
|
48
|
+
var _a;
|
|
49
|
+
return (_a = this.options) === null || _a === void 0 ? void 0 : _a.errorStrategy;
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
class AllGroup {
|
|
53
|
+
constructor(Account, Board, Item, Me, User, File, Column, Notification, Workspace, Folder, Update, Team, ItemsPage, Doc, Tag, Version, Webhook) {
|
|
54
|
+
this.Account = Account;
|
|
55
|
+
this.Board = Board;
|
|
56
|
+
this.Item = Item;
|
|
57
|
+
this.Me = Me;
|
|
58
|
+
this.User = User;
|
|
59
|
+
this.File = File;
|
|
60
|
+
this.Column = Column;
|
|
61
|
+
this.Notification = Notification;
|
|
62
|
+
this.Workspace = Workspace;
|
|
63
|
+
this.Folder = Folder;
|
|
64
|
+
this.Update = Update;
|
|
65
|
+
this.Team = Team;
|
|
66
|
+
this.ItemsPage = ItemsPage;
|
|
67
|
+
this.Doc = Doc;
|
|
68
|
+
this.Tag = Tag;
|
|
69
|
+
this.Version = Version;
|
|
70
|
+
this.Webhook = Webhook;
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* The create_column mutation allows you to create a new column on a board within the account via the API.
|
|
74
|
+
* The create_column mutation also allows you to create a new status or dropdown column with custom labels via the API.
|
|
75
|
+
* Alternative usage: Column.createColumn
|
|
76
|
+
* Documentation: https://developer.monday.com/api-reference/docs/columns#create-a-column
|
|
77
|
+
* @param options Request options.
|
|
78
|
+
*/
|
|
79
|
+
async createColumn(options) {
|
|
80
|
+
return this.Column.createColumn(options);
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* The change_column_value mutation allows you to change the value of a column in a specific item.
|
|
84
|
+
* Alternative usage: Column.changeColumnValue
|
|
85
|
+
* Documentation: https://developer.monday.com/api-reference/docs/columns#change-a-column-value
|
|
86
|
+
* @param options Request options.
|
|
87
|
+
*/
|
|
88
|
+
async changeColumnValue(options) {
|
|
89
|
+
return this.Column.changeColumnValue(options);
|
|
90
|
+
}
|
|
91
|
+
/**
|
|
92
|
+
* The change_column_value mutation allows you to change the value of a column in a specific item with a string value.
|
|
93
|
+
* Alternative usage: Column.changeSimpleColumnValue
|
|
94
|
+
* Documentation: https://developer.monday.com/api-reference/docs/columns#change-a-simple-column-value
|
|
95
|
+
* @param options Request options.
|
|
96
|
+
*/
|
|
97
|
+
async changeSimpleColumnValue(options) {
|
|
98
|
+
return this.Column.changeSimpleColumnValue(options);
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
* The change_multiple_column_values mutation allows you to change multiple column values of a specific item.
|
|
102
|
+
* Alternative usage: Column.changeMultipleColumnValues
|
|
103
|
+
* Documentation: https://developer.monday.com/api-reference/docs/columns#change-multiple-column-values
|
|
104
|
+
* @param options Request options.
|
|
105
|
+
*/
|
|
106
|
+
async changeMultipleColumnValues(options) {
|
|
107
|
+
return this.Column.changeMultipleColumnValues(options);
|
|
108
|
+
}
|
|
109
|
+
/**
|
|
110
|
+
* The change_column_title mutation allows you to change the title of an existing column via the API.
|
|
111
|
+
* Alternative usage: Column.changeColumnTitle
|
|
112
|
+
* Documentation: https://developer.monday.com/api-reference/docs/columns#change-a-column-title
|
|
113
|
+
* @param options Request options.
|
|
114
|
+
*/
|
|
115
|
+
async changeColumnTitle(options) {
|
|
116
|
+
return this.Column.changeColumnTitle(options);
|
|
117
|
+
}
|
|
118
|
+
/**
|
|
119
|
+
* The change_column_metadata mutation allows you to update the metadata of an existing column.
|
|
120
|
+
* Currently, we support updating both the title and description.
|
|
121
|
+
* Alternative usage: Column.changeColumnMetadata
|
|
122
|
+
* Documentation: https://developer.monday.com/api-reference/docs/columns#change-column-metadata
|
|
123
|
+
* @param options Request options.
|
|
124
|
+
*/
|
|
125
|
+
async changeColumnMetadata(options) {
|
|
126
|
+
return this.Column.changeColumnMetadata(options);
|
|
127
|
+
}
|
|
128
|
+
/**
|
|
129
|
+
* The delete_column mutation allows you to delete a single column from a board via the API.
|
|
130
|
+
* Alternative usage: Column.deleteColumn
|
|
131
|
+
* Documentation: https://developer.monday.com/api-reference/docs/columns#delete-a-column
|
|
132
|
+
* @param options Request options.
|
|
133
|
+
*/
|
|
134
|
+
async deleteColumn(options) {
|
|
135
|
+
return this.Column.deleteColumn(options);
|
|
136
|
+
}
|
|
137
|
+
/**
|
|
138
|
+
* Querying boards will return metadata about one or a collection of boards. This method accepts various arguments and returns an array.
|
|
139
|
+
* Alternative usage: Board.getBoards
|
|
140
|
+
* Documentation: https://developer.monday.com/api-reference/docs/boards#queries
|
|
141
|
+
* @param options Request options.
|
|
142
|
+
*/
|
|
143
|
+
async getBoards(options) {
|
|
144
|
+
return this.Board.getBoards(options);
|
|
145
|
+
}
|
|
146
|
+
/**
|
|
147
|
+
* The create_board mutation allows you to create a new board via the API.
|
|
148
|
+
* You can also specify what fields to query back from the new board when you run the mutation.
|
|
149
|
+
* 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.
|
|
150
|
+
* Alternative usage: Board.createBoard
|
|
151
|
+
* Documentation: https://developer.monday.com/api-reference/docs/boards#create-a-board
|
|
152
|
+
* @param options Request options.
|
|
153
|
+
*/
|
|
154
|
+
async createBoard(options) {
|
|
155
|
+
return this.Board.createBoard(options);
|
|
156
|
+
}
|
|
157
|
+
/**
|
|
158
|
+
* 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.
|
|
159
|
+
* Alternative usage: Board.duplicateBoard
|
|
160
|
+
* Documentation: https://developer.monday.com/api-reference/docs/boards#duplicate-a-board
|
|
161
|
+
* @param options Request options.
|
|
162
|
+
*/
|
|
163
|
+
async duplicateBoard(options) {
|
|
164
|
+
return this.Board.duplicateBoard(options);
|
|
165
|
+
}
|
|
166
|
+
/**
|
|
167
|
+
* The update_board mutation allows you to update a board via the API.
|
|
168
|
+
* Alternative usage: Board.updateBoard
|
|
169
|
+
* Documentation: https://developer.monday.com/api-reference/docs/boards#update-a-board
|
|
170
|
+
* @param options Request options.
|
|
171
|
+
*/
|
|
172
|
+
async updateBoard(options) {
|
|
173
|
+
return this.Board.updateBoard(options);
|
|
174
|
+
}
|
|
175
|
+
/**
|
|
176
|
+
* 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.
|
|
177
|
+
* Alternative usage: Board.archiveBoard
|
|
178
|
+
* Documentation: https://developer.monday.com/api-reference/docs/boards#archive-a-board
|
|
179
|
+
* @param options Request options.
|
|
180
|
+
*/
|
|
181
|
+
async archiveBoard(options) {
|
|
182
|
+
return this.Board.archiveBoard(options);
|
|
183
|
+
}
|
|
184
|
+
/**
|
|
185
|
+
* 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.
|
|
186
|
+
* Alternative usage: Board.deleteBoard
|
|
187
|
+
* Documentation: https://developer.monday.com/api-reference/docs/boards#delete-a-board
|
|
188
|
+
* @param options Request options.
|
|
189
|
+
*/
|
|
190
|
+
async deleteBoard(options) {
|
|
191
|
+
return this.Board.deleteBoard(options);
|
|
192
|
+
}
|
|
193
|
+
/**
|
|
194
|
+
* 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.
|
|
195
|
+
* Alternative usage: Board.deleteSubscribersFromBoard
|
|
196
|
+
* Documentation: https://developer.monday.com/api-reference/docs/boards#delete-subscribers-from-a-board
|
|
197
|
+
* @param options Request options.
|
|
198
|
+
*/
|
|
199
|
+
async deleteSubscribersFromBoard(options) {
|
|
200
|
+
return this.Board.deleteSubscribersFromBoard(options);
|
|
201
|
+
}
|
|
202
|
+
/**
|
|
203
|
+
* Querying items_page will return items filtered by the specified criteria. This method accepts various arguments and returns an object.
|
|
204
|
+
* Alternative usage: Board.ItemsPage.getItemsPage
|
|
205
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items_page#queries
|
|
206
|
+
* @param options Request options.
|
|
207
|
+
*/
|
|
208
|
+
async getItemsPage(options) {
|
|
209
|
+
return this.Board.ItemsPage.getItemsPage(options);
|
|
210
|
+
}
|
|
211
|
+
/**
|
|
212
|
+
* 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.
|
|
213
|
+
* Alternative usage: ItemsPage.getNextItemsPage
|
|
214
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items_page#cursor-based-pagination-using-next_items_page
|
|
215
|
+
* @param options Request options.
|
|
216
|
+
*/
|
|
217
|
+
async getNextItemsPage(options) {
|
|
218
|
+
return this.ItemsPage.getNextItemsPage(options);
|
|
219
|
+
}
|
|
220
|
+
/**
|
|
221
|
+
* 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.
|
|
222
|
+
* Alternative usage: ItemsPage.getItemsPageByColumnValues
|
|
223
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items-page-by-column-values
|
|
224
|
+
* @param options Request options.
|
|
225
|
+
*/
|
|
226
|
+
async getItemsPageByColumnValues(options) {
|
|
227
|
+
return this.ItemsPage.getItemsPageByColumnValues(options);
|
|
228
|
+
}
|
|
229
|
+
/**
|
|
230
|
+
* Querying views will return a collection of board views from a specific board. This method accepts various arguments and returns an array.
|
|
231
|
+
* You can only query views by nesting it within a boards query, so it can't be used at the root.
|
|
232
|
+
* Alternative usage: Board.View.getViews
|
|
233
|
+
* Documentation: https://developer.monday.com/api-reference/docs/board-view-queries#queries
|
|
234
|
+
* @param options Request options.
|
|
235
|
+
*/
|
|
236
|
+
async getBoardViews(options) {
|
|
237
|
+
return this.Board.View.getViews(options);
|
|
238
|
+
}
|
|
239
|
+
/**
|
|
240
|
+
* 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. *
|
|
241
|
+
* You can only query groups by nesting it within another query, so it can't be used at the root.
|
|
242
|
+
* Alternative usage: Board.Group.getGroups
|
|
243
|
+
* Documentation: https://developer.monday.com/api-reference/docs/groups#queries
|
|
244
|
+
* @param options Request options.
|
|
245
|
+
*/
|
|
246
|
+
async getBoardGroups(options) {
|
|
247
|
+
return this.Board.Group.getGroups(options);
|
|
248
|
+
}
|
|
249
|
+
/**
|
|
250
|
+
* 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.
|
|
251
|
+
* Alternative usage: Board.Group.createGroup
|
|
252
|
+
* Documentation: https://developer.monday.com/api-reference/docs/groups#create-a-group
|
|
253
|
+
* @param options
|
|
254
|
+
*/
|
|
255
|
+
async createGroup(options) {
|
|
256
|
+
return this.Board.Group.createGroup(options);
|
|
257
|
+
}
|
|
258
|
+
/**
|
|
259
|
+
* 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.
|
|
260
|
+
* Alternative usage: Board.Group.updateGroup
|
|
261
|
+
* Documentation: https://developer.monday.com/api-reference/docs/groups#update-a-group
|
|
262
|
+
* @param options
|
|
263
|
+
*/
|
|
264
|
+
async updateGroup(options) {
|
|
265
|
+
return this.Board.Group.updateGroup(options);
|
|
266
|
+
}
|
|
267
|
+
/**
|
|
268
|
+
* 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.
|
|
269
|
+
* Alternative usage: Board.Group.duplicateGroup
|
|
270
|
+
* Documentation: https://developer.monday.com/api-reference/docs/groups#duplicate-group
|
|
271
|
+
* (!) Mutation-specific rate limit:
|
|
272
|
+
* 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".
|
|
273
|
+
* @param options
|
|
274
|
+
*/
|
|
275
|
+
async duplicateGroup(options) {
|
|
276
|
+
return this.Board.Group.duplicateGroup(options);
|
|
277
|
+
}
|
|
278
|
+
/**
|
|
279
|
+
* 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.
|
|
280
|
+
* Alternative usage: Board.Group.archiveGroup
|
|
281
|
+
* Documentation: https://developer.monday.com/api-reference/docs/groups#archive-a-group
|
|
282
|
+
* @param options
|
|
283
|
+
*/
|
|
284
|
+
async archiveGroup(options) {
|
|
285
|
+
return this.Board.Group.archiveGroup(options);
|
|
286
|
+
}
|
|
287
|
+
/**
|
|
288
|
+
* 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.
|
|
289
|
+
* Alternative usage: Board.Group.deleteGroup
|
|
290
|
+
* Documentation: https://developer.monday.com/api-reference/docs/groups#delete-a-group
|
|
291
|
+
* @param options
|
|
292
|
+
*/
|
|
293
|
+
async deleteGroup(options) {
|
|
294
|
+
return this.Board.Group.deleteGroup(options);
|
|
295
|
+
}
|
|
296
|
+
/**
|
|
297
|
+
* Querying items will return metadata about one or a collection of items. This method accepts various arguments and returns an array.
|
|
298
|
+
* Alternative usage: Item.getItems
|
|
299
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#queries
|
|
300
|
+
* @param options Request options.
|
|
301
|
+
*/
|
|
302
|
+
async getItems(options) {
|
|
303
|
+
return this.Item.getItems(options);
|
|
304
|
+
}
|
|
305
|
+
/**
|
|
306
|
+
* 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.
|
|
307
|
+
* Alternative usage: Item.createItem
|
|
308
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#create-an-item
|
|
309
|
+
* @param options Request options.
|
|
310
|
+
*/
|
|
311
|
+
async createItem(options) {
|
|
312
|
+
return this.Item.createItem(options);
|
|
313
|
+
}
|
|
314
|
+
/**
|
|
315
|
+
* 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.
|
|
316
|
+
* Alternative usage: Item.duplicateItem
|
|
317
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#duplicate-an-item
|
|
318
|
+
* @param options Request options.
|
|
319
|
+
*/
|
|
320
|
+
async duplicateItem(options) {
|
|
321
|
+
return this.Item.duplicateItem(options);
|
|
322
|
+
}
|
|
323
|
+
/**
|
|
324
|
+
* 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.
|
|
325
|
+
* Alternative usage: Item.moveItemToGroup
|
|
326
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#move-item-to-group
|
|
327
|
+
* @param options Request options.
|
|
328
|
+
*/
|
|
329
|
+
async moveItemToGroup(options) {
|
|
330
|
+
return this.Item.moveItemToGroup(options);
|
|
331
|
+
}
|
|
332
|
+
/**
|
|
333
|
+
* 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.
|
|
334
|
+
* Alternative usage: Item.moveItemToBoard
|
|
335
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#move-item-to-board
|
|
336
|
+
* @param options Request options.
|
|
337
|
+
*/
|
|
338
|
+
async moveItemToBoard(options) {
|
|
339
|
+
return this.Item.moveItemToBoard(options);
|
|
340
|
+
}
|
|
341
|
+
/**
|
|
342
|
+
* 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.
|
|
343
|
+
* Alternative usage: Item.archiveItem
|
|
344
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#archive-an-item
|
|
345
|
+
* @param options Request options.
|
|
346
|
+
*/
|
|
347
|
+
async archiveItem(options) {
|
|
348
|
+
return this.Item.archiveItem(options);
|
|
349
|
+
}
|
|
350
|
+
/**
|
|
351
|
+
* 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.
|
|
352
|
+
* Alternative usage: Item.deleteItem
|
|
353
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#delete-an-item
|
|
354
|
+
* @param options Request options.
|
|
355
|
+
*/
|
|
356
|
+
async deleteItem(options) {
|
|
357
|
+
return this.Item.deleteItem(options);
|
|
358
|
+
}
|
|
359
|
+
/**
|
|
360
|
+
* 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.
|
|
361
|
+
* Alternative usage: Item.clearUpdates
|
|
362
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#clear-an-items-updates
|
|
363
|
+
* @param options Request options.
|
|
364
|
+
*/
|
|
365
|
+
async clearItemUpdates(options) {
|
|
366
|
+
return this.Item.clearUpdates(options);
|
|
367
|
+
}
|
|
368
|
+
/**
|
|
369
|
+
* Querying subitems will return metadata about one or a collection of subitems. This method does not accept any arguments and returns an array.
|
|
370
|
+
* You can only query subitems by nesting it within another query, so it can't be used at the root.
|
|
371
|
+
* Alternative usage: Item.Subitem.getSubitems
|
|
372
|
+
* Documentation: https://developer.monday.com/api-reference/docs/subitems#queries
|
|
373
|
+
* @param options Request options.
|
|
374
|
+
*/
|
|
375
|
+
async getSubitems(options) {
|
|
376
|
+
return this.Item.Subitem.getSubitems(options);
|
|
377
|
+
}
|
|
378
|
+
/**
|
|
379
|
+
* 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.
|
|
380
|
+
* Alternative usage: Item.Subitem.createSubitem
|
|
381
|
+
* Documentation: https://developer.monday.com/api-reference/docs/subitems#create-a-subitem
|
|
382
|
+
* @param options Request options.
|
|
383
|
+
*/
|
|
384
|
+
async createSubitem(options) {
|
|
385
|
+
return this.Item.Subitem.createSubitem(options);
|
|
386
|
+
}
|
|
387
|
+
/**
|
|
388
|
+
* 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.
|
|
389
|
+
* You can only query me directly at the root, so it can't be nested within another query.
|
|
390
|
+
* Alternative usage: Me.getUserDetails
|
|
391
|
+
* Documentation: https://developer.monday.com/api-reference/docs/me#queries
|
|
392
|
+
* @param options Request options.
|
|
393
|
+
*/
|
|
394
|
+
async getUserDetails(options) {
|
|
395
|
+
return this.Me.getUserDetails(options);
|
|
396
|
+
}
|
|
397
|
+
/**
|
|
398
|
+
* Querying users will return metadata about one or multiple users. This method accepts various arguments and returns an array.
|
|
399
|
+
* Alternative usage: User.getUsers
|
|
400
|
+
* Documentation: https://developer.monday.com/api-reference/docs/users#queries
|
|
401
|
+
* @param options Request options.
|
|
402
|
+
*/
|
|
403
|
+
async getUsers(options) {
|
|
404
|
+
return this.User.getUsers(options);
|
|
405
|
+
}
|
|
406
|
+
/**
|
|
407
|
+
* 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.
|
|
408
|
+
* Alternative usage: User.addUsersToBoard
|
|
409
|
+
* Documentation: https://developer.monday.com/api-reference/docs/users#add-users-to-a-board
|
|
410
|
+
* @param options Request options.
|
|
411
|
+
*/
|
|
412
|
+
async addUsersToBoard(options) {
|
|
413
|
+
return this.User.addUsersToBoard(options);
|
|
414
|
+
}
|
|
415
|
+
/**
|
|
416
|
+
* 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.
|
|
417
|
+
* Alternative usage: User.addUsersToWorkspace
|
|
418
|
+
* Documentation: https://developer.monday.com/api-reference/docs/users#add-users-to-a-workspace
|
|
419
|
+
* @param options Request options.
|
|
420
|
+
*/
|
|
421
|
+
async addUsersToWorkspace(options) {
|
|
422
|
+
return this.User.addUsersToWorkspace(options);
|
|
423
|
+
}
|
|
424
|
+
/**
|
|
425
|
+
* 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.
|
|
426
|
+
* Alternative usage: User.deleteUsersFromWorkspace
|
|
427
|
+
* Documentation: https://developer.monday.com/api-reference/docs/users#delete-users-from-a-workspace
|
|
428
|
+
* @param options Request options.
|
|
429
|
+
*/
|
|
430
|
+
async deleteUsersFromWorkspace(options) {
|
|
431
|
+
return this.User.deleteUsersFromWorkspace(options);
|
|
432
|
+
}
|
|
433
|
+
/**
|
|
434
|
+
* 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.
|
|
435
|
+
* Alternative usage: User.deactivateUsers
|
|
436
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#deactivate-users
|
|
437
|
+
* @param options Request options.
|
|
438
|
+
*/
|
|
439
|
+
async deactivateUsers(options) {
|
|
440
|
+
return this.User.deactivateUsers(options);
|
|
441
|
+
}
|
|
442
|
+
/**
|
|
443
|
+
* 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.
|
|
444
|
+
* Alternative usage: User.activateUsers
|
|
445
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#activate-users
|
|
446
|
+
* @param options Request options.
|
|
447
|
+
*/
|
|
448
|
+
async activateUsers(options) {
|
|
449
|
+
return this.User.activateUsers(options);
|
|
450
|
+
}
|
|
451
|
+
/**
|
|
452
|
+
* 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.
|
|
453
|
+
* Alternative usage: User.updateUsersRole
|
|
454
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#activate-users
|
|
455
|
+
* @param options Request options.
|
|
456
|
+
*/
|
|
457
|
+
async updateUsersRole(options) {
|
|
458
|
+
return this.User.updateUsersRole(options);
|
|
459
|
+
}
|
|
460
|
+
/**
|
|
461
|
+
* 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.
|
|
462
|
+
* Alternative usage: User.updateUsersEmailDomain
|
|
463
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#update-a-users-email-domain
|
|
464
|
+
* @param options Request options.
|
|
465
|
+
*/
|
|
466
|
+
async updateUsersEmailDomain(options) {
|
|
467
|
+
return this.User.updateUsersEmailDomain(options);
|
|
468
|
+
}
|
|
469
|
+
/**
|
|
470
|
+
* This mutation invites users to join a monday.com account. They will be in a pending status until the invitation is accepted.
|
|
471
|
+
* Alternative usage: User.inviteUsers
|
|
472
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#invite-users
|
|
473
|
+
* @param options Request options.
|
|
474
|
+
*/
|
|
475
|
+
async inviteUsers(options) {
|
|
476
|
+
return this.User.inviteUsers(options);
|
|
477
|
+
}
|
|
478
|
+
/**
|
|
479
|
+
* 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.
|
|
480
|
+
* Alternative usage: User.updateUsersAttributes
|
|
481
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#update-users-attributes
|
|
482
|
+
* @param options Request options.
|
|
483
|
+
*/
|
|
484
|
+
async updateUsersAttributes(options) {
|
|
485
|
+
return this.User.updateUsersAttributes(options);
|
|
486
|
+
}
|
|
487
|
+
/**
|
|
488
|
+
* Returns an object containing metadata about all user roles in an account (both default and custom).
|
|
489
|
+
* Alternative usage: Account.Role.getAccountRoles
|
|
490
|
+
* Documentation: https://developer.monday.com/api-reference/reference/account-roles#queries
|
|
491
|
+
* @param options Request options.
|
|
492
|
+
*/
|
|
493
|
+
async getAccountRoles(options) {
|
|
494
|
+
return this.Account.Role.getAccountRoles(options);
|
|
495
|
+
}
|
|
496
|
+
/**
|
|
497
|
+
* Querying assets will return one or a collection of assets. This method accepts various arguments and returns an array.
|
|
498
|
+
* Alternative usage: File.getAssets
|
|
499
|
+
* Documentation: https://developer.monday.com/api-reference/docs/files#queries
|
|
500
|
+
* @param options Request options.
|
|
501
|
+
*/
|
|
502
|
+
async getAssets(options) {
|
|
503
|
+
return this.File.getAssets(options);
|
|
504
|
+
}
|
|
505
|
+
/**
|
|
506
|
+
* 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.
|
|
507
|
+
* Alternative usage: File.addFileToUpdate
|
|
508
|
+
* Documentation: https://developer.monday.com/api-reference/docs/files#add-a-file-to-an-update
|
|
509
|
+
* @param options Request options.
|
|
510
|
+
*/
|
|
511
|
+
async addFileToUpdate(options) {
|
|
512
|
+
return this.File.addFileToUpdate(options);
|
|
513
|
+
}
|
|
514
|
+
/**
|
|
515
|
+
* 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.
|
|
516
|
+
* Alternative usage: File.addFileToColumn
|
|
517
|
+
* Documentation: https://developer.monday.com/api-reference/docs/files#add-file-to-the-file-column
|
|
518
|
+
* @param options Request options.
|
|
519
|
+
*/
|
|
520
|
+
async addFileToColumn(options) {
|
|
521
|
+
return this.File.addFileToColumn(options);
|
|
522
|
+
}
|
|
523
|
+
/**
|
|
524
|
+
* 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.
|
|
525
|
+
* 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.
|
|
526
|
+
* Alternative usage: Notification.createNotification
|
|
527
|
+
* Documentation: https://developer.monday.com/api-reference/docs/notification#create-a-notification
|
|
528
|
+
* @param options Request options.
|
|
529
|
+
*/
|
|
530
|
+
async createNotification(options) {
|
|
531
|
+
return this.Notification.createNotification(options);
|
|
532
|
+
}
|
|
533
|
+
/**
|
|
534
|
+
* Querying workspaces will return metadata about one or a collection of workspaces. This method accepts various arguments and returns an array.
|
|
535
|
+
* Alternative usage: Workspace.getWorkspaces
|
|
536
|
+
* Documentation: https://developer.monday.com/api-reference/docs/workspaces#queries
|
|
537
|
+
* @param options Request options.
|
|
538
|
+
*/
|
|
539
|
+
async getWorkspaces(options) {
|
|
540
|
+
return this.Workspace.getWorkspaces(options);
|
|
541
|
+
}
|
|
542
|
+
/**
|
|
543
|
+
* The create_workspace mutation allows you to create a new workspace via the API.
|
|
544
|
+
* You can also specify what fields to query back from the new workspace when you run the mutation.
|
|
545
|
+
* Alternative usage: Workspace.createWorkspace
|
|
546
|
+
* Documentation: https://developer.monday.com/api-reference/docs/workspaces#create-a-workspace
|
|
547
|
+
* @param options Request options.
|
|
548
|
+
*/
|
|
549
|
+
async createWorkspace(options) {
|
|
550
|
+
return this.Workspace.createWorkspace(options);
|
|
551
|
+
}
|
|
552
|
+
/**
|
|
553
|
+
* The update_workspace mutation allows you to update a workspace via the API.
|
|
554
|
+
* You can also specify what fields to query back from the deleted workspace when you run the mutation.
|
|
555
|
+
* Alternative usage: Workspace.updateWorkspace
|
|
556
|
+
* Documentation: https://developer.monday.com/api-reference/reference/workspaces#update-a-workspace
|
|
557
|
+
* @param options Request options.
|
|
558
|
+
*/
|
|
559
|
+
async updateWorkspace(options) {
|
|
560
|
+
return this.Workspace.updateWorkspace(options);
|
|
561
|
+
}
|
|
562
|
+
/**
|
|
563
|
+
* The delete_workspace mutation allows you to delete a workspace via the API.
|
|
564
|
+
* You can also specify what fields to query back from the deleted workspace when you run the mutation.
|
|
565
|
+
* Alternative usage: Workspace.deleteWorkspace
|
|
566
|
+
* Documentation: https://developer.monday.com/api-reference/docs/workspaces#delete-a-workspace
|
|
567
|
+
* @param options Request options.
|
|
568
|
+
*/
|
|
569
|
+
async deleteWorkspace(options) {
|
|
570
|
+
return this.Workspace.deleteWorkspace(options);
|
|
571
|
+
}
|
|
572
|
+
/**
|
|
573
|
+
* Querying updates will return metadata about one or a collection of updates.
|
|
574
|
+
* This method accepts various arguments and returns an array.
|
|
575
|
+
* Alternative usage: Update.getUpdates
|
|
576
|
+
* Documentation: https://developer.monday.com/api-reference/docs/updates#queries
|
|
577
|
+
* @param options Request options.
|
|
578
|
+
*/
|
|
579
|
+
async getUpdates(options) {
|
|
580
|
+
return this.Update.getUpdates(options);
|
|
581
|
+
}
|
|
582
|
+
/**
|
|
583
|
+
* The create_update mutation allows you to add an update to an item via the API.
|
|
584
|
+
* You can also specify what fields to query back from the new update when you run the mutation.
|
|
585
|
+
* Alternative usage: Update.createUpdate
|
|
586
|
+
* Documentation: https://developer.monday.com/api-reference/docs/updates#create-an-update
|
|
587
|
+
* @param options Request options.
|
|
588
|
+
*/
|
|
589
|
+
async createUpdate(options) {
|
|
590
|
+
return this.Update.createUpdate(options);
|
|
591
|
+
}
|
|
592
|
+
/**
|
|
593
|
+
* The edit_update mutation allows you to edit an update via the API.
|
|
594
|
+
* You can also specify what fields to query back from the update when you run the mutation.
|
|
595
|
+
* Alternative usage: Update.editUpdate
|
|
596
|
+
* Documentation: https://developer.monday.com/api-reference/reference/updates#edit-an-update
|
|
597
|
+
* @param options Request options.
|
|
598
|
+
*/
|
|
599
|
+
async editUpdate(options) {
|
|
600
|
+
return this.Update.editUpdate(options);
|
|
601
|
+
}
|
|
602
|
+
/**
|
|
603
|
+
* The delete_update mutation allows you to delete an item's update via the API.
|
|
604
|
+
* You can also specify what fields to query back from the update when you run the mutation.
|
|
605
|
+
* Alternative usage: Update.deleteUpdate
|
|
606
|
+
* Documentation: https://developer.monday.com/api-reference/docs/updates#delete-an-update
|
|
607
|
+
* @param options Request options.
|
|
608
|
+
*/
|
|
609
|
+
async deleteUpdate(options) {
|
|
610
|
+
return this.Update.deleteUpdate(options);
|
|
611
|
+
}
|
|
612
|
+
/**
|
|
613
|
+
* The like_update mutation allows you to like an update via the API.
|
|
614
|
+
* You can also specify what fields to query back from the update when you run the mutation.
|
|
615
|
+
* Alternative usage: Update.likeUpdate
|
|
616
|
+
* Documentation: https://developer.monday.com/api-reference/docs/updates#like-an-update
|
|
617
|
+
* @param options Request options.
|
|
618
|
+
*/
|
|
619
|
+
async likeUpdate(options) {
|
|
620
|
+
return this.Update.likeUpdate(options);
|
|
621
|
+
}
|
|
622
|
+
/**
|
|
623
|
+
* The unlike_update mutation allows you to unlike an update via the API.
|
|
624
|
+
* You can also specify what fields to query back from the update when you run the mutation.
|
|
625
|
+
* Alternative usage: Update.unlikeUpdate
|
|
626
|
+
* Documentation: https://developer.monday.com/api-reference/reference/updates#unlike-an-update
|
|
627
|
+
* @param options Request options.
|
|
628
|
+
*/
|
|
629
|
+
async unlikeUpdate(options) {
|
|
630
|
+
return this.Update.unlikeUpdate(options);
|
|
631
|
+
}
|
|
632
|
+
/**
|
|
633
|
+
* The pin_to_top mutation allows you to pin an update to the top of an item via the API.
|
|
634
|
+
* You can also specify what fields to query back from the update when you run the mutation.
|
|
635
|
+
* Alternative usage: Update.pinUpdate
|
|
636
|
+
* Documentation: https://developer.monday.com/api-reference/reference/updates#pin-an-update
|
|
637
|
+
* @param options Request options.
|
|
638
|
+
*/
|
|
639
|
+
async pinUpdate(options) {
|
|
640
|
+
return this.Update.pinUpdate(options);
|
|
641
|
+
}
|
|
642
|
+
/**
|
|
643
|
+
* The unpin_from_top mutation allows you to unpin an update from the top of an item via the API.
|
|
644
|
+
* You can also specify what fields to query back from the update when you run the mutation.
|
|
645
|
+
* Alternative usage: Update.unpinUpdate
|
|
646
|
+
* Documentation: https://developer.monday.com/api-reference/reference/updates#unpin-an-update
|
|
647
|
+
* @param options Request options.
|
|
648
|
+
*/
|
|
649
|
+
async unpinUpdate(options) {
|
|
650
|
+
return this.Update.unpinUpdate(options);
|
|
651
|
+
}
|
|
652
|
+
/**
|
|
653
|
+
* Querying teams will return metadata about one or several teams. This method accepts one argument and returns an array.
|
|
654
|
+
* 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.
|
|
655
|
+
* Alternative: Team.getTeam
|
|
656
|
+
* Documentation: https://developer.monday.com/api-reference/docs/teams#queries
|
|
657
|
+
* @param options
|
|
658
|
+
*/
|
|
659
|
+
async getTeams(options) {
|
|
660
|
+
return this.Team.getTeams(options);
|
|
661
|
+
}
|
|
662
|
+
/**
|
|
663
|
+
* 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.
|
|
664
|
+
* Alternative: Team.addTeamsToBoard
|
|
665
|
+
* Documentation: https://developer.monday.com/api-reference/docs/teams#add-teams-to-a-board
|
|
666
|
+
* @param options
|
|
667
|
+
*/
|
|
668
|
+
async addTeamsToBoard(options) {
|
|
669
|
+
return this.Team.addTeamsToBoard(options);
|
|
670
|
+
}
|
|
671
|
+
/**
|
|
672
|
+
* 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.
|
|
673
|
+
* Alternative: Team.addTeamsToWorkspace
|
|
674
|
+
* Documentation: https://developer.monday.com/api-reference/docs/teams#add-teams-to-a-workspace
|
|
675
|
+
* @param options
|
|
676
|
+
*/
|
|
677
|
+
async addTeamsToWorkspace(options) {
|
|
678
|
+
return this.Team.addTeamsToWorkspace(options);
|
|
679
|
+
}
|
|
680
|
+
/**
|
|
681
|
+
* The delete_teams_from_workspace mutation allows you to delete teams from a workspace via the API.
|
|
682
|
+
* You can also specify what fields to query back when you run the mutation.
|
|
683
|
+
* Alternative: Team.deleteTeamsFromWorkspace
|
|
684
|
+
* Documentation: https://developer.monday.com/api-reference/docs/teams#delete-teams-from-a-workspace
|
|
685
|
+
* @param options
|
|
686
|
+
*/
|
|
687
|
+
async deleteTeamsFromWorkspace(options) {
|
|
688
|
+
return this.Team.deleteTeamsFromWorkspace(options);
|
|
689
|
+
}
|
|
690
|
+
/**
|
|
691
|
+
* The delete_teams_from_board mutation allows you to delete teams from a board via the API.
|
|
692
|
+
* You can also specify what fields to query back when you run the mutation.
|
|
693
|
+
* Alternative: Team.deleteTeamsFromBoard
|
|
694
|
+
* Documentation: https://developer.monday.com/api-reference/docs/teams#delete-teams-from-a-board
|
|
695
|
+
* @param options
|
|
696
|
+
*/
|
|
697
|
+
async deleteTeamsFromBoard(options) {
|
|
698
|
+
return this.Team.deleteTeamsFromBoard(options);
|
|
699
|
+
}
|
|
700
|
+
/**
|
|
701
|
+
* 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.
|
|
702
|
+
* Alternative: Team.addUsersToTeam
|
|
703
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#add-users-to-a-team
|
|
704
|
+
* @param options
|
|
705
|
+
*/
|
|
706
|
+
async addUsersToTeam(options) {
|
|
707
|
+
return this.Team.addUsersToTeam(options);
|
|
708
|
+
}
|
|
709
|
+
/**
|
|
710
|
+
* 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.
|
|
711
|
+
* Alternative: Team.removeUsersFromTeam
|
|
712
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#remove-users-from-a-team
|
|
713
|
+
* @param options
|
|
714
|
+
*/
|
|
715
|
+
async removeUsersFromTeam(options) {
|
|
716
|
+
return this.Team.removeUsersFromTeam(options);
|
|
717
|
+
}
|
|
718
|
+
/**
|
|
719
|
+
* 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.
|
|
720
|
+
* Alternative: Team.createTeam
|
|
721
|
+
* Documentation: https://developer.monday.com/api-reference/reference/teams#create-team
|
|
722
|
+
* @param options
|
|
723
|
+
*/
|
|
724
|
+
async createTeam(options) {
|
|
725
|
+
return this.Team.createTeam(options);
|
|
726
|
+
}
|
|
727
|
+
/**
|
|
728
|
+
* 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.
|
|
729
|
+
* Alternative: Team.deleteTeam
|
|
730
|
+
* Documentation: https://developer.monday.com/api-reference/reference/teams#delete-team
|
|
731
|
+
* @param options
|
|
732
|
+
*/
|
|
733
|
+
async deleteTeam(options) {
|
|
734
|
+
return this.Team.deleteTeam(options);
|
|
735
|
+
}
|
|
736
|
+
/**
|
|
737
|
+
* 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.
|
|
738
|
+
* Alternative usage: Team.assignTeamOwners
|
|
739
|
+
* Documentation: https://developer.monday.com/api-reference/reference/teams#assign-team-owners
|
|
740
|
+
* @param options Request options.
|
|
741
|
+
*/
|
|
742
|
+
async assignTeamOwners(options) {
|
|
743
|
+
return this.Team.assignTeamOwners(options);
|
|
744
|
+
}
|
|
745
|
+
/**
|
|
746
|
+
* 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.
|
|
747
|
+
* * Alternative usage: Team.removeTeamOwners
|
|
748
|
+
* Documentation: https://developer.monday.com/api-reference/reference/teams#remove-team-owners
|
|
749
|
+
* @param options Request options.
|
|
750
|
+
*/
|
|
751
|
+
async removeTeamOwners(options) {
|
|
752
|
+
return this.Team.removeTeamOwners(options);
|
|
753
|
+
}
|
|
754
|
+
/**
|
|
755
|
+
* Querying docs will return metadata about a collection of docs. This method accepts various arguments and returns an array.
|
|
756
|
+
* Documentation: https://developer.monday.com/api-reference/docs/docs#queries
|
|
757
|
+
* Alternative: Doc.getDocs
|
|
758
|
+
* @param options Request options.
|
|
759
|
+
*/
|
|
760
|
+
async getDocs(options) {
|
|
761
|
+
return this.Doc.getDocs(options);
|
|
762
|
+
}
|
|
763
|
+
/**
|
|
764
|
+
* 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.
|
|
765
|
+
* Documentation: https://developer.monday.com/api-reference/docs/docs#create-a-doc
|
|
766
|
+
* Alternative: Doc.createDoc
|
|
767
|
+
* @param options Request options.
|
|
768
|
+
*/
|
|
769
|
+
async createDoc(options) {
|
|
770
|
+
return this.Doc.createDoc(options);
|
|
771
|
+
}
|
|
772
|
+
/**
|
|
773
|
+
* Querying blocks will return metadata about one or a collection of blocks. The method accepts various arguments and returns an array.
|
|
774
|
+
* Documentation: https://developer.monday.com/api-reference/docs/blocks#queries
|
|
775
|
+
* Alternative: Doc.DocBlock.getDocBlocks
|
|
776
|
+
* @param options Request options.
|
|
777
|
+
*/
|
|
778
|
+
async getDocBlocks(options) {
|
|
779
|
+
return this.Doc.DocBlock.getDocBlocks(options);
|
|
780
|
+
}
|
|
781
|
+
/**
|
|
782
|
+
* 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.
|
|
783
|
+
* Documentation: https://developer.monday.com/api-reference/docs/blocks#create-document-block
|
|
784
|
+
* Alternative: Doc.DocBlock.createDocBlock
|
|
785
|
+
* @param options Request options.
|
|
786
|
+
*/
|
|
787
|
+
async createDocBlock(options) {
|
|
788
|
+
return this.Doc.DocBlock.createDocBlock(options);
|
|
789
|
+
}
|
|
790
|
+
/**
|
|
791
|
+
* 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.
|
|
792
|
+
* Documentation: https://developer.monday.com/api-reference/docs/blocks#update-document-block
|
|
793
|
+
* Alternative: Doc.DocBlock.updateDocBlock
|
|
794
|
+
* @param options Request options.
|
|
795
|
+
*/
|
|
796
|
+
async updateDocBlock(options) {
|
|
797
|
+
return this.Doc.DocBlock.updateDocBlock(options);
|
|
798
|
+
}
|
|
799
|
+
/**
|
|
800
|
+
* 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.
|
|
801
|
+
* Documentation: https://developer.monday.com/api-reference/docs/blocks#delete-document-block
|
|
802
|
+
* Alternative: Doc.DocBlock.deleteDocBlock
|
|
803
|
+
* @param options Request options.
|
|
804
|
+
*/
|
|
805
|
+
async deleteDocBlock(options) {
|
|
806
|
+
return this.Doc.DocBlock.deleteDocBlock(options);
|
|
807
|
+
}
|
|
808
|
+
/**
|
|
809
|
+
* 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
|
|
810
|
+
* 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.
|
|
811
|
+
* 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.
|
|
812
|
+
* To return tags stored on private or shareable boards, you can nest tags within a boards query.
|
|
813
|
+
* Alternative: Tag.getTags
|
|
814
|
+
* Documentation: https://developer.monday.com/api-reference/docs/tags-queries#queries
|
|
815
|
+
* @param options Request options.
|
|
816
|
+
*/
|
|
817
|
+
async getTags(options) {
|
|
818
|
+
return this.Tag.getTags(options);
|
|
819
|
+
}
|
|
820
|
+
/**
|
|
821
|
+
* The create_or_get_tag mutation allows you to create new tags or receive their data if they already exist via the API.
|
|
822
|
+
* You can also specify what fields to query back from the tag when you run the mutation.
|
|
823
|
+
* Alternative: Tag.createOrGetTag
|
|
824
|
+
* Documentation: https://developer.monday.com/api-reference/docs/tags-queries#create-or-get-a-tag
|
|
825
|
+
* @param options Request options.
|
|
826
|
+
*/
|
|
827
|
+
async createOrGetTag(options) {
|
|
828
|
+
return this.Tag.createOrGetTag(options);
|
|
829
|
+
}
|
|
830
|
+
/**
|
|
831
|
+
* 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.
|
|
832
|
+
* Documentation: https://developer.monday.com/api-reference/docs/version#queries
|
|
833
|
+
* Alternative: Version.getVersion
|
|
834
|
+
* @param options Request options.
|
|
835
|
+
*/
|
|
836
|
+
async getVersion(options) {
|
|
837
|
+
return this.Version.getVersion(options);
|
|
838
|
+
}
|
|
839
|
+
/**
|
|
840
|
+
* Querying versions will return metadata about all available API versions. This method does not accept any arguments and returns an array.
|
|
841
|
+
* Documentation: https://developer.monday.com/api-reference/docs/versions#queries
|
|
842
|
+
* Alternative: Version.getVersions
|
|
843
|
+
* @param options Request options.
|
|
844
|
+
*/
|
|
845
|
+
async getVersions(options) {
|
|
846
|
+
return this.Version.getVersions(options);
|
|
847
|
+
}
|
|
848
|
+
/**
|
|
849
|
+
* Querying webhooks will return one or a collection of webhooks. This method accepts various arguments and returns an array.
|
|
850
|
+
* You can only query webhooks directly at the root, so it can't be nested within another query.
|
|
851
|
+
* Documentation: https://developer.monday.com/api-reference/docs/webhooks#queries
|
|
852
|
+
* Alternative: Webhook.getWebhooks
|
|
853
|
+
* @param options
|
|
854
|
+
*/
|
|
855
|
+
async getWebhooks(options) {
|
|
856
|
+
return this.Webhook.getWebhooks(options);
|
|
857
|
+
}
|
|
858
|
+
/**
|
|
859
|
+
* 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.
|
|
860
|
+
* 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.
|
|
861
|
+
*
|
|
862
|
+
* You can add a query param to your webhook URL if you want to differentiate between subitem and main item events.
|
|
863
|
+
* The URL must pass a verification test where we will send a JSON POST body request containing a challenge field.
|
|
864
|
+
* Monday.com expects your provided URL to return the token as a challenge field in your response JSON body to that request.
|
|
865
|
+
*
|
|
866
|
+
* Documentation: https://developer.monday.com/api-reference/docs/webhooks#create-a-webhook
|
|
867
|
+
* Alternative: Webhook.createWebhook
|
|
868
|
+
* @param options
|
|
869
|
+
*/
|
|
870
|
+
async createWebhook(options) {
|
|
871
|
+
return this.Webhook.createWebhook(options);
|
|
872
|
+
}
|
|
873
|
+
/**
|
|
874
|
+
* The delete_webhook mutation allows you to delete a webhook via the API.
|
|
875
|
+
* You can also specify what fields to query back when you run the mutation.
|
|
876
|
+
* After the mutation runs, it will no longer report events to the URL given.
|
|
877
|
+
* Documentation: https://developer.monday.com/api-reference/docs/webhooks#delete-a-webhook
|
|
878
|
+
* Alternative: Webhook.deleteWebhook
|
|
879
|
+
* @param options
|
|
880
|
+
*/
|
|
881
|
+
async deleteWebhook(options) {
|
|
882
|
+
return this.Webhook.deleteWebhook(options);
|
|
883
|
+
}
|
|
884
|
+
/**
|
|
885
|
+
* Querying folders will return metadata about one or a collection of folders. This method accepts various arguments and returns an array.
|
|
886
|
+
* Documentation: https://developer.monday.com/api-reference/docs/folders#queries
|
|
887
|
+
* Alternative: Folder.getFolders
|
|
888
|
+
* @param options Request options.
|
|
889
|
+
*/
|
|
890
|
+
async getFolders(options) {
|
|
891
|
+
return this.Folder.getFolders(options);
|
|
892
|
+
}
|
|
893
|
+
/**
|
|
894
|
+
* 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.
|
|
895
|
+
* Documentation: https://developer.monday.com/api-reference/docs/folders#create-a-folder
|
|
896
|
+
* Alternative: Folder.createFolder
|
|
897
|
+
* @param options Request options.
|
|
898
|
+
*/
|
|
899
|
+
async createFolder(options) {
|
|
900
|
+
return this.Folder.createFolder(options);
|
|
901
|
+
}
|
|
902
|
+
/**
|
|
903
|
+
* 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.
|
|
904
|
+
* Documentation: https://developer.monday.com/api-reference/docs/folders#update-a-folder
|
|
905
|
+
* Alternative: Folder.updateFolder
|
|
906
|
+
* @param options Request options.
|
|
907
|
+
*/
|
|
908
|
+
async updateFolder(options) {
|
|
909
|
+
return this.Folder.updateFolder(options);
|
|
910
|
+
}
|
|
911
|
+
/**
|
|
912
|
+
* 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.
|
|
913
|
+
* Documentation: https://developer.monday.com/api-reference/docs/folders#delete-a-folder
|
|
914
|
+
* Alternative: Folder.deleteFolder
|
|
915
|
+
* @param options Request options.
|
|
916
|
+
*/
|
|
917
|
+
async deleteFolder(options) {
|
|
918
|
+
return this.Folder.deleteFolder(options);
|
|
919
|
+
}
|
|
920
|
+
}
|
|
921
|
+
class NotificationGroup {
|
|
922
|
+
constructor(implementation, getGlobalErrorStrategy) {
|
|
923
|
+
this.implementation = implementation;
|
|
924
|
+
this.getGlobalErrorStrategy = getGlobalErrorStrategy;
|
|
925
|
+
}
|
|
926
|
+
/**
|
|
927
|
+
* 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.
|
|
928
|
+
* 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.
|
|
929
|
+
* Documentation: https://developer.monday.com/api-reference/docs/notification#create-a-notification
|
|
930
|
+
* @param options Request options.
|
|
931
|
+
*/
|
|
932
|
+
async createNotification(options) {
|
|
933
|
+
return await createMutation(options, 'create_notification', this.implementation, this.getGlobalErrorStrategy);
|
|
934
|
+
}
|
|
935
|
+
}
|
|
936
|
+
class TeamGroup {
|
|
937
|
+
constructor(implementation, getGlobalErrorStrategy) {
|
|
938
|
+
this.implementation = implementation;
|
|
939
|
+
this.getGlobalErrorStrategy = getGlobalErrorStrategy;
|
|
940
|
+
}
|
|
941
|
+
/**
|
|
942
|
+
* The delete_teams_from_workspace mutation allows you to delete teams from a workspace via the API.
|
|
943
|
+
* You can also specify what fields to query back when you run the mutation.
|
|
944
|
+
* Documentation: https://developer.monday.com/api-reference/docs/teams#delete-teams-from-a-workspace
|
|
945
|
+
* @param options
|
|
946
|
+
*/
|
|
947
|
+
async deleteTeamsFromWorkspace(options) {
|
|
948
|
+
return await createMutation(options, 'delete_teams_from_workspace', this.implementation, this.getGlobalErrorStrategy);
|
|
949
|
+
}
|
|
950
|
+
/**
|
|
951
|
+
* The delete_teams_from_board mutation allows you to delete teams from a board via the API.
|
|
952
|
+
* You can also specify what fields to query back when you run the mutation.
|
|
953
|
+
* Documentation: https://developer.monday.com/api-reference/docs/teams#delete-teams-from-a-board
|
|
954
|
+
* @param options
|
|
955
|
+
*/
|
|
956
|
+
async deleteTeamsFromBoard(options) {
|
|
957
|
+
return await createMutation(options, 'delete_teams_from_board', this.implementation, this.getGlobalErrorStrategy);
|
|
958
|
+
}
|
|
959
|
+
/**
|
|
960
|
+
* 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.
|
|
961
|
+
* Documentation: https://developer.monday.com/api-reference/docs/teams#add-teams-to-a-workspace
|
|
962
|
+
* @param options
|
|
963
|
+
*/
|
|
964
|
+
async addTeamsToWorkspace(options) {
|
|
965
|
+
return await createMutation(options, 'add_teams_to_workspace', this.implementation, this.getGlobalErrorStrategy);
|
|
966
|
+
}
|
|
967
|
+
/**
|
|
968
|
+
* 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.
|
|
969
|
+
* Documentation: https://developer.monday.com/api-reference/docs/teams#add-teams-to-a-board
|
|
970
|
+
* @param options
|
|
971
|
+
*/
|
|
972
|
+
async addTeamsToBoard(options) {
|
|
973
|
+
return await createMutation(options, 'add_teams_to_board', this.implementation, this.getGlobalErrorStrategy);
|
|
974
|
+
}
|
|
975
|
+
/**
|
|
976
|
+
* Querying teams will return metadata about one or several teams. This method accepts one argument and returns an array.
|
|
977
|
+
*
|
|
978
|
+
* 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.
|
|
979
|
+
* Documentation: https://developer.monday.com/api-reference/docs/teams#queries
|
|
980
|
+
* @param options
|
|
981
|
+
*/
|
|
982
|
+
async getTeams(options) {
|
|
983
|
+
return await createQuery(options, 'teams', this.implementation, this.getGlobalErrorStrategy);
|
|
984
|
+
}
|
|
985
|
+
/**
|
|
986
|
+
* 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.
|
|
987
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#add-users-to-a-team
|
|
988
|
+
* @param options
|
|
989
|
+
*/
|
|
990
|
+
async addUsersToTeam(options) {
|
|
991
|
+
return await createMutation(options, 'add_users_to_team', this.implementation, this.getGlobalErrorStrategy);
|
|
992
|
+
}
|
|
993
|
+
/**
|
|
994
|
+
* 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.
|
|
995
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#remove-users-from-a-team
|
|
996
|
+
* @param options
|
|
997
|
+
*/
|
|
998
|
+
async removeUsersFromTeam(options) {
|
|
999
|
+
return await createMutation(options, 'remove_users_from_team', this.implementation, this.getGlobalErrorStrategy);
|
|
1000
|
+
}
|
|
1001
|
+
/**
|
|
1002
|
+
* 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.
|
|
1003
|
+
* Documentation: https://developer.monday.com/api-reference/reference/teams#create-team
|
|
1004
|
+
* @param options
|
|
1005
|
+
*/
|
|
1006
|
+
async createTeam(options) {
|
|
1007
|
+
return await createMutation(options, 'create_team', this.implementation, this.getGlobalErrorStrategy);
|
|
1008
|
+
}
|
|
1009
|
+
/**
|
|
1010
|
+
* 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.
|
|
1011
|
+
* Documentation: https://developer.monday.com/api-reference/reference/teams#delete-team
|
|
1012
|
+
* @param options
|
|
1013
|
+
*/
|
|
1014
|
+
async deleteTeam(options) {
|
|
1015
|
+
return await createMutation(options, 'delete_team', this.implementation, this.getGlobalErrorStrategy);
|
|
1016
|
+
}
|
|
1017
|
+
/**
|
|
1018
|
+
* 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.
|
|
1019
|
+
* Documentation: https://developer.monday.com/api-reference/reference/teams#assign-team-owners
|
|
1020
|
+
* @param options Request options.
|
|
1021
|
+
*/
|
|
1022
|
+
async assignTeamOwners(options) {
|
|
1023
|
+
return await createMutation(options, 'assign_team_owners', this.implementation, this.getGlobalErrorStrategy);
|
|
1024
|
+
}
|
|
1025
|
+
/**
|
|
1026
|
+
* 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.
|
|
1027
|
+
* Documentation: https://developer.monday.com/api-reference/reference/teams#remove-team-owners
|
|
1028
|
+
* @param options Request options.
|
|
1029
|
+
*/
|
|
1030
|
+
async removeTeamOwners(options) {
|
|
1031
|
+
return await createMutation(options, 'remove_team_owners', this.implementation, this.getGlobalErrorStrategy);
|
|
1032
|
+
}
|
|
1033
|
+
}
|
|
1034
|
+
class AccountGroup {
|
|
1035
|
+
constructor(implementation, getGlobalErrorStrategy) {
|
|
1036
|
+
this.implementation = implementation;
|
|
1037
|
+
this.getGlobalErrorStrategy = getGlobalErrorStrategy;
|
|
1038
|
+
this.Role = new AccountRoleGroup(implementation, this.getGlobalErrorStrategy);
|
|
1039
|
+
}
|
|
1040
|
+
}
|
|
1041
|
+
class AccountRoleGroup {
|
|
1042
|
+
constructor(implementation, getGlobalErrorStrategy) {
|
|
1043
|
+
this.implementation = implementation;
|
|
1044
|
+
this.getGlobalErrorStrategy = getGlobalErrorStrategy;
|
|
1045
|
+
}
|
|
1046
|
+
/**
|
|
1047
|
+
* Returns an object containing metadata about all user roles in an account (both default and custom).
|
|
1048
|
+
* Documentation: https://developer.monday.com/api-reference/reference/account-roles#queries
|
|
1049
|
+
* @param options Request options.
|
|
1050
|
+
*/
|
|
1051
|
+
async getAccountRoles(options) {
|
|
1052
|
+
return await createQuery(options, 'account_roles', this.implementation, this.getGlobalErrorStrategy);
|
|
1053
|
+
}
|
|
1054
|
+
}
|
|
1055
|
+
class BoardGroup {
|
|
1056
|
+
constructor(implementation, getGlobalErrorStrategy) {
|
|
1057
|
+
this.implementation = implementation;
|
|
1058
|
+
this.getGlobalErrorStrategy = getGlobalErrorStrategy;
|
|
1059
|
+
this.View = new BoardViewGroup(implementation, this.getGlobalErrorStrategy);
|
|
1060
|
+
this.Group = new BoardGroupGroup(implementation, this.getGlobalErrorStrategy);
|
|
1061
|
+
this.ItemsPage = new BoardItemsPageGroup(implementation, this.getGlobalErrorStrategy);
|
|
1062
|
+
this.Tag = new BoardTagGroup(implementation, this.getGlobalErrorStrategy);
|
|
1063
|
+
}
|
|
1064
|
+
/**
|
|
1065
|
+
* Querying boards will return metadata about one or a collection of boards. This method accepts various arguments and returns an array.
|
|
1066
|
+
* Documentation: https://developer.monday.com/api-reference/docs/boards#queries
|
|
1067
|
+
* @param options Request options.
|
|
1068
|
+
*/
|
|
1069
|
+
async getBoards(options) {
|
|
1070
|
+
return await createQuery(options, 'boards', this.implementation, this.getGlobalErrorStrategy);
|
|
1071
|
+
}
|
|
1072
|
+
/**
|
|
1073
|
+
* The create_board mutation allows you to create a new board via the API.
|
|
1074
|
+
* You can also specify what fields to query back from the new board when you run the mutation.
|
|
1075
|
+
* 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.
|
|
1076
|
+
* Documentation: https://developer.monday.com/api-reference/docs/boards#create-a-board
|
|
1077
|
+
* @param options Request options.
|
|
1078
|
+
*/
|
|
1079
|
+
async createBoard(options) {
|
|
1080
|
+
return await createMutation(options, 'create_board', this.implementation, this.getGlobalErrorStrategy);
|
|
1081
|
+
}
|
|
1082
|
+
/**
|
|
1083
|
+
* 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.
|
|
1084
|
+
* Documentation: https://developer.monday.com/api-reference/docs/boards#duplicate-a-board
|
|
1085
|
+
* @param options Request options.
|
|
1086
|
+
*/
|
|
1087
|
+
async duplicateBoard(options) {
|
|
1088
|
+
return await createMutation(options, 'duplicate_board', this.implementation, this.getGlobalErrorStrategy);
|
|
1089
|
+
}
|
|
1090
|
+
/**
|
|
1091
|
+
* The update_board mutation allows you to update a board via the API.
|
|
1092
|
+
* Documentation: https://developer.monday.com/api-reference/docs/boards#update-a-board
|
|
1093
|
+
* @param options Request options.
|
|
1094
|
+
*/
|
|
1095
|
+
async updateBoard(options) {
|
|
1096
|
+
return await createMutation({ ...options, fields: {} }, 'update_board', this.implementation, this.getGlobalErrorStrategy);
|
|
1097
|
+
}
|
|
1098
|
+
/**
|
|
1099
|
+
* 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.
|
|
1100
|
+
* Documentation: https://developer.monday.com/api-reference/docs/boards#archive-a-board
|
|
1101
|
+
* @param options Request options.
|
|
1102
|
+
*/
|
|
1103
|
+
async archiveBoard(options) {
|
|
1104
|
+
return await createMutation(options, 'archive_board', this.implementation, this.getGlobalErrorStrategy);
|
|
1105
|
+
}
|
|
1106
|
+
/**
|
|
1107
|
+
* 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.
|
|
1108
|
+
* Documentation: https://developer.monday.com/api-reference/docs/boards#delete-a-board
|
|
1109
|
+
* @param options Request options.
|
|
1110
|
+
*/
|
|
1111
|
+
async deleteBoard(options) {
|
|
1112
|
+
return await createMutation(options, 'delete_board', this.implementation, this.getGlobalErrorStrategy);
|
|
1113
|
+
}
|
|
1114
|
+
/**
|
|
1115
|
+
* 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.
|
|
1116
|
+
* Documentation: https://developer.monday.com/api-reference/docs/boards#delete-subscribers-from-a-board
|
|
1117
|
+
* @param options Request options.
|
|
1118
|
+
*/
|
|
1119
|
+
async deleteSubscribersFromBoard(options) {
|
|
1120
|
+
return await createMutation(options, 'delete_subscribers_from_board', this.implementation, this.getGlobalErrorStrategy);
|
|
1121
|
+
}
|
|
1122
|
+
}
|
|
1123
|
+
class BoardGroupGroup {
|
|
1124
|
+
constructor(implementation, getGlobalErrorStrategy) {
|
|
1125
|
+
this.implementation = implementation;
|
|
1126
|
+
this.getGlobalErrorStrategy = getGlobalErrorStrategy;
|
|
1127
|
+
}
|
|
1128
|
+
/**
|
|
1129
|
+
* 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.
|
|
1130
|
+
* Documentation: https://developer.monday.com/api-reference/docs/groups#update-a-group
|
|
1131
|
+
* @param options
|
|
1132
|
+
*/
|
|
1133
|
+
async updateGroup(options) {
|
|
1134
|
+
return await createMutation(options, 'update_group', this.implementation, this.getGlobalErrorStrategy);
|
|
1135
|
+
}
|
|
1136
|
+
/**
|
|
1137
|
+
* 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.
|
|
1138
|
+
* Documentation: https://developer.monday.com/api-reference/docs/groups#duplicate-group
|
|
1139
|
+
* (!) Mutation-specific rate limit:
|
|
1140
|
+
* 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".
|
|
1141
|
+
* @param options
|
|
1142
|
+
*/
|
|
1143
|
+
async duplicateGroup(options) {
|
|
1144
|
+
return await createMutation(options, 'duplicate_group', this.implementation, this.getGlobalErrorStrategy);
|
|
1145
|
+
}
|
|
1146
|
+
/**
|
|
1147
|
+
* 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.
|
|
1148
|
+
* Documentation: https://developer.monday.com/api-reference/docs/groups#archive-a-group
|
|
1149
|
+
* @param options
|
|
1150
|
+
*/
|
|
1151
|
+
async archiveGroup(options) {
|
|
1152
|
+
return await createMutation(options, 'archive_group', this.implementation, this.getGlobalErrorStrategy);
|
|
1153
|
+
}
|
|
1154
|
+
/**
|
|
1155
|
+
* 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.
|
|
1156
|
+
* Documentation: https://developer.monday.com/api-reference/docs/groups#delete-a-group
|
|
1157
|
+
* @param options
|
|
1158
|
+
*/
|
|
1159
|
+
async deleteGroup(options) {
|
|
1160
|
+
return await createMutation(options, 'delete_group', this.implementation, this.getGlobalErrorStrategy);
|
|
1161
|
+
}
|
|
1162
|
+
/**
|
|
1163
|
+
* 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.
|
|
1164
|
+
* Documentation: https://developer.monday.com/api-reference/docs/groups#create-a-group
|
|
1165
|
+
* @param options
|
|
1166
|
+
*/
|
|
1167
|
+
async createGroup(options) {
|
|
1168
|
+
return await createMutation(options, 'create_group', this.implementation, this.getGlobalErrorStrategy);
|
|
1169
|
+
}
|
|
1170
|
+
/**
|
|
1171
|
+
* 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. *
|
|
1172
|
+
* You can only query groups by nesting it within another query, so it can't be used at the root.
|
|
1173
|
+
* Documentation: https://developer.monday.com/api-reference/docs/groups#queries
|
|
1174
|
+
* @param options Request options.
|
|
1175
|
+
*/
|
|
1176
|
+
async getGroups(options) {
|
|
1177
|
+
return await createQuery(options, 'boards', this.implementation, this.getGlobalErrorStrategy);
|
|
1178
|
+
}
|
|
1179
|
+
}
|
|
1180
|
+
class BoardViewGroup {
|
|
1181
|
+
constructor(implementation, getGlobalErrorStrategy) {
|
|
1182
|
+
this.implementation = implementation;
|
|
1183
|
+
this.getGlobalErrorStrategy = getGlobalErrorStrategy;
|
|
1184
|
+
}
|
|
1185
|
+
/**
|
|
1186
|
+
* Querying views will return a collection of board views from a specific board. This method accepts various arguments and returns an array.
|
|
1187
|
+
* You can only query views by nesting it within a boards query, so it can't be used at the root.
|
|
1188
|
+
* Documentation: https://developer.monday.com/api-reference/docs/board-view-queries#queries
|
|
1189
|
+
* @param options Request options.
|
|
1190
|
+
*/
|
|
1191
|
+
async getViews(options) {
|
|
1192
|
+
return await createQuery(options, 'boards', this.implementation, this.getGlobalErrorStrategy);
|
|
1193
|
+
}
|
|
1194
|
+
}
|
|
1195
|
+
class ItemGroup {
|
|
1196
|
+
constructor(implementation, getGlobalErrorStrategy) {
|
|
1197
|
+
this.implementation = implementation;
|
|
1198
|
+
this.getGlobalErrorStrategy = getGlobalErrorStrategy;
|
|
1199
|
+
this.Subitem = new ItemSubitemGroup(implementation, this.getGlobalErrorStrategy);
|
|
1200
|
+
}
|
|
1201
|
+
/**
|
|
1202
|
+
* Querying items will return metadata about one or a collection of items. This method accepts various arguments and returns an array.
|
|
1203
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#queries
|
|
1204
|
+
* @param options Request options.
|
|
1205
|
+
*/
|
|
1206
|
+
async getItems(options) {
|
|
1207
|
+
return await createQuery(options, 'items', this.implementation, this.getGlobalErrorStrategy);
|
|
1208
|
+
}
|
|
1209
|
+
/**
|
|
1210
|
+
* 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.
|
|
1211
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#create-an-item
|
|
1212
|
+
* @param options Request options.
|
|
1213
|
+
*/
|
|
1214
|
+
async createItem(options) {
|
|
1215
|
+
return await createMutation(options, 'create_item', this.implementation, this.getGlobalErrorStrategy);
|
|
1216
|
+
}
|
|
1217
|
+
/**
|
|
1218
|
+
* 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.
|
|
1219
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#duplicate-an-item
|
|
1220
|
+
* @param options Request options.
|
|
1221
|
+
*/
|
|
1222
|
+
async duplicateItem(options) {
|
|
1223
|
+
return await createMutation(options, 'duplicate_item', this.implementation, this.getGlobalErrorStrategy);
|
|
1224
|
+
}
|
|
1225
|
+
/**
|
|
1226
|
+
* 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.
|
|
1227
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#move-item-to-group
|
|
1228
|
+
* @param options Request options.
|
|
1229
|
+
*/
|
|
1230
|
+
async moveItemToGroup(options) {
|
|
1231
|
+
return await createMutation(options, 'move_item_to_group', this.implementation, this.getGlobalErrorStrategy);
|
|
1232
|
+
}
|
|
1233
|
+
/**
|
|
1234
|
+
* 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.
|
|
1235
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#move-item-to-board
|
|
1236
|
+
* @param options Request options.
|
|
1237
|
+
*/
|
|
1238
|
+
async moveItemToBoard(options) {
|
|
1239
|
+
return await createMutation(options, 'move_item_to_board', this.implementation, this.getGlobalErrorStrategy);
|
|
1240
|
+
}
|
|
1241
|
+
/**
|
|
1242
|
+
* 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.
|
|
1243
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#archive-an-item
|
|
1244
|
+
* @param options Request options.
|
|
1245
|
+
*/
|
|
1246
|
+
async archiveItem(options) {
|
|
1247
|
+
return await createMutation(options, 'archive_item', this.implementation, this.getGlobalErrorStrategy);
|
|
1248
|
+
}
|
|
1249
|
+
/**
|
|
1250
|
+
* 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.
|
|
1251
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#delete-an-item
|
|
1252
|
+
* @param options Request options.
|
|
1253
|
+
*/
|
|
1254
|
+
async deleteItem(options) {
|
|
1255
|
+
return await createMutation(options, 'delete_item', this.implementation, this.getGlobalErrorStrategy);
|
|
1256
|
+
}
|
|
1257
|
+
/**
|
|
1258
|
+
* 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.
|
|
1259
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items#clear-an-items-updates
|
|
1260
|
+
* @param options Request options.
|
|
1261
|
+
*/
|
|
1262
|
+
async clearUpdates(options) {
|
|
1263
|
+
return await createMutation(options, 'clear_item_updates', this.implementation, this.getGlobalErrorStrategy);
|
|
1264
|
+
}
|
|
1265
|
+
}
|
|
1266
|
+
class BoardItemsPageGroup {
|
|
1267
|
+
constructor(implementation, getGlobalErrorStrategy) {
|
|
1268
|
+
this.implementation = implementation;
|
|
1269
|
+
this.getGlobalErrorStrategy = getGlobalErrorStrategy;
|
|
1270
|
+
}
|
|
1271
|
+
/**
|
|
1272
|
+
* Querying items_page will return items filtered by the specified criteria. This method accepts various arguments and returns an object.
|
|
1273
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items_page#queries
|
|
1274
|
+
* @param options Request options.
|
|
1275
|
+
*/
|
|
1276
|
+
async getItemsPage(options) {
|
|
1277
|
+
return await createQuery(options, 'boards', this.implementation, this.getGlobalErrorStrategy);
|
|
1278
|
+
}
|
|
1279
|
+
}
|
|
1280
|
+
class BoardTagGroup {
|
|
1281
|
+
constructor(implementation, getGlobalErrorStrategy) {
|
|
1282
|
+
this.implementation = implementation;
|
|
1283
|
+
this.getGlobalErrorStrategy = getGlobalErrorStrategy;
|
|
1284
|
+
}
|
|
1285
|
+
/**
|
|
1286
|
+
* 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
|
|
1287
|
+
* 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.
|
|
1288
|
+
* 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.
|
|
1289
|
+
* To return tags stored on private or shareable boards, you can use this managed API, which is nested within a boards query.
|
|
1290
|
+
* Documentation: https://developer.monday.com/api-reference/docs/tags-queries#queries
|
|
1291
|
+
* @param options Request options.
|
|
1292
|
+
*/
|
|
1293
|
+
async getTags(options) {
|
|
1294
|
+
return await createQuery(options, 'boards', this.implementation, this.getGlobalErrorStrategy);
|
|
1295
|
+
}
|
|
1296
|
+
}
|
|
1297
|
+
class ItemsPageGroup {
|
|
1298
|
+
constructor(implementation, getGlobalErrorStrategy) {
|
|
1299
|
+
this.implementation = implementation;
|
|
1300
|
+
this.getGlobalErrorStrategy = getGlobalErrorStrategy;
|
|
1301
|
+
}
|
|
1302
|
+
/**
|
|
1303
|
+
* 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.
|
|
1304
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items_page#cursor-based-pagination-using-next_items_page
|
|
1305
|
+
* @param options Request options.
|
|
1306
|
+
*/
|
|
1307
|
+
async getNextItemsPage(options) {
|
|
1308
|
+
return await createQuery(options, 'next_items_page', this.implementation, this.getGlobalErrorStrategy);
|
|
1309
|
+
}
|
|
1310
|
+
/**
|
|
1311
|
+
* 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.
|
|
1312
|
+
* Documentation: https://developer.monday.com/api-reference/docs/items-page-by-column-values
|
|
1313
|
+
* @param options Request options.
|
|
1314
|
+
*/
|
|
1315
|
+
async getItemsPageByColumnValues(options) {
|
|
1316
|
+
return await createQuery(options, 'items_page_by_column_values', this.implementation, this.getGlobalErrorStrategy);
|
|
1317
|
+
}
|
|
1318
|
+
}
|
|
1319
|
+
class ItemSubitemGroup {
|
|
1320
|
+
constructor(implementation, getGlobalErrorStrategy) {
|
|
1321
|
+
this.implementation = implementation;
|
|
1322
|
+
this.getGlobalErrorStrategy = getGlobalErrorStrategy;
|
|
1323
|
+
}
|
|
1324
|
+
/**
|
|
1325
|
+
* Querying subitems will return metadata about one or a collection of subitems. This method does not accept any arguments and returns an array.
|
|
1326
|
+
* You can only query subitems by nesting it within another query, so it can't be used at the root.
|
|
1327
|
+
* Documentation: https://developer.monday.com/api-reference/docs/subitems#queries
|
|
1328
|
+
* @param options Request options.
|
|
1329
|
+
*/
|
|
1330
|
+
async getSubitems(options) {
|
|
1331
|
+
return await createQuery(options, 'items', this.implementation, this.getGlobalErrorStrategy);
|
|
1332
|
+
}
|
|
1333
|
+
/**
|
|
1334
|
+
* 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.
|
|
1335
|
+
* Documentation: https://developer.monday.com/api-reference/docs/subitems#create-a-subitem
|
|
1336
|
+
* @param options Request options.
|
|
1337
|
+
*/
|
|
1338
|
+
async createSubitem(options) {
|
|
1339
|
+
return await createMutation(options, 'create_subitem', this.implementation, this.getGlobalErrorStrategy);
|
|
1340
|
+
}
|
|
1341
|
+
}
|
|
1342
|
+
class MeGroup {
|
|
1343
|
+
constructor(implementation, getGlobalErrorStrategy) {
|
|
1344
|
+
this.implementation = implementation;
|
|
1345
|
+
this.getGlobalErrorStrategy = getGlobalErrorStrategy;
|
|
1346
|
+
}
|
|
1347
|
+
/**
|
|
1348
|
+
* 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.
|
|
1349
|
+
* You can only query me directly at the root, so it can't be nested within another query.
|
|
1350
|
+
* Documentation: https://developer.monday.com/api-reference/docs/me#queries
|
|
1351
|
+
* @param options Request options.
|
|
1352
|
+
*/
|
|
1353
|
+
async getUserDetails(options) {
|
|
1354
|
+
return await createQuery(options, 'me', this.implementation, this.getGlobalErrorStrategy);
|
|
1355
|
+
}
|
|
1356
|
+
}
|
|
1357
|
+
class UserGroup {
|
|
1358
|
+
constructor(implementation, getGlobalErrorStrategy) {
|
|
1359
|
+
this.implementation = implementation;
|
|
1360
|
+
this.getGlobalErrorStrategy = getGlobalErrorStrategy;
|
|
1361
|
+
}
|
|
1362
|
+
/**
|
|
1363
|
+
* Querying users will return metadata about one or multiple users. This method accepts various arguments and returns an array.
|
|
1364
|
+
* Documentation: https://developer.monday.com/api-reference/docs/users#queries
|
|
1365
|
+
* @param options Request options.
|
|
1366
|
+
*/
|
|
1367
|
+
async getUsers(options) {
|
|
1368
|
+
return await createQuery(options, 'users', this.implementation, this.getGlobalErrorStrategy);
|
|
1369
|
+
}
|
|
1370
|
+
/**
|
|
1371
|
+
* 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.
|
|
1372
|
+
* Documentation: https://developer.monday.com/api-reference/docs/users#add-users-to-a-board
|
|
1373
|
+
* @param options Request options.
|
|
1374
|
+
*/
|
|
1375
|
+
async addUsersToBoard(options) {
|
|
1376
|
+
return await createMutation(options, 'add_users_to_board', this.implementation, this.getGlobalErrorStrategy);
|
|
1377
|
+
}
|
|
1378
|
+
/**
|
|
1379
|
+
* 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.
|
|
1380
|
+
* Documentation: https://developer.monday.com/api-reference/docs/users#add-users-to-a-workspace
|
|
1381
|
+
* @param options Request options.
|
|
1382
|
+
*/
|
|
1383
|
+
async addUsersToWorkspace(options) {
|
|
1384
|
+
return await createMutation(options, 'add_users_to_workspace', this.implementation, this.getGlobalErrorStrategy);
|
|
1385
|
+
}
|
|
1386
|
+
/**
|
|
1387
|
+
* 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.
|
|
1388
|
+
* Documentation: https://developer.monday.com/api-reference/docs/users#delete-users-from-a-workspace
|
|
1389
|
+
* @param options Request options.
|
|
1390
|
+
*/
|
|
1391
|
+
async deleteUsersFromWorkspace(options) {
|
|
1392
|
+
return await createMutation(options, 'delete_users_from_workspace', this.implementation, this.getGlobalErrorStrategy);
|
|
1393
|
+
}
|
|
1394
|
+
/**
|
|
1395
|
+
* 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.
|
|
1396
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#deactivate-users
|
|
1397
|
+
* @param options Request options.
|
|
1398
|
+
*/
|
|
1399
|
+
async deactivateUsers(options) {
|
|
1400
|
+
return await createMutation(options, 'deactivate_users', this.implementation, this.getGlobalErrorStrategy);
|
|
1401
|
+
}
|
|
1402
|
+
/**
|
|
1403
|
+
* 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.
|
|
1404
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#activate-users
|
|
1405
|
+
* @param options Request options.
|
|
1406
|
+
*/
|
|
1407
|
+
async activateUsers(options) {
|
|
1408
|
+
return await createMutation(options, 'activate_users', this.implementation, this.getGlobalErrorStrategy);
|
|
1409
|
+
}
|
|
1410
|
+
/**
|
|
1411
|
+
* 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.
|
|
1412
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#update-a-users-role
|
|
1413
|
+
* @param options Request options.
|
|
1414
|
+
*/
|
|
1415
|
+
async updateUsersRole(options) {
|
|
1416
|
+
return await createMutation(options, 'update_users_role', this.implementation, this.getGlobalErrorStrategy);
|
|
1417
|
+
}
|
|
1418
|
+
/**
|
|
1419
|
+
* 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.
|
|
1420
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#update-a-users-email-domain
|
|
1421
|
+
* @param options Request options.
|
|
1422
|
+
*/
|
|
1423
|
+
async updateUsersEmailDomain(options) {
|
|
1424
|
+
return await createMutation(options, 'update_email_domain', this.implementation, this.getGlobalErrorStrategy);
|
|
1425
|
+
}
|
|
1426
|
+
/**
|
|
1427
|
+
* This mutation invites users to join a monday.com account. They will be in a pending status until the invitation is accepted.
|
|
1428
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#invite-users
|
|
1429
|
+
* @param options Request options.
|
|
1430
|
+
*/
|
|
1431
|
+
async inviteUsers(options) {
|
|
1432
|
+
return await createMutation(options, 'invite_users', this.implementation, this.getGlobalErrorStrategy);
|
|
1433
|
+
}
|
|
1434
|
+
/**
|
|
1435
|
+
* 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.
|
|
1436
|
+
* Documentation: https://developer.monday.com/api-reference/reference/users#update-users-attributes
|
|
1437
|
+
* @param options Request options.
|
|
1438
|
+
*/
|
|
1439
|
+
async updateUsersAttributes(options) {
|
|
1440
|
+
return await createMutation(options, 'update_multiple_users', this.implementation, this.getGlobalErrorStrategy);
|
|
1441
|
+
}
|
|
1442
|
+
}
|
|
1443
|
+
class FileGroup {
|
|
1444
|
+
constructor(implementation, getGlobalErrorStrategy) {
|
|
1445
|
+
this.implementation = implementation;
|
|
1446
|
+
this.getGlobalErrorStrategy = getGlobalErrorStrategy;
|
|
1447
|
+
}
|
|
1448
|
+
/**
|
|
1449
|
+
* Querying assets will return one or a collection of assets. This method accepts various arguments and returns an array.
|
|
1450
|
+
* Documentation: https://developer.monday.com/api-reference/docs/files#queries
|
|
1451
|
+
* @param options Request options.
|
|
1452
|
+
*/
|
|
1453
|
+
async getAssets(options) {
|
|
1454
|
+
return await createQuery(options, 'assets', this.implementation, this.getGlobalErrorStrategy);
|
|
1455
|
+
}
|
|
1456
|
+
/**
|
|
1457
|
+
* 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.
|
|
1458
|
+
* Documentation: https://developer.monday.com/api-reference/docs/files#add-a-file-to-an-update
|
|
1459
|
+
* @param options Request options.
|
|
1460
|
+
*/
|
|
1461
|
+
async addFileToUpdate(options) {
|
|
1462
|
+
const { headers, errorStrategy, fields, args, complexity } = options;
|
|
1463
|
+
const body = await constructUploadFilePayload('add_file_to_update', this.implementation, args, fields, complexity);
|
|
1464
|
+
const request = new Request('POST', '/v2/file', constructHeaders(body, headers), body);
|
|
1465
|
+
request.setBufferImplementation(this.implementation);
|
|
1466
|
+
return await executeHttpCall(this.implementation, request, errorStrategyBuilderConstructor, this.getGlobalErrorStrategy(), errorStrategy, errorMessageBuilder, customErrorHandlers);
|
|
1467
|
+
}
|
|
1468
|
+
/**
|
|
1469
|
+
* 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.
|
|
1470
|
+
* Documentation: https://developer.monday.com/api-reference/docs/files#add-file-to-the-file-column
|
|
1471
|
+
* @param options Request options.
|
|
1472
|
+
*/
|
|
1473
|
+
async addFileToColumn(options) {
|
|
1474
|
+
const { headers, errorStrategy, fields, args, complexity } = options;
|
|
1475
|
+
const body = await constructUploadFilePayload('add_file_to_column', this.implementation, args, fields, complexity);
|
|
1476
|
+
const request = new Request('POST', '/v2/file', constructHeaders(body, headers), body);
|
|
1477
|
+
request.setBufferImplementation(this.implementation);
|
|
1478
|
+
return await executeHttpCall(this.implementation, request, errorStrategyBuilderConstructor, this.getGlobalErrorStrategy(), errorStrategy, errorMessageBuilder, customErrorHandlers);
|
|
1479
|
+
}
|
|
1480
|
+
}
|
|
1481
|
+
class ColumnGroup {
|
|
1482
|
+
constructor(implementation, getGlobalErrorStrategy) {
|
|
1483
|
+
this.implementation = implementation;
|
|
1484
|
+
this.getGlobalErrorStrategy = getGlobalErrorStrategy;
|
|
1485
|
+
}
|
|
1486
|
+
/**
|
|
1487
|
+
* The create_column mutation allows you to create a new column on a board within the account via the API.
|
|
1488
|
+
* The create_column mutation also allows you to create a new status or dropdown column with custom labels via the API.
|
|
1489
|
+
* Documentation: https://developer.monday.com/api-reference/docs/columns#create-a-column
|
|
1490
|
+
* @param options Request options.
|
|
1491
|
+
*/
|
|
1492
|
+
async createColumn(options) {
|
|
1493
|
+
return await createMutation(options, 'create_column', this.implementation, this.getGlobalErrorStrategy);
|
|
1494
|
+
}
|
|
1495
|
+
/**
|
|
1496
|
+
* The change_column_value mutation allows you to change the value of a column in a specific item.
|
|
1497
|
+
* Documentation: https://developer.monday.com/api-reference/docs/columns#change-a-column-value
|
|
1498
|
+
* @param options Request options.
|
|
1499
|
+
*/
|
|
1500
|
+
async changeColumnValue(options) {
|
|
1501
|
+
return await createMutation(options, 'change_column_value', this.implementation, this.getGlobalErrorStrategy);
|
|
1502
|
+
}
|
|
1503
|
+
/**
|
|
1504
|
+
* The change_column_value mutation allows you to change the value of a column in a specific item with a string value.
|
|
1505
|
+
* Documentation: https://developer.monday.com/api-reference/docs/columns#change-a-simple-column-value
|
|
1506
|
+
* @param options Request options.
|
|
1507
|
+
*/
|
|
1508
|
+
async changeSimpleColumnValue(options) {
|
|
1509
|
+
return await createMutation(options, 'change_simple_column_value', this.implementation, this.getGlobalErrorStrategy);
|
|
1510
|
+
}
|
|
1511
|
+
/**
|
|
1512
|
+
* The change_multiple_column_values mutation allows you to change multiple column values of a specific item.
|
|
1513
|
+
* Documentation: https://developer.monday.com/api-reference/docs/columns#change-multiple-column-values
|
|
1514
|
+
* @param options Request options.
|
|
1515
|
+
*/
|
|
1516
|
+
async changeMultipleColumnValues(options) {
|
|
1517
|
+
return await createMutation(options, 'change_multiple_column_values', this.implementation, this.getGlobalErrorStrategy);
|
|
1518
|
+
}
|
|
1519
|
+
/**
|
|
1520
|
+
* The change_column_title mutation allows you to change the title of an existing column via the API.
|
|
1521
|
+
* Documentation: https://developer.monday.com/api-reference/docs/columns#change-a-column-title
|
|
1522
|
+
* @param options Request options.
|
|
1523
|
+
*/
|
|
1524
|
+
async changeColumnTitle(options) {
|
|
1525
|
+
return await createMutation(options, 'change_column_title', this.implementation, this.getGlobalErrorStrategy);
|
|
1526
|
+
}
|
|
1527
|
+
/**
|
|
1528
|
+
* The change_column_metadata mutation allows you to update the metadata of an existing column.
|
|
1529
|
+
* Currently, we support updating both the title and description.
|
|
1530
|
+
* Documentation: https://developer.monday.com/api-reference/docs/columns#change-column-metadata
|
|
1531
|
+
* @param options Request options.
|
|
1532
|
+
*/
|
|
1533
|
+
async changeColumnMetadata(options) {
|
|
1534
|
+
return await createMutation(options, 'change_column_metadata', this.implementation, this.getGlobalErrorStrategy);
|
|
1535
|
+
}
|
|
1536
|
+
/**
|
|
1537
|
+
* The delete_column mutation allows you to delete a single column from a board via the API.
|
|
1538
|
+
* Documentation: https://developer.monday.com/api-reference/docs/columns#delete-a-column
|
|
1539
|
+
* @param options Request options.
|
|
1540
|
+
*/
|
|
1541
|
+
async deleteColumn(options) {
|
|
1542
|
+
return await createMutation(options, 'delete_column', this.implementation, this.getGlobalErrorStrategy);
|
|
1543
|
+
}
|
|
1544
|
+
}
|
|
1545
|
+
class WorkspaceGroup {
|
|
1546
|
+
constructor(implementation, getGlobalErrorStrategy) {
|
|
1547
|
+
this.implementation = implementation;
|
|
1548
|
+
this.getGlobalErrorStrategy = getGlobalErrorStrategy;
|
|
1549
|
+
}
|
|
1550
|
+
/**
|
|
1551
|
+
* Querying workspaces will return metadata about one or a collection of workspaces.
|
|
1552
|
+
* This method accepts various arguments and returns an array.
|
|
1553
|
+
* Documentation: https://developer.monday.com/api-reference/docs/workspaces#queries
|
|
1554
|
+
* @param options Request options.
|
|
1555
|
+
*/
|
|
1556
|
+
async getWorkspaces(options) {
|
|
1557
|
+
return await createQuery(options, 'workspaces', this.implementation, this.getGlobalErrorStrategy);
|
|
1558
|
+
}
|
|
1559
|
+
/**
|
|
1560
|
+
* The create_workspace mutation allows you to create a new workspace via the API.
|
|
1561
|
+
* You can also specify what fields to query back from the new workspace when you run the mutation.
|
|
1562
|
+
* Documentation: https://developer.monday.com/api-reference/docs/workspaces#create-a-workspace
|
|
1563
|
+
* @param options Request options.
|
|
1564
|
+
*/
|
|
1565
|
+
async createWorkspace(options) {
|
|
1566
|
+
return await createMutation(options, 'create_workspace', this.implementation, this.getGlobalErrorStrategy);
|
|
1567
|
+
}
|
|
1568
|
+
/**
|
|
1569
|
+
* The update_workspace mutation allows you to update a workspace via the API.
|
|
1570
|
+
* You can also specify what fields to query back from the deleted workspace when you run the mutation.
|
|
1571
|
+
* Documentation: https://developer.monday.com/api-reference/reference/workspaces#update-a-workspace
|
|
1572
|
+
* @param options Request options.
|
|
1573
|
+
*/
|
|
1574
|
+
async updateWorkspace(options) {
|
|
1575
|
+
return await createMutation(options, 'update_workspace', this.implementation, this.getGlobalErrorStrategy);
|
|
1576
|
+
}
|
|
1577
|
+
/**
|
|
1578
|
+
* The delete_workspace mutation allows you to delete a workspace via the API.
|
|
1579
|
+
* You can also specify what fields to query back from the deleted workspace when you run the mutation.
|
|
1580
|
+
* Documentation: https://developer.monday.com/api-reference/docs/columns#delete-a-column
|
|
1581
|
+
* @param options Request options.
|
|
1582
|
+
*/
|
|
1583
|
+
async deleteWorkspace(options) {
|
|
1584
|
+
return await createMutation(options, 'delete_workspace', this.implementation, this.getGlobalErrorStrategy);
|
|
1585
|
+
}
|
|
1586
|
+
}
|
|
1587
|
+
class FolderGroup {
|
|
1588
|
+
constructor(implementation, getGlobalErrorStrategy) {
|
|
1589
|
+
this.implementation = implementation;
|
|
1590
|
+
this.getGlobalErrorStrategy = getGlobalErrorStrategy;
|
|
1591
|
+
}
|
|
1592
|
+
/**
|
|
1593
|
+
* Querying folders will return metadata about one or a collection of folders. This method accepts various arguments and returns an array.
|
|
1594
|
+
* Documentation: https://developer.monday.com/api-reference/docs/folders#queries
|
|
1595
|
+
* @param options Request options.
|
|
1596
|
+
*/
|
|
1597
|
+
async getFolders(options) {
|
|
1598
|
+
return await createQuery(options, 'folders', this.implementation, this.getGlobalErrorStrategy);
|
|
1599
|
+
}
|
|
1600
|
+
/**
|
|
1601
|
+
* 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.
|
|
1602
|
+
* Documentation: https://developer.monday.com/api-reference/docs/folders#create-a-folder
|
|
1603
|
+
* @param options Request options.
|
|
1604
|
+
*/
|
|
1605
|
+
async createFolder(options) {
|
|
1606
|
+
return await createMutation(options, 'create_folder', this.implementation, this.getGlobalErrorStrategy);
|
|
1607
|
+
}
|
|
1608
|
+
/**
|
|
1609
|
+
* 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.
|
|
1610
|
+
* Documentation: https://developer.monday.com/api-reference/docs/folders#update-a-folder
|
|
1611
|
+
* @param options Request options.
|
|
1612
|
+
*/
|
|
1613
|
+
async updateFolder(options) {
|
|
1614
|
+
return await createMutation(options, 'update_folder', this.implementation, this.getGlobalErrorStrategy);
|
|
1615
|
+
}
|
|
1616
|
+
/**
|
|
1617
|
+
* 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.
|
|
1618
|
+
* Documentation: https://developer.monday.com/api-reference/docs/folders#delete-a-folder
|
|
1619
|
+
* @param options Request options.
|
|
1620
|
+
*/
|
|
1621
|
+
async deleteFolder(options) {
|
|
1622
|
+
return await createMutation(options, 'delete_folder', this.implementation, this.getGlobalErrorStrategy);
|
|
1623
|
+
}
|
|
1624
|
+
}
|
|
1625
|
+
class UpdateGroup {
|
|
1626
|
+
constructor(implementation, getGlobalErrorStrategy) {
|
|
1627
|
+
this.implementation = implementation;
|
|
1628
|
+
this.getGlobalErrorStrategy = getGlobalErrorStrategy;
|
|
1629
|
+
}
|
|
1630
|
+
/**
|
|
1631
|
+
* Querying updates will return metadata about one or a collection of updates.
|
|
1632
|
+
* This method accepts various arguments and returns an array.
|
|
1633
|
+
* Documentation: https://developer.monday.com/api-reference/docs/updates#queries
|
|
1634
|
+
* @param options Request options.
|
|
1635
|
+
*/
|
|
1636
|
+
async getUpdates(options) {
|
|
1637
|
+
return await createQuery(options, 'updates', this.implementation, this.getGlobalErrorStrategy);
|
|
1638
|
+
}
|
|
1639
|
+
/**
|
|
1640
|
+
* The create_update mutation allows you to add an update to an item via the API.
|
|
1641
|
+
* You can also specify what fields to query back from the new update when you run the mutation.
|
|
1642
|
+
* Documentation: https://developer.monday.com/api-reference/docs/updates#create-an-update
|
|
1643
|
+
* @param options Request options.
|
|
1644
|
+
*/
|
|
1645
|
+
async createUpdate(options) {
|
|
1646
|
+
return await createMutation(options, 'create_update', this.implementation, this.getGlobalErrorStrategy);
|
|
1647
|
+
}
|
|
1648
|
+
/**
|
|
1649
|
+
* The delete_update mutation allows you to delete an item's update via the API.
|
|
1650
|
+
* You can also specify what fields to query back from the update when you run the mutation.
|
|
1651
|
+
* Documentation: https://developer.monday.com/api-reference/docs/updates#delete-an-update
|
|
1652
|
+
* @param options Request options.
|
|
1653
|
+
*/
|
|
1654
|
+
async deleteUpdate(options) {
|
|
1655
|
+
return await createMutation(options, 'delete_update', this.implementation, this.getGlobalErrorStrategy);
|
|
1656
|
+
}
|
|
1657
|
+
/**
|
|
1658
|
+
* The like_update mutation allows you to like an update via the API.
|
|
1659
|
+
* You can also specify what fields to query back from the update when you run the mutation.
|
|
1660
|
+
* Documentation: https://developer.monday.com/api-reference/docs/updates#like-an-update
|
|
1661
|
+
* @param options Request options.
|
|
1662
|
+
*/
|
|
1663
|
+
async likeUpdate(options) {
|
|
1664
|
+
return await createMutation(options, 'like_update', this.implementation, this.getGlobalErrorStrategy);
|
|
1665
|
+
}
|
|
1666
|
+
/**
|
|
1667
|
+
* The unlike_update mutation allows you to unlike an update via the API.
|
|
1668
|
+
* You can also specify what fields to query back from the update when you run the mutation.
|
|
1669
|
+
* Documentation: https://developer.monday.com/api-reference/reference/updates#unlike-an-update
|
|
1670
|
+
* @param options Request options.
|
|
1671
|
+
*/
|
|
1672
|
+
async unlikeUpdate(options) {
|
|
1673
|
+
return await createMutation(options, 'unlike_update', this.implementation, this.getGlobalErrorStrategy);
|
|
1674
|
+
}
|
|
1675
|
+
/**
|
|
1676
|
+
* The edit_update mutation allows you to edit an update via the API.
|
|
1677
|
+
* You can also specify what fields to query back from the update when you run the mutation.
|
|
1678
|
+
* Documentation: https://developer.monday.com/api-reference/reference/updates#edit-an-update
|
|
1679
|
+
* @param options Request options.
|
|
1680
|
+
*/
|
|
1681
|
+
async editUpdate(options) {
|
|
1682
|
+
return await createMutation(options, 'edit_update', this.implementation, this.getGlobalErrorStrategy);
|
|
1683
|
+
}
|
|
1684
|
+
/**
|
|
1685
|
+
* The pin_to_top mutation allows you to pin an update to the top of an item via the API.
|
|
1686
|
+
* You can also specify what fields to query back from the update when you run the mutation.
|
|
1687
|
+
* Documentation: https://developer.monday.com/api-reference/reference/updates#pin-an-update
|
|
1688
|
+
* @param options Request options.
|
|
1689
|
+
*/
|
|
1690
|
+
async pinUpdate(options) {
|
|
1691
|
+
return await createMutation(options, 'pin_to_top', this.implementation, this.getGlobalErrorStrategy);
|
|
1692
|
+
}
|
|
1693
|
+
/**
|
|
1694
|
+
* The unpin_from_top mutation allows you to unpin an update from the top of an item via the API.
|
|
1695
|
+
* You can also specify what fields to query back from the update when you run the mutation.
|
|
1696
|
+
* Documentation: https://developer.monday.com/api-reference/reference/updates#unpin-an-update
|
|
1697
|
+
* @param options Request options.
|
|
1698
|
+
*/
|
|
1699
|
+
async unpinUpdate(options) {
|
|
1700
|
+
return await createMutation(options, 'unpin_from_top', this.implementation, this.getGlobalErrorStrategy);
|
|
1701
|
+
}
|
|
1702
|
+
}
|
|
1703
|
+
class DocGroup {
|
|
1704
|
+
constructor(implementation, getGlobalErrorStrategy) {
|
|
1705
|
+
this.implementation = implementation;
|
|
1706
|
+
this.getGlobalErrorStrategy = getGlobalErrorStrategy;
|
|
1707
|
+
this.DocBlock = new DocBlockGroup(implementation, this.getGlobalErrorStrategy);
|
|
1708
|
+
}
|
|
1709
|
+
/**
|
|
1710
|
+
* Querying docs will return metadata about a collection of docs. This method accepts various arguments and returns an array.
|
|
1711
|
+
* Documentation: https://developer.monday.com/api-reference/docs/docs#queries
|
|
1712
|
+
* @param options Request options.
|
|
1713
|
+
*/
|
|
1714
|
+
async getDocs(options) {
|
|
1715
|
+
return await createQuery(options, 'docs', this.implementation, this.getGlobalErrorStrategy);
|
|
1716
|
+
}
|
|
1717
|
+
/**
|
|
1718
|
+
* 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.
|
|
1719
|
+
* Documentation: https://developer.monday.com/api-reference/docs/docs#create-a-doc
|
|
1720
|
+
* @param options Request options.
|
|
1721
|
+
*/
|
|
1722
|
+
async createDoc(options) {
|
|
1723
|
+
return await createMutation(options, 'create_doc', this.implementation, this.getGlobalErrorStrategy);
|
|
1724
|
+
}
|
|
1725
|
+
}
|
|
1726
|
+
class DocBlockGroup {
|
|
1727
|
+
constructor(implementation, getGlobalErrorStrategy) {
|
|
1728
|
+
this.implementation = implementation;
|
|
1729
|
+
this.getGlobalErrorStrategy = getGlobalErrorStrategy;
|
|
1730
|
+
}
|
|
1731
|
+
/**
|
|
1732
|
+
* Querying blocks will return metadata about one or a collection of blocks. The method accepts various arguments and returns an array.
|
|
1733
|
+
* Documentation: https://developer.monday.com/api-reference/docs/blocks#queries
|
|
1734
|
+
* @param options Request options.
|
|
1735
|
+
*/
|
|
1736
|
+
async getDocBlocks(options) {
|
|
1737
|
+
return await createQuery(options, 'docs', this.implementation, this.getGlobalErrorStrategy);
|
|
1738
|
+
}
|
|
1739
|
+
/**
|
|
1740
|
+
* 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.
|
|
1741
|
+
* Documentation: https://developer.monday.com/api-reference/docs/blocks#create-document-block
|
|
1742
|
+
* @param options Request options.
|
|
1743
|
+
*/
|
|
1744
|
+
async createDocBlock(options) {
|
|
1745
|
+
return await createMutation(options, 'create_doc_block', this.implementation, this.getGlobalErrorStrategy);
|
|
1746
|
+
}
|
|
1747
|
+
/**
|
|
1748
|
+
* 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.
|
|
1749
|
+
* Documentation: https://developer.monday.com/api-reference/docs/blocks#update-document-block
|
|
1750
|
+
* @param options Request options.
|
|
1751
|
+
*/
|
|
1752
|
+
async updateDocBlock(options) {
|
|
1753
|
+
return await createMutation(options, 'update_doc_block', this.implementation, this.getGlobalErrorStrategy);
|
|
1754
|
+
}
|
|
1755
|
+
/**
|
|
1756
|
+
* 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.
|
|
1757
|
+
* Documentation: https://developer.monday.com/api-reference/docs/blocks#delete-document-block
|
|
1758
|
+
* @param options Request options.
|
|
1759
|
+
*/
|
|
1760
|
+
async deleteDocBlock(options) {
|
|
1761
|
+
return await createMutation(options, 'delete_doc_block', this.implementation, this.getGlobalErrorStrategy);
|
|
1762
|
+
}
|
|
1763
|
+
}
|
|
1764
|
+
class TagGroup {
|
|
1765
|
+
constructor(implementation, getGlobalErrorStrategy) {
|
|
1766
|
+
this.implementation = implementation;
|
|
1767
|
+
this.getGlobalErrorStrategy = getGlobalErrorStrategy;
|
|
1768
|
+
}
|
|
1769
|
+
/**
|
|
1770
|
+
* 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
|
|
1771
|
+
* 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.
|
|
1772
|
+
* 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.
|
|
1773
|
+
* To return tags stored on private or shareable boards, you can nest tags within a boards query.
|
|
1774
|
+
* Documentation: https://developer.monday.com/api-reference/docs/tags-queries#queries
|
|
1775
|
+
* @param options Request options.
|
|
1776
|
+
*/
|
|
1777
|
+
async getTags(options) {
|
|
1778
|
+
return await createQuery(options, 'tags', this.implementation, this.getGlobalErrorStrategy);
|
|
1779
|
+
}
|
|
1780
|
+
/**
|
|
1781
|
+
* The create_or_get_tag mutation allows you to create new tags or receive their data if they already exist via the API.
|
|
1782
|
+
* You can also specify what fields to query back from the tag when you run the mutation.
|
|
1783
|
+
* Documentation: https://developer.monday.com/api-reference/docs/tags-queries#create-or-get-a-tag
|
|
1784
|
+
* @param options Request options.
|
|
1785
|
+
*/
|
|
1786
|
+
async createOrGetTag(options) {
|
|
1787
|
+
return await createMutation(options, 'create_or_get_tag', this.implementation, this.getGlobalErrorStrategy);
|
|
1788
|
+
}
|
|
1789
|
+
}
|
|
1790
|
+
class VersionGroup {
|
|
1791
|
+
constructor(implementation, getGlobalErrorStrategy) {
|
|
1792
|
+
this.implementation = implementation;
|
|
1793
|
+
this.getGlobalErrorStrategy = getGlobalErrorStrategy;
|
|
1794
|
+
}
|
|
1795
|
+
/**
|
|
1796
|
+
* 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.
|
|
1797
|
+
* Documentation: https://developer.monday.com/api-reference/docs/version#queries
|
|
1798
|
+
* @param options Request options.
|
|
1799
|
+
*/
|
|
1800
|
+
async getVersion(options) {
|
|
1801
|
+
return await createQuery(options, 'version', this.implementation, this.getGlobalErrorStrategy);
|
|
1802
|
+
}
|
|
1803
|
+
/**
|
|
1804
|
+
* Querying versions will return metadata about all available API versions. This method does not accept any arguments and returns an array.
|
|
1805
|
+
* Documentation: https://developer.monday.com/api-reference/docs/versions#queries
|
|
1806
|
+
* @param options Request options.
|
|
1807
|
+
*/
|
|
1808
|
+
async getVersions(options) {
|
|
1809
|
+
return await createQuery(options, 'versions', this.implementation, this.getGlobalErrorStrategy);
|
|
1810
|
+
}
|
|
1811
|
+
}
|
|
1812
|
+
class WebhookGroup {
|
|
1813
|
+
constructor(implementation, getGlobalErrorStrategy) {
|
|
1814
|
+
this.implementation = implementation;
|
|
1815
|
+
this.getGlobalErrorStrategy = getGlobalErrorStrategy;
|
|
1816
|
+
}
|
|
1817
|
+
/**
|
|
1818
|
+
* Querying webhooks will return one or a collection of webhooks. This method accepts various arguments and returns an array.
|
|
1819
|
+
* You can only query webhooks directly at the root, so it can't be nested within another query.
|
|
1820
|
+
* Documentation: https://developer.monday.com/api-reference/docs/webhooks#queries
|
|
1821
|
+
* @param options
|
|
1822
|
+
*/
|
|
1823
|
+
async getWebhooks(options) {
|
|
1824
|
+
return await createQuery(options, 'webhooks', this.implementation, this.getGlobalErrorStrategy);
|
|
1825
|
+
}
|
|
1826
|
+
/**
|
|
1827
|
+
* 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.
|
|
1828
|
+
* 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.
|
|
1829
|
+
*
|
|
1830
|
+
* You can add a query param to your webhook URL if you want to differentiate between subitem and main item events.
|
|
1831
|
+
* The URL must pass a verification test where we will send a JSON POST body request containing a challenge field.
|
|
1832
|
+
* Monday.com expects your provided URL to return the token as a challenge field in your response JSON body to that request.
|
|
1833
|
+
*
|
|
1834
|
+
* Documentation: https://developer.monday.com/api-reference/docs/webhooks#create-a-webhook
|
|
1835
|
+
* @param options
|
|
1836
|
+
*/
|
|
1837
|
+
async createWebhook(options) {
|
|
1838
|
+
return await createMutation(options, 'create_webhook', this.implementation, this.getGlobalErrorStrategy);
|
|
1839
|
+
}
|
|
1840
|
+
/**
|
|
1841
|
+
* The delete_webhook mutation allows you to delete a webhook via the API.
|
|
1842
|
+
* You can also specify what fields to query back when you run the mutation.
|
|
1843
|
+
* After the mutation runs, it will no longer report events to the URL given.
|
|
1844
|
+
* Documentation: https://developer.monday.com/api-reference/docs/webhooks#delete-a-webhook
|
|
1845
|
+
* @param options
|
|
1846
|
+
*/
|
|
1847
|
+
async deleteWebhook(options) {
|
|
1848
|
+
return await createMutation(options, 'delete_webhook', this.implementation, this.getGlobalErrorStrategy);
|
|
1849
|
+
}
|
|
1850
|
+
}
|