Merge pull request #183 from ToshY/generator/update-api-models-180

Generator/update api models from #180

Author: ToshY

docs/base-api.md

@@ -70,7 +70,7 @@ $bunnyHttpClient->request(
 );
 ```
 
-!!! note
+??? note
 
     - The key `type` has the following possible values:
         - `0` = DNS (DNS scripts)
@@ -109,7 +109,7 @@ $bunnyHttpClient->request(
 );
 ```
 
-!!! note
+??? note
 
     - The key `ScriptType` has the following possible values:
         - `1` = Standalone (Standalone scripts are ideal for a wide range of applications, such as building RESTful APIs, delivering UI applications, and processing data at the edge.)
@@ -118,7 +118,7 @@ $bunnyHttpClient->request(
     - The key `Id` (under `RepositorySettings`) and `DeployConfiguration` are not required when creating a new GitHub repository.
     - The key `IntegrationId` is required when creating and deploying through GitHub. It can be retrieved from the [Get GitHub Integration](base-api.md#get-github-integration) endpoint.
 
-!!! info
+??? info
 
     The Edge Scripting API can also be used for creating DNS scripts.
 
@@ -133,7 +133,7 @@ $bunnyHttpClient->request(
     );
     ```
 
-!!! example
+??? example
 
     Examples for `DeployConfiguration` payloads.
 
@@ -159,7 +159,7 @@ $bunnyHttpClient->request(
     ],
     ```
 
-!!! question
+??? question
 
     If you want to create a workflow file yourself, check out the [BunnyWay Github action deploy script](https://github.com/BunnyWay/actions/tree/main/deploy-script).
 
@@ -203,7 +203,7 @@ $bunnyHttpClient->request(
 );
 ```
 
-!!! note
+??? note
 
     - The key `ScriptType` has the following possible values:
         - `0` = DNS (DNS scripts)
@@ -225,7 +225,7 @@ $bunnyHttpClient->request(
 
 ### Variable
 
-!!! info
+??? info
 
     There is no "List Variables" endpoint to retrieve all variables for a specific script. Instead, you can retrieve 
     this information from the [Get Edge Script](#get-edge-script) endpoint.
@@ -415,7 +415,7 @@ $bunnyHttpClient->request(
 );
 ```
 
-!!! note
+??? note
 
     - The key `uuid` denotes an 8 character alphanumeric string (and **not** an ["UUID"](https://datatracker.ietf.org/doc/html/rfc9562)), 
     which can be retrieved from the [Get Releases](#get-releases) or [Get Active Release](#get-active-release) endpoints. It can also

docs/edge-scripting-api.md

@@ -76,12 +76,12 @@ $bunnyHttpClient->request(
 );
 ```
 
-!!! note
+??? note
     - Make sure your `RootPath` and `Paths` contain **leading** and **trailing** slashes.
         - If you omit the slashes in `RootPath` this will result in a `400` status code.
         - If you omit the slashes in `Paths` this will result in a `200` status code with an empty ZIP file.
 
-!!! warning
+??? warning
 
     - This endpoint (with method `POST`) is currently not documented in the API specifications.
     - This request may fail or timeout if the requested directory has too many files or is too big.
@@ -133,7 +133,7 @@ $bunnyHttpClient->request(
 );
 ```
 
-!!! warning
+??? warning
 
     - While a hash value in hexidecimal string representation is case insensitive, the value for the `Checksum` header must be in **uppercase** characters to ensure a successful upload.
     - If an incorrect `Checksum` is provided, the response will still be `201` but the file will not be uploaded.

docs/edge-storage-api.md

@@ -38,7 +38,7 @@ BunnyImageProcessor::generate(
 );
 ```
 
-!!! note
+???+ note
 
     - The `quality` argument determines the compression level of the resulting image with 0 being the lowest level of
     compression and 100 being the highest. Higher compression means smaller files, but might visually degrade the image

docs/image-processing.md

@@ -54,11 +54,11 @@ $bunnyHttpClient->request(
 );
 ```
 
-!!! note
+??? note
 
     - The key `status` consists of comma separated status codes.
 
-!!! warning
+??? warning
 
     - Sending the `date` key with an incorrect format (should be `m-d-y`) results in `403` status code.
 

docs/logging-api.md

@@ -91,7 +91,7 @@ $bunnyHttpClient->request(
 );
 ```
 
-!!! note
+??? note
 
     - The key `shieldZoneId` is not needed or required when creating a shield zone.
 
@@ -362,7 +362,7 @@ $bunnyHttpClient->request(
 );
 ```
 
-!!! warning
+??? warning
 
     - If this endpoint is requested for a shield zone on a free tier, it returns a `202` status code with the error message: `We do not support Custom WAF Rule creation on our Free Tier of Bunny Shield, please upgrade to Advanced.`
 

docs/shield-api.md

@@ -38,7 +38,7 @@ $bunnyHttpClient->request(
 );
 ```
 
-!!! note
+??? note
 
     - If the query parameter `includeThumbnails` is set to `true`, the response item(s) will include a non-empty array key `previewImageUrls` containing the URLs for the corresponding image thumbnails.
 
@@ -84,7 +84,7 @@ $bunnyHttpClient->request(
 );
 ```
 
-!!! note
+??? note
 
     - If the query parameter `includeThumbnails` is set to `true`, the response item(s) will include a non-empty array key `previewImageUrls` containing the URLs for the corresponding image thumbnails.
 
@@ -187,7 +187,7 @@ $bunnyHttpClient->request(
 );
 ```
 
-!!! note
+??? note
 
     - The `title` does not need to match the video filename and/or extension you're intending to upload.
     - A `collectionId` is not required.
@@ -236,7 +236,7 @@ $bunnyHttpClient->request(
 );
 ```
 
-!!! warning
+??? warning
 
     - This endpoint currently returns a `500` status code with the following response: 
     ```
@@ -313,15 +313,15 @@ $bunnyHttpClient->request(
 );
 ```
 
-!!! note
+??? note
 
     - The argument `outputCodecId` has the following possible values:
         - `0` = x264
         - `1` = vp9 (premium)
         - `2` = hevc (premium)
         - `3` = av1 (premium)
 
-!!! warning
+??? warning
 
     This endpoint will return a `400` status code if premium encoding is not enabled (even if the `outputCodecId` value `0` is given).
 
@@ -339,7 +339,7 @@ $bunnyHttpClient->request(
 );
 ```
 
-!!! note
+??? note
 
     - This method allows repackaging of videos for libraries that have [Enterprise DRM](https://docs.bunny.net/docs/stream-drm#mediacage-enterprise-drm) enabled.
 
@@ -397,7 +397,7 @@ $bunnyHttpClient->request(
 );
 ```
 
-!!! note
+??? note
 
     - The `thumbnailTime` denotes the video time in milliseconds to extract the main video thumbnail.
 
@@ -418,7 +418,7 @@ $bunnyHttpClient->request(
 );
 ```
 
-!!! note
+??? note
 
     - The `sourceLanguage` / `srclang` should be an [**ISO 639-1** / **ISO 639-3** language abbreviation](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).
     - The `captionsFile` requires the file contents to be sent as a base64 encoded string.
@@ -435,16 +435,16 @@ $bunnyHttpClient->request(
 );
 ```
 
-!!! note
+??? note
 
     - The `sourceLanguage` should be an [**ISO 639-1** / **ISO 639-3** language abbreviation](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes).
 
-!!! warning
+??? warning
 
     - If a caption was created with a specific ISO standard for the `sourceLanguage`, then you have to delete it with the same standard. Example: a caption created with `sourceLanguage` **ISO 639-1** can only be deleted by sending a request with `sourceLanguage` **ISO 639-1**.
     - This endpoint will always return a `200` status code, even if the subtitle with specificied `sourceLanguage` does not exist.
 
-!!! tip
+??? tip
 
     - If you (regularly) update captions make sure to purge the captions directory associated with the video. If it's not purged you might notice
     outdated subtitles displayed on the video. You can get the URL for the captions directory by using the [Get Video Play Data](#get-video-play-data) endpoint.
@@ -473,7 +473,7 @@ $bunnyHttpClient->request(
 );
 ```
 
-!!! note
+??? note
 
     - The `targetLanguages` / `sourceLanguage` require a [two-letter (set 1) language abbreviation](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) for transcribing the video.
     - Once a video has transcribed you need to set `force` to `true` in order to force a new transcription to be added.
@@ -490,7 +490,7 @@ $bunnyHttpClient->request(
 );
 ```
 
-!!! warning
+??? warning
 
     - This endpoint returns a `500` status code if the video has not been fully processed yet.
 
@@ -512,15 +512,15 @@ $bunnyHttpClient->request(
 );
 ```
 
-!!! note
+??? note
 
     - The key `resolutionsToDelete` consists of comma separated resolutions.
 
-!!! tip
+??? tip
 
     Use the [Video Resolutions Info](#video-resolutions-info) endpoint to retrieve the resolutions for the video.
 
-!!! warning
+??? warning
 
     This endpoint will return a `400` status code if all available resolutions for the video are passed to `resolutionsToDelete`, as there must be at least one resolution available after cleanup.
 
@@ -540,7 +540,7 @@ $bunnyHttpClient->request(
 );
 ```
 
-!!! note
+??? note
 
     - The `url` is a required query parameter.
 

docs/stream-api.md

@@ -93,7 +93,7 @@ $bunnyTokenAuthentication->sign(
 );
 ```
 
-!!! note
+???+ note
 
     - The argument `expirationTime` denotes the time in seconds the resource is available after signing.
     - The argument `speedLimit` denotes the download speed limit (in kB/s) for the resource.
@@ -109,7 +109,7 @@ $bunnyTokenAuthentication->sign(
     the DNS from that country and in turn, we start returning `127.0.0.1` queries towards the hostnames in use instead
     of the standard CDN routing. The traffic essentially doesn't even touch our servers in such a case."*
 
-!!! warning
+???+ warning
 
     - The example using `speedLimit` for token authentication is currently not working as expected, as it returns a `403` status
     code. A support ticket has been created at bunny.net regarding this issue.

docs/token-authentication.md

@@ -82,5 +82,5 @@ $bunnyHttpClient = new BunnyHttpClient(
 $response = $bunnyHttpClient->request($payload);
 ```
 
-!!! question
+???+ question
     While the `BunnyValidator` can be useful for development and testing purposes as it will prematurely validate the payload request data before sending the actual API request, the API itself will also validate the submitted request data.

docs/validation.md

@@ -44,6 +44,7 @@
 use ToshY\BunnyNet\Model\Api\Base\User\GetDpaDetails;
 use ToshY\BunnyNet\Model\Api\Base\User\GetDpaDetailsHtml;
 use ToshY\BunnyNet\Model\Api\Base\User\GetHomeFeed;
+use ToshY\BunnyNet\Model\Api\Base\User\GetMarketingDetails;
 use ToshY\BunnyNet\Model\Api\Base\User\GetUserDetails;
 use ToshY\BunnyNet\Model\Api\Base\User\GetWhatsNewItems;
 use ToshY\BunnyNet\Model\Api\Base\User\ListCloseAccountReasons;
@@ -180,6 +181,9 @@ final class EndpointEdgeCases
         '/user/dpa/pdfhtml' => [
             'get' => GetDpaDetailsHtml::class,
         ],
+        '/user/mkd' => [
+            'get' => GetMarketingDetails::class,
+        ],
         '/user/setNotificationsOpened' => [
             'post' => SetNotificationsOpened::class,
         ],
@@ -253,6 +257,7 @@ final class EndpointEdgeCases
         VerifyTwoFactorAuthenticationCode::class => ModelValidationStrategy::STRICT_BODY,
         GetGitHubIntegration::class => ModelValidationStrategy::NONE,
         GlobalSearch::class => ModelValidationStrategy::STRICT_QUERY,
+        GetMarketingDetails::class => ModelValidationStrategy::NONE,
     ];
 
     public const EDGE_STORAGE_VALIDATION_REPLACEMENTS = [