Skip to content

Commit 234d5c6

Browse files
committed
Implement PartialApp.reward_items
and doc a few things
1 parent f0b852e commit 234d5c6

File tree

5 files changed

+289
-58
lines changed

5 files changed

+289
-58
lines changed

docs/api.rst

Lines changed: 47 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -984,51 +984,82 @@ Apps can be manually constructed using their app ID eg:
984984
985985
.. autofunction:: CUSTOM_APP
986986

987-
.. attributetable:: steam.app.PartialApp
987+
.. attributetable:: OwnershipTicket
988988

989-
.. autoclass:: steam.app.PartialApp()
989+
.. autoclass:: OwnershipTicket()
990990
:inherited-members:
991991
:members:
992992

993-
.. attributetable:: UserApp
993+
.. attributetable:: AuthenticationTicket
994994

995-
.. autoclass:: UserApp()
995+
.. autoclass:: AuthenticationTicket()
996996
:inherited-members:
997997
:members:
998998

999-
.. attributetable:: WishlistApp
999+
.. attributetable:: EncryptedTicket
10001000

1001-
.. autoclass:: WishlistApp()
1001+
.. autoclass:: EncryptedTicket()
10021002
:inherited-members:
10031003
:members:
10041004

1005-
.. attributetable:: FetchedApp
1005+
.. attributetable:: AppShopItem
10061006

1007-
.. autoclass:: FetchedApp()
1007+
.. autoclass:: AppShopItem
10081008
:inherited-members:
10091009
:members:
10101010

1011-
.. attributetable:: DLC
1011+
.. attributetable:: AppShopItemTag
10121012

1013-
.. autoclass:: DLC()
1013+
.. autoclass:: AppShopItemTag
10141014
:inherited-members:
10151015
:members:
10161016

1017-
.. attributetable:: OwnershipTicket
1017+
.. attributetable:: AppShopItems
10181018

1019-
.. autoclass:: OwnershipTicket()
1019+
.. autoclass:: AppShopItems
10201020
:inherited-members:
10211021
:members:
10221022

1023-
.. attributetable:: AuthenticationTicket
1023+
.. attributetable:: CommunityItem
10241024

1025-
.. autoclass:: AuthenticationTicket()
1025+
.. autoclass:: CommunityItem
10261026
:inherited-members:
10271027
:members:
10281028

1029-
.. attributetable:: EncryptedTicket
1029+
.. attributetable:: RewardItem
10301030

1031-
.. autoclass:: EncryptedTicket()
1031+
.. autoclass:: RewardItem
1032+
:inherited-members:
1033+
:members:
1034+
1035+
1036+
.. attributetable:: steam.app.PartialApp
1037+
1038+
.. autoclass:: steam.app.PartialApp()
1039+
:inherited-members:
1040+
:members:
1041+
1042+
.. attributetable:: UserApp
1043+
1044+
.. autoclass:: UserApp()
1045+
:inherited-members:
1046+
:members:
1047+
1048+
.. attributetable:: WishlistApp
1049+
1050+
.. autoclass:: WishlistApp()
1051+
:inherited-members:
1052+
:members:
1053+
1054+
.. attributetable:: FetchedApp
1055+
1056+
.. autoclass:: FetchedApp()
1057+
:inherited-members:
1058+
:members:
1059+
1060+
.. attributetable:: DLC
1061+
1062+
.. autoclass:: DLC()
10321063
:inherited-members:
10331064
:members:
10341065

steam/achievement.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ class StatType: # https://partner.steamgames.com/doc/api/steam_api#ESteamUserSt
4141
class Stat:
4242
name: str
4343
"""The name of the stat."""
44-
localised_name: str
44+
display_name: str
4545
"""The display name of the stat."""
4646
app: PartialApp
4747
"""The app this stat is for."""
@@ -77,7 +77,7 @@ class Achievement:
7777
class AppAchievement(Achievement):
7878
"""Represents an achievement for an app."""
7979

80-
localised_name: str
80+
display_name: str
8181
"""The display name of the achievement."""
8282
description: str
8383
"""The description of the achievement."""
@@ -95,7 +95,7 @@ class AppAchievement(Achievement):
9595
class UserNewsAchievement(Achievement):
9696
"""Represents an achievement for an app."""
9797

98-
localised_name: str
98+
display_name: str
9999
"""The display name of the achievement."""
100100
description: str
101101
"""The description of the achievement."""
@@ -111,7 +111,7 @@ class UserNewsAchievement(Achievement):
111111
class AppStatAchievement(Achievement):
112112
"""Represents an achievement for an app."""
113113

114-
localised_name: str
114+
display_name: str
115115
"""The localised name of the achievement."""
116116
description: str
117117
"""The description of the achievement."""
@@ -129,7 +129,7 @@ class AppStatAchievement(Achievement):
129129
class UserAppAchievement(Achievement):
130130
"""Represents an achievement for a user in an app."""
131131

132-
localised_name: str
132+
display_name: str
133133
"""The localised name of the achievement."""
134134
min: int | None
135135
"""The minimum value of the stat."""

0 commit comments

Comments
 (0)