@pnp/cli-microsoft365 6.1.0 → 6.2.0-beta.02615ee

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 (63) hide show
  1. package/.eslintrc.js +6 -0
  2. package/dist/m365/aad/commands/approleassignment/approleassignment-add.js +3 -0
  3. package/dist/m365/onenote/commands/page/page-list.js +137 -0
  4. package/dist/m365/onenote/commands.js +2 -1
  5. package/dist/m365/pp/commands/aibuildermodel/aibuildermodel-get.js +110 -0
  6. package/dist/m365/pp/commands/aibuildermodel/aibuildermodel-list.js +68 -0
  7. package/dist/m365/pp/commands/aibuildermodel/aibuildermodel-remove.js +130 -0
  8. package/dist/m365/pp/commands.js +3 -0
  9. package/dist/m365/purview/commands/retentionlabel/retentionlabel-add.js +143 -0
  10. package/dist/m365/purview/commands/retentionlabel/retentionlabel-get.js +70 -0
  11. package/dist/m365/purview/commands.js +2 -0
  12. package/dist/m365/spo/commands/file/GraphFileDetails.js +3 -0
  13. package/dist/m365/spo/commands/file/file-sharinginfo-get.js +12 -12
  14. package/dist/m365/spo/commands/file/file-sharinglink-get.js +116 -0
  15. package/dist/m365/spo/commands/file/file-sharinglink-list.js +133 -0
  16. package/dist/m365/spo/commands/file/file-sharinglink-remove.js +135 -0
  17. package/dist/m365/spo/commands/group/group-member-add.js +33 -6
  18. package/dist/m365/spo/commands/group/group-member-remove.js +78 -33
  19. package/dist/m365/spo/commands/list/list-retentionlabel-ensure.js +10 -2
  20. package/dist/m365/spo/commands/listitem/ListItemRetentionLabel.js +3 -0
  21. package/dist/m365/spo/commands/listitem/SiteRetentionLabel.js +3 -0
  22. package/dist/m365/spo/commands/listitem/listitem-list.js +1 -1
  23. package/dist/m365/spo/commands/listitem/listitem-record-lock.js +129 -0
  24. package/dist/m365/spo/commands/listitem/listitem-record-unlock.js +129 -0
  25. package/dist/m365/spo/commands/listitem/listitem-retentionlabel-ensure.js +161 -0
  26. package/dist/m365/spo/commands/term/term-list.js +99 -29
  27. package/dist/m365/spo/commands.js +6 -0
  28. package/dist/m365/teams/commands/chat/chat-list.js +29 -7
  29. package/dist/request.js +2 -2
  30. package/docs/docs/cmd/onenote/page/page-list.md +140 -0
  31. package/docs/docs/cmd/planner/bucket/bucket-add.md +17 -0
  32. package/docs/docs/cmd/planner/bucket/bucket-get.md +17 -0
  33. package/docs/docs/cmd/planner/bucket/bucket-list.md +17 -0
  34. package/docs/docs/cmd/planner/plan/plan-add.md +40 -0
  35. package/docs/docs/cmd/planner/plan/plan-get.md +21 -0
  36. package/docs/docs/cmd/planner/plan/plan-list.md +19 -0
  37. package/docs/docs/cmd/planner/plan/plan-set.md +20 -0
  38. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-get.md +99 -0
  39. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-list.md +95 -0
  40. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-remove.md +53 -0
  41. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-add.md +128 -0
  42. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-get.md +95 -0
  43. package/docs/docs/cmd/spo/cdn/cdn-get.md +1 -1
  44. package/docs/docs/cmd/spo/cdn/cdn-origin-add.md +1 -1
  45. package/docs/docs/cmd/spo/cdn/cdn-origin-list.md +1 -1
  46. package/docs/docs/cmd/spo/cdn/cdn-origin-remove.md +1 -1
  47. package/docs/docs/cmd/spo/cdn/cdn-policy-list.md +1 -1
  48. package/docs/docs/cmd/spo/cdn/cdn-policy-set.md +1 -1
  49. package/docs/docs/cmd/spo/cdn/cdn-set.md +1 -1
  50. package/docs/docs/cmd/spo/file/file-sharinglink-get.md +107 -0
  51. package/docs/docs/cmd/spo/file/file-sharinglink-list.md +106 -0
  52. package/docs/docs/cmd/spo/file/file-sharinglink-remove.md +52 -0
  53. package/docs/docs/cmd/spo/group/group-member-add.md +22 -4
  54. package/docs/docs/cmd/spo/group/group-member-remove.md +24 -6
  55. package/docs/docs/cmd/spo/list/list-retentionlabel-ensure.md +8 -5
  56. package/docs/docs/cmd/spo/listitem/listitem-list.md +5 -5
  57. package/docs/docs/cmd/spo/listitem/listitem-record-lock.md +52 -0
  58. package/docs/docs/cmd/spo/listitem/listitem-record-unlock.md +52 -0
  59. package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-ensure.md +58 -0
  60. package/docs/docs/cmd/spo/term/term-list.md +138 -0
  61. package/docs/docs/cmd/teams/chat/chat-list.md +16 -4
  62. package/npm-shrinkwrap.json +184 -204
  63. package/package.json +13 -12
@@ -30,7 +30,7 @@ class SpoTermListCommand extends SpoCommand_1.default {
30
30
  return 'Lists taxonomy terms from the given term set';
31
31
  }
32
32
  defaultProperties() {
33
- return ['Id', 'Name'];
33
+ return ['Id', 'Name', 'ParentTermId'];
34
34
  }
35
35
  constructor() {
36
36
  super();
@@ -50,27 +50,47 @@ class SpoTermListCommand extends SpoCommand_1.default {
50
50
  }
51
51
  const termGroupQuery = args.options.termGroupId ? `<Method Id="77" ParentId="75" Name="GetById"><Parameters><Parameter Type="Guid">{${args.options.termGroupId}}</Parameter></Parameters></Method>` : `<Method Id="77" ParentId="75" Name="GetByName"><Parameters><Parameter Type="String">${formatting_1.formatting.escapeXml(args.options.termGroupName)}</Parameter></Parameters></Method>`;
52
52
  const termSetQuery = args.options.termSetId ? `<Method Id="82" ParentId="80" Name="GetById"><Parameters><Parameter Type="Guid">{${args.options.termSetId}}</Parameter></Parameters></Method>` : `<Method Id="82" ParentId="80" Name="GetByName"><Parameters><Parameter Type="String">${formatting_1.formatting.escapeXml(args.options.termSetName)}</Parameter></Parameters></Method>`;
53
- const requestOptions = {
54
- url: `${spoAdminUrl}/_vti_bin/client.svc/ProcessQuery`,
55
- headers: {
56
- 'X-RequestDigest': res.FormDigestValue
57
- },
58
- data: `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config_1.default.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions><ObjectPath Id="70" ObjectPathId="69" /><ObjectIdentityQuery Id="71" ObjectPathId="69" /><ObjectPath Id="73" ObjectPathId="72" /><ObjectIdentityQuery Id="74" ObjectPathId="72" /><ObjectPath Id="76" ObjectPathId="75" /><ObjectPath Id="78" ObjectPathId="77" /><ObjectIdentityQuery Id="79" ObjectPathId="77" /><ObjectPath Id="81" ObjectPathId="80" /><ObjectPath Id="83" ObjectPathId="82" /><ObjectIdentityQuery Id="84" ObjectPathId="82" /><ObjectPath Id="86" ObjectPathId="85" /><Query Id="87" ObjectPathId="85"><Query SelectAllProperties="false"><Properties /></Query><ChildItemQuery SelectAllProperties="true"><Properties><Property Name="Name" ScalarProperty="true" /><Property Name="Id" ScalarProperty="true" /></Properties></ChildItemQuery></Query></Actions><ObjectPaths><StaticMethod Id="69" Name="GetTaxonomySession" TypeId="{981cbc68-9edc-4f8d-872f-71146fcbb84f}" /><Method Id="72" ParentId="69" Name="GetDefaultSiteCollectionTermStore" /><Property Id="75" ParentId="72" Name="Groups" />${termGroupQuery}<Property Id="80" ParentId="77" Name="TermSets" />${termSetQuery}<Property Id="85" ParentId="82" Name="Terms" /></ObjectPaths></Request>`
59
- };
60
- const processQuery = yield request_1.default.post(requestOptions);
61
- const json = JSON.parse(processQuery);
62
- const response = json[0];
63
- if (response.ErrorInfo) {
64
- throw response.ErrorInfo.ErrorMessage;
65
- }
66
- const result = json[json.length - 1];
53
+ const data = `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config_1.default.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions><ObjectPath Id="70" ObjectPathId="69" /><ObjectIdentityQuery Id="71" ObjectPathId="69" /><ObjectPath Id="73" ObjectPathId="72" /><ObjectIdentityQuery Id="74" ObjectPathId="72" /><ObjectPath Id="76" ObjectPathId="75" /><ObjectPath Id="78" ObjectPathId="77" /><ObjectIdentityQuery Id="79" ObjectPathId="77" /><ObjectPath Id="81" ObjectPathId="80" /><ObjectPath Id="83" ObjectPathId="82" /><ObjectIdentityQuery Id="84" ObjectPathId="82" /><ObjectPath Id="86" ObjectPathId="85" /><Query Id="87" ObjectPathId="85"><Query SelectAllProperties="false"><Properties /></Query><ChildItemQuery SelectAllProperties="true"><Properties><Property Name="Name" ScalarProperty="true" /><Property Name="Id" ScalarProperty="true" /></Properties></ChildItemQuery></Query></Actions><ObjectPaths><StaticMethod Id="69" Name="GetTaxonomySession" TypeId="{981cbc68-9edc-4f8d-872f-71146fcbb84f}" /><Method Id="72" ParentId="69" Name="GetDefaultSiteCollectionTermStore" /><Property Id="75" ParentId="72" Name="Groups" />${termGroupQuery}<Property Id="80" ParentId="77" Name="TermSets" />${termSetQuery}<Property Id="85" ParentId="82" Name="Terms" /></ObjectPaths></Request>`;
54
+ const result = yield this.executeCsomCall(data, spoAdminUrl, res);
55
+ const terms = [];
67
56
  if (result._Child_Items_ && result._Child_Items_.length > 0) {
68
- result._Child_Items_.forEach(t => {
69
- t.CreatedDate = new Date(Number(t.CreatedDate.replace('/Date(', '').replace(')/', ''))).toISOString();
70
- t.Id = t.Id.replace('/Guid(', '').replace(')/', '');
71
- t.LastModifiedDate = new Date(Number(t.LastModifiedDate.replace('/Date(', '').replace(')/', ''))).toISOString();
57
+ for (const term of result._Child_Items_) {
58
+ this.setTermDetails(term);
59
+ terms.push(term);
60
+ if (args.options.includeChildTerms && term.TermsCount > 0) {
61
+ yield this.getChildTerms(spoAdminUrl, res, term);
62
+ }
63
+ }
64
+ }
65
+ if (!args.options.output || args.options.output === 'json') {
66
+ logger.log(terms);
67
+ }
68
+ else if (!args.options.includeChildTerms) {
69
+ // Converted to text friendly output
70
+ logger.log(terms.map(i => {
71
+ return {
72
+ Id: i.Id,
73
+ Name: i.Name
74
+ };
75
+ }));
76
+ }
77
+ else {
78
+ // Converted to text friendly output
79
+ const friendlyOutput = [];
80
+ terms.forEach(term => {
81
+ term.ParentTermId = '';
82
+ friendlyOutput.push(term);
83
+ if (term.Children && term.Children.length > 0) {
84
+ this.getFriendlyChildTerms(term, friendlyOutput);
85
+ }
72
86
  });
73
- logger.log(result._Child_Items_);
87
+ logger.log(friendlyOutput.map(i => {
88
+ return {
89
+ Id: i.Id,
90
+ Name: i.Name,
91
+ ParentTermId: i.ParentTermId
92
+ };
93
+ }));
74
94
  }
75
95
  }
76
96
  catch (err) {
@@ -78,6 +98,57 @@ class SpoTermListCommand extends SpoCommand_1.default {
78
98
  }
79
99
  });
80
100
  }
101
+ getFriendlyChildTerms(term, friendlyOutput) {
102
+ term.Children.forEach(childTerm => {
103
+ childTerm.ParentTermId = term.Id;
104
+ friendlyOutput.push(childTerm);
105
+ if (childTerm.Children && childTerm.Children.length > 0) {
106
+ this.getFriendlyChildTerms(childTerm, friendlyOutput);
107
+ }
108
+ });
109
+ }
110
+ getChildTerms(spoAdminUrl, res, parentTerm) {
111
+ return __awaiter(this, void 0, void 0, function* () {
112
+ parentTerm.Children = [];
113
+ const data = `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config_1.default.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions><ObjectPath Id="20" ObjectPathId="19" /><Query Id="21" ObjectPathId="19"><Query SelectAllProperties="false"><Properties /></Query><ChildItemQuery SelectAllProperties="true"><Properties><Property Name="CustomSortOrder" ScalarProperty="true" /><Property Name="CustomProperties" ScalarProperty="true" /><Property Name="LocalCustomProperties" ScalarProperty="true" /></Properties></ChildItemQuery></Query></Actions><ObjectPaths><Property Id="19" ParentId="16" Name="Terms" /><Identity Id="16" Name="${parentTerm._ObjectIdentity_}" /></ObjectPaths></Request>`;
114
+ const result = yield this.executeCsomCall(data, spoAdminUrl, res);
115
+ if (result._Child_Items_ && result._Child_Items_.length > 0) {
116
+ for (const term of result._Child_Items_) {
117
+ this.setTermDetails(term);
118
+ parentTerm.Children.push(term);
119
+ if (term.TermsCount > 0) {
120
+ yield this.getChildTerms(spoAdminUrl, res, term);
121
+ }
122
+ }
123
+ }
124
+ });
125
+ }
126
+ setTermDetails(term) {
127
+ term.CreatedDate = this.parseTermDateToIsoString(term.CreatedDate);
128
+ term.Id = term.Id.replace('/Guid(', '').replace(')/', '');
129
+ term.LastModifiedDate = this.parseTermDateToIsoString(term.LastModifiedDate);
130
+ }
131
+ parseTermDateToIsoString(dateAsString) {
132
+ return new Date(Number(dateAsString.replace('/Date(', '').replace(')/', ''))).toISOString();
133
+ }
134
+ executeCsomCall(data, spoAdminUrl, res) {
135
+ return __awaiter(this, void 0, void 0, function* () {
136
+ const requestOptions = {
137
+ url: `${spoAdminUrl}/_vti_bin/client.svc/ProcessQuery`,
138
+ headers: {
139
+ 'X-RequestDigest': res.FormDigestValue
140
+ },
141
+ data: data
142
+ };
143
+ const processQuery = yield request_1.default.post(requestOptions);
144
+ const json = JSON.parse(processQuery);
145
+ const response = json[0];
146
+ if (response.ErrorInfo) {
147
+ throw response.ErrorInfo.ErrorMessage;
148
+ }
149
+ return json[json.length - 1];
150
+ });
151
+ }
81
152
  }
82
153
  _SpoTermListCommand_instances = new WeakSet(), _SpoTermListCommand_initTelemetry = function _SpoTermListCommand_initTelemetry() {
83
154
  this.telemetry.push((args) => {
@@ -85,7 +156,8 @@ _SpoTermListCommand_instances = new WeakSet(), _SpoTermListCommand_initTelemetry
85
156
  termGroupId: typeof args.options.termGroupId !== 'undefined',
86
157
  termGroupName: typeof args.options.termGroupName !== 'undefined',
87
158
  termSetId: typeof args.options.termSetId !== 'undefined',
88
- termSetName: typeof args.options.termSetName !== 'undefined'
159
+ termSetName: typeof args.options.termSetName !== 'undefined',
160
+ includeChildTerms: !!args.options.includeChildTerms
89
161
  });
90
162
  });
91
163
  }, _SpoTermListCommand_initOptions = function _SpoTermListCommand_initOptions() {
@@ -97,18 +169,16 @@ _SpoTermListCommand_instances = new WeakSet(), _SpoTermListCommand_initTelemetry
97
169
  option: '--termSetId [termSetId]'
98
170
  }, {
99
171
  option: '--termSetName [termSetName]'
172
+ }, {
173
+ option: '--includeChildTerms'
100
174
  });
101
175
  }, _SpoTermListCommand_initValidators = function _SpoTermListCommand_initValidators() {
102
176
  this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
103
- if (args.options.termGroupId) {
104
- if (!validation_1.validation.isValidGuid(args.options.termGroupId)) {
105
- return `${args.options.termGroupId} is not a valid GUID`;
106
- }
177
+ if (args.options.termGroupId && !validation_1.validation.isValidGuid(args.options.termGroupId)) {
178
+ return `${args.options.termGroupId} is not a valid GUID`;
107
179
  }
108
- if (args.options.termSetId) {
109
- if (!validation_1.validation.isValidGuid(args.options.termSetId)) {
110
- return `${args.options.termSetId} is not a valid GUID`;
111
- }
180
+ if (args.options.termSetId && !validation_1.validation.isValidGuid(args.options.termSetId)) {
181
+ return `${args.options.termSetId} is not a valid GUID`;
112
182
  }
113
183
  return true;
114
184
  }));
@@ -62,6 +62,9 @@ exports.default = {
62
62
  FILE_ROLEINHERITANCE_BREAK: `${prefix} file roleinheritance break`,
63
63
  FILE_ROLEINHERITANCE_RESET: `${prefix} file roleinheritance reset`,
64
64
  FILE_SHARINGINFO_GET: `${prefix} file sharinginfo get`,
65
+ FILE_SHARINGLINK_GET: `${prefix} file sharinglink get`,
66
+ FILE_SHARINGLINK_LIST: `${prefix} file sharinglink list`,
67
+ FILE_SHARINGLINK_REMOVE: `${prefix} file sharinglink remove`,
65
68
  FILE_VERSION_CLEAR: `${prefix} file version clear`,
66
69
  FILE_VERSION_GET: `${prefix} file version get`,
67
70
  FILE_VERSION_LIST: `${prefix} file version list`,
@@ -143,8 +146,11 @@ exports.default = {
143
146
  LISTITEM_ISRECORD: `${prefix} listitem isrecord`,
144
147
  LISTITEM_LIST: `${prefix} listitem list`,
145
148
  LISTITEM_RECORD_DECLARE: `${prefix} listitem record declare`,
149
+ LISTITEM_RECORD_LOCK: `${prefix} listitem record lock`,
146
150
  LISTITEM_RECORD_UNDECLARE: `${prefix} listitem record undeclare`,
151
+ LISTITEM_RECORD_UNLOCK: `${prefix} listitem record unlock`,
147
152
  LISTITEM_REMOVE: `${prefix} listitem remove`,
153
+ LISTITEM_RETENTIONLABEL_ENSURE: `${prefix} listitem retentionlabel ensure`,
148
154
  LISTITEM_RETENTIONLABEL_REMOVE: `${prefix} listitem retentionlabel remove`,
149
155
  LISTITEM_ROLEASSIGNMENT_ADD: `${prefix} listitem roleassignment add`,
150
156
  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
  }));
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 &&
@@ -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
+ ```