Add code for administrations.

app/Api/V1/Controllers/Controller.php

@@ -30,12 +30,19 @@ use FireflyIII\Models\Preference;
 use FireflyIII\Models\TransactionCurrency;
 use FireflyIII\Support\Facades\Amount;
 use FireflyIII\Support\Facades\Steam;
+use FireflyIII\Transformers\V2\AbstractTransformer;
 use FireflyIII\User;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Foundation\Auth\Access\AuthorizesRequests;
 use Illuminate\Foundation\Bus\DispatchesJobs;
 use Illuminate\Foundation\Validation\ValidatesRequests;
+use Illuminate\Pagination\LengthAwarePaginator;
 use Illuminate\Routing\Controller as BaseController;
+use Illuminate\Support\Collection;
 use League\Fractal\Manager;
+use League\Fractal\Pagination\IlluminatePaginatorAdapter;
+use League\Fractal\Resource\Collection as FractalCollection;
+use League\Fractal\Resource\Item;
 use League\Fractal\Serializer\JsonApiSerializer;
 use Symfony\Component\HttpFoundation\Exception\BadRequestException;
 use Symfony\Component\HttpFoundation\ParameterBag;
@@ -223,4 +230,45 @@ abstract class Controller extends BaseController
 
         return $manager;
     }
+
+    final protected function jsonApiList(string $key, LengthAwarePaginator $paginator, AbstractTransformer $transformer): array
+    {
+        $manager  = new Manager();
+        $baseUrl  = sprintf('%s/api/v1/',request()->getSchemeAndHttpHost());
+
+        // TODO add stuff to path?
+
+        $manager->setSerializer(new JsonApiSerializer($baseUrl));
+
+        $objects  = $paginator->getCollection();
+
+        // the transformer, at this point, needs to collect information that ALL items in the collection
+        // require, like meta-data and stuff like that, and save it for later.
+        $objects  = $transformer->collectMetaData($objects);
+        $paginator->setCollection($objects);
+
+        $resource = new FractalCollection($objects, $transformer, $key);
+        $resource->setPaginator(new IlluminatePaginatorAdapter($paginator));
+
+        return $manager->createData($resource)->toArray();
+    }
+
+    /**
+     * Returns a JSON API object and returns it.
+     *
+     * @param array<int, mixed>|Model $object
+     */
+    final protected function jsonApiObject(string $key, array|Model $object, AbstractTransformer $transformer): array
+    {
+        // create some objects:
+        $manager  = new Manager();
+        $baseUrl  = sprintf('%s/api/v1', request()->getSchemeAndHttpHost());
+        $manager->setSerializer(new JsonApiSerializer($baseUrl));
+
+        $transformer->collectMetaData(new Collection([$object]));
+
+        $resource = new Item($object, $transformer, $key);
+
+        return $manager->createData($resource)->toArray();
+    }
 }

app/Api/V1/Controllers/Models/UserGroup/IndexController.php

@@ -0,0 +1,71 @@
+<?php
+
+/*
+ * IndexController.php
+ * Copyright (c) 2024 james@firefly-iii.org.
+ *
+ * This file is part of Firefly III (https://github.com/firefly-iii).
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see https://www.gnu.org/licenses/.
+ */
+
+declare(strict_types=1);
+
+namespace FireflyIII\Api\V1\Controllers\Models\UserGroup;
+
+use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Api\V1\Requests\Data\DateRequest;
+use FireflyIII\Repositories\UserGroup\UserGroupRepositoryInterface;
+use FireflyIII\Transformers\UserGroupTransformer;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Pagination\LengthAwarePaginator;
+
+class IndexController extends Controller
+{
+    public const string RESOURCE_KEY = 'user_groups';
+
+    private UserGroupRepositoryInterface $repository;
+
+    /**
+     * AccountController constructor.
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                $this->repository = app(UserGroupRepositoryInterface::class);
+
+                return $next($request);
+            }
+        );
+    }
+
+    public function index(DateRequest $request): JsonResponse
+    {
+        $administrations = $this->repository->get();
+        $pageSize        = $this->parameters->get('limit');
+        $count           = $administrations->count();
+        $administrations = $administrations->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
+        $paginator       = new LengthAwarePaginator($administrations, $count, $pageSize, $this->parameters->get('page'));
+        $transformer     = new UserGroupTransformer();
+
+        $transformer->setParameters($this->parameters); // give params to transformer
+
+        return response()
+            ->json($this->jsonApiList(self::RESOURCE_KEY, $paginator, $transformer))
+            ->header('Content-Type', self::CONTENT_TYPE)
+        ;
+    }
+}

app/Api/V1/Controllers/Models/UserGroup/ShowController.php

@@ -0,0 +1,63 @@
+<?php
+
+/*
+ * ShowController.php
+ * Copyright (c) 2021 james@firefly-iii.org
+ *
+ * This file is part of Firefly III (https://github.com/firefly-iii).
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+declare(strict_types=1);
+
+namespace FireflyIII\Api\V1\Controllers\Models\UserGroup;
+
+use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Models\UserGroup;
+use FireflyIII\Repositories\Webhook\WebhookRepositoryInterface;
+use FireflyIII\Transformers\UserGroupTransformer;
+use Illuminate\Http\JsonResponse;
+
+/**
+ * Class ShowController
+ */
+class ShowController extends Controller
+{
+    public const string RESOURCE_KEY = 'user_groups';
+    private WebhookRepositoryInterface $repository;
+
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                $this->repository = app(WebhookRepositoryInterface::class);
+                $this->repository->setUser(auth()->user());
+
+                return $next($request);
+            }
+        );
+    }
+
+    public function show(UserGroup $userGroup): JsonResponse
+    {
+        $transformer = new UserGroupTransformer();
+        $transformer->setParameters($this->parameters);
+
+        return response()
+            ->api($this->jsonApiObject(self::RESOURCE_KEY, $userGroup, $transformer))
+            ->header('Content-Type', self::CONTENT_TYPE);
+    }
+}

app/Api/V1/Controllers/Models/UserGroup/UpdateController.php

@@ -0,0 +1,70 @@
+<?php
+/*
+ * UpdateController.php
+ * Copyright (c) 2025 james@firefly-iii.org.
+ *
+ * This file is part of Firefly III (https://github.com/firefly-iii).
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see https://www.gnu.org/licenses/.
+ */
+
+declare(strict_types=1);
+
+namespace FireflyIII\Api\V1\Controllers\Models\UserGroup;
+
+use FireflyIII\Api\V1\Controllers\Controller;
+use FireflyIII\Api\V1\Requests\Models\UserGroup\UpdateRequest;
+use FireflyIII\Models\UserGroup;
+use FireflyIII\Repositories\UserGroup\UserGroupRepositoryInterface;
+use FireflyIII\Transformers\UserGroupTransformer;
+use Illuminate\Http\JsonResponse;
+
+class UpdateController extends Controller
+{
+    public const string RESOURCE_KEY = 'user_groups';
+
+    private UserGroupRepositoryInterface $repository;
+
+    /**
+     * AccountController constructor.
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                $this->repository = app(UserGroupRepositoryInterface::class);
+
+                return $next($request);
+            }
+        );
+    }
+
+    public function update(UpdateRequest $request, UserGroup $userGroup): JsonResponse {
+        app('log')->debug(sprintf('Now in %s', __METHOD__));
+        $data         = $request->getData();
+        $userGroup      = $this->repository->update($userGroup, $data);
+        $userGroup->refresh();
+        app('preferences')->mark();
+
+        $transformer  = new UserGroupTransformer();
+        $transformer->setParameters($this->parameters);
+
+        return response()
+            ->api($this->jsonApiObject(self::RESOURCE_KEY, $userGroup, $transformer))
+            ->header('Content-Type', self::CONTENT_TYPE)
+            ;
+    }
+
+}

app/Api/V1/Requests/Data/DateRequest.php

@@ -55,6 +55,7 @@ class DateRequest extends FormRequest
         return [
             'start' => $start,
             'end'   => $end,
+            'date' => $this->getCarbonDate('date'),
         ];
     }
 
@@ -64,8 +65,9 @@ class DateRequest extends FormRequest
     public function rules(): array
     {
         return [
-            'start' => 'required|date',
-            'end'   => 'required|date|after:start',
+            'date'  => 'date|after:1900-01-01|before:2099-12-31',
+            'start' => 'date|after:1900-01-01|before:2099-12-31|before:end|required_with:end',
+            'end'   => 'date|after:1900-01-01|before:2099-12-31|after:start|required_with:start',
         ];
     }
 }

app/Api/V1/Requests/Models/UserGroup/UpdateRequest.php

@@ -0,0 +1,66 @@
+<?php
+
+/*
+ * UpdateRequest.php
+ * Copyright (c) 2021 james@firefly-iii.org
+ *
+ * This file is part of Firefly III (https://github.com/firefly-iii).
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+declare(strict_types=1);
+
+namespace FireflyIII\Api\V1\Requests\Models\UserGroup;
+
+use FireflyIII\Models\UserGroup;
+use FireflyIII\Rules\UserGroup\UniqueTitle;
+use FireflyIII\Support\Request\ChecksLogin;
+use FireflyIII\Support\Request\ConvertsDataTypes;
+use Illuminate\Foundation\Http\FormRequest;
+
+/**
+ * Class UpdateRequest
+ */
+class UpdateRequest extends FormRequest
+{
+    use ChecksLogin;
+    use ConvertsDataTypes;
+
+    public function getData(): array
+    {
+        $fields = [
+            'title'         => ['title', 'convertString'],
+            'native_currency_id'   => ['native_currency_id', 'convertInteger'],
+            'native_currency_code' => ['native_currency_code', 'convertString'],
+        ];
+
+        return $this->getAllData($fields);
+    }
+
+    /**
+     * Rules for this request.
+     */
+    public function rules(): array
+    {
+        /** @var UserGroup $userGroup */
+        $userGroup = $this->route()->parameter('userGroup');
+
+        return [
+            'title'                => ['required','min:1','max:255'],
+            'native_currency_id'   => 'exists:transaction_currencies,id',
+            'native_currency_code' => 'exists:transaction_currencies,code',
+        ];
+    }
+}