Specification updates

mahmudindev · mahmudindev · commit c32d228ee63c · 2025-10-11T00:17:56.000+07:00
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -250,6 +250,7 @@ docs/WatchEpisodes.md
 docs/WatchEpisodesAllOfData.md
 docs/WatchEpisodesAllOfEpisodes.md
 docs/WatchPromos.md
+docs/WatchPromosAllOfData.md
 git_push.sh
 jikan_openapi/__init__.py
 jikan_openapi/api/__init__.py
@@ -504,6 +505,7 @@ jikan_openapi/models/watch_episodes.py
 jikan_openapi/models/watch_episodes_all_of_data.py
 jikan_openapi/models/watch_episodes_all_of_episodes.py
 jikan_openapi/models/watch_promos.py
+jikan_openapi/models/watch_promos_all_of_data.py
 jikan_openapi/py.typed
 jikan_openapi/rest.py
 pyproject.toml
@@ -758,4 +760,5 @@ test/test_watch_episodes.py
 test/test_watch_episodes_all_of_data.py
 test/test_watch_episodes_all_of_episodes.py
 test/test_watch_promos.py
+test/test_watch_promos_all_of_data.py
 tox.ini
diff --git a/README.md b/README.md
@@ -519,6 +519,7 @@ Class | Method | HTTP request | Description
  - [WatchEpisodesAllOfData](docs/WatchEpisodesAllOfData.md)
  - [WatchEpisodesAllOfEpisodes](docs/WatchEpisodesAllOfEpisodes.md)
  - [WatchPromos](docs/WatchPromos.md)
+ - [WatchPromosAllOfData](docs/WatchPromosAllOfData.md)
 
 
 <a id="documentation-for-authorization"></a>
diff --git a/docs/AnimeEpisodesAllOfData.md b/docs/AnimeEpisodesAllOfData.md
@@ -10,8 +10,8 @@ Name | Type | Description | Notes
 **title** | **str** | Title | [optional] 
 **title_japanese** | **str** | Title Japanese | [optional] 
 **title_romanji** | **str** | title_romanji | [optional] 
-**duration** | **int** | Episode duration in seconds | [optional] 
 **aired** | **str** | Aired Date ISO8601 | [optional] 
+**score** | **float** | Aggregated episode score (1.00 - 5.00) based on MyAnimeList user voting | [optional] 
 **filler** | **bool** | Filler episode | [optional] 
 **recap** | **bool** | Recap episode | [optional] 
 **forum_url** | **str** | Episode discussion forum URL | [optional] 
diff --git a/docs/PaginationPlusPagination.md b/docs/PaginationPlusPagination.md
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **last_visible_page** | **int** |  | [optional] 
 **has_next_page** | **bool** |  | [optional] 
+**current_page** | **int** |  | [optional] 
 **items** | [**PaginationPlusPaginationItems**](PaginationPlusPaginationItems.md) |  | [optional] 
 
 ## Example
diff --git a/docs/WatchPromos.md b/docs/WatchPromos.md
@@ -7,8 +7,7 @@ Watch Promos
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **pagination** | [**PaginationPagination**](PaginationPagination.md) |  | [optional] 
-**title** | **str** | Promo Title | [optional] 
-**data** | **List[object]** |  | [optional] 
+**data** | [**List[WatchPromosAllOfData]**](WatchPromosAllOfData.md) |  | [optional] 
 
 ## Example
 
diff --git a/docs/WatchPromosAllOfData.md b/docs/WatchPromosAllOfData.md
@@ -0,0 +1,31 @@
+# WatchPromosAllOfData
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **str** | Promo Title | [optional] 
+**entry** | [**AnimeMeta**](AnimeMeta.md) |  | [optional] 
+**trailer** | [**Trailer**](Trailer.md) |  | [optional] 
+
+## Example
+
+```python
+from jikan_openapi.models.watch_promos_all_of_data import WatchPromosAllOfData
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of WatchPromosAllOfData from a JSON string
+watch_promos_all_of_data_instance = WatchPromosAllOfData.from_json(json)
+# print the JSON string representation of the object
+print(WatchPromosAllOfData.to_json())
+
+# convert the object into a dict
+watch_promos_all_of_data_dict = watch_promos_all_of_data_instance.to_dict()
+# create an instance of WatchPromosAllOfData from a dict
+watch_promos_all_of_data_form_dict = watch_promos_all_of_data.from_dict(watch_promos_all_of_data_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/jikan_openapi/__init__.py b/jikan_openapi/__init__.py
@@ -276,3 +276,4 @@
 from jikan_openapi.models.watch_episodes_all_of_data import WatchEpisodesAllOfData
 from jikan_openapi.models.watch_episodes_all_of_episodes import WatchEpisodesAllOfEpisodes
 from jikan_openapi.models.watch_promos import WatchPromos
+from jikan_openapi.models.watch_promos_all_of_data import WatchPromosAllOfData
diff --git a/jikan_openapi/models/__init__.py b/jikan_openapi/models/__init__.py
@@ -244,3 +244,4 @@
 from jikan_openapi.models.watch_episodes_all_of_data import WatchEpisodesAllOfData
 from jikan_openapi.models.watch_episodes_all_of_episodes import WatchEpisodesAllOfEpisodes
 from jikan_openapi.models.watch_promos import WatchPromos
+from jikan_openapi.models.watch_promos_all_of_data import WatchPromosAllOfData
diff --git a/jikan_openapi/models/anime_episodes_all_of_data.py b/jikan_openapi/models/anime_episodes_all_of_data.py
@@ -18,7 +18,8 @@
 import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
-from typing import Any, ClassVar, Dict, List, Optional
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing_extensions import Annotated
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -31,12 +32,12 @@ class AnimeEpisodesAllOfData(BaseModel):
     title: Optional[StrictStr] = Field(default=None, description="Title")
     title_japanese: Optional[StrictStr] = Field(default=None, description="Title Japanese")
     title_romanji: Optional[StrictStr] = Field(default=None, description="title_romanji")
-    duration: Optional[StrictInt] = Field(default=None, description="Episode duration in seconds")
     aired: Optional[StrictStr] = Field(default=None, description="Aired Date ISO8601")
+    score: Optional[Union[Annotated[float, Field(le=5, strict=True, ge=1)], Annotated[int, Field(le=5, strict=True, ge=1)]]] = Field(default=None, description="Aggregated episode score (1.00 - 5.00) based on MyAnimeList user voting")
     filler: Optional[StrictBool] = Field(default=None, description="Filler episode")
     recap: Optional[StrictBool] = Field(default=None, description="Recap episode")
     forum_url: Optional[StrictStr] = Field(default=None, description="Episode discussion forum URL")
-    __properties: ClassVar[List[str]] = ["mal_id", "url", "title", "title_japanese", "title_romanji", "duration", "aired", "filler", "recap", "forum_url"]
+    __properties: ClassVar[List[str]] = ["mal_id", "url", "title", "title_japanese", "title_romanji", "aired", "score", "filler", "recap", "forum_url"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -92,16 +93,16 @@ def to_dict(self) -> Dict[str, Any]:
         if self.title_romanji is None and "title_romanji" in self.model_fields_set:
             _dict['title_romanji'] = None
 
-        # set to None if duration (nullable) is None
-        # and model_fields_set contains the field
-        if self.duration is None and "duration" in self.model_fields_set:
-            _dict['duration'] = None
-
         # set to None if aired (nullable) is None
         # and model_fields_set contains the field
         if self.aired is None and "aired" in self.model_fields_set:
             _dict['aired'] = None
 
+        # set to None if score (nullable) is None
+        # and model_fields_set contains the field
+        if self.score is None and "score" in self.model_fields_set:
+            _dict['score'] = None
+
         # set to None if forum_url (nullable) is None
         # and model_fields_set contains the field
         if self.forum_url is None and "forum_url" in self.model_fields_set:
@@ -124,8 +125,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "title": obj.get("title"),
             "title_japanese": obj.get("title_japanese"),
             "title_romanji": obj.get("title_romanji"),
-            "duration": obj.get("duration"),
             "aired": obj.get("aired"),
+            "score": obj.get("score"),
             "filler": obj.get("filler"),
             "recap": obj.get("recap"),
             "forum_url": obj.get("forum_url")
diff --git a/jikan_openapi/models/pagination_plus_pagination.py b/jikan_openapi/models/pagination_plus_pagination.py
@@ -29,8 +29,9 @@ class PaginationPlusPagination(BaseModel):
     """ # noqa: E501
     last_visible_page: Optional[StrictInt] = None
     has_next_page: Optional[StrictBool] = None
+    current_page: Optional[StrictInt] = None
     items: Optional[PaginationPlusPaginationItems] = None
-    __properties: ClassVar[List[str]] = ["last_visible_page", "has_next_page", "items"]
+    __properties: ClassVar[List[str]] = ["last_visible_page", "has_next_page", "current_page", "items"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -88,6 +89,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         _obj = cls.model_validate({
             "last_visible_page": obj.get("last_visible_page"),
             "has_next_page": obj.get("has_next_page"),
+            "current_page": obj.get("current_page"),
             "items": PaginationPlusPaginationItems.from_dict(obj["items"]) if obj.get("items") is not None else None
         })
         return _obj
diff --git a/jikan_openapi/models/watch_promos.py b/jikan_openapi/models/watch_promos.py
@@ -17,9 +17,10 @@
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from pydantic import BaseModel, ConfigDict
 from typing import Any, ClassVar, Dict, List, Optional
 from jikan_openapi.models.pagination_pagination import PaginationPagination
+from jikan_openapi.models.watch_promos_all_of_data import WatchPromosAllOfData
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -28,9 +29,8 @@ class WatchPromos(BaseModel):
     Watch Promos
     """ # noqa: E501
     pagination: Optional[PaginationPagination] = None
-    title: Optional[StrictStr] = Field(default=None, description="Promo Title")
-    data: Optional[List[object]] = None
-    __properties: ClassVar[List[str]] = ["pagination", "title", "data"]
+    data: Optional[List[WatchPromosAllOfData]] = None
+    __properties: ClassVar[List[str]] = ["pagination", "data"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -74,6 +74,13 @@ def to_dict(self) -> Dict[str, Any]:
         # override the default output from pydantic by calling `to_dict()` of pagination
         if self.pagination:
             _dict['pagination'] = self.pagination.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in data (list)
+        _items = []
+        if self.data:
+            for _item in self.data:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict['data'] = _items
         return _dict
 
     @classmethod
@@ -87,8 +94,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
 
         _obj = cls.model_validate({
             "pagination": PaginationPagination.from_dict(obj["pagination"]) if obj.get("pagination") is not None else None,
-            "title": obj.get("title"),
-            "data": obj.get("data")
+            "data": [WatchPromosAllOfData.from_dict(_item) for _item in obj["data"]] if obj.get("data") is not None else None
         })
         return _obj
 
diff --git a/jikan_openapi/models/watch_promos_all_of_data.py b/jikan_openapi/models/watch_promos_all_of_data.py
@@ -0,0 +1,99 @@
+# coding: utf-8
+
+"""
+    Jikan API
+
+    [Jikan](https://jikan.moe) is an **Unofficial** MyAnimeList API. It scrapes the website to satisfy the need for a complete API - which MyAnimeList lacks.  # Information  ⚡ Jikan is powered by its awesome backers - 🙏 [Become a backer](https://www.patreon.com/jikan)  ## Rate Limiting  | Duration | Requests | |----|----| | Daily | **Unlimited** | | Per Minute | 60 requests | | Per Second | 3 requests |  Note: It's still possible to get rate limited from MyAnimeList.net instead.   ## JSON Notes - Any property (except arrays or objects) whose value does not exist or is undetermined, will be `null`. - Any array or object property whose value does not exist or is undetermined, will be empty. - Any `score` property whose value does not exist or is undetermined, will be `0`. - All dates and timestamps are returned in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format and in UTC timezone  ## Caching By **CACHING**, we refer to the data parsed from MyAnimeList which is stored temporarily on our servers to provide better API performance.  All requests are cached for **24 hours**.  The following response headers will detail cache information.  | Header | Remarks | | ---- | ---- | | `Expires` | Cache expiry date | | `Last-Modified` | Cache set date | | `X-Request-Fingerprint` | Unique request fingerprint (only for cachable requests, not queries) |   Note: `X-Request-Fingerprint` will only be available on single resource requests and their child endpoints. e.g `/anime/1`, `/anime/1/relations`. They won't be available on pages which perform queries, like /anime, or /top/anime, etc.  ## Allowed HTTP(s) requests  **Jikan REST API does not provide authenticated requests for MyAnimeList.** This means you can not use it to update your anime/manga list. Only GET requests are supported which return READ-ONLY data.  ## HTTP Responses  All error responses are accompanied by a JSON Error response.  | Exception | HTTP Status | Remarks | | ---- | ---- | ---- | | N/A | `200 - OK` | The request was successful | | N/A | `304 - Not Modified` | You have the latest data (Cache Validation response) | | `BadRequestException`,`ValidationException` | `400 - Bad Request` | You've made an invalid request. Recheck documentation | | `BadResponseException` | `404 - Not Found` | The resource was not found or MyAnimeList responded with a `404` | | `BadRequestException` | `405 - Method Not Allowed` | Requested Method is not supported for resource. Only `GET` requests are allowed | | `RateLimitException` | `429 - Too Many Request` | You are being rate limited by Jikan or MyAnimeList is rate-limiting our servers (specified in the error response) | | `UpstreamException`,`ParserException`,etc. | `500 - Internal Server Error` | Something didn't work. Try again later. If you see an error response with a `report_url` URL, please click on it to open an auto-generated GitHub issue | | `ServiceUnavailableException` | `503 - Service Unavailable` | In most cases this is intentionally done if the service is down for maintenance. |  ## JSON Error Response  ```json  {      \"status\": 500,      \"type\": \"InternalException\",      \"message\": \"Exception Message\",      \"error\": \"Exception Trace\",      \"report_url\": \"https://github.com...\"   } ```  | Property | Remarks | | ---- | ---- | | `status` | Returned HTTP Status Code | | `type` | Thrown Exception | | `message` | Human-readable error message | | `error` | Error response and trace from the API | | `report_url` | Clicking this would redirect you to a generated GitHub issue |   ## Cache Validation  - All requests return a `ETag` header which is an MD5 hash of the response - You can use this hash to verify if there's new or updated content by suppliying it as the value for the `If-None-Match` in your next request header - You will get a HTTP `304 - Not Modified` response if the content has not changed - If the content has changed, you'll get a HTTP `200 - OK` response with the updated JSON response  ![Cache Validation](https://i.imgur.com/925ozVn.png 'Cache Validation')  ## Disclaimer  - Jikan is not affiliated with MyAnimeList.net. - Jikan is a free, open-source API. Please use it responsibly.  ----  By using the API, you are agreeing to Jikan's [terms of use](https://jikan.moe/terms) policy.  [v3 Documentation](https://jikan.docs.apiary.io/) - [Wrappers/SDKs](https://github.com/jikan-me/jikan#wrappers) - [Report an issue](https://github.com/jikan-me/jikan-rest/issues/new) - [Host your own server](https://github.com/jikan-me/jikan-rest)
+
+    The version of the OpenAPI document: 4.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from jikan_openapi.models.anime_meta import AnimeMeta
+from jikan_openapi.models.trailer import Trailer
+from typing import Optional, Set
+from typing_extensions import Self
+
+class WatchPromosAllOfData(BaseModel):
+    """
+    WatchPromosAllOfData
+    """ # noqa: E501
+    title: Optional[StrictStr] = Field(default=None, description="Promo Title")
+    entry: Optional[AnimeMeta] = None
+    trailer: Optional[Trailer] = None
+    __properties: ClassVar[List[str]] = ["title", "entry", "trailer"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of WatchPromosAllOfData from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of entry
+        if self.entry:
+            _dict['entry'] = self.entry.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of trailer
+        if self.trailer:
+            _dict['trailer'] = self.trailer.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of WatchPromosAllOfData from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "title": obj.get("title"),
+            "entry": AnimeMeta.from_dict(obj["entry"]) if obj.get("entry") is not None else None,
+            "trailer": Trailer.from_dict(obj["trailer"]) if obj.get("trailer") is not None else None
+        })
+        return _obj
+
+
diff --git a/test/test_anime_episodes.py b/test/test_anime_episodes.py
@@ -45,8 +45,8 @@ def make_instance(self, include_optional) -> AnimeEpisodes:
                         title = '', 
                         title_japanese = '', 
                         title_romanji = '', 
-                        duration = 56, 
                         aired = '', 
+                        score = 1, 
                         filler = True, 
                         recap = True, 
                         forum_url = '', )
diff --git a/test/test_anime_episodes_all_of_data.py b/test/test_anime_episodes_all_of_data.py
@@ -40,8 +40,8 @@ def make_instance(self, include_optional) -> AnimeEpisodesAllOfData:
                 title = '',
                 title_japanese = '',
                 title_romanji = '',
-                duration = 56,
                 aired = '',
+                score = 1,
                 filler = True,
                 recap = True,
                 forum_url = ''
diff --git a/test/test_anime_search.py b/test/test_anime_search.py
@@ -38,6 +38,7 @@ def make_instance(self, include_optional) -> AnimeSearch:
                 pagination = jikan_openapi.models.pagination_plus_pagination.pagination_plus_pagination(
                     last_visible_page = 56, 
                     has_next_page = True, 
+                    current_page = 56, 
                     items = jikan_openapi.models.pagination_plus_pagination_items.pagination_plus_pagination_items(
                         count = 56, 
                         total = 56, 
diff --git a/test/test_characters_search.py b/test/test_characters_search.py
@@ -38,6 +38,7 @@ def make_instance(self, include_optional) -> CharactersSearch:
                 pagination = jikan_openapi.models.pagination_plus_pagination.pagination_plus_pagination(
                     last_visible_page = 56, 
                     has_next_page = True, 
+                    current_page = 56, 
                     items = jikan_openapi.models.pagination_plus_pagination_items.pagination_plus_pagination_items(
                         count = 56, 
                         total = 56, 
diff --git a/test/test_manga_search.py b/test/test_manga_search.py
diff --git a/test/test_pagination_plus.py b/test/test_pagination_plus.py
diff --git a/test/test_pagination_plus_pagination.py b/test/test_pagination_plus_pagination.py
diff --git a/test/test_people_search.py b/test/test_people_search.py
diff --git a/test/test_schedules.py b/test/test_schedules.py
diff --git a/test/test_watch_promos.py b/test/test_watch_promos.py
diff --git a/test/test_watch_promos_all_of_data.py b/test/test_watch_promos_all_of_data.py
