@pnp/cli-microsoft365 6.2.0-beta.d0cdaa3 → 6.2.0-beta.d850a76

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.
Files changed (107) hide show
  1. package/.eslintrc.js +6 -0
  2. package/dist/m365/aad/commands/approleassignment/approleassignment-add.js +3 -0
  3. package/dist/m365/context/commands/option/option-remove.js +105 -0
  4. package/dist/m365/context/commands/option/option-set.js +84 -0
  5. package/dist/m365/context/commands.js +2 -0
  6. package/dist/m365/onenote/commands/page/page-list.js +137 -0
  7. package/dist/m365/onenote/commands.js +2 -1
  8. package/dist/m365/planner/commands/bucket/bucket-add.js +0 -6
  9. package/dist/m365/planner/commands/bucket/bucket-get.js +0 -6
  10. package/dist/m365/planner/commands/bucket/bucket-list.js +0 -6
  11. package/dist/m365/planner/commands/bucket/bucket-remove.js +0 -6
  12. package/dist/m365/planner/commands/bucket/bucket-set.js +0 -6
  13. package/dist/m365/planner/commands/plan/plan-add.js +0 -6
  14. package/dist/m365/planner/commands/plan/plan-get.js +0 -6
  15. package/dist/m365/planner/commands/plan/plan-list.js +0 -6
  16. package/dist/m365/planner/commands/plan/plan-remove.js +0 -6
  17. package/dist/m365/planner/commands/plan/plan-set.js +0 -6
  18. package/dist/m365/planner/commands/task/task-add.js +0 -6
  19. package/dist/m365/planner/commands/task/task-checklistitem-add.js +0 -6
  20. package/dist/m365/planner/commands/task/task-checklistitem-list.js +0 -6
  21. package/dist/m365/planner/commands/task/task-get.js +0 -6
  22. package/dist/m365/planner/commands/task/task-list.js +0 -6
  23. package/dist/m365/planner/commands/task/task-reference-list.js +0 -6
  24. package/dist/m365/planner/commands/task/task-set.js +0 -6
  25. package/dist/m365/pp/commands/aibuildermodel/aibuildermodel-get.js +110 -0
  26. package/dist/m365/pp/commands/aibuildermodel/aibuildermodel-list.js +68 -0
  27. package/dist/m365/pp/commands/aibuildermodel/aibuildermodel-remove.js +130 -0
  28. package/dist/m365/pp/commands/solution/solution-publish.js +156 -0
  29. package/dist/m365/pp/commands.js +4 -0
  30. package/dist/m365/purview/commands/retentionlabel/retentionlabel-add.js +143 -0
  31. package/dist/m365/purview/commands/retentionlabel/retentionlabel-get.js +70 -0
  32. package/dist/m365/purview/commands.js +2 -0
  33. package/dist/m365/spo/commands/file/GraphFileDetails.js +3 -0
  34. package/dist/m365/spo/commands/file/file-retentionlabel-ensure.js +121 -0
  35. package/dist/m365/spo/commands/file/file-retentionlabel-remove.js +141 -0
  36. package/dist/m365/spo/commands/file/file-sharinginfo-get.js +12 -12
  37. package/dist/m365/spo/commands/file/file-sharinglink-get.js +116 -0
  38. package/dist/m365/spo/commands/file/file-sharinglink-list.js +133 -0
  39. package/dist/m365/spo/commands/file/file-sharinglink-remove.js +135 -0
  40. package/dist/m365/spo/commands/folder/folder-retentionlabel-ensure.js +138 -0
  41. package/dist/m365/spo/commands/folder/folder-retentionlabel-remove.js +157 -0
  42. package/dist/m365/spo/commands/group/group-member-add.js +33 -6
  43. package/dist/m365/spo/commands/group/group-member-remove.js +78 -33
  44. package/dist/m365/spo/commands/list/list-add.js +3 -0
  45. package/dist/m365/spo/commands/list/list-retentionlabel-ensure.js +10 -2
  46. package/dist/m365/spo/commands/list/list-retentionlabel-remove.js +146 -0
  47. package/dist/m365/spo/commands/list/list-set.js +3 -0
  48. package/dist/m365/spo/commands/listitem/ListItemRetentionLabel.js +3 -0
  49. package/dist/m365/spo/commands/listitem/SiteRetentionLabel.js +3 -0
  50. package/dist/m365/spo/commands/listitem/listitem-list.js +1 -1
  51. package/dist/m365/spo/commands/listitem/listitem-record-lock.js +129 -0
  52. package/dist/m365/spo/commands/listitem/listitem-record-unlock.js +129 -0
  53. package/dist/m365/spo/commands/listitem/listitem-retentionlabel-ensure.js +161 -0
  54. package/dist/m365/spo/commands/listitem/listitem-retentionlabel-remove.js +2 -2
  55. package/dist/m365/spo/commands/term/term-list.js +99 -29
  56. package/dist/m365/spo/commands.js +11 -0
  57. package/dist/m365/teams/commands/chat/chat-list.js +29 -7
  58. package/dist/m365/teams/commands/message/message-send.js +81 -0
  59. package/dist/m365/teams/commands.js +1 -0
  60. package/dist/request.js +2 -2
  61. package/dist/utils/formatting.js +22 -0
  62. package/docs/docs/cmd/context/option/option-remove.md +37 -0
  63. package/docs/docs/cmd/context/option/option-set.md +31 -0
  64. package/docs/docs/cmd/onenote/page/page-list.md +140 -0
  65. package/docs/docs/cmd/planner/bucket/bucket-add.md +17 -0
  66. package/docs/docs/cmd/planner/bucket/bucket-get.md +17 -0
  67. package/docs/docs/cmd/planner/bucket/bucket-list.md +17 -0
  68. package/docs/docs/cmd/planner/plan/plan-add.md +40 -0
  69. package/docs/docs/cmd/planner/plan/plan-get.md +21 -0
  70. package/docs/docs/cmd/planner/plan/plan-list.md +19 -0
  71. package/docs/docs/cmd/planner/plan/plan-set.md +20 -0
  72. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-get.md +99 -0
  73. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-list.md +95 -0
  74. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-remove.md +53 -0
  75. package/docs/docs/cmd/pp/solution/solution-publish.md +52 -0
  76. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-add.md +128 -0
  77. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-get.md +95 -0
  78. package/docs/docs/cmd/spo/cdn/cdn-get.md +1 -1
  79. package/docs/docs/cmd/spo/cdn/cdn-origin-add.md +1 -1
  80. package/docs/docs/cmd/spo/cdn/cdn-origin-list.md +1 -1
  81. package/docs/docs/cmd/spo/cdn/cdn-origin-remove.md +1 -1
  82. package/docs/docs/cmd/spo/cdn/cdn-policy-list.md +1 -1
  83. package/docs/docs/cmd/spo/cdn/cdn-policy-set.md +1 -1
  84. package/docs/docs/cmd/spo/cdn/cdn-set.md +1 -1
  85. package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.md +47 -0
  86. package/docs/docs/cmd/spo/file/file-retentionlabel-remove.md +43 -0
  87. package/docs/docs/cmd/spo/file/file-sharinglink-get.md +107 -0
  88. package/docs/docs/cmd/spo/file/file-sharinglink-list.md +106 -0
  89. package/docs/docs/cmd/spo/file/file-sharinglink-remove.md +52 -0
  90. package/docs/docs/cmd/spo/folder/folder-retentionlabel-ensure.md +47 -0
  91. package/docs/docs/cmd/spo/folder/folder-retentionlabel-remove.md +43 -0
  92. package/docs/docs/cmd/spo/group/group-member-add.md +22 -4
  93. package/docs/docs/cmd/spo/group/group-member-remove.md +24 -6
  94. package/docs/docs/cmd/spo/list/list-add.md +3 -9
  95. package/docs/docs/cmd/spo/list/list-retentionlabel-ensure.md +8 -5
  96. package/docs/docs/cmd/spo/list/list-retentionlabel-remove.md +52 -0
  97. package/docs/docs/cmd/spo/list/list-set.md +3 -3
  98. package/docs/docs/cmd/spo/listitem/listitem-get.md +11 -12
  99. package/docs/docs/cmd/spo/listitem/listitem-list.md +5 -5
  100. package/docs/docs/cmd/spo/listitem/listitem-record-lock.md +52 -0
  101. package/docs/docs/cmd/spo/listitem/listitem-record-unlock.md +52 -0
  102. package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-ensure.md +58 -0
  103. package/docs/docs/cmd/spo/term/term-list.md +138 -0
  104. package/docs/docs/cmd/teams/chat/chat-list.md +16 -4
  105. package/docs/docs/cmd/teams/message/message-send.md +119 -0
  106. package/npm-shrinkwrap.json +182 -202
  107. package/package.json +12 -11
@@ -57,11 +57,16 @@ exports.default = {
57
57
  FILE_MOVE: `${prefix} file move`,
58
58
  FILE_REMOVE: `${prefix} file remove`,
59
59
  FILE_RENAME: `${prefix} file rename`,
60
+ FILE_RETENTIONLABEL_ENSURE: `${prefix} file retentionlabel ensure`,
61
+ FILE_RETENTIONLABEL_REMOVE: `${prefix} file retentionlabel remove`,
60
62
  FILE_ROLEASSIGNMENT_ADD: `${prefix} file roleassignment add`,
61
63
  FILE_ROLEASSIGNMENT_REMOVE: `${prefix} file roleassignment remove`,
62
64
  FILE_ROLEINHERITANCE_BREAK: `${prefix} file roleinheritance break`,
63
65
  FILE_ROLEINHERITANCE_RESET: `${prefix} file roleinheritance reset`,
64
66
  FILE_SHARINGINFO_GET: `${prefix} file sharinginfo get`,
67
+ FILE_SHARINGLINK_GET: `${prefix} file sharinglink get`,
68
+ FILE_SHARINGLINK_LIST: `${prefix} file sharinglink list`,
69
+ FILE_SHARINGLINK_REMOVE: `${prefix} file sharinglink remove`,
65
70
  FILE_VERSION_CLEAR: `${prefix} file version clear`,
66
71
  FILE_VERSION_GET: `${prefix} file version get`,
67
72
  FILE_VERSION_LIST: `${prefix} file version list`,
@@ -74,6 +79,8 @@ exports.default = {
74
79
  FOLDER_MOVE: `${prefix} folder move`,
75
80
  FOLDER_REMOVE: `${prefix} folder remove`,
76
81
  FOLDER_RENAME: `${prefix} folder rename`,
82
+ FOLDER_RETENTIONLABEL_ENSURE: `${prefix} folder retentionlabel ensure`,
83
+ FOLDER_RETENTIONLABEL_REMOVE: `${prefix} folder retentionlabel remove`,
77
84
  FOLDER_ROLEASSIGNMENT_REMOVE: `${prefix} folder roleassignment remove`,
78
85
  FOLDER_ROLEASSIGNMENT_ADD: `${prefix} folder roleassignment add`,
79
86
  FOLDER_ROLEINHERITANCE_BREAK: `${prefix} folder roleinheritance break`,
@@ -117,6 +124,7 @@ exports.default = {
117
124
  LIST_REMOVE: `${prefix} list remove`,
118
125
  LIST_RETENTIONLABEL_ENSURE: `${prefix} list retentionlabel ensure`,
119
126
  LIST_RETENTIONLABEL_GET: `${prefix} list retentionlabel get`,
127
+ LIST_RETENTIONLABEL_REMOVE: `${prefix} list retentionlabel remove`,
120
128
  LIST_ROLEASSIGNMENT_REMOVE: `${prefix} list roleassignment remove`,
121
129
  LIST_ROLEASSIGNMENT_ADD: `${prefix} list roleassignment add`,
122
130
  LIST_ROLEINHERITANCE_BREAK: `${prefix} list roleinheritance break`,
@@ -143,8 +151,11 @@ exports.default = {
143
151
  LISTITEM_ISRECORD: `${prefix} listitem isrecord`,
144
152
  LISTITEM_LIST: `${prefix} listitem list`,
145
153
  LISTITEM_RECORD_DECLARE: `${prefix} listitem record declare`,
154
+ LISTITEM_RECORD_LOCK: `${prefix} listitem record lock`,
146
155
  LISTITEM_RECORD_UNDECLARE: `${prefix} listitem record undeclare`,
156
+ LISTITEM_RECORD_UNLOCK: `${prefix} listitem record unlock`,
147
157
  LISTITEM_REMOVE: `${prefix} listitem remove`,
158
+ LISTITEM_RETENTIONLABEL_ENSURE: `${prefix} listitem retentionlabel ensure`,
148
159
  LISTITEM_RETENTIONLABEL_REMOVE: `${prefix} listitem retentionlabel remove`,
149
160
  LISTITEM_ROLEASSIGNMENT_ADD: `${prefix} listitem roleassignment add`,
150
161
  LISTITEM_ROLEASSIGNMENT_REMOVE: `${prefix} listitem roleassignment remove`,
@@ -15,9 +15,12 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
15
15
  };
16
16
  var _TeamsChatListCommand_instances, _TeamsChatListCommand_initTelemetry, _TeamsChatListCommand_initOptions, _TeamsChatListCommand_initValidators;
17
17
  Object.defineProperty(exports, "__esModule", { value: true });
18
+ const Auth_1 = require("../../../../Auth");
19
+ const accessToken_1 = require("../../../../utils/accessToken");
18
20
  const odata_1 = require("../../../../utils/odata");
19
21
  const GraphCommand_1 = require("../../../base/GraphCommand");
20
22
  const commands_1 = require("../../commands");
23
+ const validation_1 = require("../../../../utils/validation");
21
24
  class TeamsChatListCommand extends GraphCommand_1.default {
22
25
  get name() {
23
26
  return commands_1.default.CHAT_LIST;
@@ -31,16 +34,26 @@ class TeamsChatListCommand extends GraphCommand_1.default {
31
34
  constructor() {
32
35
  super();
33
36
  _TeamsChatListCommand_instances.add(this);
37
+ this.supportedTypes = ['oneOnOne', 'group', 'meeting'];
34
38
  __classPrivateFieldGet(this, _TeamsChatListCommand_instances, "m", _TeamsChatListCommand_initTelemetry).call(this);
35
39
  __classPrivateFieldGet(this, _TeamsChatListCommand_instances, "m", _TeamsChatListCommand_initOptions).call(this);
36
40
  __classPrivateFieldGet(this, _TeamsChatListCommand_instances, "m", _TeamsChatListCommand_initValidators).call(this);
37
41
  }
38
42
  commandAction(logger, args) {
39
43
  return __awaiter(this, void 0, void 0, function* () {
40
- const filter = args.options.type !== undefined ? `?$filter=chatType eq '${args.options.type}'` : '';
41
- const endpoint = `${this.resource}/v1.0/chats${filter}`;
44
+ const isAppOnlyAuth = accessToken_1.accessToken.isAppOnlyAccessToken(Auth_1.default.service.accessTokens[this.resource].accessToken);
45
+ if (isAppOnlyAuth && !args.options.userId && !args.options.userName) {
46
+ throw `The option 'userId' or 'userName' is required when obtaining chats using app only permissions`;
47
+ }
48
+ else if (!isAppOnlyAuth && (args.options.userId || args.options.userName)) {
49
+ throw `The options 'userId' or 'userName' cannot be used when obtaining chats using delegated permissions`;
50
+ }
51
+ let requestUrl = `${this.resource}/v1.0/${!isAppOnlyAuth ? 'me' : `users/${args.options.userId || args.options.userName}`}/chats`;
52
+ if (args.options.type) {
53
+ requestUrl += `?$filter=chatType eq '${args.options.type}'`;
54
+ }
42
55
  try {
43
- const items = yield odata_1.odata.getAllItems(endpoint);
56
+ const items = yield odata_1.odata.getAllItems(requestUrl);
44
57
  logger.log(items);
45
58
  }
46
59
  catch (err) {
@@ -58,13 +71,22 @@ _TeamsChatListCommand_instances = new WeakSet(), _TeamsChatListCommand_initTelem
58
71
  }, _TeamsChatListCommand_initOptions = function _TeamsChatListCommand_initOptions() {
59
72
  this.options.unshift({
60
73
  option: '-t, --type [type]',
61
- autocomplete: ['oneOnOne', 'group', 'meeting']
74
+ autocomplete: this.supportedTypes
75
+ }, {
76
+ option: '--userId [userId]'
77
+ }, {
78
+ option: '--userName [userName]'
62
79
  });
63
80
  }, _TeamsChatListCommand_initValidators = function _TeamsChatListCommand_initValidators() {
64
81
  this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
65
- const supportedTypes = ['oneOnOne', 'group', 'meeting'];
66
- if (args.options.type !== undefined && supportedTypes.indexOf(args.options.type) === -1) {
67
- return `${args.options.type} is not a valid chatType. Accepted values are ${supportedTypes.join(', ')}`;
82
+ if (args.options.type !== undefined && this.supportedTypes.indexOf(args.options.type) === -1) {
83
+ return `${args.options.type} is not a valid chatType. Accepted values are ${this.supportedTypes.join(', ')}`;
84
+ }
85
+ if (args.options.userId && args.options.userName) {
86
+ return `You can only specify either 'userId' or 'userName'`;
87
+ }
88
+ if (args.options.userId && !validation_1.validation.isValidGuid(args.options.userId)) {
89
+ return `${args.options.userId} is not a valid GUID`;
68
90
  }
69
91
  return true;
70
92
  }));
@@ -0,0 +1,81 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
12
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
13
+ if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
14
+ return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
15
+ };
16
+ var _TeamsMessageSendCommand_instances, _TeamsMessageSendCommand_initOptions, _TeamsMessageSendCommand_initValidators;
17
+ Object.defineProperty(exports, "__esModule", { value: true });
18
+ const request_1 = require("../../../../request");
19
+ const validation_1 = require("../../../../utils/validation");
20
+ const GraphCommand_1 = require("../../../base/GraphCommand");
21
+ const commands_1 = require("../../commands");
22
+ class TeamsMessageSendCommand extends GraphCommand_1.default {
23
+ get name() {
24
+ return commands_1.default.MESSAGE_SEND;
25
+ }
26
+ get description() {
27
+ return 'Sends a message to a channel in a Microsoft Teams team';
28
+ }
29
+ constructor() {
30
+ super();
31
+ _TeamsMessageSendCommand_instances.add(this);
32
+ __classPrivateFieldGet(this, _TeamsMessageSendCommand_instances, "m", _TeamsMessageSendCommand_initOptions).call(this);
33
+ __classPrivateFieldGet(this, _TeamsMessageSendCommand_instances, "m", _TeamsMessageSendCommand_initValidators).call(this);
34
+ }
35
+ commandAction(logger, args) {
36
+ return __awaiter(this, void 0, void 0, function* () {
37
+ try {
38
+ const requestOptions = {
39
+ url: `${this.resource}/v1.0/teams/${args.options.teamId}/channels/${args.options.channelId}/messages`,
40
+ headers: {
41
+ accept: 'application/json;odata.metadata=none',
42
+ 'content-type': 'application/json'
43
+ },
44
+ responseType: 'json',
45
+ data: {
46
+ body: {
47
+ contentType: 'html',
48
+ content: args.options.message
49
+ }
50
+ }
51
+ };
52
+ const response = yield request_1.default.post(requestOptions);
53
+ logger.log(response);
54
+ }
55
+ catch (err) {
56
+ this.handleRejectedODataJsonPromise(err);
57
+ }
58
+ });
59
+ }
60
+ }
61
+ _TeamsMessageSendCommand_instances = new WeakSet(), _TeamsMessageSendCommand_initOptions = function _TeamsMessageSendCommand_initOptions() {
62
+ this.options.unshift({
63
+ option: '-i, --teamId <teamId>'
64
+ }, {
65
+ option: '-c, --channelId <channelId>'
66
+ }, {
67
+ option: '-m, --message <message>'
68
+ });
69
+ }, _TeamsMessageSendCommand_initValidators = function _TeamsMessageSendCommand_initValidators() {
70
+ this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
71
+ if (!validation_1.validation.isValidGuid(args.options.teamId)) {
72
+ return `${args.options.teamId} is not a valid GUID`;
73
+ }
74
+ if (!validation_1.validation.isValidTeamsChannelId(args.options.channelId)) {
75
+ return `${args.options.channelId} is not a valid Teams ChannelId`;
76
+ }
77
+ return true;
78
+ }));
79
+ };
80
+ module.exports = new TeamsMessageSendCommand();
81
+ //# sourceMappingURL=message-send.js.map
@@ -35,6 +35,7 @@ exports.default = {
35
35
  MESSAGE_GET: `${prefix} message get`,
36
36
  MESSAGE_LIST: `${prefix} message list`,
37
37
  MESSAGE_REPLY_LIST: `${prefix} message reply list`,
38
+ MESSAGE_SEND: `${prefix} message send`,
38
39
  MESSAGINGSETTINGS_LIST: `${prefix} messagingsettings list`,
39
40
  MESSAGINGSETTINGS_SET: `${prefix} messagingsettings set`,
40
41
  REPORT_DEVICEUSAGEDISTRIBUTIONUSERCOUNTS: `${prefix} report deviceusagedistributionusercounts`,
package/dist/request.js CHANGED
@@ -150,10 +150,10 @@ class Request {
150
150
  })
151
151
  .then((res) => {
152
152
  if (resolve) {
153
- resolve(options.responseType === 'stream' ? res : res.data);
153
+ resolve((options.responseType === 'stream' || options.fullResponse) ? res : res.data);
154
154
  }
155
155
  else {
156
- _resolve(options.responseType === 'stream' ? res : res.data);
156
+ _resolve((options.responseType === 'stream' || options.fullResponse) ? res : res.data);
157
157
  }
158
158
  }, (error) => {
159
159
  if (error && error.response &&
@@ -110,6 +110,28 @@ exports.formatting = {
110
110
  default:
111
111
  return value;
112
112
  }
113
+ },
114
+ /**
115
+ * Converts an object into an xml:
116
+ * @obj the actual objec
117
+ * @returns A string containing the xml
118
+ */
119
+ objectToXml(obj) {
120
+ let xml = '';
121
+ for (const prop in obj) {
122
+ xml += "<" + prop + ">";
123
+ if (obj[prop] instanceof Array) {
124
+ for (const array in obj[prop]) {
125
+ xml += this.objectToXml(new Object(obj[prop][array]));
126
+ }
127
+ }
128
+ else {
129
+ xml += obj[prop];
130
+ }
131
+ xml += "</" + prop + ">";
132
+ }
133
+ xml = xml.replace(/<\/?[0-9]{1,}>/g, '');
134
+ return xml;
113
135
  }
114
136
  };
115
137
  //# sourceMappingURL=formatting.js.map
@@ -0,0 +1,37 @@
1
+ # context option remove
2
+
3
+ Removes an already available name from local context file.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 context option remove [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-n, --name <name>`
14
+ : The name of the option which will be deleted from the context
15
+
16
+ `--confirm`
17
+ : Don't prompt for confirming removing the option
18
+
19
+ --8<-- "docs/cmd/_global.md"
20
+
21
+ ## Examples
22
+
23
+ Removes an already available name from the local context file
24
+
25
+ ```sh
26
+ m365 context option remove --name "listName"
27
+ ```
28
+
29
+ Removes an already available name from the local context file without confirmation
30
+
31
+ ```sh
32
+ m365 context option remove --name "listName" --confirm
33
+ ```
34
+
35
+ ## Response
36
+
37
+ The command won't return a response on success.
@@ -0,0 +1,31 @@
1
+ # context option set
2
+
3
+ Allows to add a new name for the option and value to the local context file.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 context option set [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-n, --name <name>`
14
+ : The option name for which we will define the value
15
+
16
+ `-v, --value <value>`
17
+ : Default value for the option
18
+
19
+ --8<-- "docs/cmd/_global.md"
20
+
21
+ ## Examples
22
+
23
+ Define a new default value for name listName in the context
24
+
25
+ ```sh
26
+ m365 context option set --name 'listName' --value 'testList'
27
+ ```
28
+
29
+ ## Response
30
+
31
+ The command won't return a response on success.
@@ -0,0 +1,140 @@
1
+ # onenote page list
2
+
3
+ Retrieve a list of OneNote pages.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 onenote page list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `--userId [userId]`
14
+ : Id of the user. Use either `userId`, `userName`, `groupId`, `groupName` or `webUrl` but not multiple.
15
+
16
+ `--userName [userName]`
17
+ : Name of the user. Use either `userId`, `userName`, `groupId`, `groupName` or `webUrl` but not multiple.
18
+
19
+ `--groupId [groupId]`
20
+ : Id of the SharePoint group. Use either `userId`, `userName`, `groupId`, `groupName` or `webUrl` but not multiple.
21
+
22
+ `--groupName [groupName]`
23
+ : Name of the SharePoint group. Use either `userId`, `userName`, `groupId`, `groupName` or `webUrl` but not multiple.
24
+
25
+ `-u, --webUrl [webUrl]`
26
+ : URL of the SharePoint site. Use either `userId`, `userName`, `groupId`, `groupName` or `webUrl` but not multiple.
27
+
28
+ --8<-- "docs/cmd/_global.md"
29
+
30
+ ## Remarks
31
+
32
+ When we don't specify either `userId`, `userName`, `groupId`, `groupName` or `webUrl`, the OneNote pages will be retrieved of the currently logged in user.
33
+
34
+ ## Examples
35
+
36
+ List Microsoft OneNote pages for the currently logged in user
37
+
38
+ ```sh
39
+ m365 onenote page list
40
+ ```
41
+
42
+ List Microsoft OneNote pages in a specific group specified by id
43
+
44
+ ```sh
45
+ m365 onenote page list --groupId 233e43d0-dc6a-482e-9b4e-0de7a7bce9b4
46
+ ```
47
+
48
+ List Microsoft OneNote pages in a specific group specified by name
49
+
50
+ ```sh
51
+ m365 onenote page list --groupName "MyGroup"
52
+ ```
53
+
54
+ List Microsoft OneNote pages for a specific user specified by name
55
+
56
+ ```sh
57
+ m365 onenote page list --userName user1@contoso.onmicrosoft.com
58
+ ```
59
+
60
+ List Microsoft OneNote pages for a specific user specified by id
61
+
62
+ ```sh
63
+ m365 onenote page list --userId 2609af39-7775-4f94-a3dc-0dd67657e900
64
+ ```
65
+
66
+ List Microsoft OneNote pages for a specific site
67
+
68
+ ```sh
69
+ m365 onenote page list --webUrl https://contoso.sharepoint.com/sites/testsite
70
+ ```
71
+
72
+ ## Response
73
+
74
+ === "JSON"
75
+
76
+ ```json
77
+ [
78
+ {
79
+ "id": "1-a26aaec43ed348bd82edf4eb44e73d6c!68-3eb21088-b613-4698-98df-92a7d34e0678",
80
+ "self": "https://graph.microsoft.com/v1.0/users/john@contoso.com/onenote/pages/1-a26aaec43ed348bd82edf4eb44e73d6c!68-3eb21088-b613-4698-98df-92a7d34e0678",
81
+ "createdDateTime": "2023-01-07T10:57:15Z",
82
+ "title": "Page B",
83
+ "createdByAppId": "",
84
+ "contentUrl": "https://graph.microsoft.com/v1.0/users/john@contoso.com/onenote/pages/1-a26aaec43ed348bd82edf4eb44e73d6c!68-3eb21088-b613-4698-98df-92a7d34e0678/content",
85
+ "lastModifiedDateTime": "2023-01-07T10:57:17Z",
86
+ "links": {
87
+ "oneNoteClientUrl": {
88
+ "href": "onenote:https://contoso-my.sharepoint.com/personal/john_contoso_com/Documents/Notitieblokken/My%20OneNote/Test.one#Page%20B&section-id=94cacaca-d6b5-428d-b967-d3cf01b95c28&page-id=46a1b220-7ffd-4512-a571-55322097c08d&end"
89
+ },
90
+ "oneNoteWebUrl": {
91
+ "href": "https://contoso-my.sharepoint.com/personal/john_contoso_com/Documents/Notitieblokken/My%20OneNote?wd=target%28Test.one%7C94cacaca-d6b5-428d-b967-d3cf01b95c28%2FPage%20B%7C46a1b220-7ffd-4512-a571-55322097c08d%2F%29"
92
+ }
93
+ },
94
+ "parentSection": {
95
+ "id": "1-3eb21088-b613-4698-98df-92a7d34e0678",
96
+ "displayName": "Test",
97
+ "self": "https://graph.microsoft.com/v1.0/users/john@contoso.com/onenote/sections/1-3eb21088-b613-4698-98df-92a7d34e0678"
98
+ }
99
+ }
100
+ ]
101
+ ```
102
+
103
+ === "Text"
104
+
105
+ ```text
106
+ createdDateTime title id
107
+ -------------------- ------ --------------------------------------------------------------------------
108
+ 2023-01-07T10:57:15Z Page B 1-a26aaec43ed348bd82edf4eb44e73d6c!68-3eb21088-b613-4698-98df-92a7d34e0678
109
+ ```
110
+
111
+ === "CSV"
112
+
113
+ ```csv
114
+ createdDateTime,title,id
115
+ 2023-01-07T10:57:15Z,Page B,1-a26aaec43ed348bd82edf4eb44e73d6c!68-3eb21088-b613-4698-98df-92a7d34e0678
116
+ ```
117
+
118
+ === "Markdown"
119
+
120
+ ```md
121
+ # onenote page list --userName "mathijs@mathijsdev2.onmicrosoft.com"
122
+
123
+ Date: 07/01/2023
124
+
125
+ ## Page A (1-a26aaec43ed348bd82edf4eb44e73d6c!14-3eb21088-b613-4698-98df-92a7d34e0678)
126
+
127
+ ## Page B (1-a26aaec43ed348bd82edf4eb44e73d6c!68-3eb21088-b613-4698-98df-92a7d34e0678)
128
+
129
+ Property | Value
130
+ ---------|-------
131
+ id | 1-a26aaec43ed348bd82edf4eb44e73d6c!68-3eb21088-b613-4698-98df-92a7d34e0678
132
+ self | https://graph.microsoft.com/v1.0/users/john@contoso.com/onenote/pages/1-a26aaec43ed348bd82edf4eb44e73d6c!68-3eb21088-b613-4698-98df-92a7d34e0678
133
+ createdDateTime | 2023-01-07T10:57:15Z
134
+ title | Page B
135
+ createdByAppId |
136
+ contentUrl | https://graph.microsoft.com/v1.0/users/john@contoso.com/onenote/pages/1-a26aaec43ed348bd82edf4eb44e73d6c!68-3eb21088-b613-4698-98df-92a7d34e0678/content
137
+ lastModifiedDateTime | 2023-01-07T10:57:17Z
138
+ links | { "oneNoteClientUrl": { "href": "onenote:https://contoso-my.sharepoint.com/personal/john_contoso_com/Documents/Notitieblokken/My%20OneNote/Test.one#Page%20B& -id=94cacaca-d6b5-428d-b967-d3cf01b95c28&page-id=46a1b220-7ffd-4512-a571-55322097c08d&end" }, "oneNoteWebUrl": { "href": "https://contoso-my.sharepoint.com/personal/john_contoso_com/Documents/Notitieblokken/My%20OneNote?wd=target%28Test.one%7C94cacaca-d6b5-428d-b967-d3cf01b95c28%2FPage%20B%7C46a1b220-7ffd-4512-a571-55322097c08d%2F%29"}}
139
+ parentSection | {"id":"1-3eb21088-b613-4698-98df-92a7d34e0678","displayName":"Test","self":"https://graph.microsoft.com/v1.0/users/john@contoso.com/onenote/sections/1-3eb21088-b613-4698-98df-92a7d34e0678"}
140
+ ```
@@ -72,3 +72,20 @@ m365 planner bucket add --name "My Planner Bucket" --planTitle "My Planner Plan"
72
72
  id,name,planId,orderHint
73
73
  ttEB_Uj690STdR3GC1MIDZgANq1U,My Planner Bucket,xqQg5FS2LkCp935s-FIFm2QAFkHM,8585363889524958496
74
74
  ```
75
+
76
+ === "Markdown"
77
+
78
+ ```md
79
+ # planner bucket add --name "My Planner Bucket" --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM"
80
+
81
+ Date: 27/12/2022
82
+
83
+ ## My Planner Bucket (ttEB_Uj690STdR3GC1MIDZgANq1U)
84
+
85
+ Property | Value
86
+ ---------|-------
87
+ name | My Planner Bucket
88
+ planId | xqQg5FS2LkCp935s-FIFm2QAFkHM
89
+ orderHint | 8585363889524958496
90
+ id | ttEB_Uj690STdR3GC1MIDZgANq1U
91
+ ```
@@ -84,3 +84,20 @@ m365 planner bucket get --name "Planner Bucket A" --planTitle "My Plan" --ownerG
84
84
  id,name,planId,orderHint
85
85
  ttEB_Uj690STdR3GC1MIDZgANq1U,My Planner Bucket,xqQg5FS2LkCp935s-FIFm2QAFkHM,8585363889524958496
86
86
  ```
87
+
88
+ === "Markdown"
89
+
90
+ ```md
91
+ # planner bucket get --id "ttEB_Uj690STdR3GC1MIDZgANq1U"
92
+
93
+ Date: 27/12/2022
94
+
95
+ ## My Planner Bucket (ttEB_Uj690STdR3GC1MIDZgANq1U)
96
+
97
+ Property | Value
98
+ ---------|-------
99
+ name | My Planner Bucket
100
+ planId | xqQg5FS2LkCp935s-FIFm2QAFkHM
101
+ orderHint | 8585363889524958496
102
+ id | ttEB_Uj690STdR3GC1MIDZgANq1U
103
+ ```
@@ -67,3 +67,20 @@ m365 planner bucket list --planTitle "My Plan" --ownerGroupName "My Group"
67
67
  id,name,planId,orderHint
68
68
  ttEB_Uj690STdR3GC1MIDZgANq1U,My Planner Bucket,xqQg5FS2LkCp935s-FIFm2QAFkHM,8585363889524958496
69
69
  ```
70
+
71
+ === "Markdown"
72
+
73
+ ```md
74
+ # planner bucket list --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM"
75
+
76
+ Date: 27/12/2022
77
+
78
+ ## My Planner Bucket (ttEB_Uj690STdR3GC1MIDZgANq1U)
79
+
80
+ Property | Value
81
+ ---------|-------
82
+ name | My Planner Bucket
83
+ planId | xqQg5FS2LkCp935s-FIFm2QAFkHM
84
+ orderHint | 8585363889524958496
85
+ id | ttEB_Uj690STdR3GC1MIDZgANq1U
86
+ ```
@@ -97,6 +97,25 @@ m365 planner plan add --title 'My Planner Plan' --ownerGroupName 'My Planner Gro
97
97
  xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
98
98
  ```
99
99
 
100
+ === "Markdown"
101
+
102
+ ```md
103
+ # planner plan add --title "My Planner Plan" --ownerGroupId "ebf3b108-5234-4e22-b93d-656d7dae5874"
104
+
105
+ Date: 30/03/2015
106
+
107
+ ## My Planner Plan (xqQg5FS2LkCp935s-FIFm2QAFkHM)
108
+
109
+ Property | Value
110
+ ---------|-------
111
+ createdDateTime | 2015-03-30T18:36:49.2407981Z
112
+ owner | ebf3b108-5234-4e22-b93d-656d7dae5874
113
+ title | My Planner Plan
114
+ id | xqQg5FS2LkCp935s-FIFm2QAFkHM
115
+ createdBy | {"user":{"displayName":null,"id":"95e27074-6c4a-447a-aa24-9d718a0b86fa"},"application":{"displayName":null,"id":"ebf3b108-5234-4e22-b93d-656d7dae5874"}}
116
+ container | {"containerId":"ebf3b108-5234-4e22-b93d-656d7dae5874","type":"group","url":"https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"}
117
+ ```
118
+
100
119
  ### `shareWithUserIds`, `shareWithUserNames` response
101
120
 
102
121
  When we make use of the option `shareWithUserIds` or `shareWithUserNames` the response will differ.
@@ -173,3 +192,24 @@ When we make use of the option `shareWithUserIds` or `shareWithUserNames` the re
173
192
  id,title,createdDateTime,owner
174
193
  xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
175
194
  ```
195
+
196
+ === "Markdown"
197
+
198
+ ```md
199
+ # planner plan add --title "My Planner Plan" --ownerGroupId "ebf3b108-5234-4e22-b93d-656d7dae5874" --shareWithUserNames "Allan.Carroll@contoso.com,Ida.Stevens@contoso.com"
200
+
201
+ Date: 30/03/2015
202
+
203
+ ## My Planner Plan (xqQg5FS2LkCp935s-FIFm2QAFkHM)
204
+
205
+ Property | Value
206
+ ---------|-------
207
+ createdDateTime | 2015-03-30T18:36:49.2407981Z
208
+ owner | ebf3b108-5234-4e22-b93d-656d7dae5874
209
+ title | My Planner Plan
210
+ id | xqQg5FS2LkCp935s-FIFm2QAFkHM
211
+ createdBy | {"user":{"displayName":null,"id":"dd8b99a7-77c6-4238-a609-396d27844921"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
212
+ container | {"containerId":"ebf3b108-5234-4e22-b93d-656d7dae5874","type":"group","url":"https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"}
213
+ sharedWith | {"ebf3b108-5234-4e22-b93d-656d7dae5874":true,"6463a5ce-2119-4198-9f2a-628761df4a62":true}
214
+ categoryDescriptions | {"category1":null,"category2":null,"category3":null,"category4":null,"category5":null,"category6":null,"category7":null,"category8":null,"category9":null,"category10":null,"category11":null,"category12":null,"category13":null,"category14":null,"category15":null,"category16":null,"category17":null,"category18":null,"category19":null,"category20":null,"category21":null,"category22":null,"category23":null,"category24":null,"category25":null}
215
+ ```
@@ -118,3 +118,24 @@ m365 planner plan get --title "MyPlan" --ownerGroupName "My Planner Group"
118
118
  id,title,createdDateTime,owner
119
119
  xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
120
120
  ```
121
+
122
+ === "Markdown"
123
+
124
+ ```md
125
+ # planner plan get --id "xqQg5FS2LkCp935s-FIFm2QAFkHM"
126
+
127
+ Date: 27/12/2022
128
+
129
+ ## My Planner Plan (xqQg5FS2LkCp935s-FIFm2QAFkHM)
130
+
131
+ Property | Value
132
+ ---------|-------
133
+ createdDateTime | 2015-03-30T18:36:49.2407981Z
134
+ owner | ebf3b108-5234-4e22-b93d-656d7dae5874
135
+ title | My Planner Plan
136
+ id | xqQg5FS2LkCp935s-FIFm2QAFkHM
137
+ createdBy | {"user":{"displayName":null,"id":"dd8b99a7-77c6-4238-a609-396d27844921"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
138
+ container | {"containerId":"ebf3b108-5234-4e22-b93d-656d7dae5874","type":"group","url":"https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"}
139
+ sharedWith | {"aa089c1a-0ca8-4b36-ae2e-c5d60f054a2c":true,"ebf3b108-5234-4e22-b93d-656d7dae5874":true}
140
+ categoryDescriptions | {"category1":null,"category2":null,"category3":null,"category4":null,"category5":null,"category6":null,"category7":null,"category8":null,"category9":null,"category10":null,"category11":null,"category12":null,"category13":null,"category14":null,"category15":null,"category16":null,"category17":null,"category18":null,"category19":null,"category20":null,"category21":null,"category22":null,"category23":null,"category24":null,"category25":null}
141
+ ```
@@ -76,3 +76,22 @@ m365 planner plan list --ownerGroupName "My Planner Group"
76
76
  id,title,createdDateTime,owner
77
77
  xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
78
78
  ```
79
+
80
+ === "Markdown"
81
+
82
+ ```md
83
+ # planner plan list --ownerGroupId "ebf3b108-5234-4e22-b93d-656d7dae5874"
84
+
85
+ Date: 27/12/2022
86
+
87
+ ## My Planner Plan (xqQg5FS2LkCp935s-FIFm2QAFkHM)
88
+
89
+ Property | Value
90
+ ---------|-------
91
+ createdDateTime | 2021-12-12T14:00:50.4522129Z
92
+ owner | ebf3b108-5234-4e22-b93d-656d7dae5874
93
+ title | My Planner Plan
94
+ id | xqQg5FS2LkCp935s-FIFm2QAFkHM
95
+ createdBy | {"user":{"displayName":null,"id":"dd8b99a7-77c6-4238-a609-396d27844921"},"application":{"displayName":null,"id":"09abbdfd-ed23-44ee-a2d9-a627aa1c90f3"}}
96
+ container | {"containerId":"ebf3b108-5234-4e22-b93d-656d7dae5874","type":"group","url":"https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"}
97
+ ```
@@ -142,3 +142,23 @@ m365 planner plan set --id 'gndWOTSK60GfPQfiDDj43JgACDCb' --category21 'ToDo' --
142
142
  xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
143
143
  ```
144
144
 
145
+ === "Markdown"
146
+
147
+ ```md
148
+ # planner plan set --id "xqQg5FS2LkCp935s-FIFm2QAFkHM" --newTitle "My Planner Plan"
149
+
150
+ Date: 27/12/2022
151
+
152
+ ## My Planner Plan (xqQg5FS2LkCp935s-FIFm2QAFkHM)
153
+
154
+ Property | Value
155
+ ---------|-------
156
+ createdDateTime | 2015-03-30T18:36:49.2407981Z
157
+ owner | ebf3b108-5234-4e22-b93d-656d7dae5874
158
+ title | My Planner Plan
159
+ id | xqQg5FS2LkCp935s-FIFm2QAFkHM
160
+ createdBy | {"user":{"displayName":null,"id":"dd8b99a7-77c6-4238-a609-396d27844921"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
161
+ container | {"containerId":"ebf3b108-5234-4e22-b93d-656d7dae5874","type":"group","url":"https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"}
162
+ sharedWith | {"ebf3b108-5234-4e22-b93d-656d7dae5874":true,"6463a5ce-2119-4198-9f2a-628761df4a62":true}
163
+ categoryDescriptions | {"category1":null,"category2":null,"category3":null,"category4":null,"category5":null,"category6":null,"category7":null,"category8":null,"category9":null,"category10":null,"category11":null,"category12":null,"category13":null,"category14":null,"category15":null,"category16":null,"category17":null,"category18":null,"category19":null,"category20":null,"category21":null,"category22":null,"category23":null,"category24":null,"category25":null}
164
+ ```