LemmyApi/src/Endpoint/SiteEndpoint.php at master · RikudouSage/LemmyApi · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
<?php

namespace Rikudou\LemmyApi\Endpoint;

use Rikudou\LemmyApi\Attribute\Since;
use Rikudou\LemmyApi\Enum\ListingType;
use Rikudou\LemmyApi\Enum\ModlogActionType;
use Rikudou\LemmyApi\Enum\PostListingMode;
use Rikudou\LemmyApi\Enum\RegistrationMode;
use Rikudou\LemmyApi\Enum\SortType;
use Rikudou\LemmyApi\Response\GetModlogResponse;
use Rikudou\LemmyApi\Response\GetSiteResponse;
use Rikudou\LemmyApi\Response\Model\Community;
use Rikudou\LemmyApi\Response\Model\FederatedInstances;
use Rikudou\LemmyApi\Response\Model\Person;
use Rikudou\LemmyApi\Response\Model\SiteMetadata;
use Rikudou\LemmyApi\Response\SiteResponse;

/**
 * createSite is intentionally not implemented, it doesn't make sense for an api client
 */
interface SiteEndpoint
{
    public function getSite(): GetSiteResponse;

    public function getMetadata(string $url): SiteMetadata;

    /**
     * @param array<string>|null $allowedInstances
     * @param array<string>|null $blockedInstances
     * @param array<string>|null $taglines
     * @param array<string>|null $blockedUrls
     */
    public function update(
        ?int $actorNameMaxLength = null,
        ?array $allowedInstances = null,
        ?bool $applicationEmailAdmins = null,
        ?string $applicationQuestion = null,
        ?string $banner = null,
        ?array $blockedInstances = null,
        ?string $captchaDifficulty = null,
        ?bool $captchaEnabled = null,
        ?bool $communityCreationAdminOnly = null,
        ?ListingType $defaultPostListingType = null,
        ?string $defaultTheme = null,
        ?string $description = null,
        ?string $discussionLanguages = null,
        ?bool $enableDownvotes = null,
        ?bool $enableNsfw = null,
        ?bool $federationDebug = null,
        ?bool $federationEnabled = null,
        ?int $federationWorkerCount = null,
        ?bool $hideModlogModNames = null,
        ?string $icon = null,
        ?string $legalInformation = null,
        ?string $name = null,
        ?bool $privateInstance = null,
        ?int $rateLimitComment = null,
        ?int $rateLimitCommentPerSecond = null,
        ?int $rateLimitImage = null,
        ?int $rateLimitImagePerSecond = null,
        ?int $rateLimitMessage = null,
        ?int $rateLimitMessagePerSecond = null,
        ?int $rateLimitPost = null,
        ?int $rateLimitPostPerSecond = null,
        ?int $rateLimitRegister = null,
        ?int $rateLimitRegisterPerSecond = null,
        ?int $rateLimitSearch = null,
        ?int $rateLimitSearchPerSecond = null,
        ?RegistrationMode $registrationMode = null,
        ?bool $reportsEmailAdmins = null,
        ?bool $requireEmailVerification = null,
        ?string $sidebar = null,
        ?string $slurFilterRegex = null,
        ?array $taglines = null,
        #[Since(version: '0.19.4')]
        ?PostListingMode $defaultPostListingMode = null,
        #[Since(version: '0.19.4')]
        ?SortType $defaultSortType = null,
        #[Since(version: '0.19.4')]
        ?array $blockedUrls = null,
    ): SiteResponse;

    public function getFederatedInstances(): FederatedInstances;

    public function getModlog(
        Community|int|null $community = null,
        ?int $limit = null,
        Person|int|null $moderator = null,
        Person|int|null $moddedUser = null,
        ?int $page = null,
        ?ModlogActionType $actionType = null,
    ): GetModlogResponse;
}