Skip to content

Commit ddc55f2

Browse files
justoneapigithub-actions[bot]
authored andcommitted
chore: sync OpenAPI spec and generated SDK
1 parent 1e54f2d commit ddc55f2

29 files changed

+2132
-3063
lines changed

justoneapi/generated/resources/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
from justoneapi.generated.resources.tiktok_shop import TiktokShopResource
1919
from justoneapi.generated.resources.toutiao import ToutiaoResource
2020
from justoneapi.generated.resources.twitter import TwitterResource
21+
from justoneapi.generated.resources.web import WebResource
2122
from justoneapi.generated.resources.weibo import WeiboResource
2223
from justoneapi.generated.resources.weixin import WeixinResource
2324
from justoneapi.generated.resources.xiaohongshu import XiaohongshuResource
@@ -45,6 +46,7 @@
4546
"tiktok_shop": TiktokShopResource,
4647
"toutiao": ToutiaoResource,
4748
"twitter": TwitterResource,
49+
"web": WebResource,
4850
"weibo": WeiboResource,
4951
"weixin": WeixinResource,
5052
"xiaohongshu": XiaohongshuResource,
@@ -73,6 +75,7 @@
7375
"TiktokShopResource",
7476
"ToutiaoResource",
7577
"TwitterResource",
78+
"WebResource",
7679
"WeiboResource",
7780
"WeixinResource",
7881
"XiaohongshuResource",

justoneapi/generated/resources/amazon.py

Lines changed: 8 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,9 @@ def get_product_detail_v1(
1616
country: str | None = "US",
1717
) -> ApiResponse[Any]:
1818
"""
19-
Product Details (V1)
19+
Product Details
2020
21-
Retrieves detailed product information from Amazon based on the provided ASIN.
22-
It returns core product data such as title, brand, price, availability, rating,
23-
review count, product images, category information, and other publicly available details.
24-
25-
Typical use cases:
26-
- Building product catalogs and enriching item content (e.g., images)
27-
- Price monitoring and availability tracking
28-
- E-commerce analytics and competitor tracking
21+
Get Amazon product Details data, including title, brand, and price, for building product catalogs and enriching item content (e.g., images), price monitoring and availability tracking, and e-commerce analytics and competitor tracking.
2922
3023
Args:
3124
asin: ASIN (Amazon Standard Identification Number).
@@ -46,16 +39,9 @@ def get_product_top_reviews_v1(
4639
country: str | None = "US",
4740
) -> ApiResponse[Any]:
4841
"""
49-
Product Top Reviews (V1)
50-
51-
Retrieves top (most relevant or most helpful) public reviews for an Amazon product based on the provided ASIN.
52-
It returns review details such as review ID, reviewer name, rating score,
53-
review title, review content, publish time, and helpful vote count (if available).
42+
Product Top Reviews
5443
55-
Typical use cases:
56-
- Sentiment analysis and consumer feedback tracking
57-
- Product research and quality assessment
58-
- Monitoring competitor customer experience
44+
Get Amazon product Top Reviews data, including most helpful) public reviews, for sentiment analysis and consumer feedback tracking, product research and quality assessment, and monitoring competitor customer experience.
5945
6046
Args:
6147
asin: ASIN (Amazon Standard Identification Number).
@@ -77,15 +63,9 @@ def get_best_sellers_v1(
7763
page: int | None = 1,
7864
) -> ApiResponse[Any]:
7965
"""
80-
Best Sellers (V1)
66+
Best Sellers
8167
82-
Retrieves top performing products for a given category on Amazon.
83-
Supports top level best sellers categories (e.g. software). In addition, subcategories / category path can be specified.
84-
85-
Typical use cases:
86-
- Identifying trending products in specific categories
87-
- Market share analysis and category research
88-
- Tracking sales rank and popularity over time
68+
Get Amazon best Sellers data, including rank positions, product metadata, and pricing, for identifying trending products in specific categories, market share analysis and category research, and tracking sales rank and popularity over time.
8969
9070
Args:
9171
category: Best sellers category to return products for (e.g. 'software' or 'software/229535').
@@ -110,15 +90,9 @@ def get_products_by_category_v1(
11090
page: int | None = 1,
11191
) -> ApiResponse[Any]:
11292
"""
113-
Products By Category (V1)
114-
115-
Retrieves products under a specified Amazon category.
116-
Supports category-based product discovery and returns product information such as title, price, rating, review count, and other available marketplace fields.
93+
Products By Category
11794
118-
Typical use cases:
119-
- Discovering products within a specific category
120-
- Category research and competitor analysis
121-
- Monitoring product assortment, pricing, and popularity trends
95+
Get Amazon products By Category data, including title, price, and rating, for category-based product discovery and returns product information such as title, price, and rating.
12296
12397
Args:
12498
category_id: For example: https://amazon.com/s?node=172282 - the Amazon Category ID is 172282

justoneapi/generated/resources/beike.py

Lines changed: 6 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,9 @@ def ershoufang_detail_v1(
1616
house_code: str,
1717
) -> ApiResponse[Any]:
1818
"""
19-
Resale Housing Details (V1)
19+
Resale Housing Details
2020
21-
Retrieves comprehensive information for a specific second-hand property listing on Beike (Lianjia).
22-
23-
The data includes:
24-
- Pricing (total and unit price).
25-
- Physical attributes (area, layout, floor, orientation).
26-
- Listing metadata (tags, listing date).
27-
- Agent contact information.
28-
29-
Typical use cases:
30-
- Displaying a full property profile to users.
31-
- Detailed price comparison between specific listings.
21+
Get Beike resale Housing Details data, including - Pricing (total and unit price), Physical attributes (area, and layout, for displaying a full property profile to users and detailed price comparison between specific listings.
3222
3323
Args:
3424
city_id: The ID of the city (e.g., '110000' for Beijing).
@@ -50,18 +40,9 @@ def get_ershoufang_list_v1(
5040
offset: int | None = 0,
5141
) -> ApiResponse[Any]:
5242
"""
53-
Resale Housing List (V1)
54-
55-
Fetches a list of second-hand property listings from Beike (Lianjia) based on specified filters.
43+
Resale Housing List
5644
57-
Key features:
58-
- Supports filtering by city/region, price range, layout, and area.
59-
- Returns core listing details such as title, total price, unit price, and community info.
60-
- Provides house codes for fetching full details via the detail API.
61-
62-
Typical use cases:
63-
- Building search result pages for property portals.
64-
- Aggregating market data for regional housing trends.
45+
Get Beike resale Housing List data, including - Supports filtering by city/region, price range, and layout, for building search result pages for property portals and aggregating market data for regional housing trends.
6546
6647
Args:
6748
city_id: The ID of the city (e.g., '110000' for Beijing).
@@ -85,20 +66,9 @@ def community_list_v1(
8566
limit_offset: int | None = 0,
8667
) -> ApiResponse[Any]:
8768
"""
88-
Community List (V1)
89-
90-
Retrieves a list of residential communities (Xiaoqu) from Beike (Lianjia) within a specified city.
91-
92-
The data includes:
93-
- Community name and unique ID.
94-
- Average listing price and historical price trends.
95-
- Build year and architectural details.
96-
- Geographical coordinates and location information.
69+
Community List
9770
98-
Typical use cases:
99-
- Identifying popular residential areas in a city.
100-
- Comparing average housing prices across different communities.
101-
- Spatial analysis of property development patterns.
71+
Get Beike community List data, including - Community name and unique ID and Average listing price and historical price trends, for identifying popular residential areas in a city and comparing average housing prices across different communities.
10272
10373
Args:
10474
city_id: The ID of the city (e.g., '110000' for Beijing).

justoneapi/generated/resources/bilibili.py

Lines changed: 18 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,9 @@ def get_video_detail_v2(
1515
bvid: str,
1616
) -> ApiResponse[Any]:
1717
"""
18-
Video Details (V2)
18+
Video Details
1919
20-
Retrieve comprehensive details about a specific Bilibili video, including metadata (title, tags, publishing time), statistics (views, likes, danmaku count), and uploader profile information.
21-
22-
Typical use cases:
23-
- Tracking video performance and engagement metrics.
24-
- Analyzing content metadata and uploader information.
20+
Get Bilibili video Details data, including metadata (title, tags, and publishing time), for tracking video performance and engagement metrics and analyzing content metadata and uploader information.
2521
2622
Args:
2723
bvid: Bilibili Video ID (BVID).
@@ -40,13 +36,9 @@ def get_user_video_list_v2(
4036
param: str | None = None,
4137
) -> ApiResponse[Any]:
4238
"""
43-
User Published Videos (V2)
44-
45-
Retrieve a list of videos published by a specific Bilibili user, including video metadata, cover images, and engagement metrics.
39+
User Published Videos
4640
47-
Typical use cases:
48-
- Monitoring creator's content updates and publishing patterns.
49-
- Building user-specific video catalogs for analysis.
41+
Get Bilibili user Published Videos data, including titles, covers, and publish times, for creator monitoring and content performance analysis.
5042
5143
Args:
5244
uid: Bilibili User ID (UID).
@@ -66,13 +58,9 @@ def get_user_detail_v2(
6658
uid: str,
6759
) -> ApiResponse[Any]:
6860
"""
69-
User Profile (V2)
70-
71-
Retrieve detailed profile information of a specific Bilibili user, including username, avatar, level, and verification status.
61+
User Profile
7262
73-
Typical use cases:
74-
- Analyzing creator's profile, level, and verification status.
75-
- Verifying user identity and social presence on Bilibili.
63+
Get Bilibili user Profile data, including account metadata, audience metrics, and verification-related fields, for analyzing creator's profile, level, and verification status and verifying user identity and social presence on bilibili.
7664
7765
Args:
7866
uid: Bilibili User ID (UID).
@@ -92,13 +80,9 @@ def get_video_danmu_v2(
9280
page: str | None = None,
9381
) -> ApiResponse[Any]:
9482
"""
95-
Video Danmaku (V2)
83+
Video Danmaku
9684
97-
Retrieve danmaku (rolling comments) for a specific Bilibili video.
98-
99-
Typical use cases:
100-
- Analyzing real-time viewer reactions and community trends.
101-
- Sentiment analysis based on rolling comments.
85+
Get Bilibili video Danmaku data, including timeline positions and comment text, for audience reaction analysis and subtitle-style comment review.
10286
10387
Args:
10488
aid: Bilibili Archive ID (AID).
@@ -121,13 +105,9 @@ def get_video_comment_v2(
121105
cursor: str | None = None,
122106
) -> ApiResponse[Any]:
123107
"""
124-
Video Comments (V2)
125-
126-
Retrieve top-level comments for a specific Bilibili video, including commenter info, text, likes, and timestamps.
108+
Video Comments
127109
128-
Typical use cases:
129-
- Gathering detailed viewer feedback and community discussions.
130-
- Sentiment analysis and public opinion monitoring.
110+
Get Bilibili video Comments data, including commenter profiles, text, and likes, for sentiment analysis and comment moderation workflows.
131111
132112
Args:
133113
aid: Bilibili Archive ID (AID).
@@ -149,13 +129,9 @@ def search_video_v2(
149129
order: str | None = "general",
150130
) -> ApiResponse[Any]:
151131
"""
152-
Video Search (V2)
132+
Video Search
153133
154-
Search for Bilibili videos based on keywords, returning matched videos with metadata, author information, and engagement stats.
155-
156-
Typical use cases:
157-
- Discovering trending videos or creators by specific keywords.
158-
- Competitive analysis and market research on Bilibili.
134+
Get Bilibili video Search data, including matched videos, creators, and engagement metrics, for topic research and content discovery.
159135
160136
Args:
161137
keyword: Search keyword.
@@ -177,16 +153,9 @@ def share_url_transfer_v1(
177153
share_url: str,
178154
) -> ApiResponse[Any]:
179155
"""
180-
Share Link Resolution (V1)
181-
182-
Resolve Bilibili share URLs (e.g., https://b23.tv/...) to get the original content metadata.
183-
184-
Typical use cases:
185-
- Converting shortened mobile share links to standard BVID/metadata.
186-
- Automating content extraction from shared social media links.
156+
Share Link Resolution
187157
188-
Highlights
189-
- Only supports share URLs starting with 'https://b23.tv/'.
158+
Get Bilibili share Link Resolution data, including resolved video and page identifier, for converting shortened mobile share links to standard bvid/metadata and automating content extraction from shared social media links.
190159
191160
Args:
192161
share_url: Bilibili share URL (must start with https://b23.tv/).
@@ -204,13 +173,9 @@ def get_user_relation_stat(
204173
wmid: str,
205174
) -> ApiResponse[Any]:
206175
"""
207-
User Relation Stats (V1)
176+
User Relation Stats
208177
209-
Retrieve follower count and following count for a specific Bilibili user.
210-
211-
Typical use cases:
212-
- Tracking creator's follower growth and audience reach.
213-
- Analyzing social influence and account popularity.
178+
Get Bilibili user Relation Stats data, including following counts, for creator benchmarking and audience growth tracking.
214179
215180
Args:
216181
wmid: Bilibili User ID (WMID).
@@ -230,13 +195,9 @@ def get_video_caption_v1(
230195
cid: str,
231196
) -> ApiResponse[Any]:
232197
"""
233-
Video Captions (V2)
234-
235-
Retrieve subtitle/caption information for a specific Bilibili video.
198+
Video Captions
236199
237-
Typical use cases:
238-
- Extracting textual content from video subtitles for indexing or analysis.
239-
- Multi-language content processing and accessibility analysis.
200+
Get Bilibili video Captions data, including caption data, for transcript extraction and multilingual content analysis.
240201
241202
Args:
242203
bvid: Bilibili Video ID (BVID).

0 commit comments

Comments
 (0)