Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions docs/Api/FilesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ try {
## `getModFileChangelog()`

```php
getModFileChangelog($mod_id, $file_id): \Aternos\CurseForgeApi\Model\GetModFileChangelogResponse
getModFileChangelog($mod_id, $file_id, $raw, $stripped, $markup): \Aternos\CurseForgeApi\Model\GetModFileChangelogResponse
```

Get mod file changelog
Expand Down Expand Up @@ -168,9 +168,12 @@ $apiInstance = new Aternos\CurseForgeApi\Api\FilesApi(
);
$mod_id = 56; // int | The mod id the file belongs to
$file_id = 56; // int | The file id.
$raw = True; // bool | Get raw changelog without things like external link redirects
$stripped = True; // bool | Get the changelog with all HTML tags removed
$markup = True; // bool

try {
$result = $apiInstance->getModFileChangelog($mod_id, $file_id);
$result = $apiInstance->getModFileChangelog($mod_id, $file_id, $raw, $stripped, $markup);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling FilesApi->getModFileChangelog: ', $e->getMessage(), PHP_EOL;
Expand All @@ -183,6 +186,9 @@ try {
| ------------- | ------------- | ------------- | ------------- |
| **mod_id** | **int**| The mod id the file belongs to | |
| **file_id** | **int**| The file id. | |
| **raw** | **bool**| Get raw changelog without things like external link redirects | [optional] |
| **stripped** | **bool**| Get the changelog with all HTML tags removed | [optional] |
| **markup** | **bool**| | [optional] |

### Return type

Expand Down Expand Up @@ -268,7 +274,7 @@ try {
## `getModFiles()`

```php
getModFiles($mod_id, $index, $page_size, $game_version, $mod_loader_type, $game_version_type_id, $older_than_project_file_id, $release_types, $platform_type): \Aternos\CurseForgeApi\Model\GetModFilesResponse
getModFiles($mod_id, $index, $page_size, $game_version, $mod_loader_type, $game_version_type_id, $older_than_project_file_id, $release_types, $platform_type, $client_compatible): \Aternos\CurseForgeApi\Model\GetModFilesResponse
```

Get mod files.
Expand Down Expand Up @@ -303,9 +309,10 @@ $game_version_type_id = 56; // int | Filter only files that are tagged with vers
$older_than_project_file_id = 56; // int | Filter only files older than the given file ID
$release_types = array(new \Aternos\CurseForgeApi\Model\\Aternos\CurseForgeApi\Model\FileReleaseType()); // \Aternos\CurseForgeApi\Model\FileReleaseType[] | Filter only files that are of the given release types
$platform_type = new \Aternos\CurseForgeApi\Model\\Aternos\CurseForgeApi\Model\PlatformType(); // \Aternos\CurseForgeApi\Model\PlatformType | Filter only files supporting the given platform type
$client_compatible = True; // bool | When set to true, filter OUT any file that isn't client compatible.

try {
$result = $apiInstance->getModFiles($mod_id, $index, $page_size, $game_version, $mod_loader_type, $game_version_type_id, $older_than_project_file_id, $release_types, $platform_type);
$result = $apiInstance->getModFiles($mod_id, $index, $page_size, $game_version, $mod_loader_type, $game_version_type_id, $older_than_project_file_id, $release_types, $platform_type, $client_compatible);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling FilesApi->getModFiles: ', $e->getMessage(), PHP_EOL;
Expand All @@ -325,6 +332,7 @@ try {
| **older_than_project_file_id** | **int**| Filter only files older than the given file ID | [optional] |
| **release_types** | [**\Aternos\CurseForgeApi\Model\FileReleaseType[]**](../Model/\Aternos\CurseForgeApi\Model\FileReleaseType.md)| Filter only files that are of the given release types | [optional] |
| **platform_type** | [**\Aternos\CurseForgeApi\Model\PlatformType**](../Model/.md)| Filter only files supporting the given platform type | [optional] |
| **client_compatible** | **bool**| When set to true, filter OUT any file that isn't client compatible. | [optional] |

### Return type

Expand Down
14 changes: 10 additions & 4 deletions docs/Api/ModsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ try {
## `getModDescription()`

```php
getModDescription($mod_id, $raw, $stripped, $markup): \Aternos\CurseForgeApi\Model\ModDescriptionResponse
getModDescription($mod_id, $raw, $stripped, $markup, $lang): \Aternos\CurseForgeApi\Model\ModDescriptionResponse
```

Get mod description.
Expand Down Expand Up @@ -168,9 +168,10 @@ $mod_id = 56; // int | The mod id.
$raw = True; // bool | Get raw description without things like external link redirects
$stripped = True; // bool | Get the description with all HTML tags removed
$markup = True; // bool
$lang = 'en'; // string

try {
$result = $apiInstance->getModDescription($mod_id, $raw, $stripped, $markup);
$result = $apiInstance->getModDescription($mod_id, $raw, $stripped, $markup, $lang);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ModsApi->getModDescription: ', $e->getMessage(), PHP_EOL;
Expand All @@ -185,6 +186,7 @@ try {
| **raw** | **bool**| Get raw description without things like external link redirects | [optional] |
| **stripped** | **bool**| Get the description with all HTML tags removed | [optional] |
| **markup** | **bool**| | [optional] |
| **lang** | **string**| | [optional] [default to 'en'] |

### Return type

Expand Down Expand Up @@ -268,7 +270,7 @@ try {
## `searchMods()`

```php
searchMods($game_id, $index, $page_size, $class_id, $category_id, $game_version, $search_filter, $sort_field, $sort_order, $mod_loader_type, $game_version_type_id, $author_id, $slug, $category_ids, $game_versions, $mod_loader_types, $primary_author_id, $premium_type): \Aternos\CurseForgeApi\Model\SearchModsResponse
searchMods($game_id, $index, $page_size, $class_id, $category_id, $game_version, $search_filter, $sort_field, $sort_order, $mod_loader_type, $game_version_type_id, $author_id, $slug, $category_ids, $game_versions, $mod_loader_types, $primary_author_id, $premium_type, $client_compatible, $mods_search_enhanced_features): \Aternos\CurseForgeApi\Model\SearchModsResponse
```

Get all mods that match the search criteria.
Expand Down Expand Up @@ -312,9 +314,11 @@ $game_versions = 'game_versions_example'; // string | Filter by a list of game v
$mod_loader_types = 'mod_loader_types_example'; // string | Filter by a list of modloader types. This will override modLoaderType. Limited to 5 items.
$primary_author_id = 56; // int | Filter only mods that the given primaryAuthorId is the owner of.
$premium_type = new \Aternos\CurseForgeApi\Model\\Aternos\CurseForgeApi\Model\PremiumType(); // \Aternos\CurseForgeApi\Model\PremiumType | Filter only mods that are Premium or not.
$client_compatible = True; // bool | When set to true, will filter out any mod that doesn't have a default file that is compatible with the client. This is usually due to a bad file structure of the file (which might cause unexpected behaviours on the user's machine - such as overriding other mods installed).
$mods_search_enhanced_features = 56; // int | Bitwise number with values from ModsSearchEnhancedFeatures

try {
$result = $apiInstance->searchMods($game_id, $index, $page_size, $class_id, $category_id, $game_version, $search_filter, $sort_field, $sort_order, $mod_loader_type, $game_version_type_id, $author_id, $slug, $category_ids, $game_versions, $mod_loader_types, $primary_author_id, $premium_type);
$result = $apiInstance->searchMods($game_id, $index, $page_size, $class_id, $category_id, $game_version, $search_filter, $sort_field, $sort_order, $mod_loader_type, $game_version_type_id, $author_id, $slug, $category_ids, $game_versions, $mod_loader_types, $primary_author_id, $premium_type, $client_compatible, $mods_search_enhanced_features);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ModsApi->searchMods: ', $e->getMessage(), PHP_EOL;
Expand Down Expand Up @@ -343,6 +347,8 @@ try {
| **mod_loader_types** | **string**| Filter by a list of modloader types. This will override modLoaderType. Limited to 5 items. | [optional] |
| **primary_author_id** | **int**| Filter only mods that the given primaryAuthorId is the owner of. | [optional] |
| **premium_type** | [**\Aternos\CurseForgeApi\Model\PremiumType**](../Model/.md)| Filter only mods that are Premium or not. | [optional] |
| **client_compatible** | **bool**| When set to true, will filter out any mod that doesn't have a default file that is compatible with the client. This is usually due to a bad file structure of the file (which might cause unexpected behaviours on the user's machine - such as overriding other mods installed). | [optional] |
| **mods_search_enhanced_features** | **int**| Bitwise number with values from ModsSearchEnhancedFeatures | [optional] |

### Return type

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/AffiliationServiceType.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # AffiliationServiceType
# AffiliationServiceType

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/ApiResponseOfListOfMinecraftGameVersion.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # ApiResponseOfListOfMinecraftGameVersion
# ApiResponseOfListOfMinecraftGameVersion

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/ApiResponseOfListOfMinecraftModLoaderIndex.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # ApiResponseOfListOfMinecraftModLoaderIndex
# ApiResponseOfListOfMinecraftModLoaderIndex

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/ApiResponseOfMinecraftGameVersion.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # ApiResponseOfMinecraftGameVersion
# ApiResponseOfMinecraftGameVersion

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/ApiResponseOfMinecraftModLoaderVersion.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # ApiResponseOfMinecraftModLoaderVersion
# ApiResponseOfMinecraftModLoaderVersion

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/Category.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # Category
# Category

## Properties

Expand Down
8 changes: 8 additions & 0 deletions docs/Model/ClientFeaturedProjectTag.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# ClientFeaturedProjectTag

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
10 changes: 10 additions & 0 deletions docs/Model/CookerInfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# CookerInfo

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**cooker_version** | **string** | The version of the cooker that processed this file | [optional]
**cooker_revision** | **string** | The revision of the cooker that processed this file | [optional]

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
2 changes: 1 addition & 1 deletion docs/Model/CoreApiStatus.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # CoreApiStatus
# CoreApiStatus

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/CoreStatus.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # CoreStatus
# CoreStatus

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/FeaturedModsResponse.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # FeaturedModsResponse
# FeaturedModsResponse

## Properties

Expand Down
3 changes: 2 additions & 1 deletion docs/Model/File.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # File
# File

## Properties

Expand Down Expand Up @@ -30,5 +30,6 @@ Name | Type | Description | Notes
**early_access_end_date** | **\DateTime** | | [optional]
**file_fingerprint** | **int** | | [optional]
**modules** | [**\Aternos\CurseForgeApi\Model\FileModule[]**](FileModule.md) | | [optional]
**cooking_info** | [**\Aternos\CurseForgeApi\Model\CookerInfo**](CookerInfo.md) | | [optional]

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
2 changes: 1 addition & 1 deletion docs/Model/FileDependency.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # FileDependency
# FileDependency

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/FileHash.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # FileHash
# FileHash

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/FileIndex.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # FileIndex
# FileIndex

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/FileModule.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # FileModule
# FileModule

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/FileRelationType.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # FileRelationType
# FileRelationType

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/FileReleaseType.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # FileReleaseType
# FileReleaseType

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/FileStatus.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # FileStatus
# FileStatus

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/FingerprintFuzzyMatch.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # FingerprintFuzzyMatch
# FingerprintFuzzyMatch

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/FingerprintFuzzyMatchResult.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # FingerprintFuzzyMatchResult
# FingerprintFuzzyMatchResult

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/FingerprintMatch.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # FingerprintMatch
# FingerprintMatch

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/FingerprintMatchesResult.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # FingerprintMatchesResult
# FingerprintMatchesResult

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/FolderFingerprint.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # FolderFingerprint
# FolderFingerprint

## Properties

Expand Down
3 changes: 2 additions & 1 deletion docs/Model/Game.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # Game
# Game

## Properties

Expand All @@ -11,5 +11,6 @@ Name | Type | Description | Notes
**assets** | [**\Aternos\CurseForgeApi\Model\GameAssets**](GameAssets.md) | | [optional]
**status** | [**\Aternos\CurseForgeApi\Model\CoreStatus**](CoreStatus.md) | | [optional]
**api_status** | [**\Aternos\CurseForgeApi\Model\CoreApiStatus**](CoreApiStatus.md) | | [optional]
**supported_features** | [**\Aternos\CurseForgeApi\Model\GameSupportedFeatures**](GameSupportedFeatures.md) | | [optional]

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
2 changes: 1 addition & 1 deletion docs/Model/GameAssets.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # GameAssets
# GameAssets

## Properties

Expand Down
9 changes: 9 additions & 0 deletions docs/Model/GameSupportedFeatures.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# GameSupportedFeatures

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**support_mod_subscriptions** | **bool** | Whether mod subscriptions are supported for this game | [optional]

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
2 changes: 1 addition & 1 deletion docs/Model/GameVersion.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # GameVersion
# GameVersion

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/GameVersionStatus.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # GameVersionStatus
# GameVersionStatus

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/GameVersionType.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # GameVersionType
# GameVersionType

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/GameVersionTypeStatus.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # GameVersionTypeStatus
# GameVersionTypeStatus

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/GameVersionsByType.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # GameVersionsByType
# GameVersionsByType

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/GameVersionsByTypeV2.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # GameVersionsByTypeV2
# GameVersionsByTypeV2

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/GetCategoriesResponse.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # GetCategoriesResponse
# GetCategoriesResponse

## Properties

Expand Down
3 changes: 2 additions & 1 deletion docs/Model/GetFeaturedModsRequestBody.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # GetFeaturedModsRequestBody
# GetFeaturedModsRequestBody

## Properties

Expand All @@ -7,5 +7,6 @@ Name | Type | Description | Notes
**game_id** | **int** | | [optional]
**excluded_mod_ids** | **int[]** | | [optional]
**game_version_type_id** | **int** | | [optional]
**client_compatible** | **bool** | | [optional]

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
2 changes: 1 addition & 1 deletion docs/Model/GetFeaturedModsResponse.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # GetFeaturedModsResponse
# GetFeaturedModsResponse

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/GetFilesResponse.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # GetFilesResponse
# GetFilesResponse

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/GetFingerprintFuzzyMatchesResponse.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # GetFingerprintFuzzyMatchesResponse
# GetFingerprintFuzzyMatchesResponse

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/GetFingerprintMatchesRequestBody.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # GetFingerprintMatchesRequestBody
# GetFingerprintMatchesRequestBody

## Properties

Expand Down
2 changes: 1 addition & 1 deletion docs/Model/GetFingerprintMatchesResponse.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# # GetFingerprintMatchesResponse
# GetFingerprintMatchesResponse

## Properties

Expand Down
Loading
Loading