@steamsets/client-ts 0.19.4 → 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 -193
- package/docs/sdks/account/README.md +1230 -196
- 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/{internalDeleteImages.d.ts.map → accountBookmarkBadge.d.ts.map} +1 -1
- package/funcs/{badgesBookmark.js → accountBookmarkBadge.js} +3 -3
- package/funcs/{internalDeleteImages.js.map → accountBookmarkBadge.js.map} +1 -1
- package/funcs/{accountsQueue.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/{accountAccountV1GetMeta.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/{accountUpdateApp.d.ts → accountDeleteConnection.d.ts} +2 -2
- package/funcs/{externalAppV1ListBadges.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/{internalDeleteDeveloperApp.d.ts → accountDeveloperAppsDelete.d.ts} +2 -2
- package/funcs/{internalDeleteDeveloperApp.d.ts.map → accountDeveloperAppsDelete.d.ts.map} +1 -1
- package/funcs/{internalDeleteDeveloperApp.js → accountDeveloperAppsDelete.js} +3 -3
- package/funcs/{internalDeleteDeveloperApp.js.map → accountDeveloperAppsDelete.js.map} +1 -1
- package/funcs/accountDeveloperAppsUpdate.d.ts +12 -0
- package/funcs/{internalCreateDeveloperApp.d.ts.map → accountDeveloperAppsUpdate.d.ts.map} +1 -1
- package/funcs/{developerUpdateApp.js → accountDeveloperAppsUpdate.js} +3 -3
- package/funcs/{internalCreateDeveloperApp.js.map → accountDeveloperAppsUpdate.js.map} +1 -1
- package/funcs/{accountGetAccount.d.ts → accountEmailSendVerification.d.ts} +2 -3
- 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/{developerCreateDeveloperApp.d.ts → accountEmailSubscription.d.ts} +2 -3
- 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/{internalCreateDeveloperApp.d.ts → accountGetBadgeBookmarks.d.ts} +2 -3
- 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/{internalGetStaff.d.ts → accountGetImages.d.ts} +2 -2
- package/funcs/{internalGetStaff.d.ts.map → accountGetImages.d.ts.map} +1 -1
- 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/{dataGetFriends.d.ts.map → accountGetMeta.d.ts.map} +1 -1
- package/funcs/{dataAccountV1GetMeta.js → accountGetMeta.js} +3 -3
- package/funcs/{dataGetFriends.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/{dataGetApps.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/{internalDeleteImages.d.ts → accountReconnect.d.ts} +2 -2
- 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/{dataGetLeaderboardHistory.d.ts → accountSessionDelete.d.ts} +2 -2
- package/funcs/{internalUploadImages.d.ts.map → accountSessionDelete.d.ts.map} +1 -1
- package/funcs/{sessionsDelete.js → accountSessionDelete.js} +3 -3
- package/funcs/{dataAccountV1GetMeta.js.map → accountSessionDelete.js.map} +1 -1
- package/funcs/{imagesDeleteImages.d.ts → accountUpdateImages.d.ts} +2 -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/{eventsGet.d.ts → accountUpdateSettings.d.ts} +2 -2
- 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/{accountAccountV1GetMeta.d.ts.map → accountVerifyConnection.d.ts.map} +1 -1
- package/funcs/{connectionVerify.js → accountVerifyConnection.js} +3 -3
- package/funcs/{externalAppV1ListBadges.js.map → accountVerifyConnection.js.map} +1 -1
- package/funcs/{externalGetLeaderboardHistory.d.ts → adminEventsGet.d.ts} +2 -3
- 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/{dataAccountV1GetMeta.d.ts → adminRemoveVanity.d.ts} +2 -2
- package/funcs/{accountGetAccount.d.ts.map → adminRemoveVanity.d.ts.map} +1 -1
- package/funcs/{eventAdminV1RemoveVanity.js → adminRemoveVanity.js} +3 -3
- package/funcs/{accountGetAccount.js.map → adminRemoveVanity.js.map} +1 -1
- package/funcs/{externalAppV1ListBadges.d.ts → adminUpdateEvent.d.ts} +2 -2
- package/funcs/{connectionVerify.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/{internalAccountV1GetMeta.d.ts → appListBadges.d.ts} +2 -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/{dataGetInfo.d.ts → badgeSearch.d.ts} +2 -2
- package/funcs/{dataGetInfo.d.ts.map → badgeSearch.d.ts.map} +1 -1
- package/funcs/{badgesSearch.js → badgeSearch.js} +3 -3
- package/funcs/{dataGetInfo.js.map → badgeSearch.js.map} +1 -1
- 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/{connectionDelete.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/{accountLeaderboardV1GetLeaderboardAccountMeta.js → leaderboardGetAccountMeta.js} +3 -3
- package/funcs/leaderboardGetAccountMeta.js.map +1 -0
- package/funcs/{internalCheck.d.ts → livenessGet.d.ts} +2 -2
- package/funcs/livenessGet.d.ts.map +1 -0
- package/funcs/{internalCheck.js → livenessGet.js} +3 -3
- package/funcs/livenessGet.js.map +1 -0
- package/funcs/{externalGet.d.ts → locationGet.d.ts} +2 -2
- package/funcs/{externalGet.d.ts.map → locationGet.d.ts.map} +1 -1
- package/funcs/{locationsGet.js → locationGet.js} +3 -3
- package/funcs/{externalGet.js.map → locationGet.js.map} +1 -1
- 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 -5
- package/sdk/account.d.ts.map +1 -1
- package/sdk/account.js +88 -16
- 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 -45
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +3 -59
- 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/{internalDeleteDeveloperApp.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/{dataAccountV1GetMeta.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/{eventAdminV1RemoveVanity.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/{accountLeaderboardV1GetLeaderboardAccountMeta.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 +209 -27
- 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/{developer.ts → developerapps.ts} +7 -19
- 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 -88
- package/src/sdk/session.ts +6 -17
- package/docs/sdks/connections/README.md +0 -86
- package/docs/sdks/data/README.md +0 -520
- package/docs/sdks/developer/README.md +0 -252
- package/docs/sdks/event/README.md +0 -80
- package/docs/sdks/external/README.md +0 -596
- package/docs/sdks/images/README.md +0 -323
- package/docs/sdks/internal/README.md +0 -1137
- package/docs/sdks/settings/README.md +0 -471
- package/funcs/accountAccountV1GetMeta.js +0 -118
- package/funcs/accountDeleteDeveloperApp.js +0 -116
- package/funcs/accountDeleteDeveloperApp.js.map +0 -1
- package/funcs/accountGetAccount.js +0 -118
- package/funcs/accountLeaderboardV1GetLeaderboardAccountMeta.d.ts +0 -12
- package/funcs/accountLeaderboardV1GetLeaderboardAccountMeta.d.ts.map +0 -1
- package/funcs/accountLeaderboardV1GetLeaderboardAccountMeta.js.map +0 -1
- package/funcs/accountUpdateApp.js +0 -116
- package/funcs/accountUpdateApp.js.map +0 -1
- package/funcs/adminAdminV1RemoveVanity.d.ts +0 -12
- package/funcs/adminAdminV1RemoveVanity.d.ts.map +0 -1
- package/funcs/adminAdminV1RemoveVanity.js +0 -118
- 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/badgesBookmark.js.map +0 -1
- package/funcs/badgesGetBookmarks.js.map +0 -1
- package/funcs/badgesSearch.d.ts +0 -12
- 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/connectionUpdate.d.ts.map +0 -1
- package/funcs/connectionVerify.d.ts +0 -12
- package/funcs/connectionsConnect.d.ts.map +0 -1
- package/funcs/connectionsConnect.js.map +0 -1
- package/funcs/dataAccountV1GetMeta.d.ts.map +0 -1
- package/funcs/dataGetApps.d.ts.map +0 -1
- package/funcs/dataGetApps.js +0 -118
- package/funcs/dataGetApps.js.map +0 -1
- package/funcs/dataGetBadges.d.ts +0 -12
- package/funcs/dataGetBadges.d.ts.map +0 -1
- package/funcs/dataGetBadges.js +0 -118
- package/funcs/dataGetBadges.js.map +0 -1
- package/funcs/dataGetDataPoints.d.ts +0 -12
- package/funcs/dataGetDataPoints.d.ts.map +0 -1
- package/funcs/dataGetDataPoints.js +0 -118
- package/funcs/dataGetDataPoints.js.map +0 -1
- package/funcs/dataGetFriends.d.ts +0 -12
- package/funcs/dataGetFriends.js +0 -118
- package/funcs/dataGetInfo.js +0 -118
- package/funcs/dataGetLeaderboardHistory.d.ts.map +0 -1
- package/funcs/dataGetLeaderboardHistory.js +0 -116
- package/funcs/dataGetLeaderboardHistory.js.map +0 -1
- package/funcs/developerCreateDeveloperApp.d.ts.map +0 -1
- package/funcs/developerCreateDeveloperApp.js +0 -116
- package/funcs/developerCreateDeveloperApp.js.map +0 -1
- package/funcs/developerDeleteDeveloperApp.d.ts +0 -12
- package/funcs/developerDeleteDeveloperApp.d.ts.map +0 -1
- package/funcs/developerDeleteDeveloperApp.js +0 -116
- package/funcs/developerDeleteDeveloperApp.js.map +0 -1
- package/funcs/developerUpdateApp.d.ts +0 -12
- package/funcs/developerUpdateApp.d.ts.map +0 -1
- package/funcs/developerUpdateApp.js.map +0 -1
- package/funcs/eventAdminV1RemoveVanity.d.ts +0 -12
- package/funcs/eventAdminV1RemoveVanity.d.ts.map +0 -1
- package/funcs/eventAdminV1RemoveVanity.js.map +0 -1
- package/funcs/eventsGet.d.ts.map +0 -1
- package/funcs/eventsGet.js.map +0 -1
- package/funcs/eventsUpdate.d.ts +0 -12
- package/funcs/eventsUpdate.js.map +0 -1
- package/funcs/externalAppV1ListBadges.js +0 -118
- package/funcs/externalGet.js +0 -107
- package/funcs/externalGetApps.d.ts +0 -12
- package/funcs/externalGetApps.d.ts.map +0 -1
- package/funcs/externalGetApps.js +0 -118
- package/funcs/externalGetApps.js.map +0 -1
- package/funcs/externalGetBadges.d.ts +0 -12
- package/funcs/externalGetBadges.d.ts.map +0 -1
- package/funcs/externalGetBadges.js +0 -118
- package/funcs/externalGetBadges.js.map +0 -1
- package/funcs/externalGetDataPoints.d.ts +0 -12
- package/funcs/externalGetDataPoints.d.ts.map +0 -1
- package/funcs/externalGetDataPoints.js +0 -118
- package/funcs/externalGetDataPoints.js.map +0 -1
- package/funcs/externalGetFriends.d.ts +0 -12
- package/funcs/externalGetFriends.d.ts.map +0 -1
- package/funcs/externalGetFriends.js +0 -118
- package/funcs/externalGetFriends.js.map +0 -1
- package/funcs/externalGetInfo.d.ts +0 -12
- package/funcs/externalGetInfo.d.ts.map +0 -1
- package/funcs/externalGetInfo.js +0 -118
- package/funcs/externalGetInfo.js.map +0 -1
- package/funcs/externalGetLeaderboardHistory.d.ts.map +0 -1
- package/funcs/externalGetLeaderboardHistory.js +0 -116
- package/funcs/externalGetLeaderboardHistory.js.map +0 -1
- package/funcs/imagesDeleteImages.d.ts.map +0 -1
- package/funcs/imagesDeleteImages.js +0 -118
- package/funcs/imagesDeleteImages.js.map +0 -1
- package/funcs/imagesGet.d.ts +0 -11
- package/funcs/imagesGet.d.ts.map +0 -1
- package/funcs/imagesGet.js.map +0 -1
- package/funcs/imagesUpdate.d.ts +0 -12
- package/funcs/imagesUploadImages.d.ts +0 -12
- package/funcs/imagesUploadImages.d.ts.map +0 -1
- package/funcs/imagesUploadImages.js +0 -118
- package/funcs/imagesUploadImages.js.map +0 -1
- package/funcs/internalAccountV1GetMeta.d.ts.map +0 -1
- package/funcs/internalAccountV1GetMeta.js +0 -118
- package/funcs/internalAccountV1GetMeta.js.map +0 -1
- package/funcs/internalAdminV1RemoveVanity.d.ts +0 -12
- package/funcs/internalAdminV1RemoveVanity.d.ts.map +0 -1
- package/funcs/internalAdminV1RemoveVanity.js +0 -118
- package/funcs/internalAdminV1RemoveVanity.js.map +0 -1
- package/funcs/internalBadgeV1SearchSuggest.d.ts +0 -12
- package/funcs/internalBadgeV1SearchSuggest.d.ts.map +0 -1
- package/funcs/internalBadgeV1SearchSuggest.js +0 -118
- package/funcs/internalBadgeV1SearchSuggest.js.map +0 -1
- package/funcs/internalBadgeV1TagsSuggest.d.ts +0 -12
- package/funcs/internalBadgeV1TagsSuggest.d.ts.map +0 -1
- package/funcs/internalBadgeV1TagsSuggest.js +0 -118
- package/funcs/internalBadgeV1TagsSuggest.js.map +0 -1
- package/funcs/internalCheck.d.ts.map +0 -1
- package/funcs/internalCheck.js.map +0 -1
- package/funcs/internalCreateDeveloperApp.js +0 -116
- package/funcs/internalDeleteImages.js +0 -118
- package/funcs/internalGetAccount.d.ts +0 -12
- package/funcs/internalGetAccount.d.ts.map +0 -1
- package/funcs/internalGetAccount.js +0 -118
- package/funcs/internalGetAccount.js.map +0 -1
- package/funcs/internalGetStaff.js +0 -107
- package/funcs/internalGetStaff.js.map +0 -1
- package/funcs/internalGetTags.d.ts +0 -11
- package/funcs/internalGetTags.d.ts.map +0 -1
- package/funcs/internalGetTags.js +0 -107
- package/funcs/internalGetTags.js.map +0 -1
- package/funcs/internalLeaderboardV1GetLeaderboardAccountMeta.d.ts +0 -12
- package/funcs/internalLeaderboardV1GetLeaderboardAccountMeta.d.ts.map +0 -1
- package/funcs/internalLeaderboardV1GetLeaderboardAccountMeta.js +0 -116
- package/funcs/internalLeaderboardV1GetLeaderboardAccountMeta.js.map +0 -1
- package/funcs/internalUpdateApp.d.ts +0 -12
- package/funcs/internalUpdateApp.d.ts.map +0 -1
- package/funcs/internalUpdateApp.js +0 -116
- package/funcs/internalUpdateApp.js.map +0 -1
- package/funcs/internalUploadImages.d.ts +0 -12
- package/funcs/internalUploadImages.js +0 -118
- package/funcs/internalUploadImages.js.map +0 -1
- 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 +0 -116
- package/funcs/leaderboardLeaderboardV1GetLeaderboardAccountMeta.js.map +0 -1
- package/funcs/livenessCheck.d.ts +0 -17
- package/funcs/livenessCheck.d.ts.map +0 -1
- package/funcs/livenessCheck.js +0 -111
- package/funcs/locationsGet.d.ts.map +0 -1
- package/funcs/locationsGet.js.map +0 -1
- package/funcs/sessionCreate.d.ts +0 -11
- package/funcs/sessionCreate.d.ts.map +0 -1
- package/funcs/sessionCreate.js.map +0 -1
- package/funcs/sessionsDelete.d.ts +0 -12
- package/funcs/sessionsDelete.d.ts.map +0 -1
- package/funcs/sessionsGet.d.ts +0 -11
- package/funcs/sessionsGet.d.ts.map +0 -1
- package/funcs/sessionsGet.js.map +0 -1
- package/funcs/settingsGet.d.ts +0 -11
- 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/data.d.ts +0 -13
- package/sdk/data.d.ts.map +0 -1
- package/sdk/data.js +0 -40
- package/sdk/data.js.map +0 -1
- package/sdk/developer.d.ts +0 -9
- package/sdk/developer.d.ts.map +0 -1
- package/sdk/developer.js +0 -24
- package/sdk/developer.js.map +0 -1
- package/sdk/event.d.ts +0 -7
- package/sdk/event.d.ts.map +0 -1
- package/sdk/event.js +0 -16
- package/sdk/event.js.map +0 -1
- package/sdk/external.d.ts +0 -14
- package/sdk/external.d.ts.map +0 -1
- package/sdk/external.js +0 -44
- package/sdk/external.js.map +0 -1
- package/sdk/images.d.ts +0 -10
- package/sdk/images.d.ts.map +0 -1
- package/sdk/images.js +0 -28
- package/sdk/images.js.map +0 -1
- package/sdk/internal.d.ts +0 -26
- package/sdk/internal.d.ts.map +0 -1
- package/sdk/internal.js +0 -74
- package/sdk/internal.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/funcs/accountAccountV1GetMeta.ts +0 -179
- package/src/funcs/accountDeleteDeveloperApp.ts +0 -184
- package/src/funcs/accountGetAccount.ts +0 -179
- package/src/funcs/adminAdminV1RemoveVanity.ts +0 -179
- package/src/funcs/dataGetApps.ts +0 -179
- package/src/funcs/dataGetBadges.ts +0 -179
- package/src/funcs/dataGetDataPoints.ts +0 -179
- package/src/funcs/dataGetFriends.ts +0 -179
- package/src/funcs/dataGetInfo.ts +0 -179
- package/src/funcs/dataGetLeaderboardHistory.ts +0 -181
- package/src/funcs/developerCreateDeveloperApp.ts +0 -182
- package/src/funcs/developerDeleteDeveloperApp.ts +0 -184
- package/src/funcs/developerUpdateApp.ts +0 -184
- package/src/funcs/externalAppV1ListBadges.ts +0 -179
- package/src/funcs/externalGet.ts +0 -160
- package/src/funcs/externalGetApps.ts +0 -179
- package/src/funcs/externalGetBadges.ts +0 -179
- package/src/funcs/externalGetDataPoints.ts +0 -179
- package/src/funcs/externalGetFriends.ts +0 -179
- package/src/funcs/externalGetInfo.ts +0 -179
- package/src/funcs/externalGetLeaderboardHistory.ts +0 -181
- package/src/funcs/imagesDeleteImages.ts +0 -179
- package/src/funcs/imagesUploadImages.ts +0 -179
- package/src/funcs/internalAccountV1GetMeta.ts +0 -179
- package/src/funcs/internalAdminV1RemoveVanity.ts +0 -179
- package/src/funcs/internalBadgeV1SearchSuggest.ts +0 -180
- package/src/funcs/internalBadgeV1TagsSuggest.ts +0 -180
- package/src/funcs/internalCheck.ts +0 -160
- package/src/funcs/internalCreateDeveloperApp.ts +0 -182
- package/src/funcs/internalDeleteImages.ts +0 -179
- package/src/funcs/internalGetAccount.ts +0 -179
- package/src/funcs/internalGetStaff.ts +0 -160
- package/src/funcs/internalGetTags.ts +0 -160
- package/src/funcs/internalLeaderboardV1GetLeaderboardAccountMeta.ts +0 -186
- package/src/funcs/internalUpdateApp.ts +0 -184
- package/src/funcs/internalUploadImages.ts +0 -179
- package/src/funcs/leaderboardLeaderboardV1GetLeaderboardAccountMeta.ts +0 -186
- package/src/sdk/accounts.ts +0 -22
- package/src/sdk/data.ts +0 -94
- package/src/sdk/event.ts +0 -22
- package/src/sdk/external.ts +0 -104
- package/src/sdk/images.ts +0 -56
- package/src/sdk/internal.ts +0 -178
- package/src/sdk/sessions.ts +0 -32
- package/src/sdk/settings.ts +0 -80
|
@@ -7,21 +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)
|
|
23
|
-
* [
|
|
24
|
-
|
|
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 | \*/\* |
|
|
25
195
|
|
|
26
196
|
## createDeveloperApp
|
|
27
197
|
|
|
@@ -35,12 +205,836 @@ const steamSets = new SteamSets({
|
|
|
35
205
|
});
|
|
36
206
|
|
|
37
207
|
async function run() {
|
|
38
|
-
const result = await steamSets.account.createDeveloperApp({
|
|
39
|
-
description: "Your App Description",
|
|
40
|
-
environment: "production",
|
|
41
|
-
generateKey: true,
|
|
42
|
-
name: "Your App",
|
|
43
|
-
});
|
|
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({});
|
|
44
1038
|
|
|
45
1039
|
// Handle the result
|
|
46
1040
|
console.log(result);
|
|
@@ -55,7 +1049,7 @@ The standalone function version of this method:
|
|
|
55
1049
|
|
|
56
1050
|
```typescript
|
|
57
1051
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
58
|
-
import {
|
|
1052
|
+
import { accountGetFriends } from "@steamsets/client-ts/funcs/accountGetFriends.js";
|
|
59
1053
|
|
|
60
1054
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
61
1055
|
// You can create one instance of it to use across an application.
|
|
@@ -64,12 +1058,7 @@ const steamSets = new SteamSetsCore({
|
|
|
64
1058
|
});
|
|
65
1059
|
|
|
66
1060
|
async function run() {
|
|
67
|
-
const res = await
|
|
68
|
-
description: "Your App Description",
|
|
69
|
-
environment: "production",
|
|
70
|
-
generateKey: true,
|
|
71
|
-
name: "Your App",
|
|
72
|
-
});
|
|
1061
|
+
const res = await accountGetFriends(steamSets, {});
|
|
73
1062
|
|
|
74
1063
|
if (!res.ok) {
|
|
75
1064
|
throw res.error;
|
|
@@ -88,24 +1077,24 @@ run();
|
|
|
88
1077
|
|
|
89
1078
|
| Parameter | Type | Required | Description |
|
|
90
1079
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
91
|
-
| `request` | [components.
|
|
1080
|
+
| `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
92
1081
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
93
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. |
|
|
94
1083
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
95
1084
|
|
|
96
1085
|
### Response
|
|
97
1086
|
|
|
98
|
-
**Promise\<[operations.
|
|
1087
|
+
**Promise\<[operations.AccountV1GetFriendsResponse](../../models/operations/accountv1getfriendsresponse.md)\>**
|
|
99
1088
|
|
|
100
1089
|
### Errors
|
|
101
1090
|
|
|
102
1091
|
| Error Type | Status Code | Content Type |
|
|
103
1092
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
104
|
-
| errors.ErrorModel | 400, 404, 422
|
|
1093
|
+
| errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
|
|
105
1094
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
106
1095
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
107
1096
|
|
|
108
|
-
##
|
|
1097
|
+
## getImages
|
|
109
1098
|
|
|
110
1099
|
### Example Usage
|
|
111
1100
|
|
|
@@ -117,9 +1106,7 @@ const steamSets = new SteamSets({
|
|
|
117
1106
|
});
|
|
118
1107
|
|
|
119
1108
|
async function run() {
|
|
120
|
-
const result = await steamSets.account.
|
|
121
|
-
developerAppId: "da_123456",
|
|
122
|
-
});
|
|
1109
|
+
const result = await steamSets.account.getImages();
|
|
123
1110
|
|
|
124
1111
|
// Handle the result
|
|
125
1112
|
console.log(result);
|
|
@@ -134,7 +1121,7 @@ The standalone function version of this method:
|
|
|
134
1121
|
|
|
135
1122
|
```typescript
|
|
136
1123
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
137
|
-
import {
|
|
1124
|
+
import { accountGetImages } from "@steamsets/client-ts/funcs/accountGetImages.js";
|
|
138
1125
|
|
|
139
1126
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
140
1127
|
// You can create one instance of it to use across an application.
|
|
@@ -143,9 +1130,7 @@ const steamSets = new SteamSetsCore({
|
|
|
143
1130
|
});
|
|
144
1131
|
|
|
145
1132
|
async function run() {
|
|
146
|
-
const res = await
|
|
147
|
-
developerAppId: "da_123456",
|
|
148
|
-
});
|
|
1133
|
+
const res = await accountGetImages(steamSets);
|
|
149
1134
|
|
|
150
1135
|
if (!res.ok) {
|
|
151
1136
|
throw res.error;
|
|
@@ -164,24 +1149,22 @@ run();
|
|
|
164
1149
|
|
|
165
1150
|
| Parameter | Type | Required | Description |
|
|
166
1151
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
167
|
-
| `request` | [components.V1AccountDeveloperAppDeleteRequestBody](../../models/components/v1accountdeveloperappdeleterequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
168
1152
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
169
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. |
|
|
170
1154
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
171
1155
|
|
|
172
1156
|
### Response
|
|
173
1157
|
|
|
174
|
-
**Promise\<[operations.
|
|
1158
|
+
**Promise\<[operations.AccountV1ImagesGetResponse](../../models/operations/accountv1imagesgetresponse.md)\>**
|
|
175
1159
|
|
|
176
1160
|
### Errors
|
|
177
1161
|
|
|
178
1162
|
| Error Type | Status Code | Content Type |
|
|
179
1163
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
180
|
-
| errors.ErrorModel | 404, 422, 429 | application/problem+json |
|
|
181
1164
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
182
1165
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
183
1166
|
|
|
184
|
-
##
|
|
1167
|
+
## getInfo
|
|
185
1168
|
|
|
186
1169
|
### Example Usage
|
|
187
1170
|
|
|
@@ -193,12 +1176,7 @@ const steamSets = new SteamSets({
|
|
|
193
1176
|
});
|
|
194
1177
|
|
|
195
1178
|
async function run() {
|
|
196
|
-
const result = await steamSets.account.
|
|
197
|
-
imageIds: [
|
|
198
|
-
"<value>",
|
|
199
|
-
"<value>",
|
|
200
|
-
],
|
|
201
|
-
});
|
|
1179
|
+
const result = await steamSets.account.getInfo({});
|
|
202
1180
|
|
|
203
1181
|
// Handle the result
|
|
204
1182
|
console.log(result);
|
|
@@ -213,7 +1191,7 @@ The standalone function version of this method:
|
|
|
213
1191
|
|
|
214
1192
|
```typescript
|
|
215
1193
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
216
|
-
import {
|
|
1194
|
+
import { accountGetInfo } from "@steamsets/client-ts/funcs/accountGetInfo.js";
|
|
217
1195
|
|
|
218
1196
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
219
1197
|
// You can create one instance of it to use across an application.
|
|
@@ -222,12 +1200,7 @@ const steamSets = new SteamSetsCore({
|
|
|
222
1200
|
});
|
|
223
1201
|
|
|
224
1202
|
async function run() {
|
|
225
|
-
const res = await
|
|
226
|
-
imageIds: [
|
|
227
|
-
"<value>",
|
|
228
|
-
"<value>",
|
|
229
|
-
],
|
|
230
|
-
});
|
|
1203
|
+
const res = await accountGetInfo(steamSets, {});
|
|
231
1204
|
|
|
232
1205
|
if (!res.ok) {
|
|
233
1206
|
throw res.error;
|
|
@@ -246,24 +1219,24 @@ run();
|
|
|
246
1219
|
|
|
247
1220
|
| Parameter | Type | Required | Description |
|
|
248
1221
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
249
|
-
| `request` | [components.
|
|
1222
|
+
| `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
250
1223
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
251
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. |
|
|
252
1225
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
253
1226
|
|
|
254
1227
|
### Response
|
|
255
1228
|
|
|
256
|
-
**Promise\<[operations.
|
|
1229
|
+
**Promise\<[operations.AccountV1GetInfoResponse](../../models/operations/accountv1getinforesponse.md)\>**
|
|
257
1230
|
|
|
258
1231
|
### Errors
|
|
259
1232
|
|
|
260
1233
|
| Error Type | Status Code | Content Type |
|
|
261
1234
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
262
|
-
| errors.ErrorModel | 404, 422
|
|
1235
|
+
| errors.ErrorModel | 403, 404, 422, 429 | application/problem+json |
|
|
263
1236
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
264
1237
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
265
1238
|
|
|
266
|
-
##
|
|
1239
|
+
## getLeaderboardHistory
|
|
267
1240
|
|
|
268
1241
|
### Example Usage
|
|
269
1242
|
|
|
@@ -275,12 +1248,7 @@ const steamSets = new SteamSets({
|
|
|
275
1248
|
});
|
|
276
1249
|
|
|
277
1250
|
async function run() {
|
|
278
|
-
const result = await steamSets.account.
|
|
279
|
-
description: "My App Description",
|
|
280
|
-
developerAppId: "da_123456",
|
|
281
|
-
name: "My App",
|
|
282
|
-
regenerate: true,
|
|
283
|
-
});
|
|
1251
|
+
const result = await steamSets.account.getLeaderboardHistory({});
|
|
284
1252
|
|
|
285
1253
|
// Handle the result
|
|
286
1254
|
console.log(result);
|
|
@@ -295,7 +1263,7 @@ The standalone function version of this method:
|
|
|
295
1263
|
|
|
296
1264
|
```typescript
|
|
297
1265
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
298
|
-
import {
|
|
1266
|
+
import { accountGetLeaderboardHistory } from "@steamsets/client-ts/funcs/accountGetLeaderboardHistory.js";
|
|
299
1267
|
|
|
300
1268
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
301
1269
|
// You can create one instance of it to use across an application.
|
|
@@ -304,12 +1272,7 @@ const steamSets = new SteamSetsCore({
|
|
|
304
1272
|
});
|
|
305
1273
|
|
|
306
1274
|
async function run() {
|
|
307
|
-
const res = await
|
|
308
|
-
description: "My App Description",
|
|
309
|
-
developerAppId: "da_123456",
|
|
310
|
-
name: "My App",
|
|
311
|
-
regenerate: true,
|
|
312
|
-
});
|
|
1275
|
+
const res = await accountGetLeaderboardHistory(steamSets, {});
|
|
313
1276
|
|
|
314
1277
|
if (!res.ok) {
|
|
315
1278
|
throw res.error;
|
|
@@ -328,24 +1291,24 @@ run();
|
|
|
328
1291
|
|
|
329
1292
|
| Parameter | Type | Required | Description |
|
|
330
1293
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
331
|
-
| `request` | [components.
|
|
1294
|
+
| `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
332
1295
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
333
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. |
|
|
334
1297
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
335
1298
|
|
|
336
1299
|
### Response
|
|
337
1300
|
|
|
338
|
-
**Promise\<[operations.
|
|
1301
|
+
**Promise\<[operations.AccountV1GetLeaderboardHistoryResponse](../../models/operations/accountv1getleaderboardhistoryresponse.md)\>**
|
|
339
1302
|
|
|
340
1303
|
### Errors
|
|
341
1304
|
|
|
342
1305
|
| Error Type | Status Code | Content Type |
|
|
343
1306
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
344
|
-
| errors.ErrorModel | 404, 422
|
|
1307
|
+
| errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
|
|
345
1308
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
346
1309
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
347
1310
|
|
|
348
|
-
##
|
|
1311
|
+
## getMeta
|
|
349
1312
|
|
|
350
1313
|
### Example Usage
|
|
351
1314
|
|
|
@@ -357,7 +1320,7 @@ const steamSets = new SteamSets({
|
|
|
357
1320
|
});
|
|
358
1321
|
|
|
359
1322
|
async function run() {
|
|
360
|
-
const result = await steamSets.account.
|
|
1323
|
+
const result = await steamSets.account.getMeta({});
|
|
361
1324
|
|
|
362
1325
|
// Handle the result
|
|
363
1326
|
console.log(result);
|
|
@@ -372,7 +1335,7 @@ The standalone function version of this method:
|
|
|
372
1335
|
|
|
373
1336
|
```typescript
|
|
374
1337
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
375
|
-
import {
|
|
1338
|
+
import { accountGetMeta } from "@steamsets/client-ts/funcs/accountGetMeta.js";
|
|
376
1339
|
|
|
377
1340
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
378
1341
|
// You can create one instance of it to use across an application.
|
|
@@ -381,7 +1344,7 @@ const steamSets = new SteamSetsCore({
|
|
|
381
1344
|
});
|
|
382
1345
|
|
|
383
1346
|
async function run() {
|
|
384
|
-
const res = await
|
|
1347
|
+
const res = await accountGetMeta(steamSets, {});
|
|
385
1348
|
|
|
386
1349
|
if (!res.ok) {
|
|
387
1350
|
throw res.error;
|
|
@@ -400,24 +1363,24 @@ run();
|
|
|
400
1363
|
|
|
401
1364
|
| Parameter | Type | Required | Description |
|
|
402
1365
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
403
|
-
| `request` | [components.
|
|
1366
|
+
| `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
404
1367
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
405
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. |
|
|
406
1369
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
407
1370
|
|
|
408
1371
|
### Response
|
|
409
1372
|
|
|
410
|
-
**Promise\<[operations.
|
|
1373
|
+
**Promise\<[operations.AccountV1GetMetaResponse](../../models/operations/accountv1getmetaresponse.md)\>**
|
|
411
1374
|
|
|
412
1375
|
### Errors
|
|
413
1376
|
|
|
414
1377
|
| Error Type | Status Code | Content Type |
|
|
415
1378
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
416
|
-
| errors.ErrorModel |
|
|
1379
|
+
| errors.ErrorModel | 404, 422 | application/problem+json |
|
|
417
1380
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
418
1381
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
419
1382
|
|
|
420
|
-
##
|
|
1383
|
+
## getOwnedBadges
|
|
421
1384
|
|
|
422
1385
|
### Example Usage
|
|
423
1386
|
|
|
@@ -429,7 +1392,7 @@ const steamSets = new SteamSets({
|
|
|
429
1392
|
});
|
|
430
1393
|
|
|
431
1394
|
async function run() {
|
|
432
|
-
const result = await steamSets.account.
|
|
1395
|
+
const result = await steamSets.account.getOwnedBadges();
|
|
433
1396
|
|
|
434
1397
|
// Handle the result
|
|
435
1398
|
console.log(result);
|
|
@@ -444,7 +1407,7 @@ The standalone function version of this method:
|
|
|
444
1407
|
|
|
445
1408
|
```typescript
|
|
446
1409
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
447
|
-
import {
|
|
1410
|
+
import { accountGetOwnedBadges } from "@steamsets/client-ts/funcs/accountGetOwnedBadges.js";
|
|
448
1411
|
|
|
449
1412
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
450
1413
|
// You can create one instance of it to use across an application.
|
|
@@ -453,7 +1416,7 @@ const steamSets = new SteamSetsCore({
|
|
|
453
1416
|
});
|
|
454
1417
|
|
|
455
1418
|
async function run() {
|
|
456
|
-
const res = await
|
|
1419
|
+
const res = await accountGetOwnedBadges(steamSets);
|
|
457
1420
|
|
|
458
1421
|
if (!res.ok) {
|
|
459
1422
|
throw res.error;
|
|
@@ -472,24 +1435,23 @@ run();
|
|
|
472
1435
|
|
|
473
1436
|
| Parameter | Type | Required | Description |
|
|
474
1437
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
475
|
-
| `request` | [components.V1BadgesRequestBody](../../models/components/v1badgesrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
476
1438
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
477
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. |
|
|
478
1440
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
479
1441
|
|
|
480
1442
|
### Response
|
|
481
1443
|
|
|
482
|
-
**Promise\<[operations.
|
|
1444
|
+
**Promise\<[operations.AccountV1GetOwnedBadgesResponse](../../models/operations/accountv1getownedbadgesresponse.md)\>**
|
|
483
1445
|
|
|
484
1446
|
### Errors
|
|
485
1447
|
|
|
486
1448
|
| Error Type | Status Code | Content Type |
|
|
487
1449
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
488
|
-
| errors.ErrorModel |
|
|
1450
|
+
| errors.ErrorModel | 403, 404 | application/problem+json |
|
|
489
1451
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
490
1452
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
491
1453
|
|
|
492
|
-
##
|
|
1454
|
+
## getSession
|
|
493
1455
|
|
|
494
1456
|
### Example Usage
|
|
495
1457
|
|
|
@@ -501,7 +1463,7 @@ const steamSets = new SteamSets({
|
|
|
501
1463
|
});
|
|
502
1464
|
|
|
503
1465
|
async function run() {
|
|
504
|
-
const result = await steamSets.account.
|
|
1466
|
+
const result = await steamSets.account.getSession();
|
|
505
1467
|
|
|
506
1468
|
// Handle the result
|
|
507
1469
|
console.log(result);
|
|
@@ -516,7 +1478,7 @@ The standalone function version of this method:
|
|
|
516
1478
|
|
|
517
1479
|
```typescript
|
|
518
1480
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
519
|
-
import {
|
|
1481
|
+
import { accountGetSession } from "@steamsets/client-ts/funcs/accountGetSession.js";
|
|
520
1482
|
|
|
521
1483
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
522
1484
|
// You can create one instance of it to use across an application.
|
|
@@ -525,7 +1487,7 @@ const steamSets = new SteamSetsCore({
|
|
|
525
1487
|
});
|
|
526
1488
|
|
|
527
1489
|
async function run() {
|
|
528
|
-
const res = await
|
|
1490
|
+
const res = await accountGetSession(steamSets);
|
|
529
1491
|
|
|
530
1492
|
if (!res.ok) {
|
|
531
1493
|
throw res.error;
|
|
@@ -544,24 +1506,22 @@ run();
|
|
|
544
1506
|
|
|
545
1507
|
| Parameter | Type | Required | Description |
|
|
546
1508
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
547
|
-
| `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
548
1509
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
549
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. |
|
|
550
1511
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
551
1512
|
|
|
552
1513
|
### Response
|
|
553
1514
|
|
|
554
|
-
**Promise\<[operations.
|
|
1515
|
+
**Promise\<[operations.AccountV1SessionGetResponse](../../models/operations/accountv1sessiongetresponse.md)\>**
|
|
555
1516
|
|
|
556
1517
|
### Errors
|
|
557
1518
|
|
|
558
1519
|
| Error Type | Status Code | Content Type |
|
|
559
1520
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
560
|
-
| errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
|
|
561
1521
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
562
1522
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
563
1523
|
|
|
564
|
-
##
|
|
1524
|
+
## getSettings
|
|
565
1525
|
|
|
566
1526
|
### Example Usage
|
|
567
1527
|
|
|
@@ -573,7 +1533,7 @@ const steamSets = new SteamSets({
|
|
|
573
1533
|
});
|
|
574
1534
|
|
|
575
1535
|
async function run() {
|
|
576
|
-
const result = await steamSets.account.
|
|
1536
|
+
const result = await steamSets.account.getSettings();
|
|
577
1537
|
|
|
578
1538
|
// Handle the result
|
|
579
1539
|
console.log(result);
|
|
@@ -588,7 +1548,7 @@ The standalone function version of this method:
|
|
|
588
1548
|
|
|
589
1549
|
```typescript
|
|
590
1550
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
591
|
-
import {
|
|
1551
|
+
import { accountGetSettings } from "@steamsets/client-ts/funcs/accountGetSettings.js";
|
|
592
1552
|
|
|
593
1553
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
594
1554
|
// You can create one instance of it to use across an application.
|
|
@@ -597,7 +1557,7 @@ const steamSets = new SteamSetsCore({
|
|
|
597
1557
|
});
|
|
598
1558
|
|
|
599
1559
|
async function run() {
|
|
600
|
-
const res = await
|
|
1560
|
+
const res = await accountGetSettings(steamSets);
|
|
601
1561
|
|
|
602
1562
|
if (!res.ok) {
|
|
603
1563
|
throw res.error;
|
|
@@ -616,24 +1576,22 @@ run();
|
|
|
616
1576
|
|
|
617
1577
|
| Parameter | Type | Required | Description |
|
|
618
1578
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
619
|
-
| `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
620
1579
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
621
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. |
|
|
622
1581
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
623
1582
|
|
|
624
1583
|
### Response
|
|
625
1584
|
|
|
626
|
-
**Promise\<[operations.
|
|
1585
|
+
**Promise\<[operations.AccountV1SettingsGetResponse](../../models/operations/accountv1settingsgetresponse.md)\>**
|
|
627
1586
|
|
|
628
1587
|
### Errors
|
|
629
1588
|
|
|
630
1589
|
| Error Type | Status Code | Content Type |
|
|
631
1590
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
632
|
-
| errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
|
|
633
1591
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
634
1592
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
635
1593
|
|
|
636
|
-
##
|
|
1594
|
+
## getStaff
|
|
637
1595
|
|
|
638
1596
|
### Example Usage
|
|
639
1597
|
|
|
@@ -645,7 +1603,7 @@ const steamSets = new SteamSets({
|
|
|
645
1603
|
});
|
|
646
1604
|
|
|
647
1605
|
async function run() {
|
|
648
|
-
const result = await steamSets.account.
|
|
1606
|
+
const result = await steamSets.account.getStaff();
|
|
649
1607
|
|
|
650
1608
|
// Handle the result
|
|
651
1609
|
console.log(result);
|
|
@@ -660,7 +1618,7 @@ The standalone function version of this method:
|
|
|
660
1618
|
|
|
661
1619
|
```typescript
|
|
662
1620
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
663
|
-
import {
|
|
1621
|
+
import { accountGetStaff } from "@steamsets/client-ts/funcs/accountGetStaff.js";
|
|
664
1622
|
|
|
665
1623
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
666
1624
|
// You can create one instance of it to use across an application.
|
|
@@ -669,7 +1627,7 @@ const steamSets = new SteamSetsCore({
|
|
|
669
1627
|
});
|
|
670
1628
|
|
|
671
1629
|
async function run() {
|
|
672
|
-
const res = await
|
|
1630
|
+
const res = await accountGetStaff(steamSets);
|
|
673
1631
|
|
|
674
1632
|
if (!res.ok) {
|
|
675
1633
|
throw res.error;
|
|
@@ -688,24 +1646,23 @@ run();
|
|
|
688
1646
|
|
|
689
1647
|
| Parameter | Type | Required | Description |
|
|
690
1648
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
691
|
-
| `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
692
1649
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
693
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. |
|
|
694
1651
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
695
1652
|
|
|
696
1653
|
### Response
|
|
697
1654
|
|
|
698
|
-
**Promise\<[operations.
|
|
1655
|
+
**Promise\<[operations.AccountV1GetStaffResponse](../../models/operations/accountv1getstaffresponse.md)\>**
|
|
699
1656
|
|
|
700
1657
|
### Errors
|
|
701
1658
|
|
|
702
1659
|
| Error Type | Status Code | Content Type |
|
|
703
1660
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
704
|
-
| errors.ErrorModel |
|
|
1661
|
+
| errors.ErrorModel | 404, 429 | application/problem+json |
|
|
705
1662
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
706
1663
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
707
1664
|
|
|
708
|
-
##
|
|
1665
|
+
## login
|
|
709
1666
|
|
|
710
1667
|
### Example Usage
|
|
711
1668
|
|
|
@@ -717,7 +1674,20 @@ const steamSets = new SteamSets({
|
|
|
717
1674
|
});
|
|
718
1675
|
|
|
719
1676
|
async function run() {
|
|
720
|
-
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
|
+
});
|
|
721
1691
|
|
|
722
1692
|
// Handle the result
|
|
723
1693
|
console.log(result);
|
|
@@ -732,7 +1702,7 @@ The standalone function version of this method:
|
|
|
732
1702
|
|
|
733
1703
|
```typescript
|
|
734
1704
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
735
|
-
import {
|
|
1705
|
+
import { accountLogin } from "@steamsets/client-ts/funcs/accountLogin.js";
|
|
736
1706
|
|
|
737
1707
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
738
1708
|
// You can create one instance of it to use across an application.
|
|
@@ -741,7 +1711,20 @@ const steamSets = new SteamSetsCore({
|
|
|
741
1711
|
});
|
|
742
1712
|
|
|
743
1713
|
async function run() {
|
|
744
|
-
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
|
+
});
|
|
745
1728
|
|
|
746
1729
|
if (!res.ok) {
|
|
747
1730
|
throw res.error;
|
|
@@ -760,24 +1743,24 @@ run();
|
|
|
760
1743
|
|
|
761
1744
|
| Parameter | Type | Required | Description |
|
|
762
1745
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
763
|
-
| `request` | [
|
|
1746
|
+
| `request` | [operations.AccountV1SessionLoginRequest](../../models/operations/accountv1sessionloginrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
764
1747
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
765
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. |
|
|
766
1749
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
767
1750
|
|
|
768
1751
|
### Response
|
|
769
1752
|
|
|
770
|
-
**Promise\<[operations.
|
|
1753
|
+
**Promise\<[operations.AccountV1SessionLoginResponse](../../models/operations/accountv1sessionloginresponse.md)\>**
|
|
771
1754
|
|
|
772
1755
|
### Errors
|
|
773
1756
|
|
|
774
1757
|
| Error Type | Status Code | Content Type |
|
|
775
1758
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
776
|
-
| errors.ErrorModel | 400,
|
|
1759
|
+
| errors.ErrorModel | 400, 422, 429 | application/problem+json |
|
|
777
1760
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
778
1761
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
779
1762
|
|
|
780
|
-
##
|
|
1763
|
+
## queue
|
|
781
1764
|
|
|
782
1765
|
### Example Usage
|
|
783
1766
|
|
|
@@ -789,7 +1772,9 @@ const steamSets = new SteamSets({
|
|
|
789
1772
|
});
|
|
790
1773
|
|
|
791
1774
|
async function run() {
|
|
792
|
-
const result = await steamSets.account.
|
|
1775
|
+
const result = await steamSets.account.queue({
|
|
1776
|
+
force: true,
|
|
1777
|
+
});
|
|
793
1778
|
|
|
794
1779
|
// Handle the result
|
|
795
1780
|
console.log(result);
|
|
@@ -804,7 +1789,7 @@ The standalone function version of this method:
|
|
|
804
1789
|
|
|
805
1790
|
```typescript
|
|
806
1791
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
807
|
-
import {
|
|
1792
|
+
import { accountQueue } from "@steamsets/client-ts/funcs/accountQueue.js";
|
|
808
1793
|
|
|
809
1794
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
810
1795
|
// You can create one instance of it to use across an application.
|
|
@@ -813,7 +1798,9 @@ const steamSets = new SteamSetsCore({
|
|
|
813
1798
|
});
|
|
814
1799
|
|
|
815
1800
|
async function run() {
|
|
816
|
-
const res = await
|
|
1801
|
+
const res = await accountQueue(steamSets, {
|
|
1802
|
+
force: true,
|
|
1803
|
+
});
|
|
817
1804
|
|
|
818
1805
|
if (!res.ok) {
|
|
819
1806
|
throw res.error;
|
|
@@ -832,24 +1819,24 @@ run();
|
|
|
832
1819
|
|
|
833
1820
|
| Parameter | Type | Required | Description |
|
|
834
1821
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
835
|
-
| `request` | [components.
|
|
1822
|
+
| `request` | [components.V1AccountQueueRequestBody](../../models/components/v1accountqueuerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
836
1823
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
837
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. |
|
|
838
1825
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
839
1826
|
|
|
840
1827
|
### Response
|
|
841
1828
|
|
|
842
|
-
**Promise\<[operations.
|
|
1829
|
+
**Promise\<[operations.AccountV1QueueResponse](../../models/operations/accountv1queueresponse.md)\>**
|
|
843
1830
|
|
|
844
1831
|
### Errors
|
|
845
1832
|
|
|
846
1833
|
| Error Type | Status Code | Content Type |
|
|
847
1834
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
848
|
-
| errors.ErrorModel |
|
|
1835
|
+
| errors.ErrorModel | 400, 422, 429 | application/problem+json |
|
|
849
1836
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
850
1837
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
851
1838
|
|
|
852
|
-
##
|
|
1839
|
+
## reconnect
|
|
853
1840
|
|
|
854
1841
|
### Example Usage
|
|
855
1842
|
|
|
@@ -861,7 +1848,10 @@ const steamSets = new SteamSets({
|
|
|
861
1848
|
});
|
|
862
1849
|
|
|
863
1850
|
async function run() {
|
|
864
|
-
const result = await steamSets.account.
|
|
1851
|
+
const result = await steamSets.account.reconnect({
|
|
1852
|
+
code: "123456",
|
|
1853
|
+
connectionId: "123456",
|
|
1854
|
+
});
|
|
865
1855
|
|
|
866
1856
|
// Handle the result
|
|
867
1857
|
console.log(result);
|
|
@@ -876,7 +1866,7 @@ The standalone function version of this method:
|
|
|
876
1866
|
|
|
877
1867
|
```typescript
|
|
878
1868
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
879
|
-
import {
|
|
1869
|
+
import { accountReconnect } from "@steamsets/client-ts/funcs/accountReconnect.js";
|
|
880
1870
|
|
|
881
1871
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
882
1872
|
// You can create one instance of it to use across an application.
|
|
@@ -885,7 +1875,10 @@ const steamSets = new SteamSetsCore({
|
|
|
885
1875
|
});
|
|
886
1876
|
|
|
887
1877
|
async function run() {
|
|
888
|
-
const res = await
|
|
1878
|
+
const res = await accountReconnect(steamSets, {
|
|
1879
|
+
code: "123456",
|
|
1880
|
+
connectionId: "123456",
|
|
1881
|
+
});
|
|
889
1882
|
|
|
890
1883
|
if (!res.ok) {
|
|
891
1884
|
throw res.error;
|
|
@@ -904,23 +1897,24 @@ run();
|
|
|
904
1897
|
|
|
905
1898
|
| Parameter | Type | Required | Description |
|
|
906
1899
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1900
|
+
| `request` | [components.V1ReconnectRequestBody](../../models/components/v1reconnectrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
907
1901
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
908
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. |
|
|
909
1903
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
910
1904
|
|
|
911
1905
|
### Response
|
|
912
1906
|
|
|
913
|
-
**Promise\<[operations.
|
|
1907
|
+
**Promise\<[operations.AccountV1ConnectionReconnectResponse](../../models/operations/accountv1connectionreconnectresponse.md)\>**
|
|
914
1908
|
|
|
915
1909
|
### Errors
|
|
916
1910
|
|
|
917
1911
|
| Error Type | Status Code | Content Type |
|
|
918
1912
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
919
|
-
| errors.ErrorModel |
|
|
1913
|
+
| errors.ErrorModel | 400, 422 | application/problem+json |
|
|
920
1914
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
921
1915
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
922
1916
|
|
|
923
|
-
##
|
|
1917
|
+
## updateImages
|
|
924
1918
|
|
|
925
1919
|
### Example Usage
|
|
926
1920
|
|
|
@@ -932,7 +1926,7 @@ const steamSets = new SteamSets({
|
|
|
932
1926
|
});
|
|
933
1927
|
|
|
934
1928
|
async function run() {
|
|
935
|
-
const result = await steamSets.account.
|
|
1929
|
+
const result = await steamSets.account.updateImages({
|
|
936
1930
|
images: [
|
|
937
1931
|
|
|
938
1932
|
],
|
|
@@ -951,7 +1945,7 @@ The standalone function version of this method:
|
|
|
951
1945
|
|
|
952
1946
|
```typescript
|
|
953
1947
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
954
|
-
import {
|
|
1948
|
+
import { accountUpdateImages } from "@steamsets/client-ts/funcs/accountUpdateImages.js";
|
|
955
1949
|
|
|
956
1950
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
957
1951
|
// You can create one instance of it to use across an application.
|
|
@@ -960,7 +1954,7 @@ const steamSets = new SteamSetsCore({
|
|
|
960
1954
|
});
|
|
961
1955
|
|
|
962
1956
|
async function run() {
|
|
963
|
-
const res = await
|
|
1957
|
+
const res = await accountUpdateImages(steamSets, {
|
|
964
1958
|
images: [
|
|
965
1959
|
|
|
966
1960
|
],
|
|
@@ -983,24 +1977,24 @@ run();
|
|
|
983
1977
|
|
|
984
1978
|
| Parameter | Type | Required | Description |
|
|
985
1979
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
986
|
-
| `request` | [components.
|
|
1980
|
+
| `request` | [components.V1UpdateImageRequestBody](../../models/components/v1updateimagerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
987
1981
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
988
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. |
|
|
989
1983
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
990
1984
|
|
|
991
1985
|
### Response
|
|
992
1986
|
|
|
993
|
-
**Promise\<[operations.
|
|
1987
|
+
**Promise\<[operations.AccountV1ImagesUpdateResponse](../../models/operations/accountv1imagesupdateresponse.md)\>**
|
|
994
1988
|
|
|
995
1989
|
### Errors
|
|
996
1990
|
|
|
997
1991
|
| Error Type | Status Code | Content Type |
|
|
998
1992
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
999
|
-
| errors.ErrorModel | 422
|
|
1993
|
+
| errors.ErrorModel | 404, 422 | application/problem+json |
|
|
1000
1994
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
1001
1995
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1002
1996
|
|
|
1003
|
-
##
|
|
1997
|
+
## updateSettings
|
|
1004
1998
|
|
|
1005
1999
|
### Example Usage
|
|
1006
2000
|
|
|
@@ -1012,7 +2006,14 @@ const steamSets = new SteamSets({
|
|
|
1012
2006
|
});
|
|
1013
2007
|
|
|
1014
2008
|
async function run() {
|
|
1015
|
-
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
|
+
});
|
|
1016
2017
|
|
|
1017
2018
|
// Handle the result
|
|
1018
2019
|
console.log(result);
|
|
@@ -1027,7 +2028,7 @@ The standalone function version of this method:
|
|
|
1027
2028
|
|
|
1028
2029
|
```typescript
|
|
1029
2030
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
1030
|
-
import {
|
|
2031
|
+
import { accountUpdateSettings } from "@steamsets/client-ts/funcs/accountUpdateSettings.js";
|
|
1031
2032
|
|
|
1032
2033
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
1033
2034
|
// You can create one instance of it to use across an application.
|
|
@@ -1036,7 +2037,14 @@ const steamSets = new SteamSetsCore({
|
|
|
1036
2037
|
});
|
|
1037
2038
|
|
|
1038
2039
|
async function run() {
|
|
1039
|
-
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
|
+
});
|
|
1040
2048
|
|
|
1041
2049
|
if (!res.ok) {
|
|
1042
2050
|
throw res.error;
|
|
@@ -1055,24 +2063,24 @@ run();
|
|
|
1055
2063
|
|
|
1056
2064
|
| Parameter | Type | Required | Description |
|
|
1057
2065
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1058
|
-
| `request` | [
|
|
2066
|
+
| `request` | [operations.AccountV1SettingsUpdateRequest](../../models/operations/accountv1settingsupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1059
2067
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1060
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. |
|
|
1061
2069
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1062
2070
|
|
|
1063
2071
|
### Response
|
|
1064
2072
|
|
|
1065
|
-
**Promise\<[operations.
|
|
2073
|
+
**Promise\<[operations.AccountV1SettingsUpdateResponse](../../models/operations/accountv1settingsupdateresponse.md)\>**
|
|
1066
2074
|
|
|
1067
2075
|
### Errors
|
|
1068
2076
|
|
|
1069
2077
|
| Error Type | Status Code | Content Type |
|
|
1070
2078
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
1071
|
-
| errors.ErrorModel |
|
|
2079
|
+
| errors.ErrorModel | 422, 429 | application/problem+json |
|
|
1072
2080
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
1073
2081
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1074
2082
|
|
|
1075
|
-
##
|
|
2083
|
+
## uploadImages
|
|
1076
2084
|
|
|
1077
2085
|
### Example Usage
|
|
1078
2086
|
|
|
@@ -1084,34 +2092,9 @@ const steamSets = new SteamSets({
|
|
|
1084
2092
|
});
|
|
1085
2093
|
|
|
1086
2094
|
async function run() {
|
|
1087
|
-
const result = await steamSets.account.
|
|
1088
|
-
|
|
1089
|
-
|
|
1090
|
-
},
|
|
1091
|
-
badge: {
|
|
1092
|
-
id: 75458,
|
|
1093
|
-
isFoil: true,
|
|
1094
|
-
},
|
|
1095
|
-
leaderboard: "xp",
|
|
1096
|
-
location: [
|
|
1097
|
-
{
|
|
1098
|
-
city: "Bad Krozingen",
|
|
1099
|
-
country: "Germany",
|
|
1100
|
-
region: "Europe",
|
|
1101
|
-
state: "Baden-Wurttemberg",
|
|
1102
|
-
},
|
|
1103
|
-
{
|
|
1104
|
-
city: "Bad Krozingen",
|
|
1105
|
-
country: "Germany",
|
|
1106
|
-
region: "Europe",
|
|
1107
|
-
state: "Baden-Wurttemberg",
|
|
1108
|
-
},
|
|
1109
|
-
{
|
|
1110
|
-
city: "Bad Krozingen",
|
|
1111
|
-
country: "Germany",
|
|
1112
|
-
region: "Europe",
|
|
1113
|
-
state: "Baden-Wurttemberg",
|
|
1114
|
-
},
|
|
2095
|
+
const result = await steamSets.account.uploadImages({
|
|
2096
|
+
images: [
|
|
2097
|
+
|
|
1115
2098
|
],
|
|
1116
2099
|
});
|
|
1117
2100
|
|
|
@@ -1128,7 +2111,7 @@ The standalone function version of this method:
|
|
|
1128
2111
|
|
|
1129
2112
|
```typescript
|
|
1130
2113
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
1131
|
-
import {
|
|
2114
|
+
import { accountUploadImages } from "@steamsets/client-ts/funcs/accountUploadImages.js";
|
|
1132
2115
|
|
|
1133
2116
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
1134
2117
|
// You can create one instance of it to use across an application.
|
|
@@ -1137,34 +2120,9 @@ const steamSets = new SteamSetsCore({
|
|
|
1137
2120
|
});
|
|
1138
2121
|
|
|
1139
2122
|
async function run() {
|
|
1140
|
-
const res = await
|
|
1141
|
-
|
|
1142
|
-
|
|
1143
|
-
},
|
|
1144
|
-
badge: {
|
|
1145
|
-
id: 75458,
|
|
1146
|
-
isFoil: true,
|
|
1147
|
-
},
|
|
1148
|
-
leaderboard: "xp",
|
|
1149
|
-
location: [
|
|
1150
|
-
{
|
|
1151
|
-
city: "Bad Krozingen",
|
|
1152
|
-
country: "Germany",
|
|
1153
|
-
region: "Europe",
|
|
1154
|
-
state: "Baden-Wurttemberg",
|
|
1155
|
-
},
|
|
1156
|
-
{
|
|
1157
|
-
city: "Bad Krozingen",
|
|
1158
|
-
country: "Germany",
|
|
1159
|
-
region: "Europe",
|
|
1160
|
-
state: "Baden-Wurttemberg",
|
|
1161
|
-
},
|
|
1162
|
-
{
|
|
1163
|
-
city: "Bad Krozingen",
|
|
1164
|
-
country: "Germany",
|
|
1165
|
-
region: "Europe",
|
|
1166
|
-
state: "Baden-Wurttemberg",
|
|
1167
|
-
},
|
|
2123
|
+
const res = await accountUploadImages(steamSets, {
|
|
2124
|
+
images: [
|
|
2125
|
+
|
|
1168
2126
|
],
|
|
1169
2127
|
});
|
|
1170
2128
|
|
|
@@ -1185,19 +2143,95 @@ run();
|
|
|
1185
2143
|
|
|
1186
2144
|
| Parameter | Type | Required | Description |
|
|
1187
2145
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1188
|
-
| `request` | [components.
|
|
2146
|
+
| `request` | [components.V1UploadImagesRequestBody](../../models/components/v1uploadimagesrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1189
2147
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1190
2148
|
| `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. |
|
|
1191
2149
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1192
2150
|
|
|
1193
2151
|
### Response
|
|
1194
2152
|
|
|
1195
|
-
**Promise\<[operations.
|
|
2153
|
+
**Promise\<[operations.AccountV1ImagesUploadResponse](../../models/operations/accountv1imagesuploadresponse.md)\>**
|
|
1196
2154
|
|
|
1197
2155
|
### Errors
|
|
1198
2156
|
|
|
1199
2157
|
| Error Type | Status Code | Content Type |
|
|
1200
2158
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
1201
|
-
| errors.ErrorModel |
|
|
2159
|
+
| errors.ErrorModel | 422 | application/problem+json |
|
|
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 |
|
|
1202
2236
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
1203
2237
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|