nextcloud-pantry/lib/ResponseDefinitions.php

<?php

declare(strict_types=1);

// SPDX-FileCopyrightText: Chen Asraf <contact@casraf.dev>
// SPDX-License-Identifier: AGPL-3.0-or-later

namespace OCA\Pantry;

/**
 * @psalm-type PantryHouse = array{
 *     id: int,
 *     name: string,
 *     description: string|null,
 *     ownerUid: string,
 *     createdAt: int,
 *     updatedAt: int,
 *     role: string,
 * }
 *
 * @psalm-type PantryMember = array{
 *     id: int,
 *     houseId: int,
 *     userId: string,
 *     displayName: string,
 *     role: string,
 *     joinedAt: int,
 * }
 *
 * @psalm-type PantryList = array{
 *     id: int,
 *     houseId: int,
 *     name: string,
 *     description: string|null,
 *     icon: string,
 *     sortOrder: int,
 *     createdAt: int,
 *     updatedAt: int,
 * }
 *
 * @psalm-type PantryListItem = array{
 *     id: int,
 *     listId: int,
 *     name: string,
 *     categoryId: int|null,
 *     quantity: string|null,
 *     bought: bool,
 *     boughtAt: int|null,
 *     boughtBy: string|null,
 *     rrule: string|null,
 *     repeatFromCompletion: bool,
 *     nextDueAt: int|null,
 *     imageFileId: int|null,
 *     sortOrder: int,
 *     createdAt: int,
 *     updatedAt: int,
 * }
 *
 * @psalm-type PantryCategory = array{
 *     id: int,
 *     houseId: int,
 *     name: string,
 *     icon: string,
 *     color: string,
 *     sortOrder: int,
 *     createdAt: int,
 *     updatedAt: int,
 * }
 *
 * @psalm-type PantrySuccess = array{success: true}
 *
 * @psalm-type PantryLastHouse = array{houseId: int|null}
 *
 * @psalm-type PantryImageFolder = array{folder: string}
 *
 * @psalm-type PantryNotificationPrefs = array{
 *     notifyPhoto: bool,
 *     notifyNoteCreate: bool,
 *     notifyNoteEdit: bool,
 * }
 *
 * @psalm-type PantryPhotoFolder = array{
 *     id: int,
 *     houseId: int,
 *     name: string,
 *     sortOrder: int,
 *     createdAt: int,
 *     updatedAt: int,
 * }
 *
 * @psalm-type PantryNote = array{
 *     id: int,
 *     houseId: int,
 *     title: string,
 *     content: string|null,
 *     color: string|null,
 *     createdBy: string,
 *     sortOrder: int,
 *     createdAt: int,
 *     updatedAt: int,
 * }
 *
 * @psalm-type PantryPhoto = array{
 *     id: int,
 *     houseId: int,
 *     folderId: int|null,
 *     fileId: int,
 *     caption: string|null,
 *     uploadedBy: string,
 *     sortOrder: int,
 *     createdAt: int,
 *     updatedAt: int,
 * }
 */
class ResponseDefinitions {
}