Merge pull request #1358 from php-api-clients/GitHub/from-1.1.4-c0318…

…3a8896046a8cd867a6cab6116d9-from-1.1.4-c03183a8896046a8cd867a6cab6116d9
php-api-clients · Nov 20, 2024 · 2656cbb · 2656cbb
2 parents e9ee0b2 + 06a4e92
commit 2656cbb
Show file tree

Hide file tree

Showing 54 changed files with 183 additions and 186 deletions.
diff --git a/clients/GitHub/etc/openapi-client-generator.state b/clients/GitHub/etc/openapi-client-generator.state
diff --git a/clients/GitHub/src/Internal/Operation/ApiInsights/GetRouteStatsByActor.php b/clients/GitHub/src/Internal/Operation/ApiInsights/GetRouteStatsByActor.php
@@ -30,9 +30,9 @@ final class GetRouteStatsByActor
     private string $actorType;
     /**The ID of the actor **/
     private int $actorId;
-    /**The minimum timestamp to query for stats **/
+    /**The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. **/
     private string $minTimestamp;
-    /**The maximum timestamp to query for stats **/
+    /**The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. **/
     private string $maxTimestamp;
     /**The property to sort the results by. **/
     private array $sort;

diff --git a/clients/GitHub/src/Internal/Operation/ApiInsights/GetRouteStatsByActorListing.php b/clients/GitHub/src/Internal/Operation/ApiInsights/GetRouteStatsByActorListing.php
@@ -30,9 +30,9 @@ final class GetRouteStatsByActorListing
     private string $actorType;
     /**The ID of the actor **/
     private int $actorId;
-    /**The minimum timestamp to query for stats **/
+    /**The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. **/
     private string $minTimestamp;
-    /**The maximum timestamp to query for stats **/
+    /**The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. **/
     private string $maxTimestamp;
     /**The property to sort the results by. **/
     private array $sort;

diff --git a/clients/GitHub/src/Internal/Operation/ApiInsights/GetSubjectStats.php b/clients/GitHub/src/Internal/Operation/ApiInsights/GetSubjectStats.php
@@ -26,9 +26,9 @@ final class GetSubjectStats
     public const OPERATION_MATCH = 'GET /orgs/{org}/insights/api/subject-stats';
     /**The organization name. The name is not case sensitive. **/
     private string $org;
-    /**The minimum timestamp to query for stats **/
+    /**The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. **/
     private string $minTimestamp;
-    /**The maximum timestamp to query for stats **/
+    /**The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. **/
     private string $maxTimestamp;
     /**The property to sort the results by. **/
     private array $sort;

diff --git a/clients/GitHub/src/Internal/Operation/ApiInsights/GetSubjectStatsListing.php b/clients/GitHub/src/Internal/Operation/ApiInsights/GetSubjectStatsListing.php
@@ -26,9 +26,9 @@ final class GetSubjectStatsListing
     public const OPERATION_MATCH = 'LIST /orgs/{org}/insights/api/subject-stats';
     /**The organization name. The name is not case sensitive. **/
     private string $org;
-    /**The minimum timestamp to query for stats **/
+    /**The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. **/
     private string $minTimestamp;
-    /**The maximum timestamp to query for stats **/
+    /**The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. **/
     private string $maxTimestamp;
     /**The property to sort the results by. **/
     private array $sort;

diff --git a/clients/GitHub/src/Internal/Operation/ApiInsights/GetSummaryStats.php b/clients/GitHub/src/Internal/Operation/ApiInsights/GetSummaryStats.php
@@ -23,9 +23,9 @@ final class GetSummaryStats
     public const OPERATION_MATCH = 'GET /orgs/{org}/insights/api/summary-stats';
     /**The organization name. The name is not case sensitive. **/
     private string $org;
-    /**The minimum timestamp to query for stats **/
+    /**The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. **/
     private string $minTimestamp;
-    /**The maximum timestamp to query for stats **/
+    /**The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. **/
     private string $maxTimestamp;
 
     public function __construct(private readonly SchemaValidator $responseSchemaValidator, private readonly Internal\Hydrator\Operation\Orgs\Org\Insights\Api\SummaryStats $hydrator, string $org, string $minTimestamp, string $maxTimestamp)

diff --git a/clients/GitHub/src/Internal/Operation/ApiInsights/GetSummaryStatsByActor.php b/clients/GitHub/src/Internal/Operation/ApiInsights/GetSummaryStatsByActor.php
@@ -23,9 +23,9 @@ final class GetSummaryStatsByActor
     public const OPERATION_MATCH = 'GET /orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}';
     /**The organization name. The name is not case sensitive. **/
     private string $org;
-    /**The minimum timestamp to query for stats **/
+    /**The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. **/
     private string $minTimestamp;
-    /**The maximum timestamp to query for stats **/
+    /**The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. **/
     private string $maxTimestamp;
     /**The type of the actor **/
     private string $actorType;

diff --git a/clients/GitHub/src/Internal/Operation/ApiInsights/GetSummaryStatsByUser.php b/clients/GitHub/src/Internal/Operation/ApiInsights/GetSummaryStatsByUser.php
@@ -25,9 +25,9 @@ final class GetSummaryStatsByUser
     private string $org;
     /**The ID of the user to query for stats **/
     private string $userId;
-    /**The minimum timestamp to query for stats **/
+    /**The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. **/
     private string $minTimestamp;
-    /**The maximum timestamp to query for stats **/
+    /**The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. **/
     private string $maxTimestamp;
 
     public function __construct(private readonly SchemaValidator $responseSchemaValidator, private readonly Internal\Hydrator\Operation\Orgs\Org\Insights\Api\SummaryStats\Users\UserId $hydrator, string $org, string $userId, string $minTimestamp, string $maxTimestamp)

diff --git a/clients/GitHub/src/Internal/Operation/ApiInsights/GetTimeStats.php b/clients/GitHub/src/Internal/Operation/ApiInsights/GetTimeStats.php
@@ -26,9 +26,9 @@ final class GetTimeStats
     public const OPERATION_MATCH = 'GET /orgs/{org}/insights/api/time-stats';
     /**The organization name. The name is not case sensitive. **/
     private string $org;
-    /**The minimum timestamp to query for stats **/
+    /**The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. **/
     private string $minTimestamp;
-    /**The maximum timestamp to query for stats **/
+    /**The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. **/
     private string $maxTimestamp;
     /**The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) **/
     private string $timestampIncrement;

diff --git a/clients/GitHub/src/Internal/Operation/ApiInsights/GetTimeStatsByActor.php b/clients/GitHub/src/Internal/Operation/ApiInsights/GetTimeStatsByActor.php
@@ -30,9 +30,9 @@ final class GetTimeStatsByActor
     private string $actorType;
     /**The ID of the actor **/
     private int $actorId;
-    /**The minimum timestamp to query for stats **/
+    /**The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. **/
     private string $minTimestamp;
-    /**The maximum timestamp to query for stats **/
+    /**The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. **/
     private string $maxTimestamp;
     /**The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) **/
     private string $timestampIncrement;

diff --git a/clients/GitHub/src/Internal/Operation/ApiInsights/GetTimeStatsByUser.php b/clients/GitHub/src/Internal/Operation/ApiInsights/GetTimeStatsByUser.php
@@ -28,9 +28,9 @@ final class GetTimeStatsByUser
     private string $org;
     /**The ID of the user to query for stats **/
     private string $userId;
-    /**The minimum timestamp to query for stats **/
+    /**The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. **/
     private string $minTimestamp;
-    /**The maximum timestamp to query for stats **/
+    /**The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. **/
     private string $maxTimestamp;
     /**The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) **/
     private string $timestampIncrement;

diff --git a/clients/GitHub/src/Internal/Operation/ApiInsights/GetUserStats.php b/clients/GitHub/src/Internal/Operation/ApiInsights/GetUserStats.php
@@ -28,9 +28,9 @@ final class GetUserStats
     private string $org;
     /**The ID of the user to query for stats **/
     private string $userId;
-    /**The minimum timestamp to query for stats **/
+    /**The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. **/
     private string $minTimestamp;
-    /**The maximum timestamp to query for stats **/
+    /**The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. **/
     private string $maxTimestamp;
     /**The property to sort the results by. **/
     private array $sort;

diff --git a/clients/GitHub/src/Internal/Operation/ApiInsights/GetUserStatsListing.php b/clients/GitHub/src/Internal/Operation/ApiInsights/GetUserStatsListing.php
@@ -28,9 +28,9 @@ final class GetUserStatsListing
     private string $org;
     /**The ID of the user to query for stats **/
     private string $userId;
-    /**The minimum timestamp to query for stats **/
+    /**The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. **/
     private string $minTimestamp;
-    /**The maximum timestamp to query for stats **/
+    /**The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. **/
     private string $maxTimestamp;
     /**The property to sort the results by. **/
     private array $sort;

diff --git a/clients/GitHub/src/Internal/Operator/ApiInsights/GetRouteStatsByActor.php b/clients/GitHub/src/Internal/Operator/ApiInsights/GetRouteStatsByActor.php
@@ -24,7 +24,7 @@ public function __construct(private Browser $browser, private AuthenticationInte
     {
     }
 
-    /** @return Observable<Schema\ApiInsightsRouteStats> */
+    /** @return iterable<int,Schema\ApiInsightsRouteStats> */
     public function call(string $org, string $actorType, int $actorId, string $minTimestamp, string $maxTimestamp, array $sort, int $page = 1, int $perPage = 30, string $direction = 'desc'): iterable
     {
         $operation = new \ApiClients\Client\GitHub\Internal\Operation\ApiInsights\GetRouteStatsByActor($this->responseSchemaValidator, $this->hydrator, $org, $actorType, $actorId, $minTimestamp, $maxTimestamp, $sort, $page, $perPage, $direction);

diff --git a/clients/GitHub/src/Internal/Operator/ApiInsights/GetRouteStatsByActorListing.php b/clients/GitHub/src/Internal/Operator/ApiInsights/GetRouteStatsByActorListing.php
@@ -24,7 +24,7 @@ public function __construct(private Browser $browser, private AuthenticationInte
     {
     }
 
-    /** @return Observable<Schema\ApiInsightsRouteStats> */
+    /** @return iterable<int,Schema\ApiInsightsRouteStats> */
     public function call(string $org, string $actorType, int $actorId, string $minTimestamp, string $maxTimestamp, array $sort, int $page = 1, int $perPage = 30, string $direction = 'desc'): iterable
     {
         $operation = new \ApiClients\Client\GitHub\Internal\Operation\ApiInsights\GetRouteStatsByActorListing($this->responseSchemaValidator, $this->hydrator, $org, $actorType, $actorId, $minTimestamp, $maxTimestamp, $sort, $page, $perPage, $direction);

diff --git a/clients/GitHub/src/Internal/Operator/ApiInsights/GetSubjectStats.php b/clients/GitHub/src/Internal/Operator/ApiInsights/GetSubjectStats.php
@@ -24,7 +24,7 @@ public function __construct(private Browser $browser, private AuthenticationInte
     {
     }
 
-    /** @return Observable<Schema\ApiInsightsSubjectStats> */
+    /** @return iterable<int,Schema\ApiInsightsSubjectStats> */
     public function call(string $org, string $minTimestamp, string $maxTimestamp, array $sort, int $page = 1, int $perPage = 30, string $direction = 'desc'): iterable
     {
         $operation = new \ApiClients\Client\GitHub\Internal\Operation\ApiInsights\GetSubjectStats($this->responseSchemaValidator, $this->hydrator, $org, $minTimestamp, $maxTimestamp, $sort, $page, $perPage, $direction);

diff --git a/clients/GitHub/src/Internal/Operator/ApiInsights/GetSubjectStatsListing.php b/clients/GitHub/src/Internal/Operator/ApiInsights/GetSubjectStatsListing.php
@@ -24,7 +24,7 @@ public function __construct(private Browser $browser, private AuthenticationInte
     {
     }
 
-    /** @return Observable<Schema\ApiInsightsSubjectStats> */
+    /** @return iterable<int,Schema\ApiInsightsSubjectStats> */
     public function call(string $org, string $minTimestamp, string $maxTimestamp, array $sort, int $page = 1, int $perPage = 30, string $direction = 'desc'): iterable
     {
         $operation = new \ApiClients\Client\GitHub\Internal\Operation\ApiInsights\GetSubjectStatsListing($this->responseSchemaValidator, $this->hydrator, $org, $minTimestamp, $maxTimestamp, $sort, $page, $perPage, $direction);

diff --git a/clients/GitHub/src/Internal/Operator/ApiInsights/GetSummaryStats.php b/clients/GitHub/src/Internal/Operator/ApiInsights/GetSummaryStats.php
@@ -24,7 +24,6 @@ public function __construct(private Browser $browser, private AuthenticationInte
     {
     }
 
-    /** @return */
     public function call(string $org, string $minTimestamp, string $maxTimestamp): ApiInsightsSummaryStats
     {
         $operation = new \ApiClients\Client\GitHub\Internal\Operation\ApiInsights\GetSummaryStats($this->responseSchemaValidator, $this->hydrator, $org, $minTimestamp, $maxTimestamp);

diff --git a/clients/GitHub/src/Internal/Operator/ApiInsights/GetSummaryStatsByActor.php b/clients/GitHub/src/Internal/Operator/ApiInsights/GetSummaryStatsByActor.php
@@ -24,7 +24,6 @@ public function __construct(private Browser $browser, private AuthenticationInte
     {
     }
 
-    /** @return */
     public function call(string $org, string $minTimestamp, string $maxTimestamp, string $actorType, int $actorId): ApiInsightsSummaryStats
     {
         $operation = new \ApiClients\Client\GitHub\Internal\Operation\ApiInsights\GetSummaryStatsByActor($this->responseSchemaValidator, $this->hydrator, $org, $minTimestamp, $maxTimestamp, $actorType, $actorId);

diff --git a/clients/GitHub/src/Internal/Operator/ApiInsights/GetSummaryStatsByUser.php b/clients/GitHub/src/Internal/Operator/ApiInsights/GetSummaryStatsByUser.php
@@ -24,7 +24,6 @@ public function __construct(private Browser $browser, private AuthenticationInte
     {
     }
 
-    /** @return */
     public function call(string $org, string $userId, string $minTimestamp, string $maxTimestamp): ApiInsightsSummaryStats
     {
         $operation = new \ApiClients\Client\GitHub\Internal\Operation\ApiInsights\GetSummaryStatsByUser($this->responseSchemaValidator, $this->hydrator, $org, $userId, $minTimestamp, $maxTimestamp);

diff --git a/clients/GitHub/src/Internal/Operator/ApiInsights/GetTimeStats.php b/clients/GitHub/src/Internal/Operator/ApiInsights/GetTimeStats.php
@@ -24,7 +24,7 @@ public function __construct(private Browser $browser, private AuthenticationInte
     {
     }
 
-    /** @return Observable<Schema\ApiInsightsTimeStats> */
+    /** @return iterable<int,Schema\ApiInsightsTimeStats> */
     public function call(string $org, string $minTimestamp, string $maxTimestamp, string $timestampIncrement): iterable
     {
         $operation = new \ApiClients\Client\GitHub\Internal\Operation\ApiInsights\GetTimeStats($this->responseSchemaValidator, $this->hydrator, $org, $minTimestamp, $maxTimestamp, $timestampIncrement);

diff --git a/clients/GitHub/src/Internal/Operator/ApiInsights/GetTimeStatsByActor.php b/clients/GitHub/src/Internal/Operator/ApiInsights/GetTimeStatsByActor.php
@@ -24,7 +24,7 @@ public function __construct(private Browser $browser, private AuthenticationInte
     {
     }
 
-    /** @return Observable<Schema\ApiInsightsTimeStats> */
+    /** @return iterable<int,Schema\ApiInsightsTimeStats> */
     public function call(string $org, string $actorType, int $actorId, string $minTimestamp, string $maxTimestamp, string $timestampIncrement): iterable
     {
         $operation = new \ApiClients\Client\GitHub\Internal\Operation\ApiInsights\GetTimeStatsByActor($this->responseSchemaValidator, $this->hydrator, $org, $actorType, $actorId, $minTimestamp, $maxTimestamp, $timestampIncrement);

diff --git a/clients/GitHub/src/Internal/Operator/ApiInsights/GetTimeStatsByUser.php b/clients/GitHub/src/Internal/Operator/ApiInsights/GetTimeStatsByUser.php
@@ -24,7 +24,7 @@ public function __construct(private Browser $browser, private AuthenticationInte
     {
     }
 
-    /** @return Observable<Schema\ApiInsightsTimeStats> */
+    /** @return iterable<int,Schema\ApiInsightsTimeStats> */
     public function call(string $org, string $userId, string $minTimestamp, string $maxTimestamp, string $timestampIncrement): iterable
     {
         $operation = new \ApiClients\Client\GitHub\Internal\Operation\ApiInsights\GetTimeStatsByUser($this->responseSchemaValidator, $this->hydrator, $org, $userId, $minTimestamp, $maxTimestamp, $timestampIncrement);

diff --git a/clients/GitHub/src/Internal/Operator/ApiInsights/GetUserStats.php b/clients/GitHub/src/Internal/Operator/ApiInsights/GetUserStats.php
@@ -24,7 +24,7 @@ public function __construct(private Browser $browser, private AuthenticationInte
     {
     }
 
-    /** @return Observable<Schema\ApiInsightsUserStats> */
+    /** @return iterable<int,Schema\ApiInsightsUserStats> */
     public function call(string $org, string $userId, string $minTimestamp, string $maxTimestamp, array $sort, int $page = 1, int $perPage = 30, string $direction = 'desc'): iterable
     {
         $operation = new \ApiClients\Client\GitHub\Internal\Operation\ApiInsights\GetUserStats($this->responseSchemaValidator, $this->hydrator, $org, $userId, $minTimestamp, $maxTimestamp, $sort, $page, $perPage, $direction);

diff --git a/clients/GitHub/src/Internal/Operator/ApiInsights/GetUserStatsListing.php b/clients/GitHub/src/Internal/Operator/ApiInsights/GetUserStatsListing.php
@@ -24,7 +24,7 @@ public function __construct(private Browser $browser, private AuthenticationInte
     {
     }
 
-    /** @return Observable<Schema\ApiInsightsUserStats> */
+    /** @return iterable<int,Schema\ApiInsightsUserStats> */
     public function call(string $org, string $userId, string $minTimestamp, string $maxTimestamp, array $sort, int $page = 1, int $perPage = 30, string $direction = 'desc'): iterable
     {
         $operation = new \ApiClients\Client\GitHub\Internal\Operation\ApiInsights\GetUserStatsListing($this->responseSchemaValidator, $this->hydrator, $org, $userId, $minTimestamp, $maxTimestamp, $sort, $page, $perPage, $direction);