Rename ModsSearchSortField back to ModSearchSortField

Author: JulianVennen

docs/Api/ModsApi.md

@@ -301,7 +301,7 @@ $class_id = 56; // int | Filter by section id (discoverable via Categories)
 $category_id = 56; // int | Filter by category id
 $game_version = 'game_version_example'; // string | Filter by game version string
 $search_filter = 'search_filter_example'; // string | Filter by free text search in the mod name and author
-$sort_field = new \Aternos\CurseForgeApi\Model\\Aternos\CurseForgeApi\Model\ModsSearchSortField(); // \Aternos\CurseForgeApi\Model\ModsSearchSortField | Filter by ModsSearchSortField enumeration
+$sort_field = new \Aternos\CurseForgeApi\Model\\Aternos\CurseForgeApi\Model\ModSearchSortField(); // \Aternos\CurseForgeApi\Model\ModSearchSortField | Filter by ModsSearchSortField enumeration
 $sort_order = new \Aternos\CurseForgeApi\Model\\Aternos\CurseForgeApi\Model\SortOrder(); // \Aternos\CurseForgeApi\Model\SortOrder | 'asc' if sort is in ascending order, 'desc' if sort is in descending order
 $mod_loader_type = new \Aternos\CurseForgeApi\Model\\Aternos\CurseForgeApi\Model\ModLoaderType(); // \Aternos\CurseForgeApi\Model\ModLoaderType | Filter only mods associated to a given modloader (Forge, Fabric ...). Must be coupled with gameVersion.
 $game_version_type_id = 56; // int | Filter only mods that contain files tagged with versions of the given gameVersionTypeId
@@ -332,7 +332,7 @@ try {
 | **category_id** | **int**| Filter by category id | [optional] |
 | **game_version** | **string**| Filter by game version string | [optional] |
 | **search_filter** | **string**| Filter by free text search in the mod name and author | [optional] |
-| **sort_field** | [**\Aternos\CurseForgeApi\Model\ModsSearchSortField**](../Model/.md)| Filter by ModsSearchSortField enumeration | [optional] |
+| **sort_field** | [**\Aternos\CurseForgeApi\Model\ModSearchSortField**](../Model/.md)| Filter by ModsSearchSortField enumeration | [optional] |
 | **sort_order** | [**\Aternos\CurseForgeApi\Model\SortOrder**](../Model/.md)| 'asc' if sort is in ascending order, 'desc' if sort is in descending order | [optional] |
 | **mod_loader_type** | [**\Aternos\CurseForgeApi\Model\ModLoaderType**](../Model/.md)| Filter only mods associated to a given modloader (Forge, Fabric ...). Must be coupled with gameVersion. | [optional] |
 | **game_version_type_id** | **int**| Filter only mods that contain files tagged with versions of the given gameVersionTypeId | [optional] |

docs/Model/ModsSearchSortField.md renamed to docs/Model/ModSearchSortField.md

@@ -1,4 +1,4 @@
-# # ModsSearchSortField
+# # ModSearchSortField
 
 ## Properties
 

openapi.yaml

@@ -285,7 +285,7 @@ paths:
           description: Filter by ModsSearchSortField enumeration
           required: false
           schema:
-            $ref: '#/components/schemas/ModsSearchSortField'
+            $ref: '#/components/schemas/ModSearchSortField'
         - name: sortOrder
           in: query
           description: >
@@ -2043,7 +2043,7 @@ components:
         - Fabric
         - Quilt
         - NeoForge
-    ModsSearchSortField:
+    ModSearchSortField:
       description: |
         Possible enum values:
          * 1 = Featured

src/Api/ModsApi.php

@@ -1516,7 +1516,7 @@ public function getModsRequest(
      * @param  int|null $category_id Filter by category id (optional)
      * @param  string|null $game_version Filter by game version string (optional)
      * @param  string|null $search_filter Filter by free text search in the mod name and author (optional)
-     * @param  \Aternos\CurseForgeApi\Model\ModsSearchSortField|null $sort_field Filter by ModsSearchSortField enumeration (optional)
+     * @param  \Aternos\CurseForgeApi\Model\ModSearchSortField|null $sort_field Filter by ModsSearchSortField enumeration (optional)
      * @param  \Aternos\CurseForgeApi\Model\SortOrder|null $sort_order 'asc' if sort is in ascending order, 'desc' if sort is in descending order (optional)
      * @param  \Aternos\CurseForgeApi\Model\ModLoaderType|null $mod_loader_type Filter only mods associated to a given modloader (Forge, Fabric ...). Must be coupled with gameVersion. (optional)
      * @param  int|null $game_version_type_id Filter only mods that contain files tagged with versions of the given gameVersionTypeId (optional)
@@ -1541,7 +1541,7 @@ public function searchMods(
         ?int $category_id = null,
         ?string $game_version = null,
         ?string $search_filter = null,
-        ?\Aternos\CurseForgeApi\Model\ModsSearchSortField $sort_field = null,
+        ?\Aternos\CurseForgeApi\Model\ModSearchSortField $sort_field = null,
         ?\Aternos\CurseForgeApi\Model\SortOrder $sort_order = null,
         ?\Aternos\CurseForgeApi\Model\ModLoaderType $mod_loader_type = null,
         ?int $game_version_type_id = null,
@@ -1571,7 +1571,7 @@ public function searchMods(
      * @param  int|null $category_id Filter by category id (optional)
      * @param  string|null $game_version Filter by game version string (optional)
      * @param  string|null $search_filter Filter by free text search in the mod name and author (optional)
-     * @param  \Aternos\CurseForgeApi\Model\ModsSearchSortField|null $sort_field Filter by ModsSearchSortField enumeration (optional)
+     * @param  \Aternos\CurseForgeApi\Model\ModSearchSortField|null $sort_field Filter by ModsSearchSortField enumeration (optional)
      * @param  \Aternos\CurseForgeApi\Model\SortOrder|null $sort_order 'asc' if sort is in ascending order, 'desc' if sort is in descending order (optional)
      * @param  \Aternos\CurseForgeApi\Model\ModLoaderType|null $mod_loader_type Filter only mods associated to a given modloader (Forge, Fabric ...). Must be coupled with gameVersion. (optional)
      * @param  int|null $game_version_type_id Filter only mods that contain files tagged with versions of the given gameVersionTypeId (optional)
@@ -1596,7 +1596,7 @@ public function searchModsWithHttpInfo(
         ?int $category_id = null,
         ?string $game_version = null,
         ?string $search_filter = null,
-        ?\Aternos\CurseForgeApi\Model\ModsSearchSortField $sort_field = null,
+        ?\Aternos\CurseForgeApi\Model\ModSearchSortField $sort_field = null,
         ?\Aternos\CurseForgeApi\Model\SortOrder $sort_order = null,
         ?\Aternos\CurseForgeApi\Model\ModLoaderType $mod_loader_type = null,
         ?int $game_version_type_id = null,
@@ -1733,7 +1733,7 @@ public function searchModsWithHttpInfo(
      * @param  int|null $category_id Filter by category id (optional)
      * @param  string|null $game_version Filter by game version string (optional)
      * @param  string|null $search_filter Filter by free text search in the mod name and author (optional)
-     * @param  \Aternos\CurseForgeApi\Model\ModsSearchSortField|null $sort_field Filter by ModsSearchSortField enumeration (optional)
+     * @param  \Aternos\CurseForgeApi\Model\ModSearchSortField|null $sort_field Filter by ModsSearchSortField enumeration (optional)
      * @param  \Aternos\CurseForgeApi\Model\SortOrder|null $sort_order 'asc' if sort is in ascending order, 'desc' if sort is in descending order (optional)
      * @param  \Aternos\CurseForgeApi\Model\ModLoaderType|null $mod_loader_type Filter only mods associated to a given modloader (Forge, Fabric ...). Must be coupled with gameVersion. (optional)
      * @param  int|null $game_version_type_id Filter only mods that contain files tagged with versions of the given gameVersionTypeId (optional)
@@ -1757,7 +1757,7 @@ public function searchModsAsync(
         ?int $category_id = null,
         ?string $game_version = null,
         ?string $search_filter = null,
-        ?\Aternos\CurseForgeApi\Model\ModsSearchSortField $sort_field = null,
+        ?\Aternos\CurseForgeApi\Model\ModSearchSortField $sort_field = null,
         ?\Aternos\CurseForgeApi\Model\SortOrder $sort_order = null,
         ?\Aternos\CurseForgeApi\Model\ModLoaderType $mod_loader_type = null,
         ?int $game_version_type_id = null,
@@ -1791,7 +1791,7 @@ function ($response) {
      * @param  int|null $category_id Filter by category id (optional)
      * @param  string|null $game_version Filter by game version string (optional)
      * @param  string|null $search_filter Filter by free text search in the mod name and author (optional)
-     * @param  \Aternos\CurseForgeApi\Model\ModsSearchSortField|null $sort_field Filter by ModsSearchSortField enumeration (optional)
+     * @param  \Aternos\CurseForgeApi\Model\ModSearchSortField|null $sort_field Filter by ModsSearchSortField enumeration (optional)
      * @param  \Aternos\CurseForgeApi\Model\SortOrder|null $sort_order 'asc' if sort is in ascending order, 'desc' if sort is in descending order (optional)
      * @param  \Aternos\CurseForgeApi\Model\ModLoaderType|null $mod_loader_type Filter only mods associated to a given modloader (Forge, Fabric ...). Must be coupled with gameVersion. (optional)
      * @param  int|null $game_version_type_id Filter only mods that contain files tagged with versions of the given gameVersionTypeId (optional)
@@ -1815,7 +1815,7 @@ public function searchModsAsyncWithHttpInfo(
         ?int $category_id = null,
         ?string $game_version = null,
         ?string $search_filter = null,
-        ?\Aternos\CurseForgeApi\Model\ModsSearchSortField $sort_field = null,
+        ?\Aternos\CurseForgeApi\Model\ModSearchSortField $sort_field = null,
         ?\Aternos\CurseForgeApi\Model\SortOrder $sort_order = null,
         ?\Aternos\CurseForgeApi\Model\ModLoaderType $mod_loader_type = null,
         ?int $game_version_type_id = null,
@@ -1878,7 +1878,7 @@ function ($exception) {
      * @param  int|null $category_id Filter by category id (optional)
      * @param  string|null $game_version Filter by game version string (optional)
      * @param  string|null $search_filter Filter by free text search in the mod name and author (optional)
-     * @param  \Aternos\CurseForgeApi\Model\ModsSearchSortField|null $sort_field Filter by ModsSearchSortField enumeration (optional)
+     * @param  \Aternos\CurseForgeApi\Model\ModSearchSortField|null $sort_field Filter by ModsSearchSortField enumeration (optional)
      * @param  \Aternos\CurseForgeApi\Model\SortOrder|null $sort_order 'asc' if sort is in ascending order, 'desc' if sort is in descending order (optional)
      * @param  \Aternos\CurseForgeApi\Model\ModLoaderType|null $mod_loader_type Filter only mods associated to a given modloader (Forge, Fabric ...). Must be coupled with gameVersion. (optional)
      * @param  int|null $game_version_type_id Filter only mods that contain files tagged with versions of the given gameVersionTypeId (optional)
@@ -1902,7 +1902,7 @@ public function searchModsRequest(
         ?int $category_id = null,
         ?string $game_version = null,
         ?string $search_filter = null,
-        ?\Aternos\CurseForgeApi\Model\ModsSearchSortField $sort_field = null,
+        ?\Aternos\CurseForgeApi\Model\ModSearchSortField $sort_field = null,
         ?\Aternos\CurseForgeApi\Model\SortOrder $sort_order = null,
         ?\Aternos\CurseForgeApi\Model\ModLoaderType $mod_loader_type = null,
         ?int $game_version_type_id = null,
@@ -2016,7 +2016,7 @@ public function searchModsRequest(
         $queryParams = array_merge($queryParams, ObjectSerializer::toQueryValue(
             $sort_field?->value,
             'sortField', // param base name
-            'ModsSearchSortField', // openApiType
+            'ModSearchSortField', // openApiType
             'form', // style
             true, // explode
             false // required

src/Client/Options/ModSearchOptions.php

@@ -4,7 +4,7 @@
 
 use Aternos\CurseForgeApi\Client\List\PaginatedModList;
 use Aternos\CurseForgeApi\Model\ModLoaderType;
-use Aternos\CurseForgeApi\Model\ModsSearchSortField;
+use Aternos\CurseForgeApi\Model\ModSearchSortField;
 use Aternos\CurseForgeApi\Model\PremiumType;
 use Aternos\CurseForgeApi\Model\SortOrder;
 
@@ -16,7 +16,7 @@ class ModSearchOptions
      * @param int[]|null $categoryIds
      * @param string[]|null $gameVersions
      * @param string|null $searchFilter Filter by free text search in the mod name and author
-     * @param ModsSearchSortField|null $sortField
+     * @param ModSearchSortField|null $sortField
      * @param SortOrder|null $sortOrder
      * @param ModLoaderType[]|null $modLoaderTypes Filter only mods associated to a given mod loader (Forge, Fabric ...). Must be coupled with gameVersion.
      * @param int|null $gameVersionTypeId Filter only mods that contain files tagged with versions of the given gameVersionTypeId
@@ -28,21 +28,21 @@ class ModSearchOptions
      * @param int $pageSize
      */
     public function __construct(
-        protected int                  $gameId,
-        protected int                  $offset = 0,
-        protected int                  $pageSize = PaginatedModList::MAX_PAGE_SIZE,
-        protected ?int                 $classId = null,
-        protected ?array               $categoryIds = null,
-        protected ?array               $gameVersions = null,
-        protected ?string              $searchFilter = null,
-        protected ?ModsSearchSortField $sortField = null,
-        protected ?SortOrder           $sortOrder = null,
-        protected ?array               $modLoaderTypes = null,
-        protected ?int                 $gameVersionTypeId = null,
-        protected ?int                 $authorId = null,
-        protected ?int                 $primaryAuthorId = null,
-        protected ?PremiumType         $premiumType = null,
-        protected ?string              $slug = null,
+        protected int                 $gameId,
+        protected int                 $offset = 0,
+        protected int                 $pageSize = PaginatedModList::MAX_PAGE_SIZE,
+        protected ?int                $classId = null,
+        protected ?array              $categoryIds = null,
+        protected ?array              $gameVersions = null,
+        protected ?string             $searchFilter = null,
+        protected ?ModSearchSortField $sortField = null,
+        protected ?SortOrder          $sortOrder = null,
+        protected ?array              $modLoaderTypes = null,
+        protected ?int                $gameVersionTypeId = null,
+        protected ?int                $authorId = null,
+        protected ?int                $primaryAuthorId = null,
+        protected ?PremiumType        $premiumType = null,
+        protected ?string             $slug = null,
     )
     {
     }
@@ -247,18 +247,18 @@ public function setSearchFilter(?string $searchFilter): static
     }
 
     /**
-     * @return ModsSearchSortField|null
+     * @return ModSearchSortField|null
      */
-    public function getSortField(): ?ModsSearchSortField
+    public function getSortField(): ?ModSearchSortField
     {
         return $this->sortField;
     }
 
     /**
-     * @param ModsSearchSortField|null $sortField
+     * @param ModSearchSortField|null $sortField
      * @return $this
      */
-    public function setSortField(?ModsSearchSortField $sortField): static
+    public function setSortField(?ModSearchSortField $sortField): static
     {
         $this->sortField = $sortField;
         return $this;

src/Model/ModsSearchSortField.php renamed to src/Model/ModSearchSortField.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * ModsSearchSortField
+ * ModSearchSortField
  *
  * PHP version 8.1
  *
@@ -28,14 +28,14 @@
 namespace Aternos\CurseForgeApi\Model;
 
 /**
- * ModsSearchSortField Class Doc Comment
+ * ModSearchSortField Class Doc Comment
  *
  * @description Possible enum values:  * 1 &#x3D; Featured  * 2 &#x3D; Popularity  * 3 &#x3D; LastUpdated              * 4 &#x3D; Name  * 5 &#x3D; Author  * 6 &#x3D; TotalDownloads  * 7 &#x3D; Category  * 8 &#x3D; GameVersion  * 9 &#x3D; Early Access  * 10 &#x3D; Featured Release  * 11 &#x3D; Release Date  * 12 &#x3D; Rating
  * @package  Aternos\CurseForgeApi
  * @author   OpenAPI Generator team
  * @link     https://openapi-generator.tech
  */
-enum ModsSearchSortField: int
+enum ModSearchSortField: int
 {
     case FEATURED = 1;
 

tests/Unit/Client/Options/ModSearchOptionsTest.php

@@ -4,7 +4,7 @@
 
 use Aternos\CurseForgeApi\Client\Options\ModSearchOptions;
 use Aternos\CurseForgeApi\Model\ModLoaderType;
-use Aternos\CurseForgeApi\Model\ModsSearchSortField;
+use Aternos\CurseForgeApi\Model\ModSearchSortField;
 use Aternos\CurseForgeApi\Model\PremiumType;
 use Aternos\CurseForgeApi\Model\SortOrder;
 use PHPUnit\Framework\TestCase;
@@ -155,8 +155,8 @@ public function testSetSortField(): void
     {
         $modSearchOptions = new ModSearchOptions(1);
         $this->assertNull($modSearchOptions->getSortField());
-        $modSearchOptions->setSortField(ModsSearchSortField::NAME);
-        $this->assertSame(ModsSearchSortField::NAME, $modSearchOptions->getSortField());
+        $modSearchOptions->setSortField(ModSearchSortField::NAME);
+        $this->assertSame(ModSearchSortField::NAME, $modSearchOptions->getSortField());
         $modSearchOptions->setSortField(null);
         $this->assertNull($modSearchOptions->getSortField());
     }