@steamsets/client-ts 0.17.4 → 0.17.6
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 +5 -2
- package/README.md +40 -17
- package/docs/sdks/account/README.md +107 -72
- package/docs/sdks/badges/README.md +8 -0
- package/docs/sdks/internal/README.md +107 -72
- package/docs/sdks/leaderboard/README.md +107 -0
- package/funcs/accountAccountV1GetMeta.d.ts.map +1 -1
- package/funcs/accountAccountV1GetMeta.js +1 -0
- package/funcs/accountAccountV1GetMeta.js.map +1 -1
- package/funcs/accountCreateDeveloperApp.d.ts.map +1 -1
- package/funcs/accountCreateDeveloperApp.js +1 -0
- package/funcs/accountCreateDeveloperApp.js.map +1 -1
- package/funcs/accountDeleteDeveloperApp.d.ts.map +1 -1
- package/funcs/accountDeleteDeveloperApp.js +1 -0
- package/funcs/accountDeleteDeveloperApp.js.map +1 -1
- package/funcs/accountDeleteImages.d.ts.map +1 -1
- package/funcs/accountDeleteImages.js +1 -0
- package/funcs/accountDeleteImages.js.map +1 -1
- package/funcs/accountGetAccount.d.ts.map +1 -1
- package/funcs/accountGetAccount.js +1 -0
- package/funcs/accountGetAccount.js.map +1 -1
- package/funcs/accountGetApps.d.ts.map +1 -1
- package/funcs/accountGetApps.js +1 -0
- package/funcs/accountGetApps.js.map +1 -1
- package/funcs/accountGetBadges.d.ts.map +1 -1
- package/funcs/accountGetBadges.js +1 -0
- package/funcs/accountGetBadges.js.map +1 -1
- package/funcs/accountGetDataPoints.d.ts.map +1 -1
- package/funcs/accountGetDataPoints.js +1 -0
- package/funcs/accountGetDataPoints.js.map +1 -1
- package/funcs/accountGetFriends.d.ts.map +1 -1
- package/funcs/accountGetFriends.js +1 -0
- package/funcs/accountGetFriends.js.map +1 -1
- package/funcs/accountGetInfo.d.ts.map +1 -1
- package/funcs/accountGetInfo.js +1 -0
- package/funcs/accountGetInfo.js.map +1 -1
- package/funcs/accountGetLeaderboardHistory.d.ts.map +1 -1
- package/funcs/accountGetLeaderboardHistory.js +1 -0
- package/funcs/accountGetLeaderboardHistory.js.map +1 -1
- package/funcs/accountGetStaff.d.ts.map +1 -1
- package/funcs/accountGetStaff.js +1 -0
- package/funcs/accountGetStaff.js.map +1 -1
- package/funcs/{accountAccountV1AblyAuthenticate.d.ts → accountLeaderboardV1GetAccountMeta.d.ts} +3 -2
- package/funcs/accountLeaderboardV1GetAccountMeta.d.ts.map +1 -0
- package/funcs/{internalAccountV1AblyAuthenticate.js → accountLeaderboardV1GetAccountMeta.js} +21 -9
- package/funcs/accountLeaderboardV1GetAccountMeta.js.map +1 -0
- package/funcs/accountUpdateApp.d.ts.map +1 -1
- package/funcs/accountUpdateApp.js +1 -0
- package/funcs/accountUpdateApp.js.map +1 -1
- package/funcs/accountUploadImages.d.ts.map +1 -1
- package/funcs/accountUploadImages.js +1 -0
- package/funcs/accountUploadImages.js.map +1 -1
- package/funcs/accountsQueue.d.ts.map +1 -1
- package/funcs/accountsQueue.js +1 -0
- package/funcs/accountsQueue.js.map +1 -1
- package/funcs/adminGetAccount.d.ts.map +1 -1
- package/funcs/adminGetAccount.js +1 -0
- package/funcs/adminGetAccount.js.map +1 -1
- package/funcs/adminUpdateResources.d.ts.map +1 -1
- package/funcs/adminUpdateResources.js +1 -0
- package/funcs/adminUpdateResources.js.map +1 -1
- package/funcs/adminUpdateRoles.d.ts.map +1 -1
- package/funcs/adminUpdateRoles.js +1 -0
- package/funcs/adminUpdateRoles.js.map +1 -1
- package/funcs/badgeGetTags.d.ts.map +1 -1
- package/funcs/badgeGetTags.js +1 -0
- package/funcs/badgeGetTags.js.map +1 -1
- package/funcs/badgesBookmark.d.ts.map +1 -1
- package/funcs/badgesBookmark.js +1 -0
- package/funcs/badgesBookmark.js.map +1 -1
- package/funcs/badgesGetBookmarks.d.ts.map +1 -1
- package/funcs/badgesGetBookmarks.js +1 -0
- package/funcs/badgesGetBookmarks.js.map +1 -1
- package/funcs/badgesGetOwned.d.ts.map +1 -1
- package/funcs/badgesGetOwned.js +1 -0
- package/funcs/badgesGetOwned.js.map +1 -1
- package/funcs/badgesSearch.d.ts.map +1 -1
- package/funcs/badgesSearch.js +1 -0
- package/funcs/badgesSearch.js.map +1 -1
- package/funcs/badgesTag.d.ts.map +1 -1
- package/funcs/badgesTag.js +1 -0
- package/funcs/badgesTag.js.map +1 -1
- package/funcs/connectionDelete.d.ts.map +1 -1
- package/funcs/connectionDelete.js +1 -0
- package/funcs/connectionDelete.js.map +1 -1
- package/funcs/connectionReconnect.d.ts.map +1 -1
- package/funcs/connectionReconnect.js +1 -0
- package/funcs/connectionReconnect.js.map +1 -1
- package/funcs/connectionUpdate.d.ts.map +1 -1
- package/funcs/connectionUpdate.js +1 -0
- package/funcs/connectionUpdate.js.map +1 -1
- package/funcs/connectionVerify.d.ts.map +1 -1
- package/funcs/connectionVerify.js +1 -0
- package/funcs/connectionVerify.js.map +1 -1
- package/funcs/connectionsConnect.d.ts.map +1 -1
- package/funcs/connectionsConnect.js +1 -0
- package/funcs/connectionsConnect.js.map +1 -1
- package/funcs/dataAccountV1GetMeta.d.ts.map +1 -1
- package/funcs/dataAccountV1GetMeta.js +1 -0
- package/funcs/dataAccountV1GetMeta.js.map +1 -1
- package/funcs/dataGetApps.d.ts.map +1 -1
- package/funcs/dataGetApps.js +1 -0
- package/funcs/dataGetApps.js.map +1 -1
- package/funcs/dataGetBadges.d.ts.map +1 -1
- package/funcs/dataGetBadges.js +1 -0
- package/funcs/dataGetBadges.js.map +1 -1
- package/funcs/dataGetDataPoints.d.ts.map +1 -1
- package/funcs/dataGetDataPoints.js +1 -0
- package/funcs/dataGetDataPoints.js.map +1 -1
- package/funcs/dataGetFriends.d.ts.map +1 -1
- package/funcs/dataGetFriends.js +1 -0
- package/funcs/dataGetFriends.js.map +1 -1
- package/funcs/dataGetInfo.d.ts.map +1 -1
- package/funcs/dataGetInfo.js +1 -0
- package/funcs/dataGetInfo.js.map +1 -1
- package/funcs/dataGetLeaderboardHistory.d.ts.map +1 -1
- package/funcs/dataGetLeaderboardHistory.js +1 -0
- package/funcs/dataGetLeaderboardHistory.js.map +1 -1
- package/funcs/developerCreateDeveloperApp.d.ts.map +1 -1
- package/funcs/developerCreateDeveloperApp.js +1 -0
- package/funcs/developerCreateDeveloperApp.js.map +1 -1
- package/funcs/developerDeleteDeveloperApp.d.ts.map +1 -1
- package/funcs/developerDeleteDeveloperApp.js +1 -0
- package/funcs/developerDeleteDeveloperApp.js.map +1 -1
- package/funcs/developerUpdateApp.d.ts.map +1 -1
- package/funcs/developerUpdateApp.js +1 -0
- package/funcs/developerUpdateApp.js.map +1 -1
- package/funcs/eventsGet.d.ts.map +1 -1
- package/funcs/eventsGet.js +1 -0
- package/funcs/eventsGet.js.map +1 -1
- package/funcs/eventsUpdate.d.ts.map +1 -1
- package/funcs/eventsUpdate.js +1 -0
- package/funcs/eventsUpdate.js.map +1 -1
- package/funcs/externalGet.d.ts.map +1 -1
- package/funcs/externalGet.js +1 -0
- package/funcs/externalGet.js.map +1 -1
- package/funcs/externalGetApps.d.ts.map +1 -1
- package/funcs/externalGetApps.js +1 -0
- package/funcs/externalGetApps.js.map +1 -1
- package/funcs/externalGetBadges.d.ts.map +1 -1
- package/funcs/externalGetBadges.js +1 -0
- package/funcs/externalGetBadges.js.map +1 -1
- package/funcs/externalGetDataPoints.d.ts.map +1 -1
- package/funcs/externalGetDataPoints.js +1 -0
- package/funcs/externalGetDataPoints.js.map +1 -1
- package/funcs/externalGetFriends.d.ts.map +1 -1
- package/funcs/externalGetFriends.js +1 -0
- package/funcs/externalGetFriends.js.map +1 -1
- package/funcs/externalGetInfo.d.ts.map +1 -1
- package/funcs/externalGetInfo.js +1 -0
- package/funcs/externalGetInfo.js.map +1 -1
- package/funcs/externalGetLeaderboardHistory.d.ts.map +1 -1
- package/funcs/externalGetLeaderboardHistory.js +1 -0
- package/funcs/externalGetLeaderboardHistory.js.map +1 -1
- package/funcs/imagesDeleteImages.d.ts.map +1 -1
- package/funcs/imagesDeleteImages.js +1 -0
- package/funcs/imagesDeleteImages.js.map +1 -1
- package/funcs/imagesGet.d.ts.map +1 -1
- package/funcs/imagesGet.js +1 -0
- package/funcs/imagesGet.js.map +1 -1
- package/funcs/imagesUpdate.d.ts.map +1 -1
- package/funcs/imagesUpdate.js +1 -0
- package/funcs/imagesUpdate.js.map +1 -1
- package/funcs/imagesUploadImages.d.ts.map +1 -1
- package/funcs/imagesUploadImages.js +1 -0
- package/funcs/imagesUploadImages.js.map +1 -1
- package/funcs/internalAccountV1GetMeta.d.ts.map +1 -1
- package/funcs/internalAccountV1GetMeta.js +1 -0
- package/funcs/internalAccountV1GetMeta.js.map +1 -1
- package/funcs/internalCheck.d.ts.map +1 -1
- package/funcs/internalCheck.js +1 -0
- package/funcs/internalCheck.js.map +1 -1
- package/funcs/internalCreateDeveloperApp.d.ts.map +1 -1
- package/funcs/internalCreateDeveloperApp.js +1 -0
- package/funcs/internalCreateDeveloperApp.js.map +1 -1
- package/funcs/internalDeleteDeveloperApp.d.ts.map +1 -1
- package/funcs/internalDeleteDeveloperApp.js +1 -0
- package/funcs/internalDeleteDeveloperApp.js.map +1 -1
- package/funcs/internalDeleteImages.d.ts.map +1 -1
- package/funcs/internalDeleteImages.js +1 -0
- package/funcs/internalDeleteImages.js.map +1 -1
- package/funcs/internalGetAccount.d.ts.map +1 -1
- package/funcs/internalGetAccount.js +1 -0
- package/funcs/internalGetAccount.js.map +1 -1
- package/funcs/internalGetStaff.d.ts.map +1 -1
- package/funcs/internalGetStaff.js +1 -0
- package/funcs/internalGetStaff.js.map +1 -1
- package/funcs/internalGetTags.d.ts.map +1 -1
- package/funcs/internalGetTags.js +1 -0
- package/funcs/internalGetTags.js.map +1 -1
- package/funcs/internalLeaderboardV1GetAccountMeta.d.ts +11 -0
- package/funcs/internalLeaderboardV1GetAccountMeta.d.ts.map +1 -0
- package/funcs/{accountAccountV1AblyAuthenticate.js → internalLeaderboardV1GetAccountMeta.js} +21 -9
- package/funcs/internalLeaderboardV1GetAccountMeta.js.map +1 -0
- package/funcs/internalUpdateApp.d.ts.map +1 -1
- package/funcs/internalUpdateApp.js +1 -0
- package/funcs/internalUpdateApp.js.map +1 -1
- package/funcs/internalUploadImages.d.ts.map +1 -1
- package/funcs/internalUploadImages.js +1 -0
- package/funcs/internalUploadImages.js.map +1 -1
- package/funcs/leaderboardGetAccount.d.ts.map +1 -1
- package/funcs/leaderboardGetAccount.js +1 -0
- package/funcs/leaderboardGetAccount.js.map +1 -1
- package/funcs/leaderboardGetBadges.d.ts.map +1 -1
- package/funcs/leaderboardGetBadges.js +1 -0
- package/funcs/leaderboardGetBadges.js.map +1 -1
- package/funcs/leaderboardGetGroup.d.ts.map +1 -1
- package/funcs/leaderboardGetGroup.js +1 -0
- package/funcs/leaderboardGetGroup.js.map +1 -1
- package/funcs/{internalAccountV1AblyAuthenticate.d.ts → leaderboardLeaderboardV1GetAccountMeta.d.ts} +3 -2
- package/funcs/leaderboardLeaderboardV1GetAccountMeta.d.ts.map +1 -0
- package/funcs/leaderboardLeaderboardV1GetAccountMeta.js +114 -0
- package/funcs/leaderboardLeaderboardV1GetAccountMeta.js.map +1 -0
- package/funcs/livenessCheck.d.ts.map +1 -1
- package/funcs/livenessCheck.js +1 -0
- package/funcs/livenessCheck.js.map +1 -1
- package/funcs/locationsGet.d.ts.map +1 -1
- package/funcs/locationsGet.js +1 -0
- package/funcs/locationsGet.js.map +1 -1
- package/funcs/sessionCreate.d.ts.map +1 -1
- package/funcs/sessionCreate.js +1 -0
- package/funcs/sessionCreate.js.map +1 -1
- package/funcs/sessionLogin.d.ts.map +1 -1
- package/funcs/sessionLogin.js +1 -0
- package/funcs/sessionLogin.js.map +1 -1
- package/funcs/sessionsDelete.d.ts.map +1 -1
- package/funcs/sessionsDelete.js +1 -0
- package/funcs/sessionsDelete.js.map +1 -1
- package/funcs/sessionsGet.d.ts.map +1 -1
- package/funcs/sessionsGet.js +1 -0
- package/funcs/sessionsGet.js.map +1 -1
- package/funcs/settingsGet.d.ts.map +1 -1
- package/funcs/settingsGet.js +1 -0
- package/funcs/settingsGet.js.map +1 -1
- package/funcs/settingsSendVerification.d.ts.map +1 -1
- package/funcs/settingsSendVerification.js +1 -0
- package/funcs/settingsSendVerification.js.map +1 -1
- package/funcs/settingsSubscribeEmail.d.ts.map +1 -1
- package/funcs/settingsSubscribeEmail.js +1 -0
- package/funcs/settingsSubscribeEmail.js.map +1 -1
- package/funcs/settingsUpdate.d.ts.map +1 -1
- package/funcs/settingsUpdate.js +1 -0
- package/funcs/settingsUpdate.js.map +1 -1
- package/funcs/settingsUpdateRole.d.ts.map +1 -1
- package/funcs/settingsUpdateRole.js +1 -0
- package/funcs/settingsUpdateRole.js.map +1 -1
- package/funcs/settingsVerifyEmail.d.ts.map +1 -1
- package/funcs/settingsVerifyEmail.js +1 -0
- package/funcs/settingsVerifyEmail.js.map +1 -1
- package/funcs/statsGet.d.ts.map +1 -1
- package/funcs/statsGet.js +1 -0
- package/funcs/statsGet.js.map +1 -1
- package/hooks/types.d.ts +1 -0
- package/hooks/types.d.ts.map +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/security.d.ts.map +1 -1
- package/lib/security.js.map +1 -1
- package/models/components/index.d.ts +2 -1
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +2 -1
- package/models/components/index.js.map +1 -1
- package/models/components/v1leaderboardaccountmetarequestbody.d.ts +124 -0
- package/models/components/v1leaderboardaccountmetarequestbody.d.ts.map +1 -0
- package/models/components/v1leaderboardaccountmetarequestbody.js +108 -0
- package/models/components/v1leaderboardaccountmetarequestbody.js.map +1 -0
- package/models/components/v1leaderboardaccountmetaresponsebody.d.ts +36 -0
- package/models/components/v1leaderboardaccountmetaresponsebody.d.ts.map +1 -0
- package/models/components/v1leaderboardaccountmetaresponsebody.js +72 -0
- package/models/components/v1leaderboardaccountmetaresponsebody.js.map +1 -0
- package/models/components/v1searchrequest.d.ts +5 -0
- package/models/components/v1searchrequest.d.ts.map +1 -1
- package/models/components/v1searchrequest.js +2 -0
- package/models/components/v1searchrequest.js.map +1 -1
- package/models/operations/index.d.ts +1 -1
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +1 -1
- package/models/operations/index.js.map +1 -1
- package/models/operations/leaderboardv1getaccountmeta.d.ts +35 -0
- package/models/operations/leaderboardv1getaccountmeta.d.ts.map +1 -0
- package/models/operations/leaderboardv1getaccountmeta.js +75 -0
- package/models/operations/leaderboardv1getaccountmeta.js.map +1 -0
- package/package.json +1 -1
- package/sdk/account.d.ts +1 -1
- package/sdk/account.d.ts.map +1 -1
- package/sdk/account.js +4 -4
- package/sdk/account.js.map +1 -1
- package/sdk/internal.d.ts +1 -1
- package/sdk/internal.d.ts.map +1 -1
- package/sdk/internal.js +4 -4
- package/sdk/internal.js.map +1 -1
- package/sdk/leaderboard.d.ts +1 -0
- package/sdk/leaderboard.d.ts.map +1 -1
- package/sdk/leaderboard.js +4 -0
- package/sdk/leaderboard.js.map +1 -1
- package/sdk/sdk.d.ts +4 -4
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +6 -6
- package/sdk/sdk.js.map +1 -1
- package/src/funcs/accountAccountV1GetMeta.ts +1 -0
- package/src/funcs/accountCreateDeveloperApp.ts +1 -0
- package/src/funcs/accountDeleteDeveloperApp.ts +1 -0
- package/src/funcs/accountDeleteImages.ts +1 -0
- package/src/funcs/accountGetAccount.ts +1 -0
- package/src/funcs/accountGetApps.ts +1 -0
- package/src/funcs/accountGetBadges.ts +1 -0
- package/src/funcs/accountGetDataPoints.ts +1 -0
- package/src/funcs/accountGetFriends.ts +1 -0
- package/src/funcs/accountGetInfo.ts +1 -0
- package/src/funcs/accountGetLeaderboardHistory.ts +1 -0
- package/src/funcs/accountGetStaff.ts +1 -0
- package/src/funcs/{accountAccountV1AblyAuthenticate.ts → accountLeaderboardV1GetAccountMeta.ts} +32 -9
- package/src/funcs/accountUpdateApp.ts +1 -0
- package/src/funcs/accountUploadImages.ts +1 -0
- package/src/funcs/accountsQueue.ts +1 -0
- package/src/funcs/adminGetAccount.ts +1 -0
- package/src/funcs/adminUpdateResources.ts +1 -0
- package/src/funcs/adminUpdateRoles.ts +1 -0
- package/src/funcs/badgeGetTags.ts +1 -0
- package/src/funcs/badgesBookmark.ts +1 -0
- package/src/funcs/badgesGetBookmarks.ts +1 -0
- package/src/funcs/badgesGetOwned.ts +1 -0
- package/src/funcs/badgesSearch.ts +1 -0
- package/src/funcs/badgesTag.ts +1 -0
- package/src/funcs/connectionDelete.ts +1 -0
- package/src/funcs/connectionReconnect.ts +1 -0
- package/src/funcs/connectionUpdate.ts +1 -0
- package/src/funcs/connectionVerify.ts +1 -0
- package/src/funcs/connectionsConnect.ts +1 -0
- package/src/funcs/dataAccountV1GetMeta.ts +1 -0
- package/src/funcs/dataGetApps.ts +1 -0
- package/src/funcs/dataGetBadges.ts +1 -0
- package/src/funcs/dataGetDataPoints.ts +1 -0
- package/src/funcs/dataGetFriends.ts +1 -0
- package/src/funcs/dataGetInfo.ts +1 -0
- package/src/funcs/dataGetLeaderboardHistory.ts +1 -0
- package/src/funcs/developerCreateDeveloperApp.ts +1 -0
- package/src/funcs/developerDeleteDeveloperApp.ts +1 -0
- package/src/funcs/developerUpdateApp.ts +1 -0
- package/src/funcs/eventsGet.ts +1 -0
- package/src/funcs/eventsUpdate.ts +1 -0
- package/src/funcs/externalGet.ts +1 -0
- package/src/funcs/externalGetApps.ts +1 -0
- package/src/funcs/externalGetBadges.ts +1 -0
- package/src/funcs/externalGetDataPoints.ts +1 -0
- package/src/funcs/externalGetFriends.ts +1 -0
- package/src/funcs/externalGetInfo.ts +1 -0
- package/src/funcs/externalGetLeaderboardHistory.ts +1 -0
- package/src/funcs/imagesDeleteImages.ts +1 -0
- package/src/funcs/imagesGet.ts +1 -0
- package/src/funcs/imagesUpdate.ts +1 -0
- package/src/funcs/imagesUploadImages.ts +1 -0
- package/src/funcs/internalAccountV1GetMeta.ts +1 -0
- package/src/funcs/internalCheck.ts +1 -0
- package/src/funcs/internalCreateDeveloperApp.ts +1 -0
- package/src/funcs/internalDeleteDeveloperApp.ts +1 -0
- package/src/funcs/internalDeleteImages.ts +1 -0
- package/src/funcs/internalGetAccount.ts +1 -0
- package/src/funcs/internalGetStaff.ts +1 -0
- package/src/funcs/internalGetTags.ts +1 -0
- package/src/funcs/{internalAccountV1AblyAuthenticate.ts → internalLeaderboardV1GetAccountMeta.ts} +32 -9
- package/src/funcs/internalUpdateApp.ts +1 -0
- package/src/funcs/internalUploadImages.ts +1 -0
- package/src/funcs/leaderboardGetAccount.ts +1 -0
- package/src/funcs/leaderboardGetBadges.ts +1 -0
- package/src/funcs/leaderboardGetGroup.ts +1 -0
- package/src/funcs/leaderboardLeaderboardV1GetAccountMeta.ts +155 -0
- package/src/funcs/livenessCheck.ts +1 -0
- package/src/funcs/locationsGet.ts +1 -0
- package/src/funcs/sessionCreate.ts +1 -0
- package/src/funcs/sessionLogin.ts +1 -0
- package/src/funcs/sessionsDelete.ts +1 -0
- package/src/funcs/sessionsGet.ts +1 -0
- package/src/funcs/settingsGet.ts +1 -0
- package/src/funcs/settingsSendVerification.ts +1 -0
- package/src/funcs/settingsSubscribeEmail.ts +1 -0
- package/src/funcs/settingsUpdate.ts +1 -0
- package/src/funcs/settingsUpdateRole.ts +1 -0
- package/src/funcs/settingsVerifyEmail.ts +1 -0
- package/src/funcs/statsGet.ts +1 -0
- package/src/hooks/types.ts +1 -0
- package/src/lib/config.ts +3 -3
- package/src/lib/security.ts +0 -1
- package/src/models/components/index.ts +2 -1
- package/src/models/components/v1leaderboardaccountmetarequestbody.ts +162 -0
- package/src/models/components/v1leaderboardaccountmetaresponsebody.ts +91 -0
- package/src/models/components/v1searchrequest.ts +7 -0
- package/src/models/operations/index.ts +1 -1
- package/src/models/operations/leaderboardv1getaccountmeta.ts +98 -0
- package/src/sdk/account.ts +12 -10
- package/src/sdk/internal.ts +12 -10
- package/src/sdk/leaderboard.ts +12 -0
- package/src/sdk/sdk.ts +10 -10
- package/funcs/accountAccountV1AblyAuthenticate.d.ts.map +0 -1
- package/funcs/accountAccountV1AblyAuthenticate.js.map +0 -1
- package/funcs/internalAccountV1AblyAuthenticate.d.ts.map +0 -1
- package/funcs/internalAccountV1AblyAuthenticate.js.map +0 -1
- package/models/components/v1accountablyauthenticatebody.d.ts +0 -46
- package/models/components/v1accountablyauthenticatebody.d.ts.map +0 -1
- package/models/components/v1accountablyauthenticatebody.js +0 -82
- package/models/components/v1accountablyauthenticatebody.js.map +0 -1
- package/models/operations/accountv1ablyauthenticate.d.ts +0 -35
- package/models/operations/accountv1ablyauthenticate.d.ts.map +0 -1
- package/models/operations/accountv1ablyauthenticate.js +0 -75
- package/models/operations/accountv1ablyauthenticate.js.map +0 -1
- package/src/models/components/v1accountablyauthenticatebody.ts +0 -108
- package/src/models/operations/accountv1ablyauthenticate.ts +0 -94
package/FUNCTIONS.md
CHANGED
|
@@ -20,7 +20,7 @@ specific category of applications.
|
|
|
20
20
|
|
|
21
21
|
```typescript
|
|
22
22
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
23
|
-
import {
|
|
23
|
+
import { badgesBookmark } from "@steamsets/client-ts/funcs/badgesBookmark.js";
|
|
24
24
|
import { SDKValidationError } from "@steamsets/client-ts/models/errors/sdkvalidationerror.js";
|
|
25
25
|
|
|
26
26
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
@@ -30,7 +30,10 @@ const steamSets = new SteamSetsCore({
|
|
|
30
30
|
});
|
|
31
31
|
|
|
32
32
|
async function run() {
|
|
33
|
-
const res = await
|
|
33
|
+
const res = await badgesBookmark(steamSets, {
|
|
34
|
+
badgeId: "bdg_123",
|
|
35
|
+
bookmark: true,
|
|
36
|
+
});
|
|
34
37
|
|
|
35
38
|
switch (true) {
|
|
36
39
|
case res.ok:
|
package/README.md
CHANGED
|
@@ -53,7 +53,10 @@ const steamSets = new SteamSets({
|
|
|
53
53
|
});
|
|
54
54
|
|
|
55
55
|
async function run() {
|
|
56
|
-
const result = await steamSets.
|
|
56
|
+
const result = await steamSets.badges.bookmark({
|
|
57
|
+
badgeId: "bdg_123",
|
|
58
|
+
bookmark: true,
|
|
59
|
+
});
|
|
57
60
|
|
|
58
61
|
// Handle the result
|
|
59
62
|
console.log(result);
|
|
@@ -72,7 +75,6 @@ run();
|
|
|
72
75
|
|
|
73
76
|
### [account](docs/sdks/account/README.md)
|
|
74
77
|
|
|
75
|
-
* [accountV1AblyAuthenticate](docs/sdks/account/README.md#accountv1ablyauthenticate)
|
|
76
78
|
* [createDeveloperApp](docs/sdks/account/README.md#createdeveloperapp)
|
|
77
79
|
* [deleteDeveloperApp](docs/sdks/account/README.md#deletedeveloperapp)
|
|
78
80
|
* [deleteImages](docs/sdks/account/README.md#deleteimages)
|
|
@@ -87,6 +89,7 @@ run();
|
|
|
87
89
|
* [getStaff](docs/sdks/account/README.md#getstaff)
|
|
88
90
|
* [uploadImages](docs/sdks/account/README.md#uploadimages)
|
|
89
91
|
* [getAccount](docs/sdks/account/README.md#getaccount)
|
|
92
|
+
* [leaderboardV1GetAccountMeta](docs/sdks/account/README.md#leaderboardv1getaccountmeta)
|
|
90
93
|
|
|
91
94
|
### [accounts](docs/sdks/accounts/README.md)
|
|
92
95
|
|
|
@@ -161,7 +164,6 @@ run();
|
|
|
161
164
|
|
|
162
165
|
### [internal](docs/sdks/internal/README.md)
|
|
163
166
|
|
|
164
|
-
* [accountV1AblyAuthenticate](docs/sdks/internal/README.md#accountv1ablyauthenticate)
|
|
165
167
|
* [createDeveloperApp](docs/sdks/internal/README.md#createdeveloperapp)
|
|
166
168
|
* [deleteDeveloperApp](docs/sdks/internal/README.md#deletedeveloperapp)
|
|
167
169
|
* [deleteImages](docs/sdks/internal/README.md#deleteimages)
|
|
@@ -171,11 +173,13 @@ run();
|
|
|
171
173
|
* [uploadImages](docs/sdks/internal/README.md#uploadimages)
|
|
172
174
|
* [getAccount](docs/sdks/internal/README.md#getaccount)
|
|
173
175
|
* [getTags](docs/sdks/internal/README.md#gettags)
|
|
176
|
+
* [leaderboardV1GetAccountMeta](docs/sdks/internal/README.md#leaderboardv1getaccountmeta)
|
|
174
177
|
* [check](docs/sdks/internal/README.md#check) - Liveness check
|
|
175
178
|
|
|
176
179
|
### [leaderboard](docs/sdks/leaderboard/README.md)
|
|
177
180
|
|
|
178
181
|
* [getAccount](docs/sdks/leaderboard/README.md#getaccount)
|
|
182
|
+
* [leaderboardV1GetAccountMeta](docs/sdks/leaderboard/README.md#leaderboardv1getaccountmeta)
|
|
179
183
|
* [getBadges](docs/sdks/leaderboard/README.md#getbadges)
|
|
180
184
|
* [getGroup](docs/sdks/leaderboard/README.md#getgroup)
|
|
181
185
|
|
|
@@ -228,7 +232,10 @@ const steamSets = new SteamSets({
|
|
|
228
232
|
});
|
|
229
233
|
|
|
230
234
|
async function run() {
|
|
231
|
-
const result = await steamSets.
|
|
235
|
+
const result = await steamSets.badges.bookmark({
|
|
236
|
+
badgeId: "bdg_123",
|
|
237
|
+
bookmark: true,
|
|
238
|
+
}, {
|
|
232
239
|
retries: {
|
|
233
240
|
strategy: "backoff",
|
|
234
241
|
backoff: {
|
|
@@ -268,7 +275,10 @@ const steamSets = new SteamSets({
|
|
|
268
275
|
});
|
|
269
276
|
|
|
270
277
|
async function run() {
|
|
271
|
-
const result = await steamSets.
|
|
278
|
+
const result = await steamSets.badges.bookmark({
|
|
279
|
+
badgeId: "bdg_123",
|
|
280
|
+
bookmark: true,
|
|
281
|
+
});
|
|
272
282
|
|
|
273
283
|
// Handle the result
|
|
274
284
|
console.log(result);
|
|
@@ -282,13 +292,13 @@ run();
|
|
|
282
292
|
<!-- Start Error Handling [errors] -->
|
|
283
293
|
## Error Handling
|
|
284
294
|
|
|
285
|
-
Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `
|
|
295
|
+
Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `bookmark` method may throw the following errors:
|
|
286
296
|
|
|
287
|
-
| Error Type | Status Code
|
|
288
|
-
| ----------------- |
|
|
289
|
-
| errors.ErrorModel | 403
|
|
290
|
-
| errors.ErrorModel | 500
|
|
291
|
-
| errors.SDKError | 4XX, 5XX
|
|
297
|
+
| Error Type | Status Code | Content Type |
|
|
298
|
+
| ----------------- | ------------- | ------------------------ |
|
|
299
|
+
| errors.ErrorModel | 403, 404, 422 | application/problem+json |
|
|
300
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
301
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
292
302
|
|
|
293
303
|
If the method throws an error and it is not captured by the known errors, it will default to throwing a `SDKError`.
|
|
294
304
|
|
|
@@ -306,7 +316,10 @@ const steamSets = new SteamSets({
|
|
|
306
316
|
async function run() {
|
|
307
317
|
let result;
|
|
308
318
|
try {
|
|
309
|
-
result = await steamSets.
|
|
319
|
+
result = await steamSets.badges.bookmark({
|
|
320
|
+
badgeId: "bdg_123",
|
|
321
|
+
bookmark: true,
|
|
322
|
+
});
|
|
310
323
|
|
|
311
324
|
// Handle the result
|
|
312
325
|
console.log(result);
|
|
@@ -378,7 +391,10 @@ const steamSets = new SteamSets({
|
|
|
378
391
|
});
|
|
379
392
|
|
|
380
393
|
async function run() {
|
|
381
|
-
const result = await steamSets.
|
|
394
|
+
const result = await steamSets.badges.bookmark({
|
|
395
|
+
badgeId: "bdg_123",
|
|
396
|
+
bookmark: true,
|
|
397
|
+
});
|
|
382
398
|
|
|
383
399
|
// Handle the result
|
|
384
400
|
console.log(result);
|
|
@@ -400,7 +416,10 @@ const steamSets = new SteamSets({
|
|
|
400
416
|
});
|
|
401
417
|
|
|
402
418
|
async function run() {
|
|
403
|
-
const result = await steamSets.
|
|
419
|
+
const result = await steamSets.badges.bookmark({
|
|
420
|
+
badgeId: "bdg_123",
|
|
421
|
+
bookmark: true,
|
|
422
|
+
});
|
|
404
423
|
|
|
405
424
|
// Handle the result
|
|
406
425
|
console.log(result);
|
|
@@ -480,7 +499,10 @@ const steamSets = new SteamSets({
|
|
|
480
499
|
});
|
|
481
500
|
|
|
482
501
|
async function run() {
|
|
483
|
-
const result = await steamSets.
|
|
502
|
+
const result = await steamSets.badges.bookmark({
|
|
503
|
+
badgeId: "bdg_123",
|
|
504
|
+
bookmark: true,
|
|
505
|
+
});
|
|
484
506
|
|
|
485
507
|
// Handle the result
|
|
486
508
|
console.log(result);
|
|
@@ -551,7 +573,6 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
551
573
|
|
|
552
574
|
<summary>Available standalone functions</summary>
|
|
553
575
|
|
|
554
|
-
- [`accountAccountV1AblyAuthenticate`](docs/sdks/account/README.md#accountv1ablyauthenticate)
|
|
555
576
|
- [`accountAccountV1GetMeta`](docs/sdks/account/README.md#accountv1getmeta)
|
|
556
577
|
- [`accountCreateDeveloperApp`](docs/sdks/account/README.md#createdeveloperapp)
|
|
557
578
|
- [`accountDeleteDeveloperApp`](docs/sdks/account/README.md#deletedeveloperapp)
|
|
@@ -564,6 +585,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
564
585
|
- [`accountGetInfo`](docs/sdks/account/README.md#getinfo)
|
|
565
586
|
- [`accountGetLeaderboardHistory`](docs/sdks/account/README.md#getleaderboardhistory)
|
|
566
587
|
- [`accountGetStaff`](docs/sdks/account/README.md#getstaff)
|
|
588
|
+
- [`accountLeaderboardV1GetAccountMeta`](docs/sdks/account/README.md#leaderboardv1getaccountmeta)
|
|
567
589
|
- [`accountsQueue`](docs/sdks/accounts/README.md#queue)
|
|
568
590
|
- [`accountUpdateApp`](docs/sdks/account/README.md#updateapp)
|
|
569
591
|
- [`accountUploadImages`](docs/sdks/account/README.md#uploadimages)
|
|
@@ -604,7 +626,6 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
604
626
|
- [`imagesGet`](docs/sdks/images/README.md#get)
|
|
605
627
|
- [`imagesUpdate`](docs/sdks/images/README.md#update)
|
|
606
628
|
- [`imagesUploadImages`](docs/sdks/images/README.md#uploadimages)
|
|
607
|
-
- [`internalAccountV1AblyAuthenticate`](docs/sdks/internal/README.md#accountv1ablyauthenticate)
|
|
608
629
|
- [`internalAccountV1GetMeta`](docs/sdks/internal/README.md#accountv1getmeta)
|
|
609
630
|
- [`internalCheck`](docs/sdks/internal/README.md#check) - Liveness check
|
|
610
631
|
- [`internalCreateDeveloperApp`](docs/sdks/internal/README.md#createdeveloperapp)
|
|
@@ -613,11 +634,13 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
613
634
|
- [`internalGetAccount`](docs/sdks/internal/README.md#getaccount)
|
|
614
635
|
- [`internalGetStaff`](docs/sdks/internal/README.md#getstaff)
|
|
615
636
|
- [`internalGetTags`](docs/sdks/internal/README.md#gettags)
|
|
637
|
+
- [`internalLeaderboardV1GetAccountMeta`](docs/sdks/internal/README.md#leaderboardv1getaccountmeta)
|
|
616
638
|
- [`internalUpdateApp`](docs/sdks/internal/README.md#updateapp)
|
|
617
639
|
- [`internalUploadImages`](docs/sdks/internal/README.md#uploadimages)
|
|
618
640
|
- [`leaderboardGetAccount`](docs/sdks/leaderboard/README.md#getaccount)
|
|
619
641
|
- [`leaderboardGetBadges`](docs/sdks/leaderboard/README.md#getbadges)
|
|
620
642
|
- [`leaderboardGetGroup`](docs/sdks/leaderboard/README.md#getgroup)
|
|
643
|
+
- [`leaderboardLeaderboardV1GetAccountMeta`](docs/sdks/leaderboard/README.md#leaderboardv1getaccountmeta)
|
|
621
644
|
- [`livenessCheck`](docs/sdks/liveness/README.md#check) - Liveness check
|
|
622
645
|
- [`locationsGet`](docs/sdks/locations/README.md#get)
|
|
623
646
|
- [`sessionCreate`](docs/sdks/session/README.md#create)
|
|
@@ -7,7 +7,6 @@ All Requests related to account(s) are grouped here.
|
|
|
7
7
|
|
|
8
8
|
### Available Operations
|
|
9
9
|
|
|
10
|
-
* [accountV1AblyAuthenticate](#accountv1ablyauthenticate)
|
|
11
10
|
* [createDeveloperApp](#createdeveloperapp)
|
|
12
11
|
* [deleteDeveloperApp](#deletedeveloperapp)
|
|
13
12
|
* [deleteImages](#deleteimages)
|
|
@@ -22,77 +21,7 @@ All Requests related to account(s) are grouped here.
|
|
|
22
21
|
* [getStaff](#getstaff)
|
|
23
22
|
* [uploadImages](#uploadimages)
|
|
24
23
|
* [getAccount](#getaccount)
|
|
25
|
-
|
|
26
|
-
## accountV1AblyAuthenticate
|
|
27
|
-
|
|
28
|
-
### Example Usage
|
|
29
|
-
|
|
30
|
-
```typescript
|
|
31
|
-
import { SteamSets } from "@steamsets/client-ts";
|
|
32
|
-
|
|
33
|
-
const steamSets = new SteamSets({
|
|
34
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
35
|
-
});
|
|
36
|
-
|
|
37
|
-
async function run() {
|
|
38
|
-
const result = await steamSets.account.accountV1AblyAuthenticate();
|
|
39
|
-
|
|
40
|
-
// Handle the result
|
|
41
|
-
console.log(result);
|
|
42
|
-
}
|
|
43
|
-
|
|
44
|
-
run();
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
### Standalone function
|
|
48
|
-
|
|
49
|
-
The standalone function version of this method:
|
|
50
|
-
|
|
51
|
-
```typescript
|
|
52
|
-
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
53
|
-
import { accountAccountV1AblyAuthenticate } from "@steamsets/client-ts/funcs/accountAccountV1AblyAuthenticate.js";
|
|
54
|
-
|
|
55
|
-
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
56
|
-
// You can create one instance of it to use across an application.
|
|
57
|
-
const steamSets = new SteamSetsCore({
|
|
58
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
59
|
-
});
|
|
60
|
-
|
|
61
|
-
async function run() {
|
|
62
|
-
const res = await accountAccountV1AblyAuthenticate(steamSets);
|
|
63
|
-
|
|
64
|
-
if (!res.ok) {
|
|
65
|
-
throw res.error;
|
|
66
|
-
}
|
|
67
|
-
|
|
68
|
-
const { value: result } = res;
|
|
69
|
-
|
|
70
|
-
// Handle the result
|
|
71
|
-
console.log(result);
|
|
72
|
-
}
|
|
73
|
-
|
|
74
|
-
run();
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
### Parameters
|
|
78
|
-
|
|
79
|
-
| Parameter | Type | Required | Description |
|
|
80
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
81
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
82
|
-
| `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. |
|
|
83
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
84
|
-
|
|
85
|
-
### Response
|
|
86
|
-
|
|
87
|
-
**Promise\<[operations.AccountV1AblyAuthenticateResponse](../../models/operations/accountv1ablyauthenticateresponse.md)\>**
|
|
88
|
-
|
|
89
|
-
### Errors
|
|
90
|
-
|
|
91
|
-
| Error Type | Status Code | Content Type |
|
|
92
|
-
| ------------------------ | ------------------------ | ------------------------ |
|
|
93
|
-
| errors.ErrorModel | 403 | application/problem+json |
|
|
94
|
-
| errors.ErrorModel | 500 | application/problem+json |
|
|
95
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
24
|
+
* [leaderboardV1GetAccountMeta](#leaderboardv1getaccountmeta)
|
|
96
25
|
|
|
97
26
|
## createDeveloperApp
|
|
98
27
|
|
|
@@ -1141,4 +1070,110 @@ run();
|
|
|
1141
1070
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
1142
1071
|
| errors.ErrorModel | 403, 404, 422, 429 | application/problem+json |
|
|
1143
1072
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
1073
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1074
|
+
|
|
1075
|
+
## leaderboardV1GetAccountMeta
|
|
1076
|
+
|
|
1077
|
+
### Example Usage
|
|
1078
|
+
|
|
1079
|
+
```typescript
|
|
1080
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
1081
|
+
|
|
1082
|
+
const steamSets = new SteamSets({
|
|
1083
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1084
|
+
});
|
|
1085
|
+
|
|
1086
|
+
async function run() {
|
|
1087
|
+
const result = await steamSets.account.leaderboardV1GetAccountMeta({
|
|
1088
|
+
app: {
|
|
1089
|
+
appId: 730,
|
|
1090
|
+
},
|
|
1091
|
+
badge: {
|
|
1092
|
+
id: 335243,
|
|
1093
|
+
isFoil: true,
|
|
1094
|
+
},
|
|
1095
|
+
leaderboard: "xp",
|
|
1096
|
+
location: [
|
|
1097
|
+
{
|
|
1098
|
+
city: "Bad Krozingen",
|
|
1099
|
+
country: "Germany",
|
|
1100
|
+
region: "Europe",
|
|
1101
|
+
state: "Baden-Wurttemberg",
|
|
1102
|
+
},
|
|
1103
|
+
],
|
|
1104
|
+
});
|
|
1105
|
+
|
|
1106
|
+
// Handle the result
|
|
1107
|
+
console.log(result);
|
|
1108
|
+
}
|
|
1109
|
+
|
|
1110
|
+
run();
|
|
1111
|
+
```
|
|
1112
|
+
|
|
1113
|
+
### Standalone function
|
|
1114
|
+
|
|
1115
|
+
The standalone function version of this method:
|
|
1116
|
+
|
|
1117
|
+
```typescript
|
|
1118
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
1119
|
+
import { accountLeaderboardV1GetAccountMeta } from "@steamsets/client-ts/funcs/accountLeaderboardV1GetAccountMeta.js";
|
|
1120
|
+
|
|
1121
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
1122
|
+
// You can create one instance of it to use across an application.
|
|
1123
|
+
const steamSets = new SteamSetsCore({
|
|
1124
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1125
|
+
});
|
|
1126
|
+
|
|
1127
|
+
async function run() {
|
|
1128
|
+
const res = await accountLeaderboardV1GetAccountMeta(steamSets, {
|
|
1129
|
+
app: {
|
|
1130
|
+
appId: 730,
|
|
1131
|
+
},
|
|
1132
|
+
badge: {
|
|
1133
|
+
id: 335243,
|
|
1134
|
+
isFoil: true,
|
|
1135
|
+
},
|
|
1136
|
+
leaderboard: "xp",
|
|
1137
|
+
location: [
|
|
1138
|
+
{
|
|
1139
|
+
city: "Bad Krozingen",
|
|
1140
|
+
country: "Germany",
|
|
1141
|
+
region: "Europe",
|
|
1142
|
+
state: "Baden-Wurttemberg",
|
|
1143
|
+
},
|
|
1144
|
+
],
|
|
1145
|
+
});
|
|
1146
|
+
|
|
1147
|
+
if (!res.ok) {
|
|
1148
|
+
throw res.error;
|
|
1149
|
+
}
|
|
1150
|
+
|
|
1151
|
+
const { value: result } = res;
|
|
1152
|
+
|
|
1153
|
+
// Handle the result
|
|
1154
|
+
console.log(result);
|
|
1155
|
+
}
|
|
1156
|
+
|
|
1157
|
+
run();
|
|
1158
|
+
```
|
|
1159
|
+
|
|
1160
|
+
### Parameters
|
|
1161
|
+
|
|
1162
|
+
| Parameter | Type | Required | Description |
|
|
1163
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1164
|
+
| `request` | [components.V1LeaderboardAccountMetaRequestBody](../../models/components/v1leaderboardaccountmetarequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1165
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1166
|
+
| `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. |
|
|
1167
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1168
|
+
|
|
1169
|
+
### Response
|
|
1170
|
+
|
|
1171
|
+
**Promise\<[operations.LeaderboardV1GetAccountMetaResponse](../../models/operations/leaderboardv1getaccountmetaresponse.md)\>**
|
|
1172
|
+
|
|
1173
|
+
### Errors
|
|
1174
|
+
|
|
1175
|
+
| Error Type | Status Code | Content Type |
|
|
1176
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
1177
|
+
| errors.ErrorModel | 404, 422 | application/problem+json |
|
|
1178
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
1144
1179
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -246,6 +246,10 @@ async function run() {
|
|
|
246
246
|
const result = await steamSets.badges.search({
|
|
247
247
|
filter: "<value>",
|
|
248
248
|
query: "<value>",
|
|
249
|
+
sort: [
|
|
250
|
+
"\"sort\": [ \"price:asc\"",
|
|
251
|
+
"\"author:desc\" ]",
|
|
252
|
+
],
|
|
249
253
|
});
|
|
250
254
|
|
|
251
255
|
// Handle the result
|
|
@@ -273,6 +277,10 @@ async function run() {
|
|
|
273
277
|
const res = await badgesSearch(steamSets, {
|
|
274
278
|
filter: "<value>",
|
|
275
279
|
query: "<value>",
|
|
280
|
+
sort: [
|
|
281
|
+
"\"sort\": [ \"price:asc\"",
|
|
282
|
+
"\"author:desc\" ]",
|
|
283
|
+
],
|
|
276
284
|
});
|
|
277
285
|
|
|
278
286
|
if (!res.ok) {
|
|
@@ -7,7 +7,6 @@ There requests are just document for documentations sake, they are not meant to
|
|
|
7
7
|
|
|
8
8
|
### Available Operations
|
|
9
9
|
|
|
10
|
-
* [accountV1AblyAuthenticate](#accountv1ablyauthenticate)
|
|
11
10
|
* [createDeveloperApp](#createdeveloperapp)
|
|
12
11
|
* [deleteDeveloperApp](#deletedeveloperapp)
|
|
13
12
|
* [deleteImages](#deleteimages)
|
|
@@ -17,79 +16,9 @@ There requests are just document for documentations sake, they are not meant to
|
|
|
17
16
|
* [uploadImages](#uploadimages)
|
|
18
17
|
* [getAccount](#getaccount)
|
|
19
18
|
* [getTags](#gettags)
|
|
19
|
+
* [leaderboardV1GetAccountMeta](#leaderboardv1getaccountmeta)
|
|
20
20
|
* [check](#check) - Liveness check
|
|
21
21
|
|
|
22
|
-
## accountV1AblyAuthenticate
|
|
23
|
-
|
|
24
|
-
### Example Usage
|
|
25
|
-
|
|
26
|
-
```typescript
|
|
27
|
-
import { SteamSets } from "@steamsets/client-ts";
|
|
28
|
-
|
|
29
|
-
const steamSets = new SteamSets({
|
|
30
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
31
|
-
});
|
|
32
|
-
|
|
33
|
-
async function run() {
|
|
34
|
-
const result = await steamSets.internal.accountV1AblyAuthenticate();
|
|
35
|
-
|
|
36
|
-
// Handle the result
|
|
37
|
-
console.log(result);
|
|
38
|
-
}
|
|
39
|
-
|
|
40
|
-
run();
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
### Standalone function
|
|
44
|
-
|
|
45
|
-
The standalone function version of this method:
|
|
46
|
-
|
|
47
|
-
```typescript
|
|
48
|
-
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
49
|
-
import { internalAccountV1AblyAuthenticate } from "@steamsets/client-ts/funcs/internalAccountV1AblyAuthenticate.js";
|
|
50
|
-
|
|
51
|
-
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
52
|
-
// You can create one instance of it to use across an application.
|
|
53
|
-
const steamSets = new SteamSetsCore({
|
|
54
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
55
|
-
});
|
|
56
|
-
|
|
57
|
-
async function run() {
|
|
58
|
-
const res = await internalAccountV1AblyAuthenticate(steamSets);
|
|
59
|
-
|
|
60
|
-
if (!res.ok) {
|
|
61
|
-
throw res.error;
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
const { value: result } = res;
|
|
65
|
-
|
|
66
|
-
// Handle the result
|
|
67
|
-
console.log(result);
|
|
68
|
-
}
|
|
69
|
-
|
|
70
|
-
run();
|
|
71
|
-
```
|
|
72
|
-
|
|
73
|
-
### Parameters
|
|
74
|
-
|
|
75
|
-
| Parameter | Type | Required | Description |
|
|
76
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
77
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
78
|
-
| `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. |
|
|
79
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
80
|
-
|
|
81
|
-
### Response
|
|
82
|
-
|
|
83
|
-
**Promise\<[operations.AccountV1AblyAuthenticateResponse](../../models/operations/accountv1ablyauthenticateresponse.md)\>**
|
|
84
|
-
|
|
85
|
-
### Errors
|
|
86
|
-
|
|
87
|
-
| Error Type | Status Code | Content Type |
|
|
88
|
-
| ------------------------ | ------------------------ | ------------------------ |
|
|
89
|
-
| errors.ErrorModel | 403 | application/problem+json |
|
|
90
|
-
| errors.ErrorModel | 500 | application/problem+json |
|
|
91
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
92
|
-
|
|
93
22
|
## createDeveloperApp
|
|
94
23
|
|
|
95
24
|
### Example Usage
|
|
@@ -778,6 +707,112 @@ run();
|
|
|
778
707
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
779
708
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
780
709
|
|
|
710
|
+
## leaderboardV1GetAccountMeta
|
|
711
|
+
|
|
712
|
+
### Example Usage
|
|
713
|
+
|
|
714
|
+
```typescript
|
|
715
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
716
|
+
|
|
717
|
+
const steamSets = new SteamSets({
|
|
718
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
719
|
+
});
|
|
720
|
+
|
|
721
|
+
async function run() {
|
|
722
|
+
const result = await steamSets.internal.leaderboardV1GetAccountMeta({
|
|
723
|
+
app: {
|
|
724
|
+
appId: 730,
|
|
725
|
+
},
|
|
726
|
+
badge: {
|
|
727
|
+
id: 335243,
|
|
728
|
+
isFoil: true,
|
|
729
|
+
},
|
|
730
|
+
leaderboard: "xp",
|
|
731
|
+
location: [
|
|
732
|
+
{
|
|
733
|
+
city: "Bad Krozingen",
|
|
734
|
+
country: "Germany",
|
|
735
|
+
region: "Europe",
|
|
736
|
+
state: "Baden-Wurttemberg",
|
|
737
|
+
},
|
|
738
|
+
],
|
|
739
|
+
});
|
|
740
|
+
|
|
741
|
+
// Handle the result
|
|
742
|
+
console.log(result);
|
|
743
|
+
}
|
|
744
|
+
|
|
745
|
+
run();
|
|
746
|
+
```
|
|
747
|
+
|
|
748
|
+
### Standalone function
|
|
749
|
+
|
|
750
|
+
The standalone function version of this method:
|
|
751
|
+
|
|
752
|
+
```typescript
|
|
753
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
754
|
+
import { internalLeaderboardV1GetAccountMeta } from "@steamsets/client-ts/funcs/internalLeaderboardV1GetAccountMeta.js";
|
|
755
|
+
|
|
756
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
757
|
+
// You can create one instance of it to use across an application.
|
|
758
|
+
const steamSets = new SteamSetsCore({
|
|
759
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
760
|
+
});
|
|
761
|
+
|
|
762
|
+
async function run() {
|
|
763
|
+
const res = await internalLeaderboardV1GetAccountMeta(steamSets, {
|
|
764
|
+
app: {
|
|
765
|
+
appId: 730,
|
|
766
|
+
},
|
|
767
|
+
badge: {
|
|
768
|
+
id: 335243,
|
|
769
|
+
isFoil: true,
|
|
770
|
+
},
|
|
771
|
+
leaderboard: "xp",
|
|
772
|
+
location: [
|
|
773
|
+
{
|
|
774
|
+
city: "Bad Krozingen",
|
|
775
|
+
country: "Germany",
|
|
776
|
+
region: "Europe",
|
|
777
|
+
state: "Baden-Wurttemberg",
|
|
778
|
+
},
|
|
779
|
+
],
|
|
780
|
+
});
|
|
781
|
+
|
|
782
|
+
if (!res.ok) {
|
|
783
|
+
throw res.error;
|
|
784
|
+
}
|
|
785
|
+
|
|
786
|
+
const { value: result } = res;
|
|
787
|
+
|
|
788
|
+
// Handle the result
|
|
789
|
+
console.log(result);
|
|
790
|
+
}
|
|
791
|
+
|
|
792
|
+
run();
|
|
793
|
+
```
|
|
794
|
+
|
|
795
|
+
### Parameters
|
|
796
|
+
|
|
797
|
+
| Parameter | Type | Required | Description |
|
|
798
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
799
|
+
| `request` | [components.V1LeaderboardAccountMetaRequestBody](../../models/components/v1leaderboardaccountmetarequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
800
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
801
|
+
| `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. |
|
|
802
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
803
|
+
|
|
804
|
+
### Response
|
|
805
|
+
|
|
806
|
+
**Promise\<[operations.LeaderboardV1GetAccountMetaResponse](../../models/operations/leaderboardv1getaccountmetaresponse.md)\>**
|
|
807
|
+
|
|
808
|
+
### Errors
|
|
809
|
+
|
|
810
|
+
| Error Type | Status Code | Content Type |
|
|
811
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
812
|
+
| errors.ErrorModel | 404, 422 | application/problem+json |
|
|
813
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
814
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
815
|
+
|
|
781
816
|
## check
|
|
782
817
|
|
|
783
818
|
This endpoint checks if the service is alive.
|