New command: spo file unarchive. Closes #7176

Author: Saurabh7019

.devproxy/api-specs/sharepoint.yaml

@@ -73,6 +73,35 @@ paths:
       responses:
         200:
           description: OK
+  /_api/Lists(guid'{listId}')/items({itemId})/UnArchive:
+    post:
+      parameters:
+        - name: listId
+          in: path
+          required: true
+          description: list GUID
+          schema:
+            type: string
+          example: "'b2307a39-e878-458b-bc90-03bc578531d6'"
+        - name: itemId
+          in: path
+          required: true
+          description: list item ID
+          schema:
+            type: integer
+          example: 1
+      security:
+        - delegated:
+          - AllSites.Write
+          - AllSites.Manage
+          - AllSites.FullControl
+        - application:
+          - Sites.ReadWrite.All
+          - Sites.Manage.All
+          - Sites.FullControl.All
+      responses:
+        200:
+          description: OK
   /_api/contextinfo:
     post:
       security:
@@ -238,6 +267,44 @@ paths:
       responses:
         200:
           description: OK
+  /_api/web/GetFileByServerRelativePath(DecodedUrl={filePath}):
+    get:
+      parameters:
+        - name: filePath
+          in: path
+          required: true
+          description: URL-encoded server-relative path to the file
+          schema:
+            type: string
+          example: "'%2Fsites%2FM365SOBA%2Fshared%20documents%2Fgeneral%2Fdocument.docx'"
+        - name: $select
+          in: query
+          required: false
+          description: Comma-separated list of properties to return
+          schema:
+            type: string
+          example: "ListId"
+        - name: $expand
+          in: query
+          required: false
+          description: Comma-separated list of navigation properties to expand
+          schema:
+            type: string
+          example: "ListItemAllFields"
+      security:
+        - delegated:
+          - AllSites.Read
+          - AllSites.Write
+          - AllSites.Manage
+          - AllSites.FullControl
+        - application:
+          - Sites.Read.All
+          - Sites.ReadWrite.All
+          - Sites.Manage.All
+          - Sites.FullControl.All
+      responses:
+        200:
+          description: OK
   /_api/web/GetFileByServerRelativePath(DecodedUrl={filePath})/$value:
     get:
       parameters:

docs/docs/cmd/spo/file/file-unarchive.mdx

@@ -0,0 +1,68 @@
+import Global from '../../_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo file unarchive
+
+Unarchives a file
+
+## Usage
+
+```sh
+m365 spo file unarchive [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: The URL of the site where the file is located.
+
+`--url [url]`
+: The server- or site-relative decoded URL of the file to unarchive. Specify either `url` or `id`, but not both.
+
+`-i, --id [id]`
+: The UniqueId (GUID) of the file to unarchive. Specify either `url` or `id`, but not both.
+
+`-f, --force`
+: Don't prompt for confirmation.
+```
+
+<Global />
+
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource   | Permissions    |
+  |------------|----------------|
+  | SharePoint | AllSites.Write |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource   | Permissions         |
+  |------------|---------------------|
+  | SharePoint | Sites.ReadWrite.All |
+
+  </TabItem>
+</Tabs>
+
+## Examples
+
+Unarchive a file without prompting for confirmation.
+
+```sh
+m365 spo file unarchive --webUrl https://contoso.sharepoint.com/sites/Marketing --id 7a8c9207-7745-4cda-b0e2-be2618ee3030 --force
+```
+
+Unarchive a file by URL with prompting for confirmation.
+
+```sh
+m365 spo file unarchive --webUrl https://contoso.sharepoint.com/sites/Marketing --url '/sites/Marketing/shared documents/document.docx'
+```
+
+## Response
+
+The command won't return a response on success.

docs/src/config/sidebars.ts

@@ -2796,6 +2796,11 @@ const sidebars: SidebarsConfig = {
               label: 'file sharinglink set',
               id: 'cmd/spo/file/file-sharinglink-set'
             },
+            {
+              type: 'doc',
+              label: 'file unarchive',
+              id: 'cmd/spo/file/file-unarchive'
+            },
             {
               type: 'doc',
               label: 'file version clear',

src/m365/spo/commands.ts

@@ -84,6 +84,7 @@ export default {
   FILE_SHARINGLINK_LIST: `${prefix} file sharinglink list`,
   FILE_SHARINGLINK_REMOVE: `${prefix} file sharinglink remove`,
   FILE_SHARINGLINK_SET: `${prefix} file sharinglink set`,
+  FILE_UNARCHIVE: `${prefix} file unarchive`,
   FILE_VERSION_CLEAR: `${prefix} file version clear`,
   FILE_VERSION_GET: `${prefix} file version get`,
   FILE_VERSION_KEEP: `${prefix} file version keep`,