feat: add modify query

src/Query/AddressBuilder.php

@@ -136,6 +136,21 @@ public function each(callable $callback): void
         }, $callback, pageSize: $listLimit, offset: $listOffset);
     }
 
+    /**
+     * @throws OnOfficeException
+     */
+    public function modify(int $id): bool
+    {
+        $this->onOfficeService->requestApi(
+            OnOfficeAction::Modify,
+            OnOfficeResourceType::Address,
+            $id,
+            parameters: $this->modifies,
+        );
+
+        return true;
+    }
+
     public function count(): int
     {
         $recordIds = $this->recordIds;

src/Query/Builder.php

@@ -21,6 +21,11 @@ abstract class Builder
      */
     public array $filters = [];
 
+    /**
+     * An array of modify parameters.
+     */
+    public array $modifies = [];
+
     /**
      * The limit for the query.
      */
@@ -67,6 +72,19 @@ public function orderByDesc(string $column): self
         return $this->orderBy($column, 'desc');
     }
 
+    public function addModify(string|array $column, mixed $value = null): self
+    {
+        if (is_array($column)) {
+            $this->modifies = array_merge($this->modifies, $column);
+
+            return $this;
+        }
+
+        $this->modifies[$column] = $value;
+
+        return $this;
+    }
+
     public function offset(int $value): self
     {
         $this->offset = max(0, $value);
@@ -125,4 +143,6 @@ abstract public function first(): array;
     abstract public function find(int $id): array;
 
     abstract public function each(callable $callback): void;
+
+    abstract public function modify(int $id): bool;
 }

src/Query/EstateBuilder.php

@@ -109,4 +109,19 @@ public function each(callable $callback): void
             );
         }, $callback, pageSize: $listLimit, offset: $listOffset);
     }
+
+    /**
+     * @throws OnOfficeException
+     */
+    public function modify(int $id): bool
+    {
+        $this->onOfficeService->requestApi(
+            OnOfficeAction::Modify,
+            OnOfficeResourceType::Estate,
+            $id,
+            parameters: $this->modifies,
+        );
+
+        return true;
+    }
 }

src/Query/EstateFileBuilder.php

@@ -90,4 +90,12 @@ public function each(callable $callback): void
             );
         }, $callback, pageSize: $this->limit, offset: $this->offset);
     }
+
+    /**
+     * @throws OnOfficeException
+     */
+    public function modify(int $id): bool
+    {
+        throw new OnOfficeException('Not implemented');
+    }
 }

src/Query/FieldBuilder.php

@@ -78,4 +78,12 @@ public function withModules(array|string $modules): self
 
         return $this;
     }
+
+    /**
+     * @throws OnOfficeException
+     */
+    public function modify(int $id): bool
+    {
+        throw new OnOfficeException('Not implemented');
+    }
 }

src/Query/MarketplaceBuilder.php

@@ -62,4 +62,12 @@ public function each(callable $callback): void
     {
         throw new OnOfficeException('Method not implemented yet');
     }
+
+    /**
+     * @throws OnOfficeException
+     */
+    public function modify(int $id): bool
+    {
+        throw new OnOfficeException('Not implemented');
+    }
 }

src/Query/RegionBuilder.php

@@ -73,4 +73,12 @@ public function each(callable $callback): void
             );
         }, $callback, pageSize: $listLimit, offset: $listOffset);
     }
+
+    /**
+     * @throws OnOfficeException
+     */
+    public function modify(int $id): bool
+    {
+        throw new OnOfficeException('Not implemented');
+    }
 }

src/Query/RelationBuilder.php

@@ -108,4 +108,12 @@ public function relationType(OnOfficeRelationType $relationType): self
 
         return $this;
     }
+
+    /**
+     * @throws OnOfficeException
+     */
+    public function modify(int $id): bool
+    {
+        throw new OnOfficeException('Not implemented');
+    }
 }

src/Query/Testing/BaseFake.php

@@ -62,4 +62,17 @@ public function each(callable $callback): void
                 $callback($records);
             });
     }
+
+    /**
+     * @throws Throwable
+     */
+    public function modify(int $id): bool
+    {
+        $nextRequest = $this->fakeResponses->shift();
+        throw_if($nextRequest === null, new Exception('No more fake responses'));
+
+        return collect($nextRequest)
+            ->flatten()
+            ->first();
+    }
 }

src/Query/UserBuilder.php

@@ -109,4 +109,12 @@ public function each(callable $callback): void
             );
         }, $callback, pageSize: $listLimit, offset: $listOffset);
     }
+
+    /**
+     * @throws OnOfficeException
+     */
+    public function modify(int $id): bool
+    {
+        throw new OnOfficeException('Not implemented');
+    }
 }

tests/Query/BuilderTest.php

@@ -23,6 +23,11 @@ public function find(int $id): array
     public function each(callable $callback): void
     {
     }
+
+    public function modify(int $id): bool
+    {
+        return true;
+    }
 }
 
 describe('select', function () {
@@ -69,6 +74,53 @@ public function each(callable $callback): void
     });
 });
 
+describe('modifies', function () {
+    it('should return the builder instance', function () {
+        $builder = new Builder();
+
+        $result = $builder->addModify('Name', 'Foo');
+
+        expect($result)->toBeInstanceOf(Builder::class);
+    });
+
+    it('should add modifies parameters', function () {
+        $builder = new Builder();
+
+        $builder->addModify('Name', 'Foo');
+
+        expect($builder->modifies)->toBe(['Name' => 'Foo']);
+    });
+
+    it('should add multiple modifies parameters', function () {
+        $builder = new Builder();
+
+        $builder->addModify('Name', 'Foo');
+        $builder->addModify('ID', 1);
+
+        expect($builder->modifies)->toBe(['Name' => 'Foo', 'ID' => 1]);
+    });
+
+    it('should add multiple modifies parameters with the same key', function () {
+        $builder = new Builder();
+
+        $builder->addModify('Name', 'Foo');
+        $builder->addModify('Name', 'Bar');
+
+        expect($builder->modifies)->toBe(['Name' => 'Bar']);
+    });
+
+    it('should add multiple modifies parameters as array', function () {
+        $builder = new Builder();
+
+        $builder->addModify([
+            'Name' => 'Foo',
+            'ID' => 1,
+        ]);
+
+        expect($builder->modifies)->toBe(['Name' => 'Foo', 'ID' => 1]);
+    });
+});
+
 describe('orderBy', function () {
     it('should add the given column and direction to the orderBy property', function () {
         $builder = new Builder();

tests/Testing/EstateRepositoryFakeTest.php

@@ -124,3 +124,43 @@
             ->toThrow('No more fake responses');
     });
 });
+
+describe('modify', function () {
+    it('can modify', function () {
+        EstateRepository::fake([
+            [
+                true,
+            ],
+        ]);
+
+        $result = EstateRepository::query()->modify(1);
+
+        expect($result)->toBeTrue();
+    });
+
+    it('can modify multiple times', function () {
+        EstateRepository::fake([
+            [
+                true,
+            ],
+        ], [
+            [
+                true,
+            ],
+        ]);
+
+        $result = EstateRepository::query()->modify(1);
+
+        expect($result)->toBeTrue();
+
+        $result = EstateRepository::query()->modify(2);
+
+        expect($result)->toBeTrue();
+    });
+
+    it('throws an exception when no more fake responses are available', function () {
+        EstateRepository::fake();
+
+        EstateRepository::query()->modify(1);
+    })->throws(Exception::class, 'No more fake responses');
+});