@pnp/cli-microsoft365 7.0.0-beta.14c7857 → 7.0.0-beta.18ce559

package/docs/docs/cmd/spo/listitem/listitem-attachment-add.mdx

@@ -0,0 +1,110 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo listitem attachment add
+
+Adds an attachment to a list item
+
+## Usage
+
+```sh
+m365 spo listitem attachment add [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: URL of the site where the list item is located.
+
+`--listId [listId]`
+: ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listTitle [listTitle]`
+: Title of the list. Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listUrl [listUrl]`
+: Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listItemId <listItemId>`
+: The ID of the list item.
+
+`-p, --filePath <filePath>`
+: Local path to the file that will be added as an attachment to the list item.
+
+`-n, --fileName [fileName]`
+: Name for the file. If no name is provided, the name from `filePath` will be utilized.
+```
+
+<Global />
+
+## Examples
+
+Add a new attachment to a list item from a local file by using list title
+
+```sh
+m365 spo listitem attachment add --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle "DemoList" --listItemId 147 --filePath "C:/Reports/File1.jpg"
+```
+
+Add a new attachment to a list item from a local file by using list URL with a different filename
+
+```sh
+m365 spo listitem attachment add --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl "/sites/project-x/Lists/DemoList" --listItemId 147 --filePath "C:/Reports/File1.jpg" --fileName "File2"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "FileName": "File1.jpg",
+      "FileNameAsPath": {
+        "DecodedUrl": "File1.jpg"
+      },
+      "ServerRelativePath": {
+        "DecodedUrl": "/Lists/DemoList/Attachments/147/File1.jpg"
+      },
+      "ServerRelativeUrl": "/Lists/Test/Attachments/147/File1.jpg"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  FileName          : File1.jpg
+  FileNameAsPath    : {"DecodedUrl":"File1jpg"}
+  ServerRelativePath: {"DecodedUrl":"/Lists/DemoList/Attachments/743/File1.jpg"}
+  ServerRelativeUrl : /Lists/DemoList/Attachments/147/File1.jpg
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  FileName,ServerRelativeUrl
+  File1.jpg,/Lists/DemoList/Attachments/147/File1.jpg
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo listitem attachment add --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle "DemoList" --listItemId 147 --filePath "C:/Reports/File1.jpg"
+
+  Date: 25/07/2023
+
+  Property | Value
+  ---------|-------
+  FileName | File1.jpg
+  ServerRelativeUrl | /Lists/DemoList/Attachments/147/File1.jpg
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/spo/listitem/listitem-attachment-get.mdx

@@ -0,0 +1,104 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo listitem attachment get
+
+Gets an attachment from a list item
+
+## Usage
+
+```sh
+m365 spo listitem attachment get [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: URL of the site where the list item is located.
+
+`--listId [listId]`
+: ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listTitle [listTitle]`
+: Title of the list. Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listUrl [listUrl]`
+: Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listItemId <listItemId>`
+: The ID of the list item.
+
+`-n, --fileName <fileName>`
+: Name of the file to get.
+```
+
+<Global />
+
+## Examples
+
+Get an attachment from a list item by using list title.
+
+```sh
+m365 spo listitem attachment get --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle "Demo List" --listItemId 147 --fileName "File1.jpg"
+```
+
+Get an attachment from a list item by using list URL.
+
+```sh
+m365 spo listitem attachment get --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl "/sites/project-x/Lists/DemoList" --listItemId 147 --fileName "File1.jpg"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "FileName": "File1.jpg",
+    "FileNameAsPath": {
+      "DecodedUrl": "File1.jpg"
+    },
+    "ServerRelativePath": {
+      "DecodedUrl": "/sites/project-x/Lists/DemoListAttachments/147/File1.jpg"
+    },
+    "ServerRelativeUrl": "/sites/project-x/Lists/DemoListAttachments/147/File1.jpg"
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  FileName          : File1.jpg
+  FileNameAsPath    : {"DecodedUrl":"File1.jpg"}
+  ServerRelativePath: {"DecodedUrl":"/sites/project-x/Lists/DemoListAttachments/147/File1.jpg"}
+  ServerRelativeUrl : /sites/project-x/Lists/DemoListAttachments/147/File1.jpg
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  FileName,ServerRelativeUrl
+  File1.jpg,/sites/project-x/Lists/DemoListAttachments/147/File1.jpg
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo listitem attachment get --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "PnP PowerShell List" --listItemId "1" --fileName "File1.jpg"
+
+  Date: 7/20/2023
+
+  Property | Value
+  ---------|-------
+  FileName | File1.jpg
+  ServerRelativeUrl | /sites/project-x/Lists/DemoListAttachments/147/File1.jpg
+  ```
+
+  </TabItem>
+</Tabs>

package/docs/docs/cmd/spo/listitem/listitem-attachment-remove.mdx

@@ -0,0 +1,58 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo listitem attachment remove
+
+Removes an attachment from a list item
+
+## Usage
+
+```sh
+m365 spo listitem attachment remove [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: URL of the site where the list item is located.
+
+`--listId [listId]`
+: ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listTitle [listTitle]`
+: Title of the list. Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listUrl [listUrl]`
+: Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listItemId <listItemId>`
+: The ID of the list item.
+
+`-n, --fileName <fileName>`
+: Name of the file to remove.
+
+`-f, --force`
+: Don't prompt for confirmation.
+```
+
+<Global />
+
+## Examples
+
+Remove an attachment from a list item using list tile.
+
+```sh
+m365 spo listitem attachment remove --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle "Demo List" --listItemId 147 --fileName "File1.jpg"
+```
+
+Remove an attachment from a list item using list URL.
+
+```sh
+m365 spo listitem attachment remove --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl "/sites/project-x/Lists/DemoList" --listItemId 147 --fileName "File1.jpg"
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/listitem/listitem-attachment-set.mdx

@@ -0,0 +1,58 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo listitem attachment set
+
+Updates an attachment from a list item
+
+## Usage
+
+```sh
+m365 spo listitem attachment set [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: URL of the site where the list item is located.
+
+`--listId [listId]`
+: ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listTitle [listTitle]`
+: Title of the list. Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listUrl [listUrl]`
+: Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listItemId <listItemId>`
+: The ID of the list item.
+
+`-p, --filePath <filePath>`
+: Local path used for updating the attachment contents.
+
+`-n, --fileName <fileName>`
+: Name of the file to update.
+```
+
+<Global />
+
+## Examples
+
+Update an attachment from a list item by using list title
+
+```sh
+m365 spo listitem attachment set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle "Demo List" --listItemId 147 --fileName "File1.jpg" --filePath "C:/Reports/File2.jpg"
+```
+
+Update an attachment from a list item by using list URL
+
+```sh
+m365 spo listitem attachment set --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl "/sites/project-x/Lists/DemoList" --listItemId 147 --fileName "File1.jpg" --filePath "C:/Reports/File2.jpg"
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/user/user-get.mdx

@@ -19,13 +19,13 @@ m365 spo user get [options]
 : URL of the web to get the user within
 
 `-i, --id [id]`
-: ID of the user to retrieve information for. Use either `email`, `id` or `userName`, but not all.
+: ID of the user to retrieve information for. Use either `email`, `id` or `loginName`, but not all.
 
 `--email [email]`
-: Email of the user to retrieve information for. Use either `email`, `id` or `userName`, but not all.
+: Email of the user to retrieve information for. Use either `email`, `id` or `loginName`, but not all.
 
-`--userName [userName]`
-: Login name of the user to retrieve information for. Use either `email`, `id` or `userName`, but not all.
+`--loginName [loginName]`
+: Login name of the user to retrieve information for. Use either `email`, `id` or `loginName`, but not all.
 ```
 
 <Global />
@@ -38,16 +38,16 @@ Get user by email for a web
 m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x --email john.doe@mytenant.onmicrosoft.com
 ```
 
-Get user with ID _6_ for a web
+Get user by ID for a web
 
 ```sh
 m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x --id 6
 ```
 
-Get user with login name 'i:0#.f|membership|john.doe@mytenant.onmicrosoft.com' for a web
+Get user by login name for a web
 
 ```sh
-m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x --userName "i:0#.f|membership|john.doe@mytenant.onmicrosoft.com"
+m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x --loginName "i:0#.f|membership|john.doe@mytenant.onmicrosoft.com"
 ```
 
 ## Response
@@ -105,7 +105,7 @@ m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x --user
   <TabItem value="Markdown">
 
   ```md
-  # spo user get --webUrl "https://contoso.sharepoint.com" --userName "i:0#.f|membership|john.doe@contoso.onmicrosoft.com"
+  # spo user get --webUrl "https://contoso.sharepoint.com" --loginName "i:0#.f|membership|john.doe@contoso.onmicrosoft.com"
 
   Date: 4/10/2023
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "7.0.0-beta.14c7857",
+  "version": "7.0.0-beta.18ce559",
   "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
   "license": "MIT",
   "main": "./dist/api.js",