@steamsets/client-ts 0.13.5 → 0.14.0
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 +107 -0
- package/README.md +67 -49
- package/RUNTIMES.md +22 -0
- package/docs/sdks/account/README.md +165 -12
- package/docs/sdks/admin/README.md +94 -5
- package/docs/sdks/badge/README.md +14 -14
- package/docs/sdks/images/README.md +332 -0
- package/docs/sdks/settings/README.md +0 -256
- package/docs/sdks/steamsets/README.md +3 -1
- package/funcs/accountAccountV1GetBadgeBookmarks.d.ts +11 -0
- package/funcs/accountAccountV1GetBadgeBookmarks.d.ts.map +1 -0
- package/funcs/accountAccountV1GetBadgeBookmarks.js +99 -0
- package/funcs/accountAccountV1GetBadgeBookmarks.js.map +1 -0
- package/funcs/{settingsUpdateImage.d.ts → accountAccountV1ImagesGet.d.ts} +2 -3
- package/funcs/accountAccountV1ImagesGet.d.ts.map +1 -0
- package/funcs/accountAccountV1ImagesGet.js +98 -0
- package/funcs/accountAccountV1ImagesGet.js.map +1 -0
- package/funcs/{settingsDeleteImages.d.ts → accountAccountV1ImagesUpdate.d.ts} +2 -2
- package/funcs/accountAccountV1ImagesUpdate.d.ts.map +1 -0
- package/funcs/{accountUpdateImage.js → accountAccountV1ImagesUpdate.js} +9 -9
- package/funcs/accountAccountV1ImagesUpdate.js.map +1 -0
- package/funcs/accountDeleteImages.d.ts +1 -1
- package/funcs/accountDeleteImages.d.ts.map +1 -1
- package/funcs/accountDeleteImages.js +7 -5
- package/funcs/accountDeleteImages.js.map +1 -1
- package/funcs/accountGetApps.js +3 -3
- package/funcs/accountGetApps.js.map +1 -1
- package/funcs/accountGetBadges.js +3 -3
- package/funcs/accountGetBadges.js.map +1 -1
- package/funcs/accountGetDataPoints.js +3 -3
- package/funcs/accountGetDataPoints.js.map +1 -1
- package/funcs/accountGetFriends.js +3 -3
- package/funcs/accountGetFriends.js.map +1 -1
- package/funcs/accountGetInfo.js +3 -3
- package/funcs/accountGetInfo.js.map +1 -1
- package/funcs/accountGetLeaderboardHistory.js +3 -3
- package/funcs/accountGetLeaderboardHistory.js.map +1 -1
- package/funcs/accountGetStaff.js +3 -3
- package/funcs/accountGetStaff.js.map +1 -1
- package/funcs/accountSendEmailVerification.js +3 -3
- package/funcs/accountSendEmailVerification.js.map +1 -1
- package/funcs/accountUploadImages.d.ts +1 -1
- package/funcs/accountUploadImages.d.ts.map +1 -1
- package/funcs/accountUploadImages.js +7 -5
- package/funcs/accountUploadImages.js.map +1 -1
- package/funcs/accountVerifyEmail.js +3 -3
- package/funcs/accountVerifyEmail.js.map +1 -1
- package/funcs/accountsQueue.js +3 -3
- package/funcs/accountsQueue.js.map +1 -1
- package/funcs/adminAdminV1GetEvents.d.ts +10 -0
- package/funcs/adminAdminV1GetEvents.d.ts.map +1 -0
- package/funcs/adminAdminV1GetEvents.js +98 -0
- package/funcs/adminAdminV1GetEvents.js.map +1 -0
- package/funcs/adminAdminV1UpdateEvent.d.ts +2 -1
- package/funcs/adminAdminV1UpdateEvent.d.ts.map +1 -1
- package/funcs/adminAdminV1UpdateEvent.js +17 -6
- package/funcs/adminAdminV1UpdateEvent.js.map +1 -1
- package/funcs/adminAdminV1UpdateResources.js +3 -3
- package/funcs/adminAdminV1UpdateResources.js.map +1 -1
- package/funcs/adminAdminV1UpdateRoles.js +3 -3
- package/funcs/adminAdminV1UpdateRoles.js.map +1 -1
- package/funcs/adminGetAccount.d.ts +2 -1
- package/funcs/adminGetAccount.d.ts.map +1 -1
- package/funcs/adminGetAccount.js +20 -9
- package/funcs/adminGetAccount.js.map +1 -1
- package/funcs/badgeAccountV1BookmarkBadge.d.ts +11 -0
- package/funcs/badgeAccountV1BookmarkBadge.d.ts.map +1 -0
- package/funcs/{badgeBadgeV1Bookmark.js → badgeAccountV1BookmarkBadge.js} +11 -11
- package/funcs/badgeAccountV1BookmarkBadge.js.map +1 -0
- package/funcs/badgeAccountV1GetBadgeBookmarks.d.ts +11 -0
- package/funcs/badgeAccountV1GetBadgeBookmarks.d.ts.map +1 -0
- package/funcs/{badgeBadgeV1GetBookmarks.js → badgeAccountV1GetBadgeBookmarks.js} +10 -10
- package/funcs/badgeAccountV1GetBadgeBookmarks.js.map +1 -0
- package/funcs/badgeGetTags.js +3 -3
- package/funcs/badgeGetTags.js.map +1 -1
- package/funcs/badgesTag.js +3 -3
- package/funcs/badgesTag.js.map +1 -1
- package/funcs/connectionDelete.js +3 -3
- package/funcs/connectionDelete.js.map +1 -1
- package/funcs/connectionUpdate.js +3 -3
- package/funcs/connectionUpdate.js.map +1 -1
- package/funcs/connectionVerify.js +3 -3
- package/funcs/connectionVerify.js.map +1 -1
- package/funcs/connectionsConnect.js +3 -3
- package/funcs/connectionsConnect.js.map +1 -1
- package/funcs/dataGetApps.js +3 -3
- package/funcs/dataGetApps.js.map +1 -1
- package/funcs/dataGetBadges.js +3 -3
- package/funcs/dataGetBadges.js.map +1 -1
- package/funcs/dataGetDataPoints.js +3 -3
- package/funcs/dataGetDataPoints.js.map +1 -1
- package/funcs/dataGetFriends.js +3 -3
- package/funcs/dataGetFriends.js.map +1 -1
- package/funcs/dataGetInfo.js +3 -3
- package/funcs/dataGetInfo.js.map +1 -1
- package/funcs/dataGetLeaderboardHistory.js +3 -3
- package/funcs/dataGetLeaderboardHistory.js.map +1 -1
- package/funcs/dataGetStaff.js +3 -3
- package/funcs/dataGetStaff.js.map +1 -1
- package/funcs/developerCreateDeveloperApp.js +3 -3
- package/funcs/developerCreateDeveloperApp.js.map +1 -1
- package/funcs/developerDeleteDeveloperApp.js +3 -3
- package/funcs/developerDeleteDeveloperApp.js.map +1 -1
- package/funcs/developerUpdateApp.js +3 -3
- package/funcs/developerUpdateApp.js.map +1 -1
- package/funcs/imagesAccountV1ImagesGet.d.ts +10 -0
- package/funcs/imagesAccountV1ImagesGet.d.ts.map +1 -0
- package/funcs/imagesAccountV1ImagesGet.js +98 -0
- package/funcs/imagesAccountV1ImagesGet.js.map +1 -0
- package/funcs/{badgeBadgeV1GetBookmarks.d.ts → imagesAccountV1ImagesUpdate.d.ts} +2 -2
- package/funcs/imagesAccountV1ImagesUpdate.d.ts.map +1 -0
- package/funcs/{settingsUpdateImage.js → imagesAccountV1ImagesUpdate.js} +9 -9
- package/funcs/imagesAccountV1ImagesUpdate.js.map +1 -0
- package/funcs/{badgeBadgeV1Bookmark.d.ts → imagesDeleteImages.d.ts} +2 -2
- package/funcs/{accountUpdateImage.d.ts.map → imagesDeleteImages.d.ts.map} +1 -1
- package/funcs/{settingsDeleteImages.js → imagesDeleteImages.js} +10 -8
- package/funcs/imagesDeleteImages.js.map +1 -0
- package/funcs/{accountUpdateImage.d.ts → imagesUploadImages.d.ts} +2 -2
- package/funcs/imagesUploadImages.d.ts.map +1 -0
- package/funcs/{settingsUploadImages.js → imagesUploadImages.js} +10 -8
- package/funcs/imagesUploadImages.js.map +1 -0
- package/funcs/leaderboardGetAccount.js +3 -3
- package/funcs/leaderboardGetAccount.js.map +1 -1
- package/funcs/leaderboardGetBadges.js +3 -3
- package/funcs/leaderboardGetBadges.js.map +1 -1
- package/funcs/leaderboardGetGroup.js +3 -3
- package/funcs/leaderboardGetGroup.js.map +1 -1
- package/funcs/livenessCheck.js +3 -3
- package/funcs/livenessCheck.js.map +1 -1
- package/funcs/locationsGet.js +3 -3
- package/funcs/locationsGet.js.map +1 -1
- package/funcs/metaAccountV1GetEmbed.js +3 -3
- package/funcs/metaAccountV1GetEmbed.js.map +1 -1
- package/funcs/metaAccountV1GetMeta.js +3 -3
- package/funcs/metaAccountV1GetMeta.js.map +1 -1
- package/funcs/publicGetApps.js +3 -3
- package/funcs/publicGetApps.js.map +1 -1
- package/funcs/publicGetBadges.js +3 -3
- package/funcs/publicGetBadges.js.map +1 -1
- package/funcs/publicGetDataPoints.js +3 -3
- package/funcs/publicGetDataPoints.js.map +1 -1
- package/funcs/publicGetFriends.js +3 -3
- package/funcs/publicGetFriends.js.map +1 -1
- package/funcs/publicGetInfo.js +3 -3
- package/funcs/publicGetInfo.js.map +1 -1
- package/funcs/publicGetLeaderboardHistory.js +3 -3
- package/funcs/publicGetLeaderboardHistory.js.map +1 -1
- package/funcs/sessionCreate.js +3 -3
- package/funcs/sessionCreate.js.map +1 -1
- package/funcs/sessionLogin.js +3 -3
- package/funcs/sessionLogin.js.map +1 -1
- package/funcs/sessionsDelete.js +3 -3
- package/funcs/sessionsDelete.js.map +1 -1
- package/funcs/sessionsGet.js +3 -3
- package/funcs/sessionsGet.js.map +1 -1
- package/funcs/settingsGet.js +3 -3
- package/funcs/settingsGet.js.map +1 -1
- package/funcs/settingsSendEmailVerification.js +3 -3
- package/funcs/settingsSendEmailVerification.js.map +1 -1
- package/funcs/settingsUpdate.js +3 -3
- package/funcs/settingsUpdate.js.map +1 -1
- package/funcs/settingsVerifyEmail.js +3 -3
- package/funcs/settingsVerifyEmail.js.map +1 -1
- package/hooks/hooks.d.ts.map +1 -1
- package/hooks/hooks.js +18 -0
- package/hooks/hooks.js.map +1 -1
- package/hooks/types.d.ts +1 -0
- package/hooks/types.d.ts.map +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/primitives.d.ts +2 -0
- package/lib/primitives.d.ts.map +1 -1
- package/lib/primitives.js +53 -0
- package/lib/primitives.js.map +1 -1
- package/models/components/index.d.ts +12 -6
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +12 -6
- package/models/components/index.js.map +1 -1
- package/models/components/v1accountbadgebookmark.d.ts +37 -0
- package/models/components/v1accountbadgebookmark.d.ts.map +1 -0
- package/models/components/{v1badgebookmark.js → v1accountbadgebookmark.js} +17 -17
- package/models/components/v1accountbadgebookmark.js.map +1 -0
- package/models/components/v1accountbadgebookmarkrequestbody.d.ts +37 -0
- package/models/components/v1accountbadgebookmarkrequestbody.d.ts.map +1 -0
- package/models/components/{v1badgebookmarkrequestbody.js → v1accountbadgebookmarkrequestbody.js} +17 -17
- package/models/components/v1accountbadgebookmarkrequestbody.js.map +1 -0
- package/models/components/v1accountbadgebookmarkresponsebody.d.ts +32 -0
- package/models/components/v1accountbadgebookmarkresponsebody.d.ts.map +1 -0
- package/models/components/{v1getbadgebookmarksresponsebody.js → v1accountbadgebookmarkresponsebody.js} +17 -20
- package/models/components/v1accountbadgebookmarkresponsebody.js.map +1 -0
- package/models/components/v1accountbadgebookmarksrequestbody.d.ts +25 -0
- package/models/components/v1accountbadgebookmarksrequestbody.d.ts.map +1 -0
- package/models/components/v1accountbadgebookmarksrequestbody.js +55 -0
- package/models/components/v1accountbadgebookmarksrequestbody.js.map +1 -0
- package/models/components/v1accountbadgebookmarksresponsebody.d.ts +35 -0
- package/models/components/v1accountbadgebookmarksresponsebody.d.ts.map +1 -0
- package/models/components/v1accountbadgebookmarksresponsebody.js +71 -0
- package/models/components/v1accountbadgebookmarksresponsebody.js.map +1 -0
- package/models/components/v1accountlocationupdate.d.ts +57 -0
- package/models/components/v1accountlocationupdate.d.ts.map +1 -0
- package/models/components/v1accountlocationupdate.js +69 -0
- package/models/components/v1accountlocationupdate.js.map +1 -0
- package/models/components/v1accountnameupdate.d.ts +37 -0
- package/models/components/v1accountnameupdate.d.ts.map +1 -0
- package/models/components/{v1getbadgebookmarksrequestbody.js → v1accountnameupdate.js} +23 -17
- package/models/components/v1accountnameupdate.js.map +1 -0
- package/models/components/v1admingetaccountresponsebody.d.ts +148 -0
- package/models/components/v1admingetaccountresponsebody.d.ts.map +1 -0
- package/models/components/v1admingetaccountresponsebody.js +127 -0
- package/models/components/v1admingetaccountresponsebody.js.map +1 -0
- package/models/components/v1adminupdateeventrequestbody.d.ts +38 -0
- package/models/components/v1adminupdateeventrequestbody.d.ts.map +1 -0
- package/models/components/v1adminupdateeventrequestbody.js +62 -0
- package/models/components/v1adminupdateeventrequestbody.js.map +1 -0
- package/models/components/v1appeventmapping.d.ts +37 -0
- package/models/components/v1appeventmapping.d.ts.map +1 -0
- package/models/components/v1appeventmapping.js +61 -0
- package/models/components/v1appeventmapping.js.map +1 -0
- package/models/components/v1event.d.ts +6 -0
- package/models/components/v1event.d.ts.map +1 -1
- package/models/components/v1event.js +3 -0
- package/models/components/v1event.js.map +1 -1
- package/models/components/v1getimagesresponsebody.d.ts +38 -0
- package/models/components/v1getimagesresponsebody.d.ts.map +1 -0
- package/models/components/{v1badgebookmarkresponsebody.js → v1getimagesresponsebody.js} +20 -17
- package/models/components/v1getimagesresponsebody.js.map +1 -0
- package/models/components/v1getsettingsbody.d.ts +2 -6
- package/models/components/v1getsettingsbody.d.ts.map +1 -1
- package/models/components/v1getsettingsbody.js +0 -3
- package/models/components/v1getsettingsbody.js.map +1 -1
- package/models/components/v1updateimage.d.ts +37 -0
- package/models/components/v1updateimage.d.ts.map +1 -0
- package/models/components/v1updateimage.js +61 -0
- package/models/components/v1updateimage.js.map +1 -0
- package/models/components/v1updateimagerequestbody.d.ts +4 -8
- package/models/components/v1updateimagerequestbody.d.ts.map +1 -1
- package/models/components/v1updateimagerequestbody.js +3 -4
- package/models/components/v1updateimagerequestbody.js.map +1 -1
- package/models/components/v1updateimageresponsebody.d.ts +0 -5
- package/models/components/v1updateimageresponsebody.d.ts.map +1 -1
- package/models/components/v1updateimageresponsebody.js +0 -2
- package/models/components/v1updateimageresponsebody.js.map +1 -1
- package/models/components/v1updatesettingsrequestbody.d.ts +0 -6
- package/models/components/v1updatesettingsrequestbody.d.ts.map +1 -1
- package/models/components/v1updatesettingsrequestbody.js +0 -3
- package/models/components/v1updatesettingsrequestbody.js.map +1 -1
- package/models/operations/accountv1bookmarkbadge.d.ts +35 -0
- package/models/operations/accountv1bookmarkbadge.d.ts.map +1 -0
- package/models/operations/accountv1bookmarkbadge.js +75 -0
- package/models/operations/accountv1bookmarkbadge.js.map +1 -0
- package/models/operations/accountv1getbadgebookmarks.d.ts +35 -0
- package/models/operations/accountv1getbadgebookmarks.d.ts.map +1 -0
- package/models/operations/accountv1getbadgebookmarks.js +75 -0
- package/models/operations/accountv1getbadgebookmarks.js.map +1 -0
- package/models/operations/accountv1imagesdelete.d.ts +35 -0
- package/models/operations/accountv1imagesdelete.d.ts.map +1 -0
- package/models/operations/{accountv1settingsdeleteimages.js → accountv1imagesdelete.js} +17 -17
- package/models/operations/accountv1imagesdelete.js.map +1 -0
- package/models/operations/accountv1imagesget.d.ts +35 -0
- package/models/operations/accountv1imagesget.d.ts.map +1 -0
- package/models/operations/{badgev1bookmark.js → accountv1imagesget.js} +23 -23
- package/models/operations/accountv1imagesget.js.map +1 -0
- package/models/operations/accountv1imagesupdate.d.ts +35 -0
- package/models/operations/accountv1imagesupdate.d.ts.map +1 -0
- package/models/operations/{accountv1settingsupdateimage.js → accountv1imagesupdate.js} +17 -17
- package/models/operations/accountv1imagesupdate.js.map +1 -0
- package/models/operations/accountv1imagesupload.d.ts +35 -0
- package/models/operations/accountv1imagesupload.d.ts.map +1 -0
- package/models/operations/{accountv1settingsuploadimages.js → accountv1imagesupload.js} +17 -17
- package/models/operations/accountv1imagesupload.js.map +1 -0
- package/models/operations/adminv1getaccount.d.ts +35 -0
- package/models/operations/adminv1getaccount.d.ts.map +1 -0
- package/models/operations/{badgev1getbookmarks.js → adminv1getaccount.js} +23 -23
- package/models/operations/adminv1getaccount.js.map +1 -0
- package/models/operations/index.d.ts +7 -5
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +7 -5
- package/models/operations/index.js.map +1 -1
- package/package.json +1 -1
- package/sdk/account.d.ts +5 -3
- package/sdk/account.d.ts.map +1 -1
- package/sdk/account.js +11 -3
- package/sdk/account.js.map +1 -1
- package/sdk/admin.d.ts +3 -2
- package/sdk/admin.d.ts.map +1 -1
- package/sdk/admin.js +8 -4
- package/sdk/admin.js.map +1 -1
- package/sdk/badge.d.ts +2 -2
- package/sdk/badge.d.ts.map +1 -1
- package/sdk/badge.js +6 -6
- package/sdk/badge.js.map +1 -1
- package/sdk/images.d.ts +10 -0
- package/sdk/images.d.ts.map +1 -0
- package/sdk/images.js +28 -0
- package/sdk/images.js.map +1 -0
- package/sdk/sdk.d.ts +7 -4
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +11 -6
- package/sdk/sdk.js.map +1 -1
- package/sdk/settings.d.ts +0 -3
- package/sdk/settings.d.ts.map +1 -1
- package/sdk/settings.js +0 -12
- package/sdk/settings.js.map +1 -1
- package/src/funcs/accountAccountV1GetBadgeBookmarks.ts +127 -0
- package/src/funcs/accountAccountV1ImagesGet.ts +124 -0
- package/src/funcs/{accountUpdateImage.ts → accountAccountV1ImagesUpdate.ts} +9 -9
- package/src/funcs/accountDeleteImages.ts +9 -11
- package/src/funcs/accountGetApps.ts +3 -3
- package/src/funcs/accountGetBadges.ts +3 -3
- package/src/funcs/accountGetDataPoints.ts +3 -3
- package/src/funcs/accountGetFriends.ts +3 -3
- package/src/funcs/accountGetInfo.ts +3 -3
- package/src/funcs/accountGetLeaderboardHistory.ts +3 -3
- package/src/funcs/accountGetStaff.ts +3 -3
- package/src/funcs/accountSendEmailVerification.ts +3 -3
- package/src/funcs/accountUploadImages.ts +9 -11
- package/src/funcs/accountVerifyEmail.ts +3 -3
- package/src/funcs/accountsQueue.ts +3 -3
- package/src/funcs/adminAdminV1GetEvents.ts +124 -0
- package/src/funcs/adminAdminV1UpdateEvent.ts +23 -5
- package/src/funcs/adminAdminV1UpdateResources.ts +3 -3
- package/src/funcs/adminAdminV1UpdateRoles.ts +3 -3
- package/src/funcs/adminGetAccount.ts +27 -10
- package/src/funcs/{badgeBadgeV1Bookmark.ts → badgeAccountV1BookmarkBadge.ts} +12 -12
- package/src/funcs/{badgeBadgeV1GetBookmarks.ts → badgeAccountV1GetBadgeBookmarks.ts} +11 -11
- package/src/funcs/badgeGetTags.ts +3 -3
- package/src/funcs/badgesTag.ts +3 -3
- package/src/funcs/connectionDelete.ts +3 -3
- package/src/funcs/connectionUpdate.ts +3 -3
- package/src/funcs/connectionVerify.ts +3 -3
- package/src/funcs/connectionsConnect.ts +3 -3
- package/src/funcs/dataGetApps.ts +3 -3
- package/src/funcs/dataGetBadges.ts +3 -3
- package/src/funcs/dataGetDataPoints.ts +3 -3
- package/src/funcs/dataGetFriends.ts +3 -3
- package/src/funcs/dataGetInfo.ts +3 -3
- package/src/funcs/dataGetLeaderboardHistory.ts +3 -3
- package/src/funcs/dataGetStaff.ts +3 -3
- package/src/funcs/developerCreateDeveloperApp.ts +3 -3
- package/src/funcs/developerDeleteDeveloperApp.ts +3 -3
- package/src/funcs/developerUpdateApp.ts +3 -3
- package/src/funcs/imagesAccountV1ImagesGet.ts +124 -0
- package/src/funcs/{settingsUpdateImage.ts → imagesAccountV1ImagesUpdate.ts} +9 -9
- package/src/funcs/{settingsDeleteImages.ts → imagesDeleteImages.ts} +10 -12
- package/src/funcs/{settingsUploadImages.ts → imagesUploadImages.ts} +10 -12
- package/src/funcs/leaderboardGetAccount.ts +3 -3
- package/src/funcs/leaderboardGetBadges.ts +3 -3
- package/src/funcs/leaderboardGetGroup.ts +3 -3
- package/src/funcs/livenessCheck.ts +3 -3
- package/src/funcs/locationsGet.ts +3 -3
- package/src/funcs/metaAccountV1GetEmbed.ts +3 -3
- package/src/funcs/metaAccountV1GetMeta.ts +3 -3
- package/src/funcs/publicGetApps.ts +3 -3
- package/src/funcs/publicGetBadges.ts +3 -3
- package/src/funcs/publicGetDataPoints.ts +3 -3
- package/src/funcs/publicGetFriends.ts +3 -3
- package/src/funcs/publicGetInfo.ts +3 -3
- package/src/funcs/publicGetLeaderboardHistory.ts +3 -3
- package/src/funcs/sessionCreate.ts +3 -3
- package/src/funcs/sessionLogin.ts +3 -3
- package/src/funcs/sessionsDelete.ts +3 -3
- package/src/funcs/sessionsGet.ts +3 -3
- package/src/funcs/settingsGet.ts +3 -3
- package/src/funcs/settingsSendEmailVerification.ts +3 -3
- package/src/funcs/settingsUpdate.ts +3 -3
- package/src/funcs/settingsVerifyEmail.ts +3 -3
- package/src/hooks/hooks.ts +20 -0
- package/src/hooks/types.ts +7 -0
- package/src/lib/config.ts +3 -3
- package/src/lib/primitives.ts +62 -0
- package/src/models/components/index.ts +12 -6
- package/src/models/components/v1accountbadgebookmark.ts +78 -0
- package/src/models/components/v1accountbadgebookmarkrequestbody.ts +79 -0
- package/src/models/components/v1accountbadgebookmarkresponsebody.ts +82 -0
- package/src/models/components/v1accountbadgebookmarksrequestbody.ts +62 -0
- package/src/models/components/v1accountbadgebookmarksresponsebody.ts +93 -0
- package/src/models/components/v1accountlocationupdate.ts +104 -0
- package/src/models/components/v1accountnameupdate.ts +76 -0
- package/src/models/components/v1admingetaccountresponsebody.ts +261 -0
- package/src/models/components/v1adminupdateeventrequestbody.ts +84 -0
- package/src/models/components/v1appeventmapping.ts +76 -0
- package/src/models/components/v1event.ts +13 -0
- package/src/models/components/v1getimagesresponsebody.ts +91 -0
- package/src/models/components/v1getsettingsbody.ts +2 -13
- package/src/models/components/v1updateimage.ts +72 -0
- package/src/models/components/v1updateimagerequestbody.ts +11 -12
- package/src/models/components/v1updateimageresponsebody.ts +0 -7
- package/src/models/components/v1updatesettingsrequestbody.ts +0 -13
- package/src/models/operations/accountv1bookmarkbadge.ts +93 -0
- package/src/models/operations/accountv1getbadgebookmarks.ts +96 -0
- package/src/models/operations/{accountv1settingsdeleteimages.ts → accountv1imagesdelete.ts} +22 -25
- package/src/models/operations/accountv1imagesget.ts +89 -0
- package/src/models/operations/{accountv1settingsupdateimage.ts → accountv1imagesupdate.ts} +22 -25
- package/src/models/operations/{accountv1settingsuploadimages.ts → accountv1imagesupload.ts} +22 -25
- package/src/models/operations/adminv1getaccount.ts +91 -0
- package/src/models/operations/index.ts +7 -5
- package/src/sdk/account.ts +28 -6
- package/src/sdk/admin.ts +15 -1
- package/src/sdk/badge.ts +10 -10
- package/src/sdk/images.ts +56 -0
- package/src/sdk/sdk.ts +14 -8
- package/src/sdk/settings.ts +0 -36
- package/src/types/operations.ts +11 -5
- package/types/operations.d.ts +5 -3
- package/types/operations.d.ts.map +1 -1
- package/types/operations.js +3 -0
- package/types/operations.js.map +1 -1
- package/funcs/accountUpdateImage.js.map +0 -1
- package/funcs/badgeBadgeV1Bookmark.d.ts.map +0 -1
- package/funcs/badgeBadgeV1Bookmark.js.map +0 -1
- package/funcs/badgeBadgeV1GetBookmarks.d.ts.map +0 -1
- package/funcs/badgeBadgeV1GetBookmarks.js.map +0 -1
- package/funcs/settingsDeleteImages.d.ts.map +0 -1
- package/funcs/settingsDeleteImages.js.map +0 -1
- package/funcs/settingsUpdateImage.d.ts.map +0 -1
- package/funcs/settingsUpdateImage.js.map +0 -1
- package/funcs/settingsUploadImages.d.ts +0 -11
- package/funcs/settingsUploadImages.d.ts.map +0 -1
- package/funcs/settingsUploadImages.js.map +0 -1
- package/models/components/emailnotification.d.ts +0 -66
- package/models/components/emailnotification.d.ts.map +0 -1
- package/models/components/emailnotification.js +0 -82
- package/models/components/emailnotification.js.map +0 -1
- package/models/components/v1badgebookmark.d.ts +0 -37
- package/models/components/v1badgebookmark.d.ts.map +0 -1
- package/models/components/v1badgebookmark.js.map +0 -1
- package/models/components/v1badgebookmarkrequestbody.d.ts +0 -37
- package/models/components/v1badgebookmarkrequestbody.d.ts.map +0 -1
- package/models/components/v1badgebookmarkrequestbody.js.map +0 -1
- package/models/components/v1badgebookmarkresponsebody.d.ts +0 -32
- package/models/components/v1badgebookmarkresponsebody.d.ts.map +0 -1
- package/models/components/v1badgebookmarkresponsebody.js.map +0 -1
- package/models/components/v1getbadgebookmarksrequestbody.d.ts +0 -25
- package/models/components/v1getbadgebookmarksrequestbody.d.ts.map +0 -1
- package/models/components/v1getbadgebookmarksrequestbody.js.map +0 -1
- package/models/components/v1getbadgebookmarksresponsebody.d.ts +0 -35
- package/models/components/v1getbadgebookmarksresponsebody.d.ts.map +0 -1
- package/models/components/v1getbadgebookmarksresponsebody.js.map +0 -1
- package/models/operations/accountv1settingsdeleteimages.d.ts +0 -35
- package/models/operations/accountv1settingsdeleteimages.d.ts.map +0 -1
- package/models/operations/accountv1settingsdeleteimages.js.map +0 -1
- package/models/operations/accountv1settingsupdateimage.d.ts +0 -35
- package/models/operations/accountv1settingsupdateimage.d.ts.map +0 -1
- package/models/operations/accountv1settingsupdateimage.js.map +0 -1
- package/models/operations/accountv1settingsuploadimages.d.ts +0 -35
- package/models/operations/accountv1settingsuploadimages.d.ts.map +0 -1
- package/models/operations/accountv1settingsuploadimages.js.map +0 -1
- package/models/operations/badgev1bookmark.d.ts +0 -35
- package/models/operations/badgev1bookmark.d.ts.map +0 -1
- package/models/operations/badgev1bookmark.js.map +0 -1
- package/models/operations/badgev1getbookmarks.d.ts +0 -35
- package/models/operations/badgev1getbookmarks.d.ts.map +0 -1
- package/models/operations/badgev1getbookmarks.js.map +0 -1
- package/src/models/components/emailnotification.ts +0 -109
- package/src/models/components/v1badgebookmark.ts +0 -76
- package/src/models/components/v1badgebookmarkrequestbody.ts +0 -76
- package/src/models/components/v1badgebookmarkresponsebody.ts +0 -80
- package/src/models/components/v1getbadgebookmarksrequestbody.ts +0 -60
- package/src/models/components/v1getbadgebookmarksresponsebody.ts +0 -90
- package/src/models/operations/badgev1bookmark.ts +0 -91
- package/src/models/operations/badgev1getbookmarks.ts +0 -93
package/FUNCTIONS.md
ADDED
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
# Standalone Functions
|
|
2
|
+
|
|
3
|
+
> [!NOTE]
|
|
4
|
+
> This section is useful if you are using a bundler and targetting browsers and
|
|
5
|
+
> runtimes where the size of an application affects performance and load times.
|
|
6
|
+
|
|
7
|
+
Every method in this SDK is also available as a standalone function. This
|
|
8
|
+
alternative API is suitable when targetting the browser or serverless runtimes
|
|
9
|
+
and using a bundler to build your application since all unused functionality
|
|
10
|
+
will be tree-shaken away. This includes code for unused methods, Zod schemas,
|
|
11
|
+
encoding helpers and response handlers. The result is dramatically smaller
|
|
12
|
+
impact on the application's final bundle size which grows very slowly as you use
|
|
13
|
+
more and more functionality from this SDK.
|
|
14
|
+
|
|
15
|
+
Calling methods through the main SDK class remains a valid and generally more
|
|
16
|
+
more ergonomic option. Standalone functions represent an optimisation for a
|
|
17
|
+
specific category of applications.
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
23
|
+
import { badgeAccountV1BookmarkBadge } from "@steamsets/client-ts/funcs/badgeAccountV1BookmarkBadge.js";
|
|
24
|
+
import { SDKValidationError } from "@steamsets/client-ts/models/errors/sdkvalidationerror.js";
|
|
25
|
+
|
|
26
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
27
|
+
// You can create one instance of it to use across an application.
|
|
28
|
+
const steamSets = new SteamSetsCore({
|
|
29
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
30
|
+
});
|
|
31
|
+
|
|
32
|
+
async function run() {
|
|
33
|
+
const res = await badgeAccountV1BookmarkBadge(steamSets, {
|
|
34
|
+
badgeId: "bdg_123",
|
|
35
|
+
bookmark: true,
|
|
36
|
+
});
|
|
37
|
+
|
|
38
|
+
switch (true) {
|
|
39
|
+
case res.ok:
|
|
40
|
+
// The success case will be handled outside of the switch block
|
|
41
|
+
break;
|
|
42
|
+
case res.error instanceof SDKValidationError:
|
|
43
|
+
// Pretty-print validation errors.
|
|
44
|
+
return console.log(res.error.pretty());
|
|
45
|
+
case res.error instanceof Error:
|
|
46
|
+
return console.log(res.error);
|
|
47
|
+
default:
|
|
48
|
+
// TypeScript's type checking will fail on the following line if the above
|
|
49
|
+
// cases were not exhaustive.
|
|
50
|
+
res.error satisfies never;
|
|
51
|
+
throw new Error("Assertion failed: expected error checks to be exhaustive: " + res.error);
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
const { value: result } = res;
|
|
56
|
+
|
|
57
|
+
// Handle the result
|
|
58
|
+
console.log(result);
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
run();
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## Result types
|
|
65
|
+
|
|
66
|
+
Standalone functions differ from SDK methods in that they return a
|
|
67
|
+
`Result<Value, Error>` type to capture _known errors_ and document them using
|
|
68
|
+
the type system. By avoiding throwing errors, application code maintains clear
|
|
69
|
+
control flow and error-handling become part of the regular flow of application
|
|
70
|
+
code.
|
|
71
|
+
|
|
72
|
+
> We use the term "known errors" because standalone functions, and JavaScript
|
|
73
|
+
> code in general, can still throw unexpected errors such as `TypeError`s,
|
|
74
|
+
> `RangeError`s and `DOMException`s. Exhaustively catching all errors may be
|
|
75
|
+
> something this SDK addresses in the future. Nevertheless, there is still a lot
|
|
76
|
+
> of benefit from capturing most errors and turning them into values.
|
|
77
|
+
|
|
78
|
+
The second reason for this style of programming is because these functions will
|
|
79
|
+
typically be used in front-end applications where exception throwing is
|
|
80
|
+
sometimes discouraged or considered unidiomatic. React and similar ecosystems
|
|
81
|
+
and libraries tend to promote this style of programming so that components
|
|
82
|
+
render useful content under all states (loading, success, error and so on).
|
|
83
|
+
|
|
84
|
+
The general pattern when calling standalone functions looks like this:
|
|
85
|
+
|
|
86
|
+
```typescript
|
|
87
|
+
import { Core } from "<sdk-package-name>";
|
|
88
|
+
import { fetchSomething } from "<sdk-package-name>/funcs/fetchSomething.js";
|
|
89
|
+
|
|
90
|
+
const client = new Core();
|
|
91
|
+
|
|
92
|
+
async function run() {
|
|
93
|
+
const result = await fetchSomething(client, { id: "123" });
|
|
94
|
+
if (!result.ok) {
|
|
95
|
+
// You can throw the error or handle it. It's your choice now.
|
|
96
|
+
throw result.error;
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
console.log(result.value);
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
run();
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
Notably, `result.error` above will have an explicit type compared to a try-catch
|
|
106
|
+
variation where the error in the catch block can only be of type `unknown` (or
|
|
107
|
+
`any` depending on your TypeScript settings).
|
package/README.md
CHANGED
|
@@ -53,9 +53,9 @@ const steamSets = new SteamSets({
|
|
|
53
53
|
});
|
|
54
54
|
|
|
55
55
|
async function run() {
|
|
56
|
-
const result = await steamSets.
|
|
57
|
-
|
|
58
|
-
|
|
56
|
+
const result = await steamSets.badge.accountV1BookmarkBadge({
|
|
57
|
+
badgeId: "bdg_123",
|
|
58
|
+
bookmark: true,
|
|
59
59
|
});
|
|
60
60
|
|
|
61
61
|
// Handle the result
|
|
@@ -77,14 +77,16 @@ run();
|
|
|
77
77
|
|
|
78
78
|
* [deleteImages](docs/sdks/account/README.md#deleteimages)
|
|
79
79
|
* [getApps](docs/sdks/account/README.md#getapps)
|
|
80
|
+
* [accountV1GetBadgeBookmarks](docs/sdks/account/README.md#accountv1getbadgebookmarks)
|
|
80
81
|
* [getBadges](docs/sdks/account/README.md#getbadges)
|
|
81
82
|
* [getDataPoints](docs/sdks/account/README.md#getdatapoints)
|
|
82
83
|
* [getFriends](docs/sdks/account/README.md#getfriends)
|
|
84
|
+
* [accountV1ImagesGet](docs/sdks/account/README.md#accountv1imagesget)
|
|
83
85
|
* [getInfo](docs/sdks/account/README.md#getinfo)
|
|
84
86
|
* [getLeaderboardHistory](docs/sdks/account/README.md#getleaderboardhistory)
|
|
85
87
|
* [getStaff](docs/sdks/account/README.md#getstaff)
|
|
86
88
|
* [sendEmailVerification](docs/sdks/account/README.md#sendemailverification)
|
|
87
|
-
* [
|
|
89
|
+
* [accountV1ImagesUpdate](docs/sdks/account/README.md#accountv1imagesupdate)
|
|
88
90
|
* [uploadImages](docs/sdks/account/README.md#uploadimages)
|
|
89
91
|
* [verifyEmail](docs/sdks/account/README.md#verifyemail)
|
|
90
92
|
|
|
@@ -95,14 +97,15 @@ run();
|
|
|
95
97
|
### [admin](docs/sdks/admin/README.md)
|
|
96
98
|
|
|
97
99
|
* [getAccount](docs/sdks/admin/README.md#getaccount)
|
|
100
|
+
* [adminV1GetEvents](docs/sdks/admin/README.md#adminv1getevents)
|
|
98
101
|
* [adminV1UpdateEvent](docs/sdks/admin/README.md#adminv1updateevent)
|
|
99
102
|
* [adminV1UpdateResources](docs/sdks/admin/README.md#adminv1updateresources)
|
|
100
103
|
* [adminV1UpdateRoles](docs/sdks/admin/README.md#adminv1updateroles)
|
|
101
104
|
|
|
102
105
|
### [badge](docs/sdks/badge/README.md)
|
|
103
106
|
|
|
104
|
-
* [
|
|
105
|
-
* [
|
|
107
|
+
* [accountV1BookmarkBadge](docs/sdks/badge/README.md#accountv1bookmarkbadge)
|
|
108
|
+
* [accountV1GetBadgeBookmarks](docs/sdks/badge/README.md#accountv1getbadgebookmarks)
|
|
106
109
|
* [getTags](docs/sdks/badge/README.md#gettags)
|
|
107
110
|
|
|
108
111
|
### [badges](docs/sdks/badges/README.md)
|
|
@@ -135,6 +138,13 @@ run();
|
|
|
135
138
|
* [deleteDeveloperApp](docs/sdks/developer/README.md#deletedeveloperapp)
|
|
136
139
|
* [updateApp](docs/sdks/developer/README.md#updateapp)
|
|
137
140
|
|
|
141
|
+
### [images](docs/sdks/images/README.md)
|
|
142
|
+
|
|
143
|
+
* [deleteImages](docs/sdks/images/README.md#deleteimages)
|
|
144
|
+
* [accountV1ImagesGet](docs/sdks/images/README.md#accountv1imagesget)
|
|
145
|
+
* [accountV1ImagesUpdate](docs/sdks/images/README.md#accountv1imagesupdate)
|
|
146
|
+
* [uploadImages](docs/sdks/images/README.md#uploadimages)
|
|
147
|
+
|
|
138
148
|
### [leaderboard](docs/sdks/leaderboard/README.md)
|
|
139
149
|
|
|
140
150
|
* [getAccount](docs/sdks/leaderboard/README.md#getaccount)
|
|
@@ -175,12 +185,9 @@ run();
|
|
|
175
185
|
|
|
176
186
|
### [settings](docs/sdks/settings/README.md)
|
|
177
187
|
|
|
178
|
-
* [deleteImages](docs/sdks/settings/README.md#deleteimages)
|
|
179
188
|
* [get](docs/sdks/settings/README.md#get)
|
|
180
189
|
* [sendEmailVerification](docs/sdks/settings/README.md#sendemailverification)
|
|
181
|
-
* [updateImage](docs/sdks/settings/README.md#updateimage)
|
|
182
190
|
* [update](docs/sdks/settings/README.md#update)
|
|
183
|
-
* [uploadImages](docs/sdks/settings/README.md#uploadimages)
|
|
184
191
|
* [verifyEmail](docs/sdks/settings/README.md#verifyemail)
|
|
185
192
|
|
|
186
193
|
|
|
@@ -201,9 +208,9 @@ const steamSets = new SteamSets({
|
|
|
201
208
|
});
|
|
202
209
|
|
|
203
210
|
async function run() {
|
|
204
|
-
const result = await steamSets.
|
|
205
|
-
|
|
206
|
-
|
|
211
|
+
const result = await steamSets.badge.accountV1BookmarkBadge({
|
|
212
|
+
badgeId: "bdg_123",
|
|
213
|
+
bookmark: true,
|
|
207
214
|
}, {
|
|
208
215
|
retries: {
|
|
209
216
|
strategy: "backoff",
|
|
@@ -244,9 +251,9 @@ const steamSets = new SteamSets({
|
|
|
244
251
|
});
|
|
245
252
|
|
|
246
253
|
async function run() {
|
|
247
|
-
const result = await steamSets.
|
|
248
|
-
|
|
249
|
-
|
|
254
|
+
const result = await steamSets.badge.accountV1BookmarkBadge({
|
|
255
|
+
badgeId: "bdg_123",
|
|
256
|
+
bookmark: true,
|
|
250
257
|
});
|
|
251
258
|
|
|
252
259
|
// Handle the result
|
|
@@ -273,12 +280,12 @@ If a HTTP request fails, an operation my also throw an error from the `models/er
|
|
|
273
280
|
| InvalidRequestError | Any input used to create a request is invalid |
|
|
274
281
|
| UnexpectedClientError | Unrecognised or unexpected error |
|
|
275
282
|
|
|
276
|
-
In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective *Errors* tables in SDK docs for more details on possible error types for each operation. For example, the `
|
|
283
|
+
In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective *Errors* tables in SDK docs for more details on possible error types for each operation. For example, the `accountV1BookmarkBadge` method may throw the following errors:
|
|
277
284
|
|
|
278
|
-
| Error Type | Status Code
|
|
279
|
-
| ----------------- |
|
|
280
|
-
| errors.ErrorModel |
|
|
281
|
-
| errors.SDKError | 4XX, 5XX
|
|
285
|
+
| Error Type | Status Code | Content Type |
|
|
286
|
+
| ----------------- | ------------------ | ------------------------ |
|
|
287
|
+
| errors.ErrorModel | 403, 404, 422, 500 | application/problem+json |
|
|
288
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
282
289
|
|
|
283
290
|
```typescript
|
|
284
291
|
import { SteamSets } from "@steamsets/client-ts";
|
|
@@ -294,9 +301,9 @@ const steamSets = new SteamSets({
|
|
|
294
301
|
async function run() {
|
|
295
302
|
let result;
|
|
296
303
|
try {
|
|
297
|
-
result = await steamSets.
|
|
298
|
-
|
|
299
|
-
|
|
304
|
+
result = await steamSets.badge.accountV1BookmarkBadge({
|
|
305
|
+
badgeId: "bdg_123",
|
|
306
|
+
bookmark: true,
|
|
300
307
|
});
|
|
301
308
|
|
|
302
309
|
// Handle the result
|
|
@@ -352,9 +359,9 @@ const steamSets = new SteamSets({
|
|
|
352
359
|
});
|
|
353
360
|
|
|
354
361
|
async function run() {
|
|
355
|
-
const result = await steamSets.
|
|
356
|
-
|
|
357
|
-
|
|
362
|
+
const result = await steamSets.badge.accountV1BookmarkBadge({
|
|
363
|
+
badgeId: "bdg_123",
|
|
364
|
+
bookmark: true,
|
|
358
365
|
});
|
|
359
366
|
|
|
360
367
|
// Handle the result
|
|
@@ -377,9 +384,9 @@ const steamSets = new SteamSets({
|
|
|
377
384
|
});
|
|
378
385
|
|
|
379
386
|
async function run() {
|
|
380
|
-
const result = await steamSets.
|
|
381
|
-
|
|
382
|
-
|
|
387
|
+
const result = await steamSets.badge.accountV1BookmarkBadge({
|
|
388
|
+
badgeId: "bdg_123",
|
|
389
|
+
bookmark: true,
|
|
383
390
|
});
|
|
384
391
|
|
|
385
392
|
// Handle the result
|
|
@@ -460,9 +467,9 @@ const steamSets = new SteamSets({
|
|
|
460
467
|
});
|
|
461
468
|
|
|
462
469
|
async function run() {
|
|
463
|
-
const result = await steamSets.
|
|
464
|
-
|
|
465
|
-
|
|
470
|
+
const result = await steamSets.badge.accountV1BookmarkBadge({
|
|
471
|
+
badgeId: "bdg_123",
|
|
472
|
+
bookmark: true,
|
|
466
473
|
});
|
|
467
474
|
|
|
468
475
|
// Handle the result
|
|
@@ -534,6 +541,9 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
534
541
|
|
|
535
542
|
<summary>Available standalone functions</summary>
|
|
536
543
|
|
|
544
|
+
- [`accountAccountV1GetBadgeBookmarks`](docs/sdks/account/README.md#accountv1getbadgebookmarks)
|
|
545
|
+
- [`accountAccountV1ImagesGet`](docs/sdks/account/README.md#accountv1imagesget)
|
|
546
|
+
- [`accountAccountV1ImagesUpdate`](docs/sdks/account/README.md#accountv1imagesupdate)
|
|
537
547
|
- [`accountDeleteImages`](docs/sdks/account/README.md#deleteimages)
|
|
538
548
|
- [`accountGetApps`](docs/sdks/account/README.md#getapps)
|
|
539
549
|
- [`accountGetBadges`](docs/sdks/account/README.md#getbadges)
|
|
@@ -544,15 +554,15 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
544
554
|
- [`accountGetStaff`](docs/sdks/account/README.md#getstaff)
|
|
545
555
|
- [`accountSendEmailVerification`](docs/sdks/account/README.md#sendemailverification)
|
|
546
556
|
- [`accountsQueue`](docs/sdks/accounts/README.md#queue)
|
|
547
|
-
- [`accountUpdateImage`](docs/sdks/account/README.md#updateimage)
|
|
548
557
|
- [`accountUploadImages`](docs/sdks/account/README.md#uploadimages)
|
|
549
558
|
- [`accountVerifyEmail`](docs/sdks/account/README.md#verifyemail)
|
|
559
|
+
- [`adminAdminV1GetEvents`](docs/sdks/admin/README.md#adminv1getevents)
|
|
550
560
|
- [`adminAdminV1UpdateEvent`](docs/sdks/admin/README.md#adminv1updateevent)
|
|
551
561
|
- [`adminAdminV1UpdateResources`](docs/sdks/admin/README.md#adminv1updateresources)
|
|
552
562
|
- [`adminAdminV1UpdateRoles`](docs/sdks/admin/README.md#adminv1updateroles)
|
|
553
563
|
- [`adminGetAccount`](docs/sdks/admin/README.md#getaccount)
|
|
554
|
-
- [`
|
|
555
|
-
- [`
|
|
564
|
+
- [`badgeAccountV1BookmarkBadge`](docs/sdks/badge/README.md#accountv1bookmarkbadge)
|
|
565
|
+
- [`badgeAccountV1GetBadgeBookmarks`](docs/sdks/badge/README.md#accountv1getbadgebookmarks)
|
|
556
566
|
- [`badgeGetTags`](docs/sdks/badge/README.md#gettags)
|
|
557
567
|
- [`badgesTag`](docs/sdks/badges/README.md#tag)
|
|
558
568
|
- [`connectionDelete`](docs/sdks/connection/README.md#delete)
|
|
@@ -569,6 +579,10 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
569
579
|
- [`developerCreateDeveloperApp`](docs/sdks/developer/README.md#createdeveloperapp)
|
|
570
580
|
- [`developerDeleteDeveloperApp`](docs/sdks/developer/README.md#deletedeveloperapp)
|
|
571
581
|
- [`developerUpdateApp`](docs/sdks/developer/README.md#updateapp)
|
|
582
|
+
- [`imagesAccountV1ImagesGet`](docs/sdks/images/README.md#accountv1imagesget)
|
|
583
|
+
- [`imagesAccountV1ImagesUpdate`](docs/sdks/images/README.md#accountv1imagesupdate)
|
|
584
|
+
- [`imagesDeleteImages`](docs/sdks/images/README.md#deleteimages)
|
|
585
|
+
- [`imagesUploadImages`](docs/sdks/images/README.md#uploadimages)
|
|
572
586
|
- [`leaderboardGetAccount`](docs/sdks/leaderboard/README.md#getaccount)
|
|
573
587
|
- [`leaderboardGetBadges`](docs/sdks/leaderboard/README.md#getbadges)
|
|
574
588
|
- [`leaderboardGetGroup`](docs/sdks/leaderboard/README.md#getgroup)
|
|
@@ -586,12 +600,9 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
586
600
|
- [`sessionLogin`](docs/sdks/session/README.md#login)
|
|
587
601
|
- [`sessionsDelete`](docs/sdks/sessions/README.md#delete)
|
|
588
602
|
- [`sessionsGet`](docs/sdks/sessions/README.md#get)
|
|
589
|
-
- [`settingsDeleteImages`](docs/sdks/settings/README.md#deleteimages)
|
|
590
603
|
- [`settingsGet`](docs/sdks/settings/README.md#get)
|
|
591
604
|
- [`settingsSendEmailVerification`](docs/sdks/settings/README.md#sendemailverification)
|
|
592
605
|
- [`settingsUpdate`](docs/sdks/settings/README.md#update)
|
|
593
|
-
- [`settingsUpdateImage`](docs/sdks/settings/README.md#updateimage)
|
|
594
|
-
- [`settingsUploadImages`](docs/sdks/settings/README.md#uploadimages)
|
|
595
606
|
- [`settingsVerifyEmail`](docs/sdks/settings/README.md#verifyemail)
|
|
596
607
|
|
|
597
608
|
</details>
|
|
@@ -622,18 +633,25 @@ const sdk = new SteamSets({ debugLogger: console });
|
|
|
622
633
|
|
|
623
634
|
<!-- Start Table of Contents [toc] -->
|
|
624
635
|
## Table of Contents
|
|
636
|
+
<!-- $toc-max-depth=2 -->
|
|
637
|
+
* [openapi](#openapi)
|
|
638
|
+
* [SDK Installation](#sdk-installation)
|
|
639
|
+
* [SDK Example Usage](#sdk-example-usage)
|
|
640
|
+
* [Available Resources and Operations](#available-resources-and-operations)
|
|
641
|
+
* [Retries](#retries)
|
|
642
|
+
* [Error Handling](#error-handling)
|
|
643
|
+
* [Server Selection](#server-selection)
|
|
644
|
+
* [Custom HTTP Client](#custom-http-client)
|
|
645
|
+
* [Authentication](#authentication)
|
|
646
|
+
* [Special Types](#special-types)
|
|
647
|
+
* [SDK Installation](#sdk-installation-1)
|
|
648
|
+
* [Requirements](#requirements)
|
|
649
|
+
* [Standalone functions](#standalone-functions)
|
|
650
|
+
* [Debugging](#debugging)
|
|
651
|
+
* [Development](#development)
|
|
652
|
+
* [Maturity](#maturity)
|
|
653
|
+
* [Contributions](#contributions)
|
|
625
654
|
|
|
626
|
-
* [SDK Installation](#sdk-installation)
|
|
627
|
-
* [Requirements](#requirements)
|
|
628
|
-
* [SDK Example Usage](#sdk-example-usage)
|
|
629
|
-
* [Available Resources and Operations](#available-resources-and-operations)
|
|
630
|
-
* [Standalone functions](#standalone-functions)
|
|
631
|
-
* [Retries](#retries)
|
|
632
|
-
* [Error Handling](#error-handling)
|
|
633
|
-
* [Server Selection](#server-selection)
|
|
634
|
-
* [Custom HTTP Client](#custom-http-client)
|
|
635
|
-
* [Authentication](#authentication)
|
|
636
|
-
* [Debugging](#debugging)
|
|
637
655
|
<!-- End Table of Contents [toc] -->
|
|
638
656
|
|
|
639
657
|
<!-- Placeholder for Future Speakeasy SDK Sections -->
|
package/RUNTIMES.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Supported JavaScript runtimes
|
|
2
|
+
|
|
3
|
+
This SDK is intended to be used in JavaScript runtimes that support the following features:
|
|
4
|
+
|
|
5
|
+
* [Web Fetch API][web-fetch]
|
|
6
|
+
* [Web Streams API][web-streams] and in particular `ReadableStream`
|
|
7
|
+
* [Async iterables][async-iter] using `Symbol.asyncIterator`
|
|
8
|
+
|
|
9
|
+
[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
|
|
10
|
+
[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
|
|
11
|
+
[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols
|
|
12
|
+
|
|
13
|
+
Runtime environments that are explicitly supported are:
|
|
14
|
+
|
|
15
|
+
- Evergreen browsers which include: Chrome, Safari, Edge, Firefox
|
|
16
|
+
- Node.js active and maintenance LTS releases
|
|
17
|
+
- Currently, this is v18 and v20
|
|
18
|
+
- Bun v1 and above
|
|
19
|
+
- Deno v1.39
|
|
20
|
+
- Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
|
|
21
|
+
|
|
22
|
+
[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
|
|
@@ -9,14 +9,16 @@ Account related operations
|
|
|
9
9
|
|
|
10
10
|
* [deleteImages](#deleteimages)
|
|
11
11
|
* [getApps](#getapps)
|
|
12
|
+
* [accountV1GetBadgeBookmarks](#accountv1getbadgebookmarks)
|
|
12
13
|
* [getBadges](#getbadges)
|
|
13
14
|
* [getDataPoints](#getdatapoints)
|
|
14
15
|
* [getFriends](#getfriends)
|
|
16
|
+
* [accountV1ImagesGet](#accountv1imagesget)
|
|
15
17
|
* [getInfo](#getinfo)
|
|
16
18
|
* [getLeaderboardHistory](#getleaderboardhistory)
|
|
17
19
|
* [getStaff](#getstaff)
|
|
18
20
|
* [sendEmailVerification](#sendemailverification)
|
|
19
|
-
* [
|
|
21
|
+
* [accountV1ImagesUpdate](#accountv1imagesupdate)
|
|
20
22
|
* [uploadImages](#uploadimages)
|
|
21
23
|
* [verifyEmail](#verifyemail)
|
|
22
24
|
|
|
@@ -35,6 +37,7 @@ async function run() {
|
|
|
35
37
|
const result = await steamSets.account.deleteImages({
|
|
36
38
|
imageIds: [
|
|
37
39
|
"<value>",
|
|
40
|
+
"<value>",
|
|
38
41
|
],
|
|
39
42
|
});
|
|
40
43
|
|
|
@@ -63,6 +66,7 @@ async function run() {
|
|
|
63
66
|
const res = await accountDeleteImages(steamSets, {
|
|
64
67
|
imageIds: [
|
|
65
68
|
"<value>",
|
|
69
|
+
"<value>",
|
|
66
70
|
],
|
|
67
71
|
});
|
|
68
72
|
|
|
@@ -90,7 +94,7 @@ run();
|
|
|
90
94
|
|
|
91
95
|
### Response
|
|
92
96
|
|
|
93
|
-
**Promise\<[operations.
|
|
97
|
+
**Promise\<[operations.AccountV1ImagesDeleteResponse](../../models/operations/accountv1imagesdeleteresponse.md)\>**
|
|
94
98
|
|
|
95
99
|
### Errors
|
|
96
100
|
|
|
@@ -170,6 +174,77 @@ run();
|
|
|
170
174
|
| errors.ErrorModel | 400, 403, 404, 422, 500 | application/problem+json |
|
|
171
175
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
172
176
|
|
|
177
|
+
## accountV1GetBadgeBookmarks
|
|
178
|
+
|
|
179
|
+
### Example Usage
|
|
180
|
+
|
|
181
|
+
```typescript
|
|
182
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
183
|
+
|
|
184
|
+
const steamSets = new SteamSets({
|
|
185
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
186
|
+
});
|
|
187
|
+
|
|
188
|
+
async function run() {
|
|
189
|
+
const result = await steamSets.account.accountV1GetBadgeBookmarks({});
|
|
190
|
+
|
|
191
|
+
// Handle the result
|
|
192
|
+
console.log(result);
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
run();
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
### Standalone function
|
|
199
|
+
|
|
200
|
+
The standalone function version of this method:
|
|
201
|
+
|
|
202
|
+
```typescript
|
|
203
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
204
|
+
import { accountAccountV1GetBadgeBookmarks } from "@steamsets/client-ts/funcs/accountAccountV1GetBadgeBookmarks.js";
|
|
205
|
+
|
|
206
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
207
|
+
// You can create one instance of it to use across an application.
|
|
208
|
+
const steamSets = new SteamSetsCore({
|
|
209
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
210
|
+
});
|
|
211
|
+
|
|
212
|
+
async function run() {
|
|
213
|
+
const res = await accountAccountV1GetBadgeBookmarks(steamSets, {});
|
|
214
|
+
|
|
215
|
+
if (!res.ok) {
|
|
216
|
+
throw res.error;
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
const { value: result } = res;
|
|
220
|
+
|
|
221
|
+
// Handle the result
|
|
222
|
+
console.log(result);
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
run();
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
### Parameters
|
|
229
|
+
|
|
230
|
+
| Parameter | Type | Required | Description |
|
|
231
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
232
|
+
| `request` | [components.V1AccountBadgeBookmarksRequestBody](../../models/components/v1accountbadgebookmarksrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
233
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
234
|
+
| `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. |
|
|
235
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
236
|
+
|
|
237
|
+
### Response
|
|
238
|
+
|
|
239
|
+
**Promise\<[operations.AccountV1GetBadgeBookmarksResponse](../../models/operations/accountv1getbadgebookmarksresponse.md)\>**
|
|
240
|
+
|
|
241
|
+
### Errors
|
|
242
|
+
|
|
243
|
+
| Error Type | Status Code | Content Type |
|
|
244
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
245
|
+
| errors.ErrorModel | 403, 404, 422, 500 | application/problem+json |
|
|
246
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
247
|
+
|
|
173
248
|
## getBadges
|
|
174
249
|
|
|
175
250
|
### Example Usage
|
|
@@ -383,6 +458,76 @@ run();
|
|
|
383
458
|
| errors.ErrorModel | 400, 403, 404, 422, 500 | application/problem+json |
|
|
384
459
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
385
460
|
|
|
461
|
+
## accountV1ImagesGet
|
|
462
|
+
|
|
463
|
+
### Example Usage
|
|
464
|
+
|
|
465
|
+
```typescript
|
|
466
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
467
|
+
|
|
468
|
+
const steamSets = new SteamSets({
|
|
469
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
470
|
+
});
|
|
471
|
+
|
|
472
|
+
async function run() {
|
|
473
|
+
const result = await steamSets.account.accountV1ImagesGet();
|
|
474
|
+
|
|
475
|
+
// Handle the result
|
|
476
|
+
console.log(result);
|
|
477
|
+
}
|
|
478
|
+
|
|
479
|
+
run();
|
|
480
|
+
```
|
|
481
|
+
|
|
482
|
+
### Standalone function
|
|
483
|
+
|
|
484
|
+
The standalone function version of this method:
|
|
485
|
+
|
|
486
|
+
```typescript
|
|
487
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
488
|
+
import { accountAccountV1ImagesGet } from "@steamsets/client-ts/funcs/accountAccountV1ImagesGet.js";
|
|
489
|
+
|
|
490
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
491
|
+
// You can create one instance of it to use across an application.
|
|
492
|
+
const steamSets = new SteamSetsCore({
|
|
493
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
494
|
+
});
|
|
495
|
+
|
|
496
|
+
async function run() {
|
|
497
|
+
const res = await accountAccountV1ImagesGet(steamSets);
|
|
498
|
+
|
|
499
|
+
if (!res.ok) {
|
|
500
|
+
throw res.error;
|
|
501
|
+
}
|
|
502
|
+
|
|
503
|
+
const { value: result } = res;
|
|
504
|
+
|
|
505
|
+
// Handle the result
|
|
506
|
+
console.log(result);
|
|
507
|
+
}
|
|
508
|
+
|
|
509
|
+
run();
|
|
510
|
+
```
|
|
511
|
+
|
|
512
|
+
### Parameters
|
|
513
|
+
|
|
514
|
+
| Parameter | Type | Required | Description |
|
|
515
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
516
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
517
|
+
| `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. |
|
|
518
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
519
|
+
|
|
520
|
+
### Response
|
|
521
|
+
|
|
522
|
+
**Promise\<[operations.AccountV1ImagesGetResponse](../../models/operations/accountv1imagesgetresponse.md)\>**
|
|
523
|
+
|
|
524
|
+
### Errors
|
|
525
|
+
|
|
526
|
+
| Error Type | Status Code | Content Type |
|
|
527
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
528
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
529
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
530
|
+
|
|
386
531
|
## getInfo
|
|
387
532
|
|
|
388
533
|
### Example Usage
|
|
@@ -666,7 +811,7 @@ run();
|
|
|
666
811
|
| errors.ErrorModel | 404, 422, 429, 500 | application/problem+json |
|
|
667
812
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
668
813
|
|
|
669
|
-
##
|
|
814
|
+
## accountV1ImagesUpdate
|
|
670
815
|
|
|
671
816
|
### Example Usage
|
|
672
817
|
|
|
@@ -678,9 +823,13 @@ const steamSets = new SteamSets({
|
|
|
678
823
|
});
|
|
679
824
|
|
|
680
825
|
async function run() {
|
|
681
|
-
const result = await steamSets.account.
|
|
682
|
-
|
|
683
|
-
|
|
826
|
+
const result = await steamSets.account.accountV1ImagesUpdate({
|
|
827
|
+
images: [
|
|
828
|
+
{
|
|
829
|
+
active: true,
|
|
830
|
+
imageId: "123456",
|
|
831
|
+
},
|
|
832
|
+
],
|
|
684
833
|
});
|
|
685
834
|
|
|
686
835
|
// Handle the result
|
|
@@ -696,7 +845,7 @@ The standalone function version of this method:
|
|
|
696
845
|
|
|
697
846
|
```typescript
|
|
698
847
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
699
|
-
import {
|
|
848
|
+
import { accountAccountV1ImagesUpdate } from "@steamsets/client-ts/funcs/accountAccountV1ImagesUpdate.js";
|
|
700
849
|
|
|
701
850
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
702
851
|
// You can create one instance of it to use across an application.
|
|
@@ -705,9 +854,13 @@ const steamSets = new SteamSetsCore({
|
|
|
705
854
|
});
|
|
706
855
|
|
|
707
856
|
async function run() {
|
|
708
|
-
const res = await
|
|
709
|
-
|
|
710
|
-
|
|
857
|
+
const res = await accountAccountV1ImagesUpdate(steamSets, {
|
|
858
|
+
images: [
|
|
859
|
+
{
|
|
860
|
+
active: true,
|
|
861
|
+
imageId: "123456",
|
|
862
|
+
},
|
|
863
|
+
],
|
|
711
864
|
});
|
|
712
865
|
|
|
713
866
|
if (!res.ok) {
|
|
@@ -734,7 +887,7 @@ run();
|
|
|
734
887
|
|
|
735
888
|
### Response
|
|
736
889
|
|
|
737
|
-
**Promise\<[operations.
|
|
890
|
+
**Promise\<[operations.AccountV1ImagesUpdateResponse](../../models/operations/accountv1imagesupdateresponse.md)\>**
|
|
738
891
|
|
|
739
892
|
### Errors
|
|
740
893
|
|
|
@@ -819,7 +972,7 @@ run();
|
|
|
819
972
|
|
|
820
973
|
### Response
|
|
821
974
|
|
|
822
|
-
**Promise\<[operations.
|
|
975
|
+
**Promise\<[operations.AccountV1ImagesUploadResponse](../../models/operations/accountv1imagesuploadresponse.md)\>**
|
|
823
976
|
|
|
824
977
|
### Errors
|
|
825
978
|
|