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