Add UNKNOWN_TO_SDK value to enums (#1998)

fix 1921

Author: jderusse

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## NOT RELEASED
 
+### Added
+
+- Add `UNKNOWN_TO_SDK` value to enums that is used when the API returns an value that is not (or not yet) known by the AsyncAws
+
 ### Dependency bumped
 
 - Drop support for PHP versions lower than 8.2

src/Enum/DimensionUnit.php

@@ -7,6 +7,9 @@ final class DimensionUnit
     public const FEET = 'Feet';
     public const METERS = 'Meters';
 
+    /**
+     * @psalm-assert-if-true self::* $value
+     */
     public static function exists(string $value): bool
     {
         return isset([

src/Enum/DistanceUnit.php

@@ -6,7 +6,11 @@ final class DistanceUnit
 {
     public const KILOMETERS = 'Kilometers';
     public const MILES = 'Miles';
+    public const UNKNOWN_TO_SDK = 'UNKNOWN_TO_SDK';
 
+    /**
+     * @psalm-assert-if-true self::* $value
+     */
     public static function exists(string $value): bool
     {
         return isset([

src/Enum/OptimizationMode.php

@@ -7,6 +7,9 @@ final class OptimizationMode
     public const FASTEST_ROUTE = 'FastestRoute';
     public const SHORTEST_ROUTE = 'ShortestRoute';
 
+    /**
+     * @psalm-assert-if-true self::* $value
+     */
     public static function exists(string $value): bool
     {
         return isset([

src/Enum/RouteMatrixErrorCode.php

@@ -10,7 +10,11 @@ final class RouteMatrixErrorCode
     public const POSITIONS_NOT_FOUND = 'PositionsNotFound';
     public const ROUTE_NOT_FOUND = 'RouteNotFound';
     public const ROUTE_TOO_LONG = 'RouteTooLong';
+    public const UNKNOWN_TO_SDK = 'UNKNOWN_TO_SDK';
 
+    /**
+     * @psalm-assert-if-true self::* $value
+     */
     public static function exists(string $value): bool
     {
         return isset([

src/Enum/TravelMode.php

@@ -10,6 +10,9 @@ final class TravelMode
     public const TRUCK = 'Truck';
     public const WALKING = 'Walking';
 
+    /**
+     * @psalm-assert-if-true self::* $value
+     */
     public static function exists(string $value): bool
     {
         return isset([

src/Enum/ValidationExceptionReason.php

@@ -10,7 +10,11 @@ final class ValidationExceptionReason
     public const OTHER = 'Other';
     public const UNKNOWN_FIELD = 'UnknownField';
     public const UNKNOWN_OPERATION = 'UnknownOperation';
+    public const UNKNOWN_TO_SDK = 'UNKNOWN_TO_SDK';
 
+    /**
+     * @psalm-assert-if-true self::* $value
+     */
     public static function exists(string $value): bool
     {
         return isset([

src/Enum/VehicleWeightUnit.php

@@ -7,6 +7,9 @@ final class VehicleWeightUnit
     public const KILOGRAMS = 'Kilograms';
     public const POUNDS = 'Pounds';
 
+    /**
+     * @psalm-assert-if-true self::* $value
+     */
     public static function exists(string $value): bool
     {
         return isset([

src/Exception/ValidationException.php

@@ -46,7 +46,7 @@ protected function populateResult(ResponseInterface $response): void
     {
         $data = $response->toArray(false);
 
-        $this->reason = (string) $data['reason'];
+        $this->reason = !ValidationExceptionReason::exists((string) $data['reason']) ? ValidationExceptionReason::UNKNOWN_TO_SDK : (string) $data['reason'];
         $this->fieldList = $this->populateResultValidationExceptionFieldList($data['fieldList'] ?? []);
     }
 

src/Input/CalculateRouteMatrixRequest.php

@@ -424,6 +424,7 @@ private function requestBody(): array
 
         if (null !== $v = $this->travelMode) {
             if (!TravelMode::exists($v)) {
+                /** @psalm-suppress NoValue */
                 throw new InvalidArgument(\sprintf('Invalid parameter "TravelMode" for "%s". The value "%s" is not a valid "TravelMode".', __CLASS__, $v));
             }
             $payload['TravelMode'] = $v;
@@ -436,6 +437,7 @@ private function requestBody(): array
         }
         if (null !== $v = $this->distanceUnit) {
             if (!DistanceUnit::exists($v)) {
+                /** @psalm-suppress NoValue */
                 throw new InvalidArgument(\sprintf('Invalid parameter "DistanceUnit" for "%s". The value "%s" is not a valid "DistanceUnit".', __CLASS__, $v));
             }
             $payload['DistanceUnit'] = $v;