@pnp/cli-microsoft365 5.9.0-beta.60e454b → 5.9.0-beta.77d7f6b

package/dist/m365/spo/commands/listitem/listitem-roleassignment-add.js

@@ -0,0 +1,239 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    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");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _SpoListItemRoleAssignmentAddCommand_instances, _SpoListItemRoleAssignmentAddCommand_initTelemetry, _SpoListItemRoleAssignmentAddCommand_initOptions, _SpoListItemRoleAssignmentAddCommand_initValidators;
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const SpoCommand_1 = require("../../../base/SpoCommand");
+const commands_1 = require("../../commands");
+const SpoUserGetCommand = require("../user/user-get");
+const SpoGroupGetCommand = require("../group/group-get");
+const SpoRoleDefinitionListCommand = require("../roledefinition/roledefinition-list");
+const validation_1 = require("../../../../utils/validation");
+const formatting_1 = require("../../../../utils/formatting");
+const urlUtil_1 = require("../../../../utils/urlUtil");
+const Cli_1 = require("../../../../cli/Cli");
+class SpoListItemRoleAssignmentAddCommand extends SpoCommand_1.default {
+    constructor() {
+        super();
+        _SpoListItemRoleAssignmentAddCommand_instances.add(this);
+        __classPrivateFieldGet(this, _SpoListItemRoleAssignmentAddCommand_instances, "m", _SpoListItemRoleAssignmentAddCommand_initTelemetry).call(this);
+        __classPrivateFieldGet(this, _SpoListItemRoleAssignmentAddCommand_instances, "m", _SpoListItemRoleAssignmentAddCommand_initOptions).call(this);
+        __classPrivateFieldGet(this, _SpoListItemRoleAssignmentAddCommand_instances, "m", _SpoListItemRoleAssignmentAddCommand_initValidators).call(this);
+    }
+    get name() {
+        return commands_1.default.LISTITEM_ROLEASSIGNMENT_ADD;
+    }
+    get description() {
+        return 'Adds a role assignment to a listitem.';
+    }
+    commandAction(logger, args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.verbose) {
+                logger.logToStderr(`Adding role assignment to listitem in site at ${args.options.webUrl}...`);
+            }
+            try {
+                let requestUrl = `${args.options.webUrl}/_api/web/`;
+                if (args.options.listId) {
+                    requestUrl += `lists(guid'${formatting_1.formatting.encodeQueryParameter(args.options.listId)}')/`;
+                }
+                else if (args.options.listTitle) {
+                    requestUrl += `lists/getByTitle('${formatting_1.formatting.encodeQueryParameter(args.options.listTitle)}')/`;
+                }
+                else if (args.options.listUrl) {
+                    const listServerRelativeUrl = urlUtil_1.urlUtil.getServerRelativePath(args.options.webUrl, args.options.listUrl);
+                    requestUrl += `GetList('${formatting_1.formatting.encodeQueryParameter(listServerRelativeUrl)}')/`;
+                }
+                requestUrl += `items(${args.options.listItemId})/`;
+                const roleDefinitionId = yield this.getRoleDefinitionId(args.options);
+                let principalId = 0;
+                if (args.options.upn) {
+                    principalId = yield this.getUserPrincipalId(args.options);
+                    yield this.addRoleAssignment(requestUrl, roleDefinitionId, principalId);
+                }
+                else if (args.options.groupName) {
+                    principalId = yield this.getGroupPrincipalId(args.options);
+                    yield this.addRoleAssignment(requestUrl, roleDefinitionId, principalId);
+                }
+                else {
+                    principalId = args.options.principalId;
+                    yield this.addRoleAssignment(requestUrl, roleDefinitionId, principalId);
+                }
+            }
+            catch (err) {
+                this.handleRejectedODataJsonPromise(err);
+            }
+        });
+    }
+    addRoleAssignment(requestUrl, roleDefinitionId, principalId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const requestOptions = {
+                    url: `${requestUrl}roleassignments/addroleassignment(principalid='${principalId}',roledefid='${roleDefinitionId}')`,
+                    method: 'POST',
+                    headers: {
+                        'accept': 'application/json;odata=nometadata',
+                        'content-type': 'application/json'
+                    },
+                    responseType: 'json'
+                };
+                yield request_1.default.post(requestOptions);
+            }
+            catch (err) {
+                return Promise.reject(err);
+            }
+        });
+    }
+    getRoleDefinitionId(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!options.roleDefinitionName) {
+                return options.roleDefinitionId;
+            }
+            try {
+                const roleDefinitionListCommandOptions = {
+                    webUrl: options.webUrl,
+                    output: 'json',
+                    debug: this.debug,
+                    verbose: this.verbose
+                };
+                const output = yield Cli_1.Cli.executeCommandWithOutput(SpoRoleDefinitionListCommand, { options: Object.assign(Object.assign({}, roleDefinitionListCommandOptions), { _: [] }) });
+                const getRoleDefinitionListOutput = JSON.parse(output.stdout);
+                const roleDefinitionId = getRoleDefinitionListOutput.find((role) => role.Name === options.roleDefinitionName).Id;
+                return roleDefinitionId;
+            }
+            catch (err) {
+                return Promise.reject(err);
+            }
+        });
+    }
+    getGroupPrincipalId(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const groupGetCommandOptions = {
+                    webUrl: options.webUrl,
+                    name: options.groupName,
+                    output: 'json',
+                    debug: this.debug,
+                    verbose: this.verbose
+                };
+                const output = yield Cli_1.Cli.executeCommandWithOutput(SpoGroupGetCommand, { options: Object.assign(Object.assign({}, groupGetCommandOptions), { _: [] }) });
+                const getGroupOutput = JSON.parse(output.stdout);
+                return getGroupOutput.Id;
+            }
+            catch (err) {
+                return Promise.reject(err);
+            }
+        });
+    }
+    getUserPrincipalId(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const userGetCommandOptions = {
+                    webUrl: options.webUrl,
+                    email: options.upn,
+                    id: undefined,
+                    output: 'json',
+                    debug: this.debug,
+                    verbose: this.verbose
+                };
+                const output = yield Cli_1.Cli.executeCommandWithOutput(SpoUserGetCommand, { options: Object.assign(Object.assign({}, userGetCommandOptions), { _: [] }) });
+                const getUserOutput = JSON.parse(output.stdout);
+                return getUserOutput.Id;
+            }
+            catch (err) {
+                return Promise.reject(err);
+            }
+        });
+    }
+}
+_SpoListItemRoleAssignmentAddCommand_instances = new WeakSet(), _SpoListItemRoleAssignmentAddCommand_initTelemetry = function _SpoListItemRoleAssignmentAddCommand_initTelemetry() {
+    this.telemetry.push((args) => {
+        Object.assign(this.telemetryProperties, {
+            listId: typeof args.options.listId !== 'undefined',
+            listTitle: typeof args.options.listTitle !== 'undefined',
+            listUrl: typeof args.options.listUrl !== 'undefined',
+            principalId: typeof args.options.principalId !== 'undefined',
+            upn: typeof args.options.upn !== 'undefined',
+            groupName: typeof args.options.groupName !== 'undefined',
+            roleDefinitionId: typeof args.options.roleDefinitionId !== 'undefined',
+            roleDefinitionName: typeof args.options.roleDefinitionName !== 'undefined'
+        });
+    });
+}, _SpoListItemRoleAssignmentAddCommand_initOptions = function _SpoListItemRoleAssignmentAddCommand_initOptions() {
+    this.options.unshift({
+        option: '-u, --webUrl <webUrl>'
+    }, {
+        option: '--listItemId <listItemId>'
+    }, {
+        option: '--listId [listId]'
+    }, {
+        option: '--listTitle [listTitle]'
+    }, {
+        option: '--listUrl [listUrl]'
+    }, {
+        option: '--principalId [principalId]'
+    }, {
+        option: '--upn [upn]'
+    }, {
+        option: '--groupName [groupName]'
+    }, {
+        option: '--roleDefinitionId [roleDefinitionId]'
+    }, {
+        option: '--roleDefinitionName [roleDefinitionName]'
+    });
+}, _SpoListItemRoleAssignmentAddCommand_initValidators = function _SpoListItemRoleAssignmentAddCommand_initValidators() {
+    this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
+        const isValidSharePointUrl = validation_1.validation.isValidSharePointUrl(args.options.webUrl);
+        if (isValidSharePointUrl !== true) {
+            return isValidSharePointUrl;
+        }
+        if (args.options.listId && !validation_1.validation.isValidGuid(args.options.listId)) {
+            return `${args.options.listId} is not a valid GUID`;
+        }
+        if (args.options.listItemId && isNaN(args.options.listItemId)) {
+            return `Specified listItemId ${args.options.listItemId} is not a number`;
+        }
+        if (args.options.principalId && isNaN(args.options.principalId)) {
+            return `Specified principalId ${args.options.principalId} is not a number`;
+        }
+        if (args.options.roleDefinitionId && isNaN(args.options.roleDefinitionId)) {
+            return `Specified roleDefinitionId ${args.options.roleDefinitionId} is not a number`;
+        }
+        const listOptions = [args.options.listId, args.options.listTitle, args.options.listUrl];
+        if (listOptions.some(item => item !== undefined) && listOptions.filter(item => item !== undefined).length > 1) {
+            return `Specify either list id or title or list url`;
+        }
+        if (listOptions.filter(item => item !== undefined).length === 0) {
+            return `Specify at least list id or title or list url`;
+        }
+        const principalOptions = [args.options.principalId, args.options.upn, args.options.groupName];
+        if (!principalOptions.some(item => item !== undefined)) {
+            return `Specify either principalId, upn or groupName`;
+        }
+        if (principalOptions.filter(item => item !== undefined).length > 1) {
+            return `Specify either principalId, upn or groupName but not multiple`;
+        }
+        const roleDefinitionOptions = [args.options.roleDefinitionId, args.options.roleDefinitionName];
+        if (!roleDefinitionOptions.some(item => item !== undefined)) {
+            return `Specify either roleDefinitionId or roleDefinitionName`;
+        }
+        if (roleDefinitionOptions.filter(item => item !== undefined).length > 1) {
+            return `Specify either roleDefinitionId or roleDefinitionName but not multiple`;
+        }
+        return true;
+    }));
+};
+module.exports = new SpoListItemRoleAssignmentAddCommand();
+//# sourceMappingURL=listitem-roleassignment-add.js.map

package/dist/m365/spo/commands.js

@@ -137,6 +137,7 @@ exports.default = {
     LISTITEM_RECORD_DECLARE: `${prefix} listitem record declare`,
     LISTITEM_RECORD_UNDECLARE: `${prefix} listitem record undeclare`,
     LISTITEM_REMOVE: `${prefix} listitem remove`,
+    LISTITEM_ROLEASSIGNMENT_ADD: `${prefix} listitem roleassignment add`,
     LISTITEM_ROLEASSIGNMENT_REMOVE: `${prefix} listitem roleassignment remove`,
     LISTITEM_ROLEINHERITANCE_BREAK: `${prefix} listitem roleinheritance break`,
     LISTITEM_ROLEINHERITANCE_RESET: `${prefix} listitem roleinheritance reset`,

package/dist/m365/todo/commands/task/task-add.js

@@ -13,9 +13,10 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     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");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _TodoTaskAddCommand_instances, _TodoTaskAddCommand_initTelemetry, _TodoTaskAddCommand_initOptions, _TodoTaskAddCommand_initOptionSets;
+var _TodoTaskAddCommand_instances, _TodoTaskAddCommand_initTelemetry, _TodoTaskAddCommand_initOptions, _TodoTaskAddCommand_initValidators, _TodoTaskAddCommand_initOptionSets;
 Object.defineProperty(exports, "__esModule", { value: true });
 const request_1 = require("../../../../request");
+const validation_1 = require("../../../../utils/validation");
 const GraphCommand_1 = require("../../../base/GraphCommand");
 const commands_1 = require("../../commands");
 class TodoTaskAddCommand extends GraphCommand_1.default {
@@ -24,6 +25,7 @@ class TodoTaskAddCommand extends GraphCommand_1.default {
         _TodoTaskAddCommand_instances.add(this);
         __classPrivateFieldGet(this, _TodoTaskAddCommand_instances, "m", _TodoTaskAddCommand_initTelemetry).call(this);
         __classPrivateFieldGet(this, _TodoTaskAddCommand_instances, "m", _TodoTaskAddCommand_initOptions).call(this);
+        __classPrivateFieldGet(this, _TodoTaskAddCommand_instances, "m", _TodoTaskAddCommand_initValidators).call(this);
         __classPrivateFieldGet(this, _TodoTaskAddCommand_instances, "m", _TodoTaskAddCommand_initOptionSets).call(this);
     }
     get name() {
@@ -33,6 +35,7 @@ class TodoTaskAddCommand extends GraphCommand_1.default {
         return 'Add a task to a Microsoft To Do task list';
     }
     commandAction(logger, args) {
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const endpoint = `${this.resource}/v1.0`;
             try {
@@ -44,7 +47,14 @@ class TodoTaskAddCommand extends GraphCommand_1.default {
                         'Content-Type': 'application/json'
                     },
                     data: {
-                        title: args.options.title
+                        title: args.options.title,
+                        body: {
+                            content: args.options.bodyContent,
+                            contentType: ((_a = args.options.bodyContentType) === null || _a === void 0 ? void 0 : _a.toLowerCase()) || 'text'
+                        },
+                        importance: (_b = args.options.importance) === null || _b === void 0 ? void 0 : _b.toLowerCase(),
+                        dueDateTime: this.getDateTimeTimeZone(args.options.dueDateTime),
+                        reminderDateTime: this.getDateTimeTimeZone(args.options.reminderDateTime)
                     },
                     responseType: 'json'
                 };
@@ -56,6 +66,15 @@ class TodoTaskAddCommand extends GraphCommand_1.default {
             }
         });
     }
+    getDateTimeTimeZone(dateTime) {
+        if (!dateTime) {
+            return undefined;
+        }
+        return {
+            dateTime: dateTime,
+            timeZone: 'Etc/GMT'
+        };
+    }
     getTodoListId(args) {
         if (args.options.listId) {
             return Promise.resolve(args.options.listId);
@@ -81,7 +100,12 @@ _TodoTaskAddCommand_instances = new WeakSet(), _TodoTaskAddCommand_initTelemetry
     this.telemetry.push((args) => {
         Object.assign(this.telemetryProperties, {
             listId: typeof args.options.listId !== 'undefined',
-            listName: typeof args.options.listName !== 'undefined'
+            listName: typeof args.options.listName !== 'undefined',
+            bodyContent: typeof args.options.bodyContent !== 'undefined',
+            bodyContentType: args.options.bodyContentType,
+            dueDateTime: typeof args.options.dueDateTime !== 'undefined',
+            importance: args.options.importance,
+            reminderDateTime: typeof args.options.reminderDateTime !== 'undefined'
         });
     });
 }, _TodoTaskAddCommand_initOptions = function _TodoTaskAddCommand_initOptions() {
@@ -91,7 +115,35 @@ _TodoTaskAddCommand_instances = new WeakSet(), _TodoTaskAddCommand_initTelemetry
         option: '--listName [listName]'
     }, {
         option: '--listId [listId]'
+    }, {
+        option: '--bodyContent [bodyContent]'
+    }, {
+        option: '--bodyContentType [bodyContentType]',
+        autocomplete: ['text', 'html']
+    }, {
+        option: '--dueDateTime [dueDateTime]'
+    }, {
+        option: '--importance [importance]',
+        autocomplete: ['low', 'normal', 'high']
+    }, {
+        option: '--reminderDateTime [reminderDateTime]'
     });
+}, _TodoTaskAddCommand_initValidators = function _TodoTaskAddCommand_initValidators() {
+    this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
+        if (args.options.bodyContentType && ['text', 'html'].indexOf(args.options.bodyContentType.toLowerCase()) === -1) {
+            return `'${args.options.bodyContentType}' is not a valid value for the bodyContentType option. Allowed values are text|html`;
+        }
+        if (args.options.importance && ['low', 'normal', 'high'].indexOf(args.options.importance.toLowerCase()) === -1) {
+            return `'${args.options.importance}' is not a valid value for the importance option. Allowed values are low|normal|high`;
+        }
+        if (args.options.dueDateTime && !validation_1.validation.isValidISODateTime(args.options.dueDateTime)) {
+            return `'${args.options.dueDateTime}' is not a valid ISO date string`;
+        }
+        if (args.options.reminderDateTime && !validation_1.validation.isValidISODateTime(args.options.reminderDateTime)) {
+            return `'${args.options.reminderDateTime}' is not a valid ISO date string`;
+        }
+        return true;
+    }));
 }, _TodoTaskAddCommand_initOptionSets = function _TodoTaskAddCommand_initOptionSets() {
     this.optionSets.push(['listId', 'listName']);
 };

package/docs/docs/_clisettings.md

@@ -0,0 +1,19 @@
+## Available settings
+
+Following is the list of configuration settings available in CLI for Microsoft 365.
+
+Setting name|Definition|Default value
+------------|----------|-------------
+`autoOpenBrowserOnLogin`|Automatically open the browser to the Azure AD login page after running `m365 login` command in device code mode. This setting will be replaced by `autoOpenLinksInBrowser` in the next major release.|`false`
+`autoOpenLinksInBrowser`|Automatically open the browser for all commands which return a url and expect the user to copy paste this to the browser. For example when logging in, using `m365 login` in device code mode. This setting will replace `autoOpenBrowserOnLogin` in the next major release.|`false`
+`copyDeviceCodeToClipboard`|Automatically copy the device code to the clipboard when running `m365 login` command in device code mode|`false`
+`csvEscape`|Single character used for escaping; only apply to characters matching the quote and the escape options|`"`
+`csvHeader`|Display the column names on the first line|`true`
+`csvQuote`|The quote characters surrounding a field. An empty quote value will preserve the original field, whether it contains quotation marks or not.|` `
+`csvQuoted`|Quote all the non-empty fields even if not required|`false`
+`csvQuotedEmpty`|Quote empty strings and overrides quoted_string on empty strings when defined|`false`
+`errorOutput`|Defines if errors should be written to `stdout` or `stderr`|`stderr`
+`output`|Defines the default output when issuing a command|`json`
+`printErrorsAsPlainText`|When output mode is set to `json`, print error messages as plain-text rather than JSON|`true`
+`prompt`|Prompts for missing values in required options|`false`
+`showHelpOnFailure`|Automatically display help when executing a command failed|`true`

package/docs/docs/cmd/outlook/mail/mail-send.md

@@ -43,6 +43,9 @@ m365 outlook sendmail [options]
 `--importance [importance]`
 : The importance of the message. Available options: `low`, `normal` or `high`. Default is `normal`.
 
+`--attachment [attachment]`
+: Path to the file that will be added as attachment to the email. This option can be used multiple times to attach multiple attachments.
+
 `--saveToSentItems [saveToSentItems]`
 : Save email in the sent items folder. Default `true`.
 
@@ -50,6 +53,10 @@ m365 outlook sendmail [options]
 
 ## Remarks
 
+### Attachments
+
+When using the `attachment` option, note that the total size of all attachment files cannot exceed 3 MB.
+
 ### If you are connected using app only authentication
 
 - Always specify a user id or upn in the `--sender` option. The email will be sent as if it came from the specified user, and can optionally be saved in the sent folder of that user account.
@@ -116,3 +123,9 @@ Send an email with cc and bcc recipients marked as important
 ```sh
 m365 outlook mail send --to chris@contoso.com --cc claire@contoso.com --bcc randy@contoso.com --subject "DG2000 Data Sheets" --bodyContents "The latest data sheets are in the team site" --importance high
 ```
+
+Send an email with multiple attachments
+
+```sh
+m365 outlook mail send --to chris@contoso.com --subject "Monthly reports" --bodyContents "Here are the reports of this month." --attachment "C:/Reports/File1.jpg" --attachment "C:/Reports/File2.docx" --attachment "C:/Reports/File3.xlsx"
+```

package/docs/docs/cmd/planner/bucket/bucket-add.md

@@ -46,3 +46,32 @@ Adds a Microsoft Planner bucket with the name _My Planner Bucket_ for plan with
 ```sh
 m365 planner bucket add --name "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
 ```
+
+## Response
+
+=== "JSON"
+
+    ``` json
+    {
+      "name": "My Planner Bucket",
+      "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
+      "orderHint": "8585363889524958496",
+      "id": "ttEB_Uj690STdR3GC1MIDZgANq1U"
+    }
+    ```
+
+=== "Text"
+
+    ``` text
+    id       : ttEB_Uj690STdR3GC1MIDZgANq1U
+    name     : My Planner Bucket
+    orderHint: 8585363889524958496
+    planId   : xqQg5FS2LkCp935s-FIFm2QAFkHM
+    ```
+
+=== "CSV"
+
+    ``` text
+    id,name,planId,orderHint
+    ttEB_Uj690STdR3GC1MIDZgANq1U,My Planner Bucket,xqQg5FS2LkCp935s-FIFm2QAFkHM,8585363889524958496
+    ```

package/docs/docs/cmd/planner/bucket/bucket-get.md

@@ -58,3 +58,32 @@ Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by groupId ee0f40f
 ```sh
 m365 planner bucket get --name "Planner Bucket A" --planTitle "My Plan" --ownerGroupId "ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e"
 ```
+
+## Response
+
+=== "JSON"
+
+    ``` json
+    {
+      "name": "My Planner Bucket",
+      "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
+      "orderHint": "8585363889524958496",
+      "id": "ttEB_Uj690STdR3GC1MIDZgANq1U"
+    }
+    ```
+
+=== "Text"
+
+    ``` text
+    id       : ttEB_Uj690STdR3GC1MIDZgANq1U
+    name     : My Planner Bucket
+    orderHint: 8585363889524958496
+    planId   : xqQg5FS2LkCp935s-FIFm2QAFkHM
+    ```
+
+=== "CSV"
+
+    ``` text
+    id,name,planId,orderHint
+    ttEB_Uj690STdR3GC1MIDZgANq1U,My Planner Bucket,xqQg5FS2LkCp935s-FIFm2QAFkHM,8585363889524958496
+    ```

package/docs/docs/cmd/planner/bucket/bucket-list.md

@@ -40,3 +40,33 @@ Lists the Microsoft Planner buckets in the Plan _My Plan_ owned by group _My Gro
 ```sh
 m365 planner bucket list --planTitle "My Plan" --ownerGroupName "My Group"
 ```
+
+## Response
+
+=== "JSON"
+
+    ``` json
+    [
+      {
+        "name": "My Planner Bucket",
+        "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
+        "orderHint": "8585363889524958496",
+        "id": "ttEB_Uj690STdR3GC1MIDZgANq1U"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ``` text
+    id                            name               planId                        orderHint
+    ----------------------------  -----------------  ----------------------------  -------------------
+    ttEB_Uj690STdR3GC1MIDZgANq1U  My Planner Bucket  xqQg5FS2LkCp935s-FIFm2QAFkHM  8585363889524958496
+    ```
+
+=== "CSV"
+
+    ``` CSV
+    id,name,planId,orderHint
+    ttEB_Uj690STdR3GC1MIDZgANq1U,My Planner Bucket,xqQg5FS2LkCp935s-FIFm2QAFkHM,8585363889524958496
+    ```

package/docs/docs/cmd/planner/bucket/bucket-remove.md

@@ -61,3 +61,7 @@ Removes the Microsoft Planner bucket with name _My Bucket_ in the Plan _My Plan_
 ```sh
 m365 planner bucket remove --name "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group"
 ```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/planner/bucket/bucket-set.md

@@ -58,3 +58,7 @@ Updates the Microsoft Planner bucket named _My Bucket_ in the Plan _My Plan_ own
 ```sh
 m365 planner bucket set --name "My Bucket" --planTitle "My Plan" --ownerGroupId 00000000-0000-0000-0000-000000000000 --newName "New bucket name"
 ```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/planner/plan/plan-add.md

@@ -50,3 +50,126 @@ Adds a Microsoft Planner plan with the name _My Planner Plan_ for Group _My Plan
 ```sh
 m365 planner plan add --title 'My Planner Plan' --ownerGroupName 'My Planner Group' --shareWithUserNames 'Allan.Carroll@contoso.com,Ida.Stevens@contoso.com'
 ```
+
+## Response
+
+### Standard response
+
+=== "JSON"
+
+    ``` json
+    {
+      "createdDateTime": "2015-03-30T18:36:49.2407981Z",
+      "owner": "ebf3b108-5234-4e22-b93d-656d7dae5874",
+      "title": "My Planner Plan",
+      "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
+      "createdBy": {
+        "user": {
+          "displayName": null,
+          "id": "95e27074-6c4a-447a-aa24-9d718a0b86fa"
+        },
+        "application": {
+          "displayName": null,
+          "id": "ebf3b108-5234-4e22-b93d-656d7dae5874"
+        }
+      },
+      "container": {
+        "containerId": "ebf3b108-5234-4e22-b93d-656d7dae5874",
+        "type": "group",
+        "url": "https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"
+      }
+    }
+    ```
+
+=== "Text"
+
+    ``` text
+    createdDateTime: 2015-03-30T18:36:49.2407981Z
+    id             : xqQg5FS2LkCp935s-FIFm2QAFkHM
+    owner          : ebf3b108-5234-4e22-b93d-656d7dae5874
+    title          : My Planner Plan
+    ```
+
+=== "CSV"
+
+    ``` text
+    id,title,createdDateTime,owner
+    xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
+    ```
+
+### `shareWithUserIds`, `shareWithUserNames` response
+
+When we make use of the option `shareWithUserIds` or `shareWithUserNames` the response will differ. 
+
+=== "JSON"
+
+    ``` json
+    {
+      "createdDateTime": "2015-03-30T18:36:49.2407981Z",
+      "owner": "ebf3b108-5234-4e22-b93d-656d7dae5874",
+      "title": "My Planner Plan",
+      "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
+      "createdBy": {
+        "user": {
+          "displayName": null,
+          "id": "95e27074-6c4a-447a-aa24-9d718a0b86fa"
+        },
+        "application": {
+          "displayName": null,
+          "id": "ebf3b108-5234-4e22-b93d-656d7dae5874"
+        }
+      },
+      "container": {
+        "containerId": "ebf3b108-5234-4e22-b93d-656d7dae5874",
+        "type": "group",
+        "url": "https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"
+      },
+      "sharedWith": {
+        "ebf3b108-5234-4e22-b93d-656d7dae5874": true,
+        "6463a5ce-2119-4198-9f2a-628761df4a62": true
+      },
+      "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
+      }
+    }
+    ```
+
+=== "Text"
+
+    ``` text
+    createdDateTime: 2015-03-30T18:36:49.2407981Z
+    id             : xqQg5FS2LkCp935s-FIFm2QAFkHM
+    owner          : ebf3b108-5234-4e22-b93d-656d7dae5874
+    title          : My Planner Plan
+    ```
+
+=== "CSV"
+
+    ``` text
+    id,title,createdDateTime,owner
+    xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
+    ```