@steamsets/client-ts 0.19.5 → 0.22.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/FUNCTIONS.md +2 -2
- package/README.md +95 -104
- package/docs/sdks/account/README.md +1355 -117
- package/docs/sdks/admin/README.md +94 -5
- package/docs/sdks/app/README.md +5 -5
- package/docs/sdks/badge/README.md +226 -10
- package/docs/sdks/badges/README.md +8 -375
- package/docs/sdks/connection/README.md +4 -239
- package/docs/sdks/{sessions → developerapps}/README.md +28 -16
- package/docs/sdks/events/README.md +4 -93
- package/docs/sdks/leaderboard/README.md +5 -77
- package/docs/sdks/liveness/README.md +5 -5
- package/docs/sdks/{locations → location}/README.md +7 -5
- package/docs/sdks/{accounts → roles}/README.md +10 -14
- package/docs/sdks/session/README.md +11 -106
- package/funcs/{locationsGet.d.ts → accountBookmarkBadge.d.ts} +3 -2
- package/funcs/accountBookmarkBadge.d.ts.map +1 -0
- package/funcs/{badgesBookmark.js → accountBookmarkBadge.js} +3 -3
- package/funcs/accountBookmarkBadge.js.map +1 -0
- package/funcs/{eventsUpdate.d.ts → accountConnect.d.ts} +2 -2
- package/funcs/{badgesBookmark.d.ts.map → accountConnect.d.ts.map} +1 -1
- package/funcs/{connectionsConnect.js → accountConnect.js} +3 -3
- package/funcs/{sessionsDelete.js.map → accountConnect.js.map} +1 -1
- package/funcs/{accountUpdateApp.d.ts → accountConnectionUpdate.d.ts} +2 -2
- package/funcs/{badgeBadgeV1TagsSuggest.d.ts.map → accountConnectionUpdate.d.ts.map} +1 -1
- package/funcs/{connectionUpdate.js → accountConnectionUpdate.js} +3 -3
- package/funcs/{badgeBadgeV1TagsSuggest.js.map → accountConnectionUpdate.js.map} +1 -1
- package/funcs/{settingsVerifyEmail.d.ts → accountCreateSession.d.ts} +2 -3
- package/funcs/accountCreateSession.d.ts.map +1 -0
- package/funcs/{sessionCreate.js → accountCreateSession.js} +3 -3
- package/funcs/accountCreateSession.js.map +1 -0
- package/funcs/accountDeleteConnection.d.ts +12 -0
- package/funcs/{accountAccountV1GetMeta.d.ts.map → accountDeleteConnection.d.ts.map} +1 -1
- package/funcs/{connectionDelete.js → accountDeleteConnection.js} +3 -3
- package/funcs/{accountAccountV1GetMeta.js.map → accountDeleteConnection.js.map} +1 -1
- package/funcs/accountDeveloperAppsDelete.d.ts +12 -0
- package/funcs/accountDeveloperAppsDelete.d.ts.map +1 -0
- package/funcs/{accountDeleteDeveloperApp.js → accountDeveloperAppsDelete.js} +3 -3
- package/funcs/accountDeveloperAppsDelete.js.map +1 -0
- package/funcs/accountDeveloperAppsUpdate.d.ts +12 -0
- package/funcs/accountDeveloperAppsUpdate.d.ts.map +1 -0
- package/funcs/{accountUpdateApp.js → accountDeveloperAppsUpdate.js} +3 -3
- package/funcs/accountDeveloperAppsUpdate.js.map +1 -0
- package/funcs/accountEmailSendVerification.d.ts +11 -0
- package/funcs/accountEmailSendVerification.d.ts.map +1 -0
- package/funcs/{settingsSendVerification.js → accountEmailSendVerification.js} +3 -3
- package/funcs/accountEmailSendVerification.js.map +1 -0
- package/funcs/accountEmailSubscription.d.ts +11 -0
- package/funcs/{settingsSendVerification.d.ts.map → accountEmailSubscription.d.ts.map} +1 -1
- package/funcs/{settingsSubscribeEmail.js → accountEmailSubscription.js} +3 -3
- package/funcs/accountEmailSubscription.js.map +1 -0
- package/funcs/{badgeBadgeV1TagsSuggest.d.ts → accountEmailVerify.d.ts} +2 -2
- package/funcs/{appAppV1ListBadges.d.ts.map → accountEmailVerify.d.ts.map} +1 -1
- package/funcs/{settingsVerifyEmail.js → accountEmailVerify.js} +3 -3
- package/funcs/{appAppV1ListBadges.js.map → accountEmailVerify.js.map} +1 -1
- package/funcs/accountGetBadgeBookmarks.d.ts +11 -0
- package/funcs/accountGetBadgeBookmarks.d.ts.map +1 -0
- package/funcs/{badgesGetBookmarks.js → accountGetBadgeBookmarks.js} +3 -3
- package/funcs/accountGetBadgeBookmarks.js.map +1 -0
- package/funcs/{adminAdminV1RemoveVanity.d.ts → accountGetImages.d.ts} +2 -3
- package/funcs/accountGetImages.d.ts.map +1 -0
- package/funcs/{imagesGet.js → accountGetImages.js} +3 -3
- package/funcs/accountGetImages.js.map +1 -0
- package/funcs/{settingsSendVerification.d.ts → accountGetMeta.d.ts} +3 -2
- package/funcs/{sessionsDelete.d.ts.map → accountGetMeta.d.ts.map} +1 -1
- package/funcs/{accountAccountV1GetMeta.js → accountGetMeta.js} +3 -3
- package/funcs/{badgesBookmark.js.map → accountGetMeta.js.map} +1 -1
- package/funcs/{badgesGetBookmarks.d.ts → accountGetOwnedBadges.d.ts} +2 -2
- package/funcs/accountGetOwnedBadges.d.ts.map +1 -0
- package/funcs/{badgesGetOwned.js → accountGetOwnedBadges.js} +3 -3
- package/funcs/accountGetOwnedBadges.js.map +1 -0
- package/funcs/{appAppV1ListBadges.d.ts → accountGetSession.d.ts} +2 -3
- package/funcs/accountGetSession.d.ts.map +1 -0
- package/funcs/{sessionsGet.js → accountGetSession.js} +3 -3
- package/funcs/{livenessCheck.js.map → accountGetSession.js.map} +1 -1
- package/funcs/{settingsSubscribeEmail.d.ts → accountGetSettings.d.ts} +2 -2
- package/funcs/{badgesGetBookmarks.d.ts.map → accountGetSettings.d.ts.map} +1 -1
- package/funcs/{settingsGet.js → accountGetSettings.js} +3 -3
- package/funcs/accountGetSettings.js.map +1 -0
- package/funcs/{sessionLogin.d.ts → accountLogin.d.ts} +2 -2
- package/funcs/{sessionLogin.d.ts.map → accountLogin.d.ts.map} +1 -1
- package/funcs/{sessionLogin.js → accountLogin.js} +3 -3
- package/funcs/{sessionLogin.js.map → accountLogin.js.map} +1 -1
- package/funcs/{accountsQueue.d.ts → accountQueue.d.ts} +2 -2
- package/funcs/{eventsUpdate.d.ts.map → accountQueue.d.ts.map} +1 -1
- package/funcs/{accountsQueue.js → accountQueue.js} +3 -3
- package/funcs/{imagesUpdate.js.map → accountQueue.js.map} +1 -1
- package/funcs/accountReconnect.d.ts +12 -0
- package/funcs/{accountUpdateApp.d.ts.map → accountReconnect.d.ts.map} +1 -1
- package/funcs/{connectionReconnect.js → accountReconnect.js} +3 -3
- package/funcs/{connectionVerify.js.map → accountReconnect.js.map} +1 -1
- package/funcs/{settingsUpdateRole.d.ts → accountRolesUpdate.d.ts} +2 -2
- package/funcs/{settingsUpdateRole.d.ts.map → accountRolesUpdate.d.ts.map} +1 -1
- package/funcs/{settingsUpdateRole.js → accountRolesUpdate.js} +3 -3
- package/funcs/{settingsUpdateRole.js.map → accountRolesUpdate.js.map} +1 -1
- package/funcs/accountSessionDelete.d.ts +12 -0
- package/funcs/accountSessionDelete.d.ts.map +1 -0
- package/funcs/{sessionsDelete.js → accountSessionDelete.js} +3 -3
- package/funcs/accountSessionDelete.js.map +1 -0
- package/funcs/{sessionCreate.d.ts → accountUpdateImages.d.ts} +3 -2
- package/funcs/{settingsVerifyEmail.d.ts.map → accountUpdateImages.d.ts.map} +1 -1
- package/funcs/{imagesUpdate.js → accountUpdateImages.js} +3 -3
- package/funcs/{connectionReconnect.js.map → accountUpdateImages.js.map} +1 -1
- package/funcs/accountUpdateSettings.d.ts +11 -0
- package/funcs/accountUpdateSettings.d.ts.map +1 -0
- package/funcs/{settingsUpdate.js → accountUpdateSettings.js} +3 -3
- package/funcs/accountUpdateSettings.js.map +1 -0
- package/funcs/accountVerifyConnection.d.ts +12 -0
- package/funcs/accountVerifyConnection.d.ts.map +1 -0
- package/funcs/{connectionVerify.js → accountVerifyConnection.js} +3 -3
- package/funcs/accountVerifyConnection.js.map +1 -0
- package/funcs/{sessionsGet.d.ts → adminEventsGet.d.ts} +2 -2
- package/funcs/{badgesGetOwned.d.ts.map → adminEventsGet.d.ts.map} +1 -1
- package/funcs/{eventsGet.js → adminEventsGet.js} +3 -3
- package/funcs/{badgesGetOwned.js.map → adminEventsGet.js.map} +1 -1
- package/funcs/{imagesGet.d.ts → adminRemoveVanity.d.ts} +3 -2
- package/funcs/adminRemoveVanity.d.ts.map +1 -0
- package/funcs/{adminAdminV1RemoveVanity.js → adminRemoveVanity.js} +3 -3
- package/funcs/adminRemoveVanity.js.map +1 -0
- package/funcs/{accountAccountV1GetMeta.d.ts → adminUpdateEvent.d.ts} +2 -2
- package/funcs/{connectionDelete.d.ts.map → adminUpdateEvent.d.ts.map} +1 -1
- package/funcs/{eventsUpdate.js → adminUpdateEvent.js} +3 -3
- package/funcs/{connectionDelete.js.map → adminUpdateEvent.js.map} +1 -1
- package/funcs/{settingsGet.d.ts → appListBadges.d.ts} +3 -2
- package/funcs/{accountsQueue.d.ts.map → appListBadges.d.ts.map} +1 -1
- package/funcs/{appAppV1ListBadges.js → appListBadges.js} +3 -3
- package/funcs/{accountsQueue.js.map → appListBadges.js.map} +1 -1
- package/funcs/{badgesSearch.d.ts → badgeSearch.d.ts} +2 -2
- package/funcs/badgeSearch.d.ts.map +1 -0
- package/funcs/{badgesSearch.js → badgeSearch.js} +3 -3
- package/funcs/badgeSearch.js.map +1 -0
- package/funcs/{connectionsConnect.d.ts → badgeSuggest.d.ts} +2 -2
- package/funcs/{imagesUpdate.d.ts.map → badgeSuggest.d.ts.map} +1 -1
- package/funcs/{badgeBadgeV1SearchSuggest.js → badgeSuggest.js} +3 -3
- package/funcs/{badgesSearch.js.map → badgeSuggest.js.map} +1 -1
- package/funcs/badgeSuggestTags.d.ts +12 -0
- package/funcs/{connectionUpdate.d.ts.map → badgeSuggestTags.d.ts.map} +1 -1
- package/funcs/{badgeBadgeV1TagsSuggest.js → badgeSuggestTags.js} +3 -3
- package/funcs/{connectionUpdate.js.map → badgeSuggestTags.js.map} +1 -1
- package/funcs/{badgesTag.d.ts → badgeTag.d.ts} +2 -2
- package/funcs/badgeTag.d.ts.map +1 -0
- package/funcs/{badgesTag.js → badgeTag.js} +3 -3
- package/funcs/badgeTag.js.map +1 -0
- package/funcs/{badgesGetOwned.d.ts → leaderboardBadgesGetList.d.ts} +2 -2
- package/funcs/leaderboardBadgesGetList.d.ts.map +1 -0
- package/funcs/{leaderboardGetBadges.js → leaderboardBadgesGetList.js} +3 -3
- package/funcs/leaderboardBadgesGetList.js.map +1 -0
- package/funcs/{accountDeleteDeveloperApp.d.ts → leaderboardGetAccountMeta.d.ts} +2 -2
- package/funcs/{accountDeleteDeveloperApp.d.ts.map → leaderboardGetAccountMeta.d.ts.map} +1 -1
- package/funcs/{leaderboardLeaderboardV1GetLeaderboardAccountMeta.js → leaderboardGetAccountMeta.js} +3 -3
- package/funcs/leaderboardGetAccountMeta.js.map +1 -0
- package/funcs/{livenessCheck.d.ts → livenessGet.d.ts} +2 -2
- package/funcs/livenessGet.d.ts.map +1 -0
- package/funcs/{livenessCheck.js → livenessGet.js} +3 -3
- package/funcs/livenessGet.js.map +1 -0
- package/funcs/{eventsGet.d.ts → locationGet.d.ts} +2 -2
- package/funcs/{sessionsGet.d.ts.map → locationGet.d.ts.map} +1 -1
- package/funcs/{locationsGet.js → locationGet.js} +3 -3
- package/funcs/locationGet.js.map +1 -0
- package/jsr.json +1 -1
- package/lib/config.d.ts +2 -2
- package/lib/config.js +2 -2
- package/package.json +1 -1
- package/sdk/account.d.ts +31 -3
- package/sdk/account.d.ts.map +1 -1
- package/sdk/account.js +89 -9
- package/sdk/account.js.map +1 -1
- package/sdk/admin.d.ts +5 -1
- package/sdk/admin.d.ts.map +1 -1
- package/sdk/admin.js +11 -3
- package/sdk/admin.js.map +1 -1
- package/sdk/app.d.ts +1 -1
- package/sdk/app.d.ts.map +1 -1
- package/sdk/app.js +3 -3
- package/sdk/app.js.map +1 -1
- package/sdk/badge.d.ts +4 -2
- package/sdk/badge.d.ts.map +1 -1
- package/sdk/badge.js +14 -6
- package/sdk/badge.js.map +1 -1
- package/sdk/badges.d.ts +1 -6
- package/sdk/badges.d.ts.map +1 -1
- package/sdk/badges.js +3 -19
- package/sdk/badges.js.map +1 -1
- package/sdk/connection.d.ts +0 -3
- package/sdk/connection.d.ts.map +1 -1
- package/sdk/connection.js +2 -14
- package/sdk/connection.js.map +1 -1
- package/sdk/developerapps.d.ts +8 -0
- package/sdk/developerapps.d.ts.map +1 -0
- package/sdk/developerapps.js +20 -0
- package/sdk/developerapps.js.map +1 -0
- package/sdk/events.d.ts +0 -2
- package/sdk/events.d.ts.map +1 -1
- package/sdk/events.js +2 -6
- package/sdk/events.js.map +1 -1
- package/sdk/leaderboard.d.ts +4 -2
- package/sdk/leaderboard.d.ts.map +1 -1
- package/sdk/leaderboard.js +7 -7
- package/sdk/leaderboard.js.map +1 -1
- package/sdk/liveness.d.ts +1 -1
- package/sdk/liveness.d.ts.map +1 -1
- package/sdk/liveness.js +3 -3
- package/sdk/liveness.js.map +1 -1
- package/sdk/{locations.d.ts → location.d.ts} +2 -2
- package/sdk/location.d.ts.map +1 -0
- package/sdk/location.js +16 -0
- package/sdk/location.js.map +1 -0
- package/sdk/roles.d.ts +7 -0
- package/sdk/roles.d.ts.map +1 -0
- package/sdk/roles.js +16 -0
- package/sdk/roles.js.map +1 -0
- package/sdk/sdk.d.ts +3 -30
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +3 -39
- package/sdk/sdk.js.map +1 -1
- package/sdk/session.d.ts +2 -2
- package/sdk/session.d.ts.map +1 -1
- package/sdk/session.js +3 -7
- package/sdk/session.js.map +1 -1
- package/src/funcs/{badgesBookmark.ts → accountBookmarkBadge.ts} +1 -1
- package/src/funcs/{connectionsConnect.ts → accountConnect.ts} +1 -1
- package/src/funcs/{connectionUpdate.ts → accountConnectionUpdate.ts} +1 -1
- package/src/funcs/{sessionCreate.ts → accountCreateSession.ts} +1 -1
- package/src/funcs/{connectionDelete.ts → accountDeleteConnection.ts} +1 -1
- package/src/funcs/{accountDeleteDeveloperApp.ts → accountDeveloperAppsDelete.ts} +1 -1
- package/src/funcs/{accountUpdateApp.ts → accountDeveloperAppsUpdate.ts} +1 -1
- package/src/funcs/{settingsSendVerification.ts → accountEmailSendVerification.ts} +1 -1
- package/src/funcs/{settingsSubscribeEmail.ts → accountEmailSubscription.ts} +1 -1
- package/src/funcs/{settingsVerifyEmail.ts → accountEmailVerify.ts} +1 -1
- package/src/funcs/{badgesGetBookmarks.ts → accountGetBadgeBookmarks.ts} +1 -1
- package/src/funcs/{imagesGet.ts → accountGetImages.ts} +1 -1
- package/src/funcs/{accountAccountV1GetMeta.ts → accountGetMeta.ts} +1 -1
- package/src/funcs/{badgesGetOwned.ts → accountGetOwnedBadges.ts} +1 -1
- package/src/funcs/{sessionsGet.ts → accountGetSession.ts} +1 -1
- package/src/funcs/{settingsGet.ts → accountGetSettings.ts} +1 -1
- package/src/funcs/{sessionLogin.ts → accountLogin.ts} +1 -1
- package/src/funcs/{accountsQueue.ts → accountQueue.ts} +1 -1
- package/src/funcs/{connectionReconnect.ts → accountReconnect.ts} +1 -1
- package/src/funcs/{settingsUpdateRole.ts → accountRolesUpdate.ts} +1 -1
- package/src/funcs/{sessionsDelete.ts → accountSessionDelete.ts} +1 -1
- package/src/funcs/{imagesUpdate.ts → accountUpdateImages.ts} +1 -1
- package/src/funcs/{settingsUpdate.ts → accountUpdateSettings.ts} +1 -1
- package/src/funcs/{connectionVerify.ts → accountVerifyConnection.ts} +1 -1
- package/src/funcs/{eventsGet.ts → adminEventsGet.ts} +1 -1
- package/src/funcs/{adminAdminV1RemoveVanity.ts → adminRemoveVanity.ts} +1 -1
- package/src/funcs/{eventsUpdate.ts → adminUpdateEvent.ts} +1 -1
- package/src/funcs/{appAppV1ListBadges.ts → appListBadges.ts} +1 -1
- package/src/funcs/{badgesSearch.ts → badgeSearch.ts} +1 -1
- package/src/funcs/{badgeBadgeV1SearchSuggest.ts → badgeSuggest.ts} +1 -1
- package/src/funcs/{badgeBadgeV1TagsSuggest.ts → badgeSuggestTags.ts} +1 -1
- package/src/funcs/{badgesTag.ts → badgeTag.ts} +1 -1
- package/src/funcs/{leaderboardGetBadges.ts → leaderboardBadgesGetList.ts} +1 -1
- package/src/funcs/{leaderboardLeaderboardV1GetLeaderboardAccountMeta.ts → leaderboardGetAccountMeta.ts} +1 -1
- package/src/funcs/{livenessCheck.ts → livenessGet.ts} +1 -1
- package/src/funcs/{locationsGet.ts → locationGet.ts} +1 -1
- package/src/lib/config.ts +2 -2
- package/src/sdk/account.ts +219 -13
- package/src/sdk/admin.ts +21 -3
- package/src/sdk/app.ts +3 -3
- package/src/sdk/badge.ts +30 -6
- package/src/sdk/badges.ts +4 -51
- package/src/sdk/connection.ts +2 -38
- package/src/sdk/developerapps.ts +34 -0
- package/src/sdk/events.ts +2 -15
- package/src/sdk/leaderboard.ts +9 -13
- package/src/sdk/liveness.ts +3 -3
- package/src/sdk/{locations.ts → location.ts} +3 -3
- package/src/sdk/{connections.ts → roles.ts} +6 -6
- package/src/sdk/sdk.ts +4 -58
- package/src/sdk/session.ts +6 -17
- package/docs/sdks/connections/README.md +0 -86
- package/docs/sdks/images/README.md +0 -159
- package/docs/sdks/settings/README.md +0 -471
- package/funcs/accountDeleteDeveloperApp.js.map +0 -1
- package/funcs/accountUpdateApp.js.map +0 -1
- package/funcs/adminAdminV1RemoveVanity.d.ts.map +0 -1
- package/funcs/adminAdminV1RemoveVanity.js.map +0 -1
- package/funcs/badgeBadgeV1SearchSuggest.d.ts +0 -12
- package/funcs/badgeBadgeV1SearchSuggest.d.ts.map +0 -1
- package/funcs/badgeBadgeV1SearchSuggest.js.map +0 -1
- package/funcs/badgesBookmark.d.ts +0 -12
- package/funcs/badgesGetBookmarks.js.map +0 -1
- package/funcs/badgesSearch.d.ts.map +0 -1
- package/funcs/badgesTag.d.ts.map +0 -1
- package/funcs/badgesTag.js.map +0 -1
- package/funcs/connectionDelete.d.ts +0 -12
- package/funcs/connectionReconnect.d.ts +0 -12
- package/funcs/connectionReconnect.d.ts.map +0 -1
- package/funcs/connectionUpdate.d.ts +0 -12
- package/funcs/connectionVerify.d.ts +0 -12
- package/funcs/connectionVerify.d.ts.map +0 -1
- package/funcs/connectionsConnect.d.ts.map +0 -1
- package/funcs/connectionsConnect.js.map +0 -1
- package/funcs/eventsGet.d.ts.map +0 -1
- package/funcs/eventsGet.js.map +0 -1
- package/funcs/eventsUpdate.js.map +0 -1
- package/funcs/imagesGet.d.ts.map +0 -1
- package/funcs/imagesGet.js.map +0 -1
- package/funcs/imagesUpdate.d.ts +0 -12
- package/funcs/leaderboardGetBadges.d.ts +0 -11
- package/funcs/leaderboardGetBadges.d.ts.map +0 -1
- package/funcs/leaderboardGetBadges.js.map +0 -1
- package/funcs/leaderboardLeaderboardV1GetLeaderboardAccountMeta.d.ts +0 -12
- package/funcs/leaderboardLeaderboardV1GetLeaderboardAccountMeta.d.ts.map +0 -1
- package/funcs/leaderboardLeaderboardV1GetLeaderboardAccountMeta.js.map +0 -1
- package/funcs/livenessCheck.d.ts.map +0 -1
- package/funcs/locationsGet.d.ts.map +0 -1
- package/funcs/locationsGet.js.map +0 -1
- package/funcs/sessionCreate.d.ts.map +0 -1
- package/funcs/sessionCreate.js.map +0 -1
- package/funcs/sessionsDelete.d.ts +0 -12
- package/funcs/sessionsGet.js.map +0 -1
- package/funcs/settingsGet.d.ts.map +0 -1
- package/funcs/settingsGet.js.map +0 -1
- package/funcs/settingsSendVerification.js.map +0 -1
- package/funcs/settingsSubscribeEmail.d.ts.map +0 -1
- package/funcs/settingsSubscribeEmail.js.map +0 -1
- package/funcs/settingsUpdate.d.ts +0 -11
- package/funcs/settingsUpdate.d.ts.map +0 -1
- package/funcs/settingsUpdate.js.map +0 -1
- package/funcs/settingsVerifyEmail.js.map +0 -1
- package/sdk/accounts.d.ts +0 -7
- package/sdk/accounts.d.ts.map +0 -1
- package/sdk/accounts.js +0 -16
- package/sdk/accounts.js.map +0 -1
- package/sdk/connections.d.ts +0 -7
- package/sdk/connections.d.ts.map +0 -1
- package/sdk/connections.js +0 -16
- package/sdk/connections.js.map +0 -1
- package/sdk/images.d.ts +0 -8
- package/sdk/images.d.ts.map +0 -1
- package/sdk/images.js +0 -20
- package/sdk/images.js.map +0 -1
- package/sdk/locations.d.ts.map +0 -1
- package/sdk/locations.js +0 -16
- package/sdk/locations.js.map +0 -1
- package/sdk/sessions.d.ts +0 -8
- package/sdk/sessions.d.ts.map +0 -1
- package/sdk/sessions.js +0 -20
- package/sdk/sessions.js.map +0 -1
- package/sdk/settings.d.ts +0 -12
- package/sdk/settings.d.ts.map +0 -1
- package/sdk/settings.js +0 -36
- package/sdk/settings.js.map +0 -1
- package/src/sdk/accounts.ts +0 -22
- package/src/sdk/images.ts +0 -32
- package/src/sdk/sessions.ts +0 -32
- package/src/sdk/settings.ts +0 -80
|
@@ -7,19 +7,191 @@ All Requests related to account(s) are grouped here.
|
|
|
7
7
|
|
|
8
8
|
### Available Operations
|
|
9
9
|
|
|
10
|
+
* [bookmarkBadge](#bookmarkbadge)
|
|
11
|
+
* [connect](#connect)
|
|
10
12
|
* [createDeveloperApp](#createdeveloperapp)
|
|
11
|
-
* [
|
|
13
|
+
* [createSession](#createsession)
|
|
14
|
+
* [deleteConnection](#deleteconnection)
|
|
12
15
|
* [deleteImages](#deleteimages)
|
|
13
|
-
* [
|
|
16
|
+
* [emailSendVerification](#emailsendverification)
|
|
17
|
+
* [emailSubscription](#emailsubscription)
|
|
18
|
+
* [emailVerify](#emailverify)
|
|
14
19
|
* [getApps](#getapps)
|
|
20
|
+
* [getBadgeBookmarks](#getbadgebookmarks)
|
|
15
21
|
* [getBadges](#getbadges)
|
|
16
22
|
* [getDataPoints](#getdatapoints)
|
|
17
23
|
* [getFriends](#getfriends)
|
|
24
|
+
* [getImages](#getimages)
|
|
18
25
|
* [getInfo](#getinfo)
|
|
19
26
|
* [getLeaderboardHistory](#getleaderboardhistory)
|
|
20
|
-
* [
|
|
27
|
+
* [getMeta](#getmeta)
|
|
28
|
+
* [getOwnedBadges](#getownedbadges)
|
|
29
|
+
* [getSession](#getsession)
|
|
30
|
+
* [getSettings](#getsettings)
|
|
21
31
|
* [getStaff](#getstaff)
|
|
32
|
+
* [login](#login)
|
|
33
|
+
* [queue](#queue)
|
|
34
|
+
* [reconnect](#reconnect)
|
|
35
|
+
* [updateImages](#updateimages)
|
|
36
|
+
* [updateSettings](#updatesettings)
|
|
22
37
|
* [uploadImages](#uploadimages)
|
|
38
|
+
* [verifyConnection](#verifyconnection)
|
|
39
|
+
|
|
40
|
+
## bookmarkBadge
|
|
41
|
+
|
|
42
|
+
### Example Usage
|
|
43
|
+
|
|
44
|
+
```typescript
|
|
45
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
46
|
+
|
|
47
|
+
const steamSets = new SteamSets({
|
|
48
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
49
|
+
});
|
|
50
|
+
|
|
51
|
+
async function run() {
|
|
52
|
+
const result = await steamSets.account.bookmarkBadge({
|
|
53
|
+
badgeId: "bdg_123",
|
|
54
|
+
bookmark: true,
|
|
55
|
+
});
|
|
56
|
+
|
|
57
|
+
// Handle the result
|
|
58
|
+
console.log(result);
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
run();
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Standalone function
|
|
65
|
+
|
|
66
|
+
The standalone function version of this method:
|
|
67
|
+
|
|
68
|
+
```typescript
|
|
69
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
70
|
+
import { accountBookmarkBadge } from "@steamsets/client-ts/funcs/accountBookmarkBadge.js";
|
|
71
|
+
|
|
72
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
73
|
+
// You can create one instance of it to use across an application.
|
|
74
|
+
const steamSets = new SteamSetsCore({
|
|
75
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
76
|
+
});
|
|
77
|
+
|
|
78
|
+
async function run() {
|
|
79
|
+
const res = await accountBookmarkBadge(steamSets, {
|
|
80
|
+
badgeId: "bdg_123",
|
|
81
|
+
bookmark: true,
|
|
82
|
+
});
|
|
83
|
+
|
|
84
|
+
if (!res.ok) {
|
|
85
|
+
throw res.error;
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
const { value: result } = res;
|
|
89
|
+
|
|
90
|
+
// Handle the result
|
|
91
|
+
console.log(result);
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
run();
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### Parameters
|
|
98
|
+
|
|
99
|
+
| Parameter | Type | Required | Description |
|
|
100
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
101
|
+
| `request` | [components.V1AccountBadgeBookmarkRequestBody](../../models/components/v1accountbadgebookmarkrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
102
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
103
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
104
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
105
|
+
|
|
106
|
+
### Response
|
|
107
|
+
|
|
108
|
+
**Promise\<[operations.AccountV1BookmarkBadgeResponse](../../models/operations/accountv1bookmarkbadgeresponse.md)\>**
|
|
109
|
+
|
|
110
|
+
### Errors
|
|
111
|
+
|
|
112
|
+
| Error Type | Status Code | Content Type |
|
|
113
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
114
|
+
| errors.ErrorModel | 403, 404, 422 | application/problem+json |
|
|
115
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
116
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
117
|
+
|
|
118
|
+
## connect
|
|
119
|
+
|
|
120
|
+
### Example Usage
|
|
121
|
+
|
|
122
|
+
```typescript
|
|
123
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
124
|
+
|
|
125
|
+
const steamSets = new SteamSets({
|
|
126
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
127
|
+
});
|
|
128
|
+
|
|
129
|
+
async function run() {
|
|
130
|
+
const result = await steamSets.account.connect({
|
|
131
|
+
code: "123456",
|
|
132
|
+
provider: "discord",
|
|
133
|
+
});
|
|
134
|
+
|
|
135
|
+
// Handle the result
|
|
136
|
+
console.log(result);
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
run();
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
### Standalone function
|
|
143
|
+
|
|
144
|
+
The standalone function version of this method:
|
|
145
|
+
|
|
146
|
+
```typescript
|
|
147
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
148
|
+
import { accountConnect } from "@steamsets/client-ts/funcs/accountConnect.js";
|
|
149
|
+
|
|
150
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
151
|
+
// You can create one instance of it to use across an application.
|
|
152
|
+
const steamSets = new SteamSetsCore({
|
|
153
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
154
|
+
});
|
|
155
|
+
|
|
156
|
+
async function run() {
|
|
157
|
+
const res = await accountConnect(steamSets, {
|
|
158
|
+
code: "123456",
|
|
159
|
+
provider: "discord",
|
|
160
|
+
});
|
|
161
|
+
|
|
162
|
+
if (!res.ok) {
|
|
163
|
+
throw res.error;
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
const { value: result } = res;
|
|
167
|
+
|
|
168
|
+
// Handle the result
|
|
169
|
+
console.log(result);
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
run();
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
### Parameters
|
|
176
|
+
|
|
177
|
+
| Parameter | Type | Required | Description |
|
|
178
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
179
|
+
| `request` | [components.V1ConnectRequestBody](../../models/components/v1connectrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
180
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
181
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
182
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
183
|
+
|
|
184
|
+
### Response
|
|
185
|
+
|
|
186
|
+
**Promise\<[operations.AccountV1ConnectionConnectResponse](../../models/operations/accountv1connectionconnectresponse.md)\>**
|
|
187
|
+
|
|
188
|
+
### Errors
|
|
189
|
+
|
|
190
|
+
| Error Type | Status Code | Content Type |
|
|
191
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
192
|
+
| errors.ErrorModel | 400, 422 | application/problem+json |
|
|
193
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
194
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
23
195
|
|
|
24
196
|
## createDeveloperApp
|
|
25
197
|
|
|
@@ -33,12 +205,978 @@ const steamSets = new SteamSets({
|
|
|
33
205
|
});
|
|
34
206
|
|
|
35
207
|
async function run() {
|
|
36
|
-
const result = await steamSets.account.createDeveloperApp({
|
|
37
|
-
description: "Your App Description",
|
|
38
|
-
environment: "production",
|
|
39
|
-
generateKey: true,
|
|
40
|
-
name: "Your App",
|
|
41
|
-
});
|
|
208
|
+
const result = await steamSets.account.createDeveloperApp({
|
|
209
|
+
description: "Your App Description",
|
|
210
|
+
environment: "production",
|
|
211
|
+
generateKey: true,
|
|
212
|
+
name: "Your App",
|
|
213
|
+
});
|
|
214
|
+
|
|
215
|
+
// Handle the result
|
|
216
|
+
console.log(result);
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
run();
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
### Standalone function
|
|
223
|
+
|
|
224
|
+
The standalone function version of this method:
|
|
225
|
+
|
|
226
|
+
```typescript
|
|
227
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
228
|
+
import { accountCreateDeveloperApp } from "@steamsets/client-ts/funcs/accountCreateDeveloperApp.js";
|
|
229
|
+
|
|
230
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
231
|
+
// You can create one instance of it to use across an application.
|
|
232
|
+
const steamSets = new SteamSetsCore({
|
|
233
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
234
|
+
});
|
|
235
|
+
|
|
236
|
+
async function run() {
|
|
237
|
+
const res = await accountCreateDeveloperApp(steamSets, {
|
|
238
|
+
description: "Your App Description",
|
|
239
|
+
environment: "production",
|
|
240
|
+
generateKey: true,
|
|
241
|
+
name: "Your App",
|
|
242
|
+
});
|
|
243
|
+
|
|
244
|
+
if (!res.ok) {
|
|
245
|
+
throw res.error;
|
|
246
|
+
}
|
|
247
|
+
|
|
248
|
+
const { value: result } = res;
|
|
249
|
+
|
|
250
|
+
// Handle the result
|
|
251
|
+
console.log(result);
|
|
252
|
+
}
|
|
253
|
+
|
|
254
|
+
run();
|
|
255
|
+
```
|
|
256
|
+
|
|
257
|
+
### Parameters
|
|
258
|
+
|
|
259
|
+
| Parameter | Type | Required | Description |
|
|
260
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
261
|
+
| `request` | [components.V1DeveloperAppCreateRequestBody](../../models/components/v1developerappcreaterequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
262
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
263
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
264
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
265
|
+
|
|
266
|
+
### Response
|
|
267
|
+
|
|
268
|
+
**Promise\<[operations.AccountV1SettingsDeveloperAppCreateResponse](../../models/operations/accountv1settingsdeveloperappcreateresponse.md)\>**
|
|
269
|
+
|
|
270
|
+
### Errors
|
|
271
|
+
|
|
272
|
+
| Error Type | Status Code | Content Type |
|
|
273
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
274
|
+
| errors.ErrorModel | 400, 404, 422 | application/problem+json |
|
|
275
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
276
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
277
|
+
|
|
278
|
+
## createSession
|
|
279
|
+
|
|
280
|
+
### Example Usage
|
|
281
|
+
|
|
282
|
+
```typescript
|
|
283
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
284
|
+
|
|
285
|
+
const steamSets = new SteamSets({
|
|
286
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
287
|
+
});
|
|
288
|
+
|
|
289
|
+
async function run() {
|
|
290
|
+
const result = await steamSets.account.createSession({});
|
|
291
|
+
|
|
292
|
+
// Handle the result
|
|
293
|
+
console.log(result);
|
|
294
|
+
}
|
|
295
|
+
|
|
296
|
+
run();
|
|
297
|
+
```
|
|
298
|
+
|
|
299
|
+
### Standalone function
|
|
300
|
+
|
|
301
|
+
The standalone function version of this method:
|
|
302
|
+
|
|
303
|
+
```typescript
|
|
304
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
305
|
+
import { accountCreateSession } from "@steamsets/client-ts/funcs/accountCreateSession.js";
|
|
306
|
+
|
|
307
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
308
|
+
// You can create one instance of it to use across an application.
|
|
309
|
+
const steamSets = new SteamSetsCore({
|
|
310
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
311
|
+
});
|
|
312
|
+
|
|
313
|
+
async function run() {
|
|
314
|
+
const res = await accountCreateSession(steamSets, {});
|
|
315
|
+
|
|
316
|
+
if (!res.ok) {
|
|
317
|
+
throw res.error;
|
|
318
|
+
}
|
|
319
|
+
|
|
320
|
+
const { value: result } = res;
|
|
321
|
+
|
|
322
|
+
// Handle the result
|
|
323
|
+
console.log(result);
|
|
324
|
+
}
|
|
325
|
+
|
|
326
|
+
run();
|
|
327
|
+
```
|
|
328
|
+
|
|
329
|
+
### Parameters
|
|
330
|
+
|
|
331
|
+
| Parameter | Type | Required | Description |
|
|
332
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
333
|
+
| `request` | [operations.AccountV1SessionCreateRequest](../../models/operations/accountv1sessioncreaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
334
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
335
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
336
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
337
|
+
|
|
338
|
+
### Response
|
|
339
|
+
|
|
340
|
+
**Promise\<[operations.AccountV1SessionCreateResponse](../../models/operations/accountv1sessioncreateresponse.md)\>**
|
|
341
|
+
|
|
342
|
+
### Errors
|
|
343
|
+
|
|
344
|
+
| Error Type | Status Code | Content Type |
|
|
345
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
346
|
+
| errors.ErrorModel | 422 | application/problem+json |
|
|
347
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
348
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
349
|
+
|
|
350
|
+
## deleteConnection
|
|
351
|
+
|
|
352
|
+
### Example Usage
|
|
353
|
+
|
|
354
|
+
```typescript
|
|
355
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
356
|
+
|
|
357
|
+
const steamSets = new SteamSets({
|
|
358
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
359
|
+
});
|
|
360
|
+
|
|
361
|
+
async function run() {
|
|
362
|
+
const result = await steamSets.account.deleteConnection({
|
|
363
|
+
connectionId: "123456",
|
|
364
|
+
});
|
|
365
|
+
|
|
366
|
+
// Handle the result
|
|
367
|
+
console.log(result);
|
|
368
|
+
}
|
|
369
|
+
|
|
370
|
+
run();
|
|
371
|
+
```
|
|
372
|
+
|
|
373
|
+
### Standalone function
|
|
374
|
+
|
|
375
|
+
The standalone function version of this method:
|
|
376
|
+
|
|
377
|
+
```typescript
|
|
378
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
379
|
+
import { accountDeleteConnection } from "@steamsets/client-ts/funcs/accountDeleteConnection.js";
|
|
380
|
+
|
|
381
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
382
|
+
// You can create one instance of it to use across an application.
|
|
383
|
+
const steamSets = new SteamSetsCore({
|
|
384
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
385
|
+
});
|
|
386
|
+
|
|
387
|
+
async function run() {
|
|
388
|
+
const res = await accountDeleteConnection(steamSets, {
|
|
389
|
+
connectionId: "123456",
|
|
390
|
+
});
|
|
391
|
+
|
|
392
|
+
if (!res.ok) {
|
|
393
|
+
throw res.error;
|
|
394
|
+
}
|
|
395
|
+
|
|
396
|
+
const { value: result } = res;
|
|
397
|
+
|
|
398
|
+
// Handle the result
|
|
399
|
+
console.log(result);
|
|
400
|
+
}
|
|
401
|
+
|
|
402
|
+
run();
|
|
403
|
+
```
|
|
404
|
+
|
|
405
|
+
### Parameters
|
|
406
|
+
|
|
407
|
+
| Parameter | Type | Required | Description |
|
|
408
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
409
|
+
| `request` | [components.V1DeleteConnectionRequestBody](../../models/components/v1deleteconnectionrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
410
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
411
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
412
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
413
|
+
|
|
414
|
+
### Response
|
|
415
|
+
|
|
416
|
+
**Promise\<[operations.AccountV1ConnectionDeleteConnectionResponse](../../models/operations/accountv1connectiondeleteconnectionresponse.md)\>**
|
|
417
|
+
|
|
418
|
+
### Errors
|
|
419
|
+
|
|
420
|
+
| Error Type | Status Code | Content Type |
|
|
421
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
422
|
+
| errors.ErrorModel | 400, 422 | application/problem+json |
|
|
423
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
424
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
425
|
+
|
|
426
|
+
## deleteImages
|
|
427
|
+
|
|
428
|
+
### Example Usage
|
|
429
|
+
|
|
430
|
+
```typescript
|
|
431
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
432
|
+
|
|
433
|
+
const steamSets = new SteamSets({
|
|
434
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
435
|
+
});
|
|
436
|
+
|
|
437
|
+
async function run() {
|
|
438
|
+
const result = await steamSets.account.deleteImages({
|
|
439
|
+
imageIds: [
|
|
440
|
+
"<value>",
|
|
441
|
+
"<value>",
|
|
442
|
+
],
|
|
443
|
+
});
|
|
444
|
+
|
|
445
|
+
// Handle the result
|
|
446
|
+
console.log(result);
|
|
447
|
+
}
|
|
448
|
+
|
|
449
|
+
run();
|
|
450
|
+
```
|
|
451
|
+
|
|
452
|
+
### Standalone function
|
|
453
|
+
|
|
454
|
+
The standalone function version of this method:
|
|
455
|
+
|
|
456
|
+
```typescript
|
|
457
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
458
|
+
import { accountDeleteImages } from "@steamsets/client-ts/funcs/accountDeleteImages.js";
|
|
459
|
+
|
|
460
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
461
|
+
// You can create one instance of it to use across an application.
|
|
462
|
+
const steamSets = new SteamSetsCore({
|
|
463
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
464
|
+
});
|
|
465
|
+
|
|
466
|
+
async function run() {
|
|
467
|
+
const res = await accountDeleteImages(steamSets, {
|
|
468
|
+
imageIds: [
|
|
469
|
+
"<value>",
|
|
470
|
+
"<value>",
|
|
471
|
+
],
|
|
472
|
+
});
|
|
473
|
+
|
|
474
|
+
if (!res.ok) {
|
|
475
|
+
throw res.error;
|
|
476
|
+
}
|
|
477
|
+
|
|
478
|
+
const { value: result } = res;
|
|
479
|
+
|
|
480
|
+
// Handle the result
|
|
481
|
+
console.log(result);
|
|
482
|
+
}
|
|
483
|
+
|
|
484
|
+
run();
|
|
485
|
+
```
|
|
486
|
+
|
|
487
|
+
### Parameters
|
|
488
|
+
|
|
489
|
+
| Parameter | Type | Required | Description |
|
|
490
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
491
|
+
| `request` | [components.V1DeleteImagesRequestBody](../../models/components/v1deleteimagesrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
492
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
493
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
494
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
495
|
+
|
|
496
|
+
### Response
|
|
497
|
+
|
|
498
|
+
**Promise\<[operations.AccountV1ImagesDeleteResponse](../../models/operations/accountv1imagesdeleteresponse.md)\>**
|
|
499
|
+
|
|
500
|
+
### Errors
|
|
501
|
+
|
|
502
|
+
| Error Type | Status Code | Content Type |
|
|
503
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
504
|
+
| errors.ErrorModel | 404, 422 | application/problem+json |
|
|
505
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
506
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
507
|
+
|
|
508
|
+
## emailSendVerification
|
|
509
|
+
|
|
510
|
+
### Example Usage
|
|
511
|
+
|
|
512
|
+
```typescript
|
|
513
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
514
|
+
|
|
515
|
+
const steamSets = new SteamSets({
|
|
516
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
517
|
+
});
|
|
518
|
+
|
|
519
|
+
async function run() {
|
|
520
|
+
const result = await steamSets.account.emailSendVerification({});
|
|
521
|
+
|
|
522
|
+
// Handle the result
|
|
523
|
+
console.log(result);
|
|
524
|
+
}
|
|
525
|
+
|
|
526
|
+
run();
|
|
527
|
+
```
|
|
528
|
+
|
|
529
|
+
### Standalone function
|
|
530
|
+
|
|
531
|
+
The standalone function version of this method:
|
|
532
|
+
|
|
533
|
+
```typescript
|
|
534
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
535
|
+
import { accountEmailSendVerification } from "@steamsets/client-ts/funcs/accountEmailSendVerification.js";
|
|
536
|
+
|
|
537
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
538
|
+
// You can create one instance of it to use across an application.
|
|
539
|
+
const steamSets = new SteamSetsCore({
|
|
540
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
541
|
+
});
|
|
542
|
+
|
|
543
|
+
async function run() {
|
|
544
|
+
const res = await accountEmailSendVerification(steamSets, {});
|
|
545
|
+
|
|
546
|
+
if (!res.ok) {
|
|
547
|
+
throw res.error;
|
|
548
|
+
}
|
|
549
|
+
|
|
550
|
+
const { value: result } = res;
|
|
551
|
+
|
|
552
|
+
// Handle the result
|
|
553
|
+
console.log(result);
|
|
554
|
+
}
|
|
555
|
+
|
|
556
|
+
run();
|
|
557
|
+
```
|
|
558
|
+
|
|
559
|
+
### Parameters
|
|
560
|
+
|
|
561
|
+
| Parameter | Type | Required | Description |
|
|
562
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
563
|
+
| `request` | [operations.AccountV1SettingsEmailSendVerificationRequest](../../models/operations/accountv1settingsemailsendverificationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
564
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
565
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
566
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
567
|
+
|
|
568
|
+
### Response
|
|
569
|
+
|
|
570
|
+
**Promise\<[operations.AccountV1SettingsEmailSendVerificationResponse](../../models/operations/accountv1settingsemailsendverificationresponse.md)\>**
|
|
571
|
+
|
|
572
|
+
### Errors
|
|
573
|
+
|
|
574
|
+
| Error Type | Status Code | Content Type |
|
|
575
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
576
|
+
| errors.ErrorModel | 404, 422, 429 | application/problem+json |
|
|
577
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
578
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
579
|
+
|
|
580
|
+
## emailSubscription
|
|
581
|
+
|
|
582
|
+
### Example Usage
|
|
583
|
+
|
|
584
|
+
```typescript
|
|
585
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
586
|
+
|
|
587
|
+
const steamSets = new SteamSets({
|
|
588
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
589
|
+
});
|
|
590
|
+
|
|
591
|
+
async function run() {
|
|
592
|
+
const result = await steamSets.account.emailSubscription({
|
|
593
|
+
v1EmailSubscriptionRequestBody: {
|
|
594
|
+
email: "steamsets@example.com",
|
|
595
|
+
subscribed: true,
|
|
596
|
+
},
|
|
597
|
+
});
|
|
598
|
+
|
|
599
|
+
// Handle the result
|
|
600
|
+
console.log(result);
|
|
601
|
+
}
|
|
602
|
+
|
|
603
|
+
run();
|
|
604
|
+
```
|
|
605
|
+
|
|
606
|
+
### Standalone function
|
|
607
|
+
|
|
608
|
+
The standalone function version of this method:
|
|
609
|
+
|
|
610
|
+
```typescript
|
|
611
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
612
|
+
import { accountEmailSubscription } from "@steamsets/client-ts/funcs/accountEmailSubscription.js";
|
|
613
|
+
|
|
614
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
615
|
+
// You can create one instance of it to use across an application.
|
|
616
|
+
const steamSets = new SteamSetsCore({
|
|
617
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
618
|
+
});
|
|
619
|
+
|
|
620
|
+
async function run() {
|
|
621
|
+
const res = await accountEmailSubscription(steamSets, {
|
|
622
|
+
v1EmailSubscriptionRequestBody: {
|
|
623
|
+
email: "steamsets@example.com",
|
|
624
|
+
subscribed: true,
|
|
625
|
+
},
|
|
626
|
+
});
|
|
627
|
+
|
|
628
|
+
if (!res.ok) {
|
|
629
|
+
throw res.error;
|
|
630
|
+
}
|
|
631
|
+
|
|
632
|
+
const { value: result } = res;
|
|
633
|
+
|
|
634
|
+
// Handle the result
|
|
635
|
+
console.log(result);
|
|
636
|
+
}
|
|
637
|
+
|
|
638
|
+
run();
|
|
639
|
+
```
|
|
640
|
+
|
|
641
|
+
### Parameters
|
|
642
|
+
|
|
643
|
+
| Parameter | Type | Required | Description |
|
|
644
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
645
|
+
| `request` | [operations.AccountV1SettingsEmailSubscribeRequest](../../models/operations/accountv1settingsemailsubscriberequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
646
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
647
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
648
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
649
|
+
|
|
650
|
+
### Response
|
|
651
|
+
|
|
652
|
+
**Promise\<[operations.AccountV1SettingsEmailSubscribeResponse](../../models/operations/accountv1settingsemailsubscriberesponse.md)\>**
|
|
653
|
+
|
|
654
|
+
### Errors
|
|
655
|
+
|
|
656
|
+
| Error Type | Status Code | Content Type |
|
|
657
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
658
|
+
| errors.ErrorModel | 400, 422, 429 | application/problem+json |
|
|
659
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
660
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
661
|
+
|
|
662
|
+
## emailVerify
|
|
663
|
+
|
|
664
|
+
### Example Usage
|
|
665
|
+
|
|
666
|
+
```typescript
|
|
667
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
668
|
+
|
|
669
|
+
const steamSets = new SteamSets({
|
|
670
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
671
|
+
});
|
|
672
|
+
|
|
673
|
+
async function run() {
|
|
674
|
+
const result = await steamSets.account.emailVerify({
|
|
675
|
+
code: "123456",
|
|
676
|
+
});
|
|
677
|
+
|
|
678
|
+
// Handle the result
|
|
679
|
+
console.log(result);
|
|
680
|
+
}
|
|
681
|
+
|
|
682
|
+
run();
|
|
683
|
+
```
|
|
684
|
+
|
|
685
|
+
### Standalone function
|
|
686
|
+
|
|
687
|
+
The standalone function version of this method:
|
|
688
|
+
|
|
689
|
+
```typescript
|
|
690
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
691
|
+
import { accountEmailVerify } from "@steamsets/client-ts/funcs/accountEmailVerify.js";
|
|
692
|
+
|
|
693
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
694
|
+
// You can create one instance of it to use across an application.
|
|
695
|
+
const steamSets = new SteamSetsCore({
|
|
696
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
697
|
+
});
|
|
698
|
+
|
|
699
|
+
async function run() {
|
|
700
|
+
const res = await accountEmailVerify(steamSets, {
|
|
701
|
+
code: "123456",
|
|
702
|
+
});
|
|
703
|
+
|
|
704
|
+
if (!res.ok) {
|
|
705
|
+
throw res.error;
|
|
706
|
+
}
|
|
707
|
+
|
|
708
|
+
const { value: result } = res;
|
|
709
|
+
|
|
710
|
+
// Handle the result
|
|
711
|
+
console.log(result);
|
|
712
|
+
}
|
|
713
|
+
|
|
714
|
+
run();
|
|
715
|
+
```
|
|
716
|
+
|
|
717
|
+
### Parameters
|
|
718
|
+
|
|
719
|
+
| Parameter | Type | Required | Description |
|
|
720
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
721
|
+
| `request` | [components.V1VerifyEmailRequestBody](../../models/components/v1verifyemailrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
722
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
723
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
724
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
725
|
+
|
|
726
|
+
### Response
|
|
727
|
+
|
|
728
|
+
**Promise\<[operations.AccountV1SettingsEmailVerifyResponse](../../models/operations/accountv1settingsemailverifyresponse.md)\>**
|
|
729
|
+
|
|
730
|
+
### Errors
|
|
731
|
+
|
|
732
|
+
| Error Type | Status Code | Content Type |
|
|
733
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
734
|
+
| errors.ErrorModel | 404, 422, 429 | application/problem+json |
|
|
735
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
736
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
737
|
+
|
|
738
|
+
## getApps
|
|
739
|
+
|
|
740
|
+
### Example Usage
|
|
741
|
+
|
|
742
|
+
```typescript
|
|
743
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
744
|
+
|
|
745
|
+
const steamSets = new SteamSets({
|
|
746
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
747
|
+
});
|
|
748
|
+
|
|
749
|
+
async function run() {
|
|
750
|
+
const result = await steamSets.account.getApps({});
|
|
751
|
+
|
|
752
|
+
// Handle the result
|
|
753
|
+
console.log(result);
|
|
754
|
+
}
|
|
755
|
+
|
|
756
|
+
run();
|
|
757
|
+
```
|
|
758
|
+
|
|
759
|
+
### Standalone function
|
|
760
|
+
|
|
761
|
+
The standalone function version of this method:
|
|
762
|
+
|
|
763
|
+
```typescript
|
|
764
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
765
|
+
import { accountGetApps } from "@steamsets/client-ts/funcs/accountGetApps.js";
|
|
766
|
+
|
|
767
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
768
|
+
// You can create one instance of it to use across an application.
|
|
769
|
+
const steamSets = new SteamSetsCore({
|
|
770
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
771
|
+
});
|
|
772
|
+
|
|
773
|
+
async function run() {
|
|
774
|
+
const res = await accountGetApps(steamSets, {});
|
|
775
|
+
|
|
776
|
+
if (!res.ok) {
|
|
777
|
+
throw res.error;
|
|
778
|
+
}
|
|
779
|
+
|
|
780
|
+
const { value: result } = res;
|
|
781
|
+
|
|
782
|
+
// Handle the result
|
|
783
|
+
console.log(result);
|
|
784
|
+
}
|
|
785
|
+
|
|
786
|
+
run();
|
|
787
|
+
```
|
|
788
|
+
|
|
789
|
+
### Parameters
|
|
790
|
+
|
|
791
|
+
| Parameter | Type | Required | Description |
|
|
792
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
793
|
+
| `request` | [components.V1AccountsAppsRequestBody](../../models/components/v1accountsappsrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
794
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
795
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
796
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
797
|
+
|
|
798
|
+
### Response
|
|
799
|
+
|
|
800
|
+
**Promise\<[operations.AccountV1GetAppsResponse](../../models/operations/accountv1getappsresponse.md)\>**
|
|
801
|
+
|
|
802
|
+
### Errors
|
|
803
|
+
|
|
804
|
+
| Error Type | Status Code | Content Type |
|
|
805
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
806
|
+
| errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
|
|
807
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
808
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
809
|
+
|
|
810
|
+
## getBadgeBookmarks
|
|
811
|
+
|
|
812
|
+
### Example Usage
|
|
813
|
+
|
|
814
|
+
```typescript
|
|
815
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
816
|
+
|
|
817
|
+
const steamSets = new SteamSets({
|
|
818
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
819
|
+
});
|
|
820
|
+
|
|
821
|
+
async function run() {
|
|
822
|
+
const result = await steamSets.account.getBadgeBookmarks();
|
|
823
|
+
|
|
824
|
+
// Handle the result
|
|
825
|
+
console.log(result);
|
|
826
|
+
}
|
|
827
|
+
|
|
828
|
+
run();
|
|
829
|
+
```
|
|
830
|
+
|
|
831
|
+
### Standalone function
|
|
832
|
+
|
|
833
|
+
The standalone function version of this method:
|
|
834
|
+
|
|
835
|
+
```typescript
|
|
836
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
837
|
+
import { accountGetBadgeBookmarks } from "@steamsets/client-ts/funcs/accountGetBadgeBookmarks.js";
|
|
838
|
+
|
|
839
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
840
|
+
// You can create one instance of it to use across an application.
|
|
841
|
+
const steamSets = new SteamSetsCore({
|
|
842
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
843
|
+
});
|
|
844
|
+
|
|
845
|
+
async function run() {
|
|
846
|
+
const res = await accountGetBadgeBookmarks(steamSets);
|
|
847
|
+
|
|
848
|
+
if (!res.ok) {
|
|
849
|
+
throw res.error;
|
|
850
|
+
}
|
|
851
|
+
|
|
852
|
+
const { value: result } = res;
|
|
853
|
+
|
|
854
|
+
// Handle the result
|
|
855
|
+
console.log(result);
|
|
856
|
+
}
|
|
857
|
+
|
|
858
|
+
run();
|
|
859
|
+
```
|
|
860
|
+
|
|
861
|
+
### Parameters
|
|
862
|
+
|
|
863
|
+
| Parameter | Type | Required | Description |
|
|
864
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
865
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
866
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
867
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
868
|
+
|
|
869
|
+
### Response
|
|
870
|
+
|
|
871
|
+
**Promise\<[operations.AccountV1GetBadgeBookmarksResponse](../../models/operations/accountv1getbadgebookmarksresponse.md)\>**
|
|
872
|
+
|
|
873
|
+
### Errors
|
|
874
|
+
|
|
875
|
+
| Error Type | Status Code | Content Type |
|
|
876
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
877
|
+
| errors.ErrorModel | 403, 404 | application/problem+json |
|
|
878
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
879
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
880
|
+
|
|
881
|
+
## getBadges
|
|
882
|
+
|
|
883
|
+
### Example Usage
|
|
884
|
+
|
|
885
|
+
```typescript
|
|
886
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
887
|
+
|
|
888
|
+
const steamSets = new SteamSets({
|
|
889
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
890
|
+
});
|
|
891
|
+
|
|
892
|
+
async function run() {
|
|
893
|
+
const result = await steamSets.account.getBadges({});
|
|
894
|
+
|
|
895
|
+
// Handle the result
|
|
896
|
+
console.log(result);
|
|
897
|
+
}
|
|
898
|
+
|
|
899
|
+
run();
|
|
900
|
+
```
|
|
901
|
+
|
|
902
|
+
### Standalone function
|
|
903
|
+
|
|
904
|
+
The standalone function version of this method:
|
|
905
|
+
|
|
906
|
+
```typescript
|
|
907
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
908
|
+
import { accountGetBadges } from "@steamsets/client-ts/funcs/accountGetBadges.js";
|
|
909
|
+
|
|
910
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
911
|
+
// You can create one instance of it to use across an application.
|
|
912
|
+
const steamSets = new SteamSetsCore({
|
|
913
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
914
|
+
});
|
|
915
|
+
|
|
916
|
+
async function run() {
|
|
917
|
+
const res = await accountGetBadges(steamSets, {});
|
|
918
|
+
|
|
919
|
+
if (!res.ok) {
|
|
920
|
+
throw res.error;
|
|
921
|
+
}
|
|
922
|
+
|
|
923
|
+
const { value: result } = res;
|
|
924
|
+
|
|
925
|
+
// Handle the result
|
|
926
|
+
console.log(result);
|
|
927
|
+
}
|
|
928
|
+
|
|
929
|
+
run();
|
|
930
|
+
```
|
|
931
|
+
|
|
932
|
+
### Parameters
|
|
933
|
+
|
|
934
|
+
| Parameter | Type | Required | Description |
|
|
935
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
936
|
+
| `request` | [components.V1BadgesRequestBody](../../models/components/v1badgesrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
937
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
938
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
939
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
940
|
+
|
|
941
|
+
### Response
|
|
942
|
+
|
|
943
|
+
**Promise\<[operations.AccountV1GetBadgesResponse](../../models/operations/accountv1getbadgesresponse.md)\>**
|
|
944
|
+
|
|
945
|
+
### Errors
|
|
946
|
+
|
|
947
|
+
| Error Type | Status Code | Content Type |
|
|
948
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
949
|
+
| errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
|
|
950
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
951
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
952
|
+
|
|
953
|
+
## getDataPoints
|
|
954
|
+
|
|
955
|
+
### Example Usage
|
|
956
|
+
|
|
957
|
+
```typescript
|
|
958
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
959
|
+
|
|
960
|
+
const steamSets = new SteamSets({
|
|
961
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
962
|
+
});
|
|
963
|
+
|
|
964
|
+
async function run() {
|
|
965
|
+
const result = await steamSets.account.getDataPoints({});
|
|
966
|
+
|
|
967
|
+
// Handle the result
|
|
968
|
+
console.log(result);
|
|
969
|
+
}
|
|
970
|
+
|
|
971
|
+
run();
|
|
972
|
+
```
|
|
973
|
+
|
|
974
|
+
### Standalone function
|
|
975
|
+
|
|
976
|
+
The standalone function version of this method:
|
|
977
|
+
|
|
978
|
+
```typescript
|
|
979
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
980
|
+
import { accountGetDataPoints } from "@steamsets/client-ts/funcs/accountGetDataPoints.js";
|
|
981
|
+
|
|
982
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
983
|
+
// You can create one instance of it to use across an application.
|
|
984
|
+
const steamSets = new SteamSetsCore({
|
|
985
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
986
|
+
});
|
|
987
|
+
|
|
988
|
+
async function run() {
|
|
989
|
+
const res = await accountGetDataPoints(steamSets, {});
|
|
990
|
+
|
|
991
|
+
if (!res.ok) {
|
|
992
|
+
throw res.error;
|
|
993
|
+
}
|
|
994
|
+
|
|
995
|
+
const { value: result } = res;
|
|
996
|
+
|
|
997
|
+
// Handle the result
|
|
998
|
+
console.log(result);
|
|
999
|
+
}
|
|
1000
|
+
|
|
1001
|
+
run();
|
|
1002
|
+
```
|
|
1003
|
+
|
|
1004
|
+
### Parameters
|
|
1005
|
+
|
|
1006
|
+
| Parameter | Type | Required | Description |
|
|
1007
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1008
|
+
| `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1009
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1010
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1011
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1012
|
+
|
|
1013
|
+
### Response
|
|
1014
|
+
|
|
1015
|
+
**Promise\<[operations.AccountV1GetDataPointsResponse](../../models/operations/accountv1getdatapointsresponse.md)\>**
|
|
1016
|
+
|
|
1017
|
+
### Errors
|
|
1018
|
+
|
|
1019
|
+
| Error Type | Status Code | Content Type |
|
|
1020
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
1021
|
+
| errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
|
|
1022
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
1023
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1024
|
+
|
|
1025
|
+
## getFriends
|
|
1026
|
+
|
|
1027
|
+
### Example Usage
|
|
1028
|
+
|
|
1029
|
+
```typescript
|
|
1030
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
1031
|
+
|
|
1032
|
+
const steamSets = new SteamSets({
|
|
1033
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1034
|
+
});
|
|
1035
|
+
|
|
1036
|
+
async function run() {
|
|
1037
|
+
const result = await steamSets.account.getFriends({});
|
|
1038
|
+
|
|
1039
|
+
// Handle the result
|
|
1040
|
+
console.log(result);
|
|
1041
|
+
}
|
|
1042
|
+
|
|
1043
|
+
run();
|
|
1044
|
+
```
|
|
1045
|
+
|
|
1046
|
+
### Standalone function
|
|
1047
|
+
|
|
1048
|
+
The standalone function version of this method:
|
|
1049
|
+
|
|
1050
|
+
```typescript
|
|
1051
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
1052
|
+
import { accountGetFriends } from "@steamsets/client-ts/funcs/accountGetFriends.js";
|
|
1053
|
+
|
|
1054
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
1055
|
+
// You can create one instance of it to use across an application.
|
|
1056
|
+
const steamSets = new SteamSetsCore({
|
|
1057
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1058
|
+
});
|
|
1059
|
+
|
|
1060
|
+
async function run() {
|
|
1061
|
+
const res = await accountGetFriends(steamSets, {});
|
|
1062
|
+
|
|
1063
|
+
if (!res.ok) {
|
|
1064
|
+
throw res.error;
|
|
1065
|
+
}
|
|
1066
|
+
|
|
1067
|
+
const { value: result } = res;
|
|
1068
|
+
|
|
1069
|
+
// Handle the result
|
|
1070
|
+
console.log(result);
|
|
1071
|
+
}
|
|
1072
|
+
|
|
1073
|
+
run();
|
|
1074
|
+
```
|
|
1075
|
+
|
|
1076
|
+
### Parameters
|
|
1077
|
+
|
|
1078
|
+
| Parameter | Type | Required | Description |
|
|
1079
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1080
|
+
| `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1081
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1082
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1083
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1084
|
+
|
|
1085
|
+
### Response
|
|
1086
|
+
|
|
1087
|
+
**Promise\<[operations.AccountV1GetFriendsResponse](../../models/operations/accountv1getfriendsresponse.md)\>**
|
|
1088
|
+
|
|
1089
|
+
### Errors
|
|
1090
|
+
|
|
1091
|
+
| Error Type | Status Code | Content Type |
|
|
1092
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
1093
|
+
| errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
|
|
1094
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
1095
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1096
|
+
|
|
1097
|
+
## getImages
|
|
1098
|
+
|
|
1099
|
+
### Example Usage
|
|
1100
|
+
|
|
1101
|
+
```typescript
|
|
1102
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
1103
|
+
|
|
1104
|
+
const steamSets = new SteamSets({
|
|
1105
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1106
|
+
});
|
|
1107
|
+
|
|
1108
|
+
async function run() {
|
|
1109
|
+
const result = await steamSets.account.getImages();
|
|
1110
|
+
|
|
1111
|
+
// Handle the result
|
|
1112
|
+
console.log(result);
|
|
1113
|
+
}
|
|
1114
|
+
|
|
1115
|
+
run();
|
|
1116
|
+
```
|
|
1117
|
+
|
|
1118
|
+
### Standalone function
|
|
1119
|
+
|
|
1120
|
+
The standalone function version of this method:
|
|
1121
|
+
|
|
1122
|
+
```typescript
|
|
1123
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
1124
|
+
import { accountGetImages } from "@steamsets/client-ts/funcs/accountGetImages.js";
|
|
1125
|
+
|
|
1126
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
1127
|
+
// You can create one instance of it to use across an application.
|
|
1128
|
+
const steamSets = new SteamSetsCore({
|
|
1129
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1130
|
+
});
|
|
1131
|
+
|
|
1132
|
+
async function run() {
|
|
1133
|
+
const res = await accountGetImages(steamSets);
|
|
1134
|
+
|
|
1135
|
+
if (!res.ok) {
|
|
1136
|
+
throw res.error;
|
|
1137
|
+
}
|
|
1138
|
+
|
|
1139
|
+
const { value: result } = res;
|
|
1140
|
+
|
|
1141
|
+
// Handle the result
|
|
1142
|
+
console.log(result);
|
|
1143
|
+
}
|
|
1144
|
+
|
|
1145
|
+
run();
|
|
1146
|
+
```
|
|
1147
|
+
|
|
1148
|
+
### Parameters
|
|
1149
|
+
|
|
1150
|
+
| Parameter | Type | Required | Description |
|
|
1151
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1152
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1153
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1154
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1155
|
+
|
|
1156
|
+
### Response
|
|
1157
|
+
|
|
1158
|
+
**Promise\<[operations.AccountV1ImagesGetResponse](../../models/operations/accountv1imagesgetresponse.md)\>**
|
|
1159
|
+
|
|
1160
|
+
### Errors
|
|
1161
|
+
|
|
1162
|
+
| Error Type | Status Code | Content Type |
|
|
1163
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
1164
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
1165
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1166
|
+
|
|
1167
|
+
## getInfo
|
|
1168
|
+
|
|
1169
|
+
### Example Usage
|
|
1170
|
+
|
|
1171
|
+
```typescript
|
|
1172
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
1173
|
+
|
|
1174
|
+
const steamSets = new SteamSets({
|
|
1175
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1176
|
+
});
|
|
1177
|
+
|
|
1178
|
+
async function run() {
|
|
1179
|
+
const result = await steamSets.account.getInfo({});
|
|
42
1180
|
|
|
43
1181
|
// Handle the result
|
|
44
1182
|
console.log(result);
|
|
@@ -53,7 +1191,7 @@ The standalone function version of this method:
|
|
|
53
1191
|
|
|
54
1192
|
```typescript
|
|
55
1193
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
56
|
-
import {
|
|
1194
|
+
import { accountGetInfo } from "@steamsets/client-ts/funcs/accountGetInfo.js";
|
|
57
1195
|
|
|
58
1196
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
59
1197
|
// You can create one instance of it to use across an application.
|
|
@@ -62,12 +1200,7 @@ const steamSets = new SteamSetsCore({
|
|
|
62
1200
|
});
|
|
63
1201
|
|
|
64
1202
|
async function run() {
|
|
65
|
-
const res = await
|
|
66
|
-
description: "Your App Description",
|
|
67
|
-
environment: "production",
|
|
68
|
-
generateKey: true,
|
|
69
|
-
name: "Your App",
|
|
70
|
-
});
|
|
1203
|
+
const res = await accountGetInfo(steamSets, {});
|
|
71
1204
|
|
|
72
1205
|
if (!res.ok) {
|
|
73
1206
|
throw res.error;
|
|
@@ -86,24 +1219,24 @@ run();
|
|
|
86
1219
|
|
|
87
1220
|
| Parameter | Type | Required | Description |
|
|
88
1221
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
89
|
-
| `request` | [components.
|
|
1222
|
+
| `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
90
1223
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
91
1224
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
92
1225
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
93
1226
|
|
|
94
1227
|
### Response
|
|
95
1228
|
|
|
96
|
-
**Promise\<[operations.
|
|
1229
|
+
**Promise\<[operations.AccountV1GetInfoResponse](../../models/operations/accountv1getinforesponse.md)\>**
|
|
97
1230
|
|
|
98
1231
|
### Errors
|
|
99
1232
|
|
|
100
1233
|
| Error Type | Status Code | Content Type |
|
|
101
1234
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
102
|
-
| errors.ErrorModel |
|
|
1235
|
+
| errors.ErrorModel | 403, 404, 422, 429 | application/problem+json |
|
|
103
1236
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
104
1237
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
105
1238
|
|
|
106
|
-
##
|
|
1239
|
+
## getLeaderboardHistory
|
|
107
1240
|
|
|
108
1241
|
### Example Usage
|
|
109
1242
|
|
|
@@ -115,9 +1248,7 @@ const steamSets = new SteamSets({
|
|
|
115
1248
|
});
|
|
116
1249
|
|
|
117
1250
|
async function run() {
|
|
118
|
-
const result = await steamSets.account.
|
|
119
|
-
developerAppId: "da_123456",
|
|
120
|
-
});
|
|
1251
|
+
const result = await steamSets.account.getLeaderboardHistory({});
|
|
121
1252
|
|
|
122
1253
|
// Handle the result
|
|
123
1254
|
console.log(result);
|
|
@@ -132,7 +1263,7 @@ The standalone function version of this method:
|
|
|
132
1263
|
|
|
133
1264
|
```typescript
|
|
134
1265
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
135
|
-
import {
|
|
1266
|
+
import { accountGetLeaderboardHistory } from "@steamsets/client-ts/funcs/accountGetLeaderboardHistory.js";
|
|
136
1267
|
|
|
137
1268
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
138
1269
|
// You can create one instance of it to use across an application.
|
|
@@ -141,9 +1272,7 @@ const steamSets = new SteamSetsCore({
|
|
|
141
1272
|
});
|
|
142
1273
|
|
|
143
1274
|
async function run() {
|
|
144
|
-
const res = await
|
|
145
|
-
developerAppId: "da_123456",
|
|
146
|
-
});
|
|
1275
|
+
const res = await accountGetLeaderboardHistory(steamSets, {});
|
|
147
1276
|
|
|
148
1277
|
if (!res.ok) {
|
|
149
1278
|
throw res.error;
|
|
@@ -162,24 +1291,24 @@ run();
|
|
|
162
1291
|
|
|
163
1292
|
| Parameter | Type | Required | Description |
|
|
164
1293
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
165
|
-
| `request` | [components.
|
|
1294
|
+
| `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
166
1295
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
167
1296
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
168
1297
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
169
1298
|
|
|
170
1299
|
### Response
|
|
171
1300
|
|
|
172
|
-
**Promise\<[operations.
|
|
1301
|
+
**Promise\<[operations.AccountV1GetLeaderboardHistoryResponse](../../models/operations/accountv1getleaderboardhistoryresponse.md)\>**
|
|
173
1302
|
|
|
174
1303
|
### Errors
|
|
175
1304
|
|
|
176
1305
|
| Error Type | Status Code | Content Type |
|
|
177
1306
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
178
|
-
| errors.ErrorModel | 404, 422
|
|
1307
|
+
| errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
|
|
179
1308
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
180
1309
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
181
1310
|
|
|
182
|
-
##
|
|
1311
|
+
## getMeta
|
|
183
1312
|
|
|
184
1313
|
### Example Usage
|
|
185
1314
|
|
|
@@ -191,12 +1320,7 @@ const steamSets = new SteamSets({
|
|
|
191
1320
|
});
|
|
192
1321
|
|
|
193
1322
|
async function run() {
|
|
194
|
-
const result = await steamSets.account.
|
|
195
|
-
imageIds: [
|
|
196
|
-
"<value>",
|
|
197
|
-
"<value>",
|
|
198
|
-
],
|
|
199
|
-
});
|
|
1323
|
+
const result = await steamSets.account.getMeta({});
|
|
200
1324
|
|
|
201
1325
|
// Handle the result
|
|
202
1326
|
console.log(result);
|
|
@@ -211,7 +1335,7 @@ The standalone function version of this method:
|
|
|
211
1335
|
|
|
212
1336
|
```typescript
|
|
213
1337
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
214
|
-
import {
|
|
1338
|
+
import { accountGetMeta } from "@steamsets/client-ts/funcs/accountGetMeta.js";
|
|
215
1339
|
|
|
216
1340
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
217
1341
|
// You can create one instance of it to use across an application.
|
|
@@ -220,12 +1344,7 @@ const steamSets = new SteamSetsCore({
|
|
|
220
1344
|
});
|
|
221
1345
|
|
|
222
1346
|
async function run() {
|
|
223
|
-
const res = await
|
|
224
|
-
imageIds: [
|
|
225
|
-
"<value>",
|
|
226
|
-
"<value>",
|
|
227
|
-
],
|
|
228
|
-
});
|
|
1347
|
+
const res = await accountGetMeta(steamSets, {});
|
|
229
1348
|
|
|
230
1349
|
if (!res.ok) {
|
|
231
1350
|
throw res.error;
|
|
@@ -244,14 +1363,14 @@ run();
|
|
|
244
1363
|
|
|
245
1364
|
| Parameter | Type | Required | Description |
|
|
246
1365
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
247
|
-
| `request` | [components.
|
|
1366
|
+
| `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
248
1367
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
249
1368
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
250
1369
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
251
1370
|
|
|
252
1371
|
### Response
|
|
253
1372
|
|
|
254
|
-
**Promise\<[operations.
|
|
1373
|
+
**Promise\<[operations.AccountV1GetMetaResponse](../../models/operations/accountv1getmetaresponse.md)\>**
|
|
255
1374
|
|
|
256
1375
|
### Errors
|
|
257
1376
|
|
|
@@ -261,7 +1380,7 @@ run();
|
|
|
261
1380
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
262
1381
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
263
1382
|
|
|
264
|
-
##
|
|
1383
|
+
## getOwnedBadges
|
|
265
1384
|
|
|
266
1385
|
### Example Usage
|
|
267
1386
|
|
|
@@ -273,12 +1392,7 @@ const steamSets = new SteamSets({
|
|
|
273
1392
|
});
|
|
274
1393
|
|
|
275
1394
|
async function run() {
|
|
276
|
-
const result = await steamSets.account.
|
|
277
|
-
description: "My App Description",
|
|
278
|
-
developerAppId: "da_123456",
|
|
279
|
-
name: "My App",
|
|
280
|
-
regenerate: true,
|
|
281
|
-
});
|
|
1395
|
+
const result = await steamSets.account.getOwnedBadges();
|
|
282
1396
|
|
|
283
1397
|
// Handle the result
|
|
284
1398
|
console.log(result);
|
|
@@ -293,7 +1407,7 @@ The standalone function version of this method:
|
|
|
293
1407
|
|
|
294
1408
|
```typescript
|
|
295
1409
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
296
|
-
import {
|
|
1410
|
+
import { accountGetOwnedBadges } from "@steamsets/client-ts/funcs/accountGetOwnedBadges.js";
|
|
297
1411
|
|
|
298
1412
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
299
1413
|
// You can create one instance of it to use across an application.
|
|
@@ -302,12 +1416,7 @@ const steamSets = new SteamSetsCore({
|
|
|
302
1416
|
});
|
|
303
1417
|
|
|
304
1418
|
async function run() {
|
|
305
|
-
const res = await
|
|
306
|
-
description: "My App Description",
|
|
307
|
-
developerAppId: "da_123456",
|
|
308
|
-
name: "My App",
|
|
309
|
-
regenerate: true,
|
|
310
|
-
});
|
|
1419
|
+
const res = await accountGetOwnedBadges(steamSets);
|
|
311
1420
|
|
|
312
1421
|
if (!res.ok) {
|
|
313
1422
|
throw res.error;
|
|
@@ -326,24 +1435,23 @@ run();
|
|
|
326
1435
|
|
|
327
1436
|
| Parameter | Type | Required | Description |
|
|
328
1437
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
329
|
-
| `request` | [components.V1AccountDeveloperAppUpdateRequestBody](../../models/components/v1accountdeveloperappupdaterequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
330
1438
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
331
1439
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
332
1440
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
333
1441
|
|
|
334
1442
|
### Response
|
|
335
1443
|
|
|
336
|
-
**Promise\<[operations.
|
|
1444
|
+
**Promise\<[operations.AccountV1GetOwnedBadgesResponse](../../models/operations/accountv1getownedbadgesresponse.md)\>**
|
|
337
1445
|
|
|
338
1446
|
### Errors
|
|
339
1447
|
|
|
340
1448
|
| Error Type | Status Code | Content Type |
|
|
341
1449
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
342
|
-
| errors.ErrorModel |
|
|
1450
|
+
| errors.ErrorModel | 403, 404 | application/problem+json |
|
|
343
1451
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
344
1452
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
345
1453
|
|
|
346
|
-
##
|
|
1454
|
+
## getSession
|
|
347
1455
|
|
|
348
1456
|
### Example Usage
|
|
349
1457
|
|
|
@@ -355,7 +1463,7 @@ const steamSets = new SteamSets({
|
|
|
355
1463
|
});
|
|
356
1464
|
|
|
357
1465
|
async function run() {
|
|
358
|
-
const result = await steamSets.account.
|
|
1466
|
+
const result = await steamSets.account.getSession();
|
|
359
1467
|
|
|
360
1468
|
// Handle the result
|
|
361
1469
|
console.log(result);
|
|
@@ -370,7 +1478,7 @@ The standalone function version of this method:
|
|
|
370
1478
|
|
|
371
1479
|
```typescript
|
|
372
1480
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
373
|
-
import {
|
|
1481
|
+
import { accountGetSession } from "@steamsets/client-ts/funcs/accountGetSession.js";
|
|
374
1482
|
|
|
375
1483
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
376
1484
|
// You can create one instance of it to use across an application.
|
|
@@ -379,7 +1487,7 @@ const steamSets = new SteamSetsCore({
|
|
|
379
1487
|
});
|
|
380
1488
|
|
|
381
1489
|
async function run() {
|
|
382
|
-
const res = await
|
|
1490
|
+
const res = await accountGetSession(steamSets);
|
|
383
1491
|
|
|
384
1492
|
if (!res.ok) {
|
|
385
1493
|
throw res.error;
|
|
@@ -398,24 +1506,22 @@ run();
|
|
|
398
1506
|
|
|
399
1507
|
| Parameter | Type | Required | Description |
|
|
400
1508
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
401
|
-
| `request` | [components.V1AccountsAppsRequestBody](../../models/components/v1accountsappsrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
402
1509
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
403
1510
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
404
1511
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
405
1512
|
|
|
406
1513
|
### Response
|
|
407
1514
|
|
|
408
|
-
**Promise\<[operations.
|
|
1515
|
+
**Promise\<[operations.AccountV1SessionGetResponse](../../models/operations/accountv1sessiongetresponse.md)\>**
|
|
409
1516
|
|
|
410
1517
|
### Errors
|
|
411
1518
|
|
|
412
1519
|
| Error Type | Status Code | Content Type |
|
|
413
1520
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
414
|
-
| errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
|
|
415
1521
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
416
1522
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
417
1523
|
|
|
418
|
-
##
|
|
1524
|
+
## getSettings
|
|
419
1525
|
|
|
420
1526
|
### Example Usage
|
|
421
1527
|
|
|
@@ -427,7 +1533,7 @@ const steamSets = new SteamSets({
|
|
|
427
1533
|
});
|
|
428
1534
|
|
|
429
1535
|
async function run() {
|
|
430
|
-
const result = await steamSets.account.
|
|
1536
|
+
const result = await steamSets.account.getSettings();
|
|
431
1537
|
|
|
432
1538
|
// Handle the result
|
|
433
1539
|
console.log(result);
|
|
@@ -442,7 +1548,7 @@ The standalone function version of this method:
|
|
|
442
1548
|
|
|
443
1549
|
```typescript
|
|
444
1550
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
445
|
-
import {
|
|
1551
|
+
import { accountGetSettings } from "@steamsets/client-ts/funcs/accountGetSettings.js";
|
|
446
1552
|
|
|
447
1553
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
448
1554
|
// You can create one instance of it to use across an application.
|
|
@@ -451,7 +1557,7 @@ const steamSets = new SteamSetsCore({
|
|
|
451
1557
|
});
|
|
452
1558
|
|
|
453
1559
|
async function run() {
|
|
454
|
-
const res = await
|
|
1560
|
+
const res = await accountGetSettings(steamSets);
|
|
455
1561
|
|
|
456
1562
|
if (!res.ok) {
|
|
457
1563
|
throw res.error;
|
|
@@ -470,24 +1576,22 @@ run();
|
|
|
470
1576
|
|
|
471
1577
|
| Parameter | Type | Required | Description |
|
|
472
1578
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
473
|
-
| `request` | [components.V1BadgesRequestBody](../../models/components/v1badgesrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
474
1579
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
475
1580
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
476
1581
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
477
1582
|
|
|
478
1583
|
### Response
|
|
479
1584
|
|
|
480
|
-
**Promise\<[operations.
|
|
1585
|
+
**Promise\<[operations.AccountV1SettingsGetResponse](../../models/operations/accountv1settingsgetresponse.md)\>**
|
|
481
1586
|
|
|
482
1587
|
### Errors
|
|
483
1588
|
|
|
484
1589
|
| Error Type | Status Code | Content Type |
|
|
485
1590
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
486
|
-
| errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
|
|
487
1591
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
488
1592
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
489
1593
|
|
|
490
|
-
##
|
|
1594
|
+
## getStaff
|
|
491
1595
|
|
|
492
1596
|
### Example Usage
|
|
493
1597
|
|
|
@@ -499,7 +1603,7 @@ const steamSets = new SteamSets({
|
|
|
499
1603
|
});
|
|
500
1604
|
|
|
501
1605
|
async function run() {
|
|
502
|
-
const result = await steamSets.account.
|
|
1606
|
+
const result = await steamSets.account.getStaff();
|
|
503
1607
|
|
|
504
1608
|
// Handle the result
|
|
505
1609
|
console.log(result);
|
|
@@ -514,7 +1618,7 @@ The standalone function version of this method:
|
|
|
514
1618
|
|
|
515
1619
|
```typescript
|
|
516
1620
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
517
|
-
import {
|
|
1621
|
+
import { accountGetStaff } from "@steamsets/client-ts/funcs/accountGetStaff.js";
|
|
518
1622
|
|
|
519
1623
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
520
1624
|
// You can create one instance of it to use across an application.
|
|
@@ -523,7 +1627,7 @@ const steamSets = new SteamSetsCore({
|
|
|
523
1627
|
});
|
|
524
1628
|
|
|
525
1629
|
async function run() {
|
|
526
|
-
const res = await
|
|
1630
|
+
const res = await accountGetStaff(steamSets);
|
|
527
1631
|
|
|
528
1632
|
if (!res.ok) {
|
|
529
1633
|
throw res.error;
|
|
@@ -542,24 +1646,23 @@ run();
|
|
|
542
1646
|
|
|
543
1647
|
| Parameter | Type | Required | Description |
|
|
544
1648
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
545
|
-
| `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
546
1649
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
547
1650
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
548
1651
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
549
1652
|
|
|
550
1653
|
### Response
|
|
551
1654
|
|
|
552
|
-
**Promise\<[operations.
|
|
1655
|
+
**Promise\<[operations.AccountV1GetStaffResponse](../../models/operations/accountv1getstaffresponse.md)\>**
|
|
553
1656
|
|
|
554
1657
|
### Errors
|
|
555
1658
|
|
|
556
1659
|
| Error Type | Status Code | Content Type |
|
|
557
1660
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
558
|
-
| errors.ErrorModel |
|
|
1661
|
+
| errors.ErrorModel | 404, 429 | application/problem+json |
|
|
559
1662
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
560
1663
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
561
1664
|
|
|
562
|
-
##
|
|
1665
|
+
## login
|
|
563
1666
|
|
|
564
1667
|
### Example Usage
|
|
565
1668
|
|
|
@@ -571,7 +1674,20 @@ const steamSets = new SteamSets({
|
|
|
571
1674
|
});
|
|
572
1675
|
|
|
573
1676
|
async function run() {
|
|
574
|
-
const result = await steamSets.account.
|
|
1677
|
+
const result = await steamSets.account.login({
|
|
1678
|
+
loginRequestBody: {
|
|
1679
|
+
openidAssocHandle: "123456",
|
|
1680
|
+
openidClaimedId: "76561198842603734",
|
|
1681
|
+
openidIdentity: "https://steamsets.com/api/v1/openid/login",
|
|
1682
|
+
openidMode: "checkid_setup",
|
|
1683
|
+
openidNs: "http://specs.openid.net/auth/2.0",
|
|
1684
|
+
openidOpEndpoint: "https://steamsets.com/api/v1/openid/login",
|
|
1685
|
+
openidResponseNonce: "123456",
|
|
1686
|
+
openidReturnTo: "https://example.com",
|
|
1687
|
+
openidSig: "123456",
|
|
1688
|
+
openidSigned: "123456",
|
|
1689
|
+
},
|
|
1690
|
+
});
|
|
575
1691
|
|
|
576
1692
|
// Handle the result
|
|
577
1693
|
console.log(result);
|
|
@@ -586,7 +1702,7 @@ The standalone function version of this method:
|
|
|
586
1702
|
|
|
587
1703
|
```typescript
|
|
588
1704
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
589
|
-
import {
|
|
1705
|
+
import { accountLogin } from "@steamsets/client-ts/funcs/accountLogin.js";
|
|
590
1706
|
|
|
591
1707
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
592
1708
|
// You can create one instance of it to use across an application.
|
|
@@ -595,7 +1711,20 @@ const steamSets = new SteamSetsCore({
|
|
|
595
1711
|
});
|
|
596
1712
|
|
|
597
1713
|
async function run() {
|
|
598
|
-
const res = await
|
|
1714
|
+
const res = await accountLogin(steamSets, {
|
|
1715
|
+
loginRequestBody: {
|
|
1716
|
+
openidAssocHandle: "123456",
|
|
1717
|
+
openidClaimedId: "76561198842603734",
|
|
1718
|
+
openidIdentity: "https://steamsets.com/api/v1/openid/login",
|
|
1719
|
+
openidMode: "checkid_setup",
|
|
1720
|
+
openidNs: "http://specs.openid.net/auth/2.0",
|
|
1721
|
+
openidOpEndpoint: "https://steamsets.com/api/v1/openid/login",
|
|
1722
|
+
openidResponseNonce: "123456",
|
|
1723
|
+
openidReturnTo: "https://example.com",
|
|
1724
|
+
openidSig: "123456",
|
|
1725
|
+
openidSigned: "123456",
|
|
1726
|
+
},
|
|
1727
|
+
});
|
|
599
1728
|
|
|
600
1729
|
if (!res.ok) {
|
|
601
1730
|
throw res.error;
|
|
@@ -614,24 +1743,24 @@ run();
|
|
|
614
1743
|
|
|
615
1744
|
| Parameter | Type | Required | Description |
|
|
616
1745
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
617
|
-
| `request` | [
|
|
1746
|
+
| `request` | [operations.AccountV1SessionLoginRequest](../../models/operations/accountv1sessionloginrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
618
1747
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
619
1748
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
620
1749
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
621
1750
|
|
|
622
1751
|
### Response
|
|
623
1752
|
|
|
624
|
-
**Promise\<[operations.
|
|
1753
|
+
**Promise\<[operations.AccountV1SessionLoginResponse](../../models/operations/accountv1sessionloginresponse.md)\>**
|
|
625
1754
|
|
|
626
1755
|
### Errors
|
|
627
1756
|
|
|
628
1757
|
| Error Type | Status Code | Content Type |
|
|
629
1758
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
630
|
-
| errors.ErrorModel | 400,
|
|
1759
|
+
| errors.ErrorModel | 400, 422, 429 | application/problem+json |
|
|
631
1760
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
632
1761
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
633
1762
|
|
|
634
|
-
##
|
|
1763
|
+
## queue
|
|
635
1764
|
|
|
636
1765
|
### Example Usage
|
|
637
1766
|
|
|
@@ -643,7 +1772,9 @@ const steamSets = new SteamSets({
|
|
|
643
1772
|
});
|
|
644
1773
|
|
|
645
1774
|
async function run() {
|
|
646
|
-
const result = await steamSets.account.
|
|
1775
|
+
const result = await steamSets.account.queue({
|
|
1776
|
+
force: true,
|
|
1777
|
+
});
|
|
647
1778
|
|
|
648
1779
|
// Handle the result
|
|
649
1780
|
console.log(result);
|
|
@@ -658,7 +1789,7 @@ The standalone function version of this method:
|
|
|
658
1789
|
|
|
659
1790
|
```typescript
|
|
660
1791
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
661
|
-
import {
|
|
1792
|
+
import { accountQueue } from "@steamsets/client-ts/funcs/accountQueue.js";
|
|
662
1793
|
|
|
663
1794
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
664
1795
|
// You can create one instance of it to use across an application.
|
|
@@ -667,7 +1798,9 @@ const steamSets = new SteamSetsCore({
|
|
|
667
1798
|
});
|
|
668
1799
|
|
|
669
1800
|
async function run() {
|
|
670
|
-
const res = await
|
|
1801
|
+
const res = await accountQueue(steamSets, {
|
|
1802
|
+
force: true,
|
|
1803
|
+
});
|
|
671
1804
|
|
|
672
1805
|
if (!res.ok) {
|
|
673
1806
|
throw res.error;
|
|
@@ -686,24 +1819,24 @@ run();
|
|
|
686
1819
|
|
|
687
1820
|
| Parameter | Type | Required | Description |
|
|
688
1821
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
689
|
-
| `request` | [components.
|
|
1822
|
+
| `request` | [components.V1AccountQueueRequestBody](../../models/components/v1accountqueuerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
690
1823
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
691
1824
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
692
1825
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
693
1826
|
|
|
694
1827
|
### Response
|
|
695
1828
|
|
|
696
|
-
**Promise\<[operations.
|
|
1829
|
+
**Promise\<[operations.AccountV1QueueResponse](../../models/operations/accountv1queueresponse.md)\>**
|
|
697
1830
|
|
|
698
1831
|
### Errors
|
|
699
1832
|
|
|
700
1833
|
| Error Type | Status Code | Content Type |
|
|
701
1834
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
702
|
-
| errors.ErrorModel |
|
|
1835
|
+
| errors.ErrorModel | 400, 422, 429 | application/problem+json |
|
|
703
1836
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
704
1837
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
705
1838
|
|
|
706
|
-
##
|
|
1839
|
+
## reconnect
|
|
707
1840
|
|
|
708
1841
|
### Example Usage
|
|
709
1842
|
|
|
@@ -715,7 +1848,10 @@ const steamSets = new SteamSets({
|
|
|
715
1848
|
});
|
|
716
1849
|
|
|
717
1850
|
async function run() {
|
|
718
|
-
const result = await steamSets.account.
|
|
1851
|
+
const result = await steamSets.account.reconnect({
|
|
1852
|
+
code: "123456",
|
|
1853
|
+
connectionId: "123456",
|
|
1854
|
+
});
|
|
719
1855
|
|
|
720
1856
|
// Handle the result
|
|
721
1857
|
console.log(result);
|
|
@@ -730,7 +1866,7 @@ The standalone function version of this method:
|
|
|
730
1866
|
|
|
731
1867
|
```typescript
|
|
732
1868
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
733
|
-
import {
|
|
1869
|
+
import { accountReconnect } from "@steamsets/client-ts/funcs/accountReconnect.js";
|
|
734
1870
|
|
|
735
1871
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
736
1872
|
// You can create one instance of it to use across an application.
|
|
@@ -739,7 +1875,10 @@ const steamSets = new SteamSetsCore({
|
|
|
739
1875
|
});
|
|
740
1876
|
|
|
741
1877
|
async function run() {
|
|
742
|
-
const res = await
|
|
1878
|
+
const res = await accountReconnect(steamSets, {
|
|
1879
|
+
code: "123456",
|
|
1880
|
+
connectionId: "123456",
|
|
1881
|
+
});
|
|
743
1882
|
|
|
744
1883
|
if (!res.ok) {
|
|
745
1884
|
throw res.error;
|
|
@@ -758,24 +1897,24 @@ run();
|
|
|
758
1897
|
|
|
759
1898
|
| Parameter | Type | Required | Description |
|
|
760
1899
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
761
|
-
| `request` | [components.
|
|
1900
|
+
| `request` | [components.V1ReconnectRequestBody](../../models/components/v1reconnectrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
762
1901
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
763
1902
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
764
1903
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
765
1904
|
|
|
766
1905
|
### Response
|
|
767
1906
|
|
|
768
|
-
**Promise\<[operations.
|
|
1907
|
+
**Promise\<[operations.AccountV1ConnectionReconnectResponse](../../models/operations/accountv1connectionreconnectresponse.md)\>**
|
|
769
1908
|
|
|
770
1909
|
### Errors
|
|
771
1910
|
|
|
772
1911
|
| Error Type | Status Code | Content Type |
|
|
773
1912
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
774
|
-
| errors.ErrorModel | 400,
|
|
1913
|
+
| errors.ErrorModel | 400, 422 | application/problem+json |
|
|
775
1914
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
776
1915
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
777
1916
|
|
|
778
|
-
##
|
|
1917
|
+
## updateImages
|
|
779
1918
|
|
|
780
1919
|
### Example Usage
|
|
781
1920
|
|
|
@@ -787,7 +1926,11 @@ const steamSets = new SteamSets({
|
|
|
787
1926
|
});
|
|
788
1927
|
|
|
789
1928
|
async function run() {
|
|
790
|
-
const result = await steamSets.account.
|
|
1929
|
+
const result = await steamSets.account.updateImages({
|
|
1930
|
+
images: [
|
|
1931
|
+
|
|
1932
|
+
],
|
|
1933
|
+
});
|
|
791
1934
|
|
|
792
1935
|
// Handle the result
|
|
793
1936
|
console.log(result);
|
|
@@ -802,7 +1945,7 @@ The standalone function version of this method:
|
|
|
802
1945
|
|
|
803
1946
|
```typescript
|
|
804
1947
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
805
|
-
import {
|
|
1948
|
+
import { accountUpdateImages } from "@steamsets/client-ts/funcs/accountUpdateImages.js";
|
|
806
1949
|
|
|
807
1950
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
808
1951
|
// You can create one instance of it to use across an application.
|
|
@@ -811,7 +1954,11 @@ const steamSets = new SteamSetsCore({
|
|
|
811
1954
|
});
|
|
812
1955
|
|
|
813
1956
|
async function run() {
|
|
814
|
-
const res = await
|
|
1957
|
+
const res = await accountUpdateImages(steamSets, {
|
|
1958
|
+
images: [
|
|
1959
|
+
|
|
1960
|
+
],
|
|
1961
|
+
});
|
|
815
1962
|
|
|
816
1963
|
if (!res.ok) {
|
|
817
1964
|
throw res.error;
|
|
@@ -830,14 +1977,14 @@ run();
|
|
|
830
1977
|
|
|
831
1978
|
| Parameter | Type | Required | Description |
|
|
832
1979
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
833
|
-
| `request` | [components.
|
|
1980
|
+
| `request` | [components.V1UpdateImageRequestBody](../../models/components/v1updateimagerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
834
1981
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
835
1982
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
836
1983
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
837
1984
|
|
|
838
1985
|
### Response
|
|
839
1986
|
|
|
840
|
-
**Promise\<[operations.
|
|
1987
|
+
**Promise\<[operations.AccountV1ImagesUpdateResponse](../../models/operations/accountv1imagesupdateresponse.md)\>**
|
|
841
1988
|
|
|
842
1989
|
### Errors
|
|
843
1990
|
|
|
@@ -847,7 +1994,7 @@ run();
|
|
|
847
1994
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
848
1995
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
849
1996
|
|
|
850
|
-
##
|
|
1997
|
+
## updateSettings
|
|
851
1998
|
|
|
852
1999
|
### Example Usage
|
|
853
2000
|
|
|
@@ -859,7 +2006,14 @@ const steamSets = new SteamSets({
|
|
|
859
2006
|
});
|
|
860
2007
|
|
|
861
2008
|
async function run() {
|
|
862
|
-
const result = await steamSets.account.
|
|
2009
|
+
const result = await steamSets.account.updateSettings({
|
|
2010
|
+
v1UpdateSettingsRequestBody: {
|
|
2011
|
+
email: "steamsets@example.com",
|
|
2012
|
+
hidden: true,
|
|
2013
|
+
language: "en",
|
|
2014
|
+
vanity: "flo",
|
|
2015
|
+
},
|
|
2016
|
+
});
|
|
863
2017
|
|
|
864
2018
|
// Handle the result
|
|
865
2019
|
console.log(result);
|
|
@@ -874,7 +2028,7 @@ The standalone function version of this method:
|
|
|
874
2028
|
|
|
875
2029
|
```typescript
|
|
876
2030
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
877
|
-
import {
|
|
2031
|
+
import { accountUpdateSettings } from "@steamsets/client-ts/funcs/accountUpdateSettings.js";
|
|
878
2032
|
|
|
879
2033
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
880
2034
|
// You can create one instance of it to use across an application.
|
|
@@ -883,7 +2037,14 @@ const steamSets = new SteamSetsCore({
|
|
|
883
2037
|
});
|
|
884
2038
|
|
|
885
2039
|
async function run() {
|
|
886
|
-
const res = await
|
|
2040
|
+
const res = await accountUpdateSettings(steamSets, {
|
|
2041
|
+
v1UpdateSettingsRequestBody: {
|
|
2042
|
+
email: "steamsets@example.com",
|
|
2043
|
+
hidden: true,
|
|
2044
|
+
language: "en",
|
|
2045
|
+
vanity: "flo",
|
|
2046
|
+
},
|
|
2047
|
+
});
|
|
887
2048
|
|
|
888
2049
|
if (!res.ok) {
|
|
889
2050
|
throw res.error;
|
|
@@ -902,19 +2063,20 @@ run();
|
|
|
902
2063
|
|
|
903
2064
|
| Parameter | Type | Required | Description |
|
|
904
2065
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2066
|
+
| `request` | [operations.AccountV1SettingsUpdateRequest](../../models/operations/accountv1settingsupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
905
2067
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
906
2068
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
907
2069
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
908
2070
|
|
|
909
2071
|
### Response
|
|
910
2072
|
|
|
911
|
-
**Promise\<[operations.
|
|
2073
|
+
**Promise\<[operations.AccountV1SettingsUpdateResponse](../../models/operations/accountv1settingsupdateresponse.md)\>**
|
|
912
2074
|
|
|
913
2075
|
### Errors
|
|
914
2076
|
|
|
915
2077
|
| Error Type | Status Code | Content Type |
|
|
916
2078
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
917
|
-
| errors.ErrorModel |
|
|
2079
|
+
| errors.ErrorModel | 422, 429 | application/problem+json |
|
|
918
2080
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
919
2081
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
920
2082
|
|
|
@@ -996,4 +2158,80 @@ run();
|
|
|
996
2158
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
997
2159
|
| errors.ErrorModel | 422 | application/problem+json |
|
|
998
2160
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
2161
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
2162
|
+
|
|
2163
|
+
## verifyConnection
|
|
2164
|
+
|
|
2165
|
+
### Example Usage
|
|
2166
|
+
|
|
2167
|
+
```typescript
|
|
2168
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
2169
|
+
|
|
2170
|
+
const steamSets = new SteamSets({
|
|
2171
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
2172
|
+
});
|
|
2173
|
+
|
|
2174
|
+
async function run() {
|
|
2175
|
+
const result = await steamSets.account.verifyConnection({
|
|
2176
|
+
connectionId: "123456",
|
|
2177
|
+
});
|
|
2178
|
+
|
|
2179
|
+
// Handle the result
|
|
2180
|
+
console.log(result);
|
|
2181
|
+
}
|
|
2182
|
+
|
|
2183
|
+
run();
|
|
2184
|
+
```
|
|
2185
|
+
|
|
2186
|
+
### Standalone function
|
|
2187
|
+
|
|
2188
|
+
The standalone function version of this method:
|
|
2189
|
+
|
|
2190
|
+
```typescript
|
|
2191
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
2192
|
+
import { accountVerifyConnection } from "@steamsets/client-ts/funcs/accountVerifyConnection.js";
|
|
2193
|
+
|
|
2194
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
2195
|
+
// You can create one instance of it to use across an application.
|
|
2196
|
+
const steamSets = new SteamSetsCore({
|
|
2197
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
2198
|
+
});
|
|
2199
|
+
|
|
2200
|
+
async function run() {
|
|
2201
|
+
const res = await accountVerifyConnection(steamSets, {
|
|
2202
|
+
connectionId: "123456",
|
|
2203
|
+
});
|
|
2204
|
+
|
|
2205
|
+
if (!res.ok) {
|
|
2206
|
+
throw res.error;
|
|
2207
|
+
}
|
|
2208
|
+
|
|
2209
|
+
const { value: result } = res;
|
|
2210
|
+
|
|
2211
|
+
// Handle the result
|
|
2212
|
+
console.log(result);
|
|
2213
|
+
}
|
|
2214
|
+
|
|
2215
|
+
run();
|
|
2216
|
+
```
|
|
2217
|
+
|
|
2218
|
+
### Parameters
|
|
2219
|
+
|
|
2220
|
+
| Parameter | Type | Required | Description |
|
|
2221
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2222
|
+
| `request` | [components.V1VerifyConnectionRequestBody](../../models/components/v1verifyconnectionrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
2223
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2224
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2225
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2226
|
+
|
|
2227
|
+
### Response
|
|
2228
|
+
|
|
2229
|
+
**Promise\<[operations.AccountV1ConnectionVerifyConnectionResponse](../../models/operations/accountv1connectionverifyconnectionresponse.md)\>**
|
|
2230
|
+
|
|
2231
|
+
### Errors
|
|
2232
|
+
|
|
2233
|
+
| Error Type | Status Code | Content Type |
|
|
2234
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
2235
|
+
| errors.ErrorModel | 400, 422 | application/problem+json |
|
|
2236
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
999
2237
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|