Automatically update PHP SDK

Author: github-actions[bot]

composer.json

@@ -1,6 +1,6 @@
 {
   "name": "trophy/php",
-  "version": "1.0.18",
+  "version": "1.0.19",
   "description": "Trophy PHP Library",
   "keywords": [
     "trophy",

src/Streaks/Requests/StreaksRankingsRequest.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Trophy\Streaks\Requests;
+
+use Trophy\Core\Json\JsonSerializableType;
+use Trophy\Streaks\Types\StreaksRankingsRequestType;
+
+class StreaksRankingsRequest extends JsonSerializableType
+{
+    /**
+     * @var ?int $limit Number of users to return. Must be between 1 and 100.
+     */
+    public ?int $limit;
+
+    /**
+     * @var ?value-of<StreaksRankingsRequestType> $type Whether to rank users by active streaks or longest streaks ever achieved.
+     */
+    public ?string $type;
+
+    /**
+     * @param array{
+     *   limit?: ?int,
+     *   type?: ?value-of<StreaksRankingsRequestType>,
+     * } $values
+     */
+    public function __construct(
+        array $values = [],
+    ) {
+        $this->limit = $values['limit'] ?? null;
+        $this->type = $values['type'] ?? null;
+    }
+}

src/Streaks/StreaksClient.php

@@ -0,0 +1,111 @@
+<?php
+
+namespace Trophy\Streaks;
+
+use GuzzleHttp\ClientInterface;
+use Trophy\Core\Client\RawClient;
+use Trophy\Streaks\Requests\StreaksRankingsRequest;
+use Trophy\Types\StreakRankingUser;
+use Trophy\Exceptions\TrophyException;
+use Trophy\Exceptions\TrophyApiException;
+use Trophy\Core\Json\JsonApiRequest;
+use Trophy\Environments;
+use Trophy\Core\Client\HttpMethod;
+use Trophy\Core\Json\JsonDecoder;
+use JsonException;
+use GuzzleHttp\Exception\RequestException;
+use Psr\Http\Client\ClientExceptionInterface;
+
+class StreaksClient
+{
+    /**
+     * @var array{
+     *   baseUrl?: string,
+     *   client?: ClientInterface,
+     *   headers?: array<string, string>,
+     *   maxRetries?: int,
+     * } $options
+     */
+    private array $options;
+
+    /**
+     * @var RawClient $client
+     */
+    private RawClient $client;
+
+    /**
+     * @param RawClient $client
+     * @param ?array{
+     *   baseUrl?: string,
+     *   client?: ClientInterface,
+     *   headers?: array<string, string>,
+     *   maxRetries?: int,
+     * } $options
+     */
+    public function __construct(
+        RawClient $client,
+        ?array $options = null,
+    ) {
+        $this->client = $client;
+        $this->options = $options ?? [];
+    }
+
+    /**
+     * Get the top users by streak length (active or longest).
+     *
+     * @param StreaksRankingsRequest $request
+     * @param ?array{
+     *   baseUrl?: string,
+     *   maxRetries?: int,
+     * } $options
+     * @return array<StreakRankingUser>
+     * @throws TrophyException
+     * @throws TrophyApiException
+     */
+    public function rankings(StreaksRankingsRequest $request, ?array $options = null): array
+    {
+        $options = array_merge($this->options, $options ?? []);
+        $query = [];
+        if ($request->limit != null) {
+            $query['limit'] = $request->limit;
+        }
+        if ($request->type != null) {
+            $query['type'] = $request->type;
+        }
+        try {
+            $response = $this->client->sendRequest(
+                new JsonApiRequest(
+                    baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Default_->value,
+                    path: "streaks/rankings",
+                    method: HttpMethod::GET,
+                    query: $query,
+                ),
+                $options,
+            );
+            $statusCode = $response->getStatusCode();
+            if ($statusCode >= 200 && $statusCode < 400) {
+                $json = $response->getBody()->getContents();
+                return JsonDecoder::decodeArray($json, [StreakRankingUser::class]); // @phpstan-ignore-line
+            }
+        } catch (JsonException $e) {
+            throw new TrophyException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+        } catch (RequestException $e) {
+            $response = $e->getResponse();
+            if ($response === null) {
+                throw new TrophyException(message: $e->getMessage(), previous: $e);
+            }
+            throw new TrophyApiException(
+                message: "API request failed",
+                statusCode: $response->getStatusCode(),
+                body: $response->getBody()->getContents(),
+            );
+        } catch (ClientExceptionInterface $e) {
+            throw new TrophyException(message: $e->getMessage(), previous: $e);
+        }
+        throw new TrophyApiException(
+            message: 'API request failed',
+            statusCode: $statusCode,
+            body: $response->getBody()->getContents(),
+        );
+    }
+}

src/Streaks/Types/StreaksRankingsRequestType.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Trophy\Streaks\Types;
+
+enum StreaksRankingsRequestType: string
+{
+    case Active = "active";
+    case Longest = "longest";
+}

src/TrophyClient.php

@@ -5,6 +5,7 @@
 use Trophy\Achievements\AchievementsClient;
 use Trophy\Metrics\MetricsClient;
 use Trophy\Users\UsersClient;
+use Trophy\Streaks\StreaksClient;
 use Trophy\Points\PointsClient;
 use GuzzleHttp\ClientInterface;
 use Trophy\Core\Client\RawClient;
@@ -26,6 +27,11 @@ class TrophyClient
      */
     public UsersClient $users;
 
+    /**
+     * @var StreaksClient $streaks
+     */
+    public StreaksClient $streaks;
+
     /**
      * @var PointsClient $points
      */
@@ -78,6 +84,7 @@ public function __construct(
         $this->achievements = new AchievementsClient($this->client, $this->options);
         $this->metrics = new MetricsClient($this->client, $this->options);
         $this->users = new UsersClient($this->client, $this->options);
+        $this->streaks = new StreaksClient($this->client, $this->options);
         $this->points = new PointsClient($this->client, $this->options);
     }
 }

src/Types/StreakRankingUser.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace Trophy\Types;
+
+use Trophy\Core\Json\JsonSerializableType;
+use Trophy\Core\Json\JsonProperty;
+
+/**
+ * A user with their streak length in the rankings.
+ */
+class StreakRankingUser extends JsonSerializableType
+{
+    /**
+     * @var string $userId The ID of the user.
+     */
+    #[JsonProperty('userId')]
+    public string $userId;
+
+    /**
+     * @var ?string $name The name of the user. May be null if no name is set.
+     */
+    #[JsonProperty('name')]
+    public ?string $name;
+
+    /**
+     * @var int $streakLength The user's streak length (active or longest depending on query parameter).
+     */
+    #[JsonProperty('streakLength')]
+    public int $streakLength;
+
+    /**
+     * @param array{
+     *   userId: string,
+     *   name?: ?string,
+     *   streakLength: int,
+     * } $values
+     */
+    public function __construct(
+        array $values,
+    ) {
+        $this->userId = $values['userId'];
+        $this->name = $values['name'] ?? null;
+        $this->streakLength = $values['streakLength'];
+    }
+
+    /**
+     * @return string
+     */
+    public function __toString(): string
+    {
+        return $this->toJson();
+    }
+}