[12.1] Add permanent project removal and restore (#872)

* Add permanent project removal and restore

Co-authored-by: Philipp Kolmann <2240760+pkolmann@users.noreply.github.com>

* Apply fixes from StyleCI

---------

Co-authored-by: Philipp Kolmann <2240760+pkolmann@users.noreply.github.com>
Co-authored-by: StyleCI Bot <bot@styleci.io>

Author: 3 people

CHANGELOG.md

@@ -19,6 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Add support for listing merge requests associated with a deployment
 * Add support for `with_custom_attributes` and `with_projects` in `Groups::show`
 * Add support for project remote mirror read endpoints
+* Add support for permanent project removal and project restoration
 
 
 ## [12.0.0] - 2025-02-23

src/Api/Projects.php

@@ -194,9 +194,29 @@ public function update(int|string $project_id, array $parameters): mixed
         return $this->put('projects/'.self::encodePath($project_id), $parameters);
     }
 
-    public function remove(int|string $project_id): mixed
+    /**
+     * @param array $parameters {
+     *
+     *     @var string      $full_path           full path of project to use with permanently_remove
+     *     @var bool|string $permanently_remove Immediately delete a project that is already marked for deletion.
+     * }
+     */
+    public function remove(int|string $project_id, array $parameters = []): mixed
+    {
+        $resolver = new OptionsResolver();
+        $resolver->setDefined('full_path')
+            ->setAllowedTypes('full_path', 'string')
+        ;
+        $resolver->setDefined('permanently_remove')
+            ->setAllowedTypes('permanently_remove', ['bool', 'string'])
+        ;
+
+        return $this->delete('projects/'.self::encodePath($project_id), $resolver->resolve($parameters));
+    }
+
+    public function restore(int|string $project_id): mixed
     {
-        return $this->delete('projects/'.self::encodePath($project_id));
+        return $this->post('projects/'.self::encodePath($project_id).'/restore');
     }
 
     public function archive(int|string $project_id): mixed

tests/Api/ProjectsTest.php

@@ -345,6 +345,54 @@ public function shouldRemoveProject(): void
         $this->assertEquals($expectedBool, $api->remove(1));
     }
 
+    #[Test]
+    public function shouldRemoveProjectPermanently(): void
+    {
+        $expectedBool = true;
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('delete')
+            ->with('projects/1', ['full_path' => 'group/project', 'permanently_remove' => true])
+            ->willReturn($expectedBool);
+
+        $this->assertEquals($expectedBool, $api->remove(1, [
+            'full_path' => 'group/project',
+            'permanently_remove' => true,
+        ]));
+    }
+
+    #[Test]
+    public function shouldRemoveProjectPermanentlyWithStringParameter(): void
+    {
+        $expectedBool = true;
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('delete')
+            ->with('projects/1', ['full_path' => 'group/project', 'permanently_remove' => 'true'])
+            ->willReturn($expectedBool);
+
+        $this->assertEquals($expectedBool, $api->remove(1, [
+            'full_path' => 'group/project',
+            'permanently_remove' => 'true',
+        ]));
+    }
+
+    #[Test]
+    public function shouldRestoreProject(): void
+    {
+        $expectedArray = ['id' => 1, 'name' => 'Project Name'];
+
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('post')
+            ->with('projects/1/restore')
+            ->willReturn($expectedArray);
+
+        $this->assertEquals($expectedArray, $api->restore(1));
+    }
+
     #[Test]
     public function shouldGetPipelines(): void
     {