@steamsets/client-ts 0.5.1 → 0.5.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -0
- package/docs/sdks/account/README.md +160 -2
- package/docs/sdks/data/README.md +160 -2
- package/docs/sdks/public/README.md +160 -2
- package/funcs/accountAccountV1GetApps.js +2 -2
- package/funcs/accountAccountV1GetApps.js.map +1 -1
- package/funcs/accountAccountV1GetBadges.js +2 -2
- package/funcs/accountAccountV1GetBadges.js.map +1 -1
- package/funcs/accountAccountV1GetFriends.d.ts +13 -0
- package/funcs/accountAccountV1GetFriends.d.ts.map +1 -0
- package/funcs/accountAccountV1GetFriends.js +105 -0
- package/funcs/accountAccountV1GetFriends.js.map +1 -0
- package/funcs/accountAccountV1GetLeaderboardHistory.d.ts +13 -0
- package/funcs/accountAccountV1GetLeaderboardHistory.d.ts.map +1 -0
- package/funcs/accountAccountV1GetLeaderboardHistory.js +105 -0
- package/funcs/accountAccountV1GetLeaderboardHistory.js.map +1 -0
- package/funcs/dataAccountV1GetApps.js +2 -2
- package/funcs/dataAccountV1GetApps.js.map +1 -1
- package/funcs/dataAccountV1GetBadges.js +2 -2
- package/funcs/dataAccountV1GetBadges.js.map +1 -1
- package/funcs/dataAccountV1GetFriends.d.ts +13 -0
- package/funcs/dataAccountV1GetFriends.d.ts.map +1 -0
- package/funcs/dataAccountV1GetFriends.js +105 -0
- package/funcs/dataAccountV1GetFriends.js.map +1 -0
- package/funcs/dataAccountV1GetLeaderboardHistory.d.ts +13 -0
- package/funcs/dataAccountV1GetLeaderboardHistory.d.ts.map +1 -0
- package/funcs/dataAccountV1GetLeaderboardHistory.js +105 -0
- package/funcs/dataAccountV1GetLeaderboardHistory.js.map +1 -0
- package/funcs/publicAccountV1GetApps.js +2 -2
- package/funcs/publicAccountV1GetApps.js.map +1 -1
- package/funcs/publicAccountV1GetBadges.js +2 -2
- package/funcs/publicAccountV1GetBadges.js.map +1 -1
- package/funcs/publicAccountV1GetFriends.d.ts +13 -0
- package/funcs/publicAccountV1GetFriends.d.ts.map +1 -0
- package/funcs/publicAccountV1GetFriends.js +105 -0
- package/funcs/publicAccountV1GetFriends.js.map +1 -0
- package/funcs/publicAccountV1GetLeaderboardHistory.d.ts +13 -0
- package/funcs/publicAccountV1GetLeaderboardHistory.d.ts.map +1 -0
- package/funcs/publicAccountV1GetLeaderboardHistory.js +105 -0
- package/funcs/publicAccountV1GetLeaderboardHistory.js.map +1 -0
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/models/components/accountleaderboardhistory.d.ts +96 -0
- package/models/components/accountleaderboardhistory.d.ts.map +1 -0
- package/models/components/accountleaderboardhistory.js +91 -0
- package/models/components/accountleaderboardhistory.js.map +1 -0
- package/models/components/index.d.ts +5 -1
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +5 -1
- package/models/components/index.js.map +1 -1
- package/models/components/v1accountapp.d.ts +53 -0
- package/models/components/v1accountapp.d.ts.map +1 -0
- package/models/components/{v1app.js → v1accountapp.js} +11 -11
- package/models/components/v1accountapp.js.map +1 -0
- package/models/components/v1accountfriend.d.ts +198 -0
- package/models/components/v1accountfriend.d.ts.map +1 -0
- package/models/components/v1accountfriend.js +133 -0
- package/models/components/v1accountfriend.js.map +1 -0
- package/models/components/v1accountfriendsresponsebody.d.ts +31 -0
- package/models/components/v1accountfriendsresponsebody.d.ts.map +1 -0
- package/models/components/v1accountfriendsresponsebody.js +66 -0
- package/models/components/v1accountfriendsresponsebody.js.map +1 -0
- package/models/components/v1accountleaderboardhistoryresponsebody.d.ts +31 -0
- package/models/components/v1accountleaderboardhistoryresponsebody.d.ts.map +1 -0
- package/models/components/v1accountleaderboardhistoryresponsebody.js +66 -0
- package/models/components/v1accountleaderboardhistoryresponsebody.js.map +1 -0
- package/models/components/v1accountsappsresponsebody.d.ts +3 -3
- package/models/components/v1accountsappsresponsebody.d.ts.map +1 -1
- package/models/components/v1accountsappsresponsebody.js +3 -3
- package/models/components/v1accountsappsresponsebody.js.map +1 -1
- package/models/operations/accountv1getfriends.d.ts +58 -0
- package/models/operations/accountv1getfriends.d.ts.map +1 -0
- package/models/operations/accountv1getfriends.js +107 -0
- package/models/operations/accountv1getfriends.js.map +1 -0
- package/models/operations/accountv1getleaderboardhistory.d.ts +58 -0
- package/models/operations/accountv1getleaderboardhistory.d.ts.map +1 -0
- package/models/operations/accountv1getleaderboardhistory.js +107 -0
- package/models/operations/accountv1getleaderboardhistory.js.map +1 -0
- package/models/operations/index.d.ts +2 -0
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +2 -0
- package/models/operations/index.js.map +1 -1
- package/package.json +1 -1
- package/sdk/account.d.ts +8 -0
- package/sdk/account.d.ts.map +1 -1
- package/sdk/account.js +14 -0
- package/sdk/account.js.map +1 -1
- package/sdk/data.d.ts +8 -0
- package/sdk/data.d.ts.map +1 -1
- package/sdk/data.js +14 -0
- package/sdk/data.js.map +1 -1
- package/sdk/public.d.ts +8 -0
- package/sdk/public.d.ts.map +1 -1
- package/sdk/public.js +14 -0
- package/sdk/public.js.map +1 -1
- package/src/funcs/accountAccountV1GetApps.ts +2 -2
- package/src/funcs/accountAccountV1GetBadges.ts +2 -2
- package/src/funcs/accountAccountV1GetFriends.ts +139 -0
- package/src/funcs/accountAccountV1GetLeaderboardHistory.ts +139 -0
- package/src/funcs/dataAccountV1GetApps.ts +2 -2
- package/src/funcs/dataAccountV1GetBadges.ts +2 -2
- package/src/funcs/dataAccountV1GetFriends.ts +139 -0
- package/src/funcs/dataAccountV1GetLeaderboardHistory.ts +139 -0
- package/src/funcs/publicAccountV1GetApps.ts +2 -2
- package/src/funcs/publicAccountV1GetBadges.ts +2 -2
- package/src/funcs/publicAccountV1GetFriends.ts +139 -0
- package/src/funcs/publicAccountV1GetLeaderboardHistory.ts +139 -0
- package/src/lib/config.ts +3 -3
- package/src/models/components/accountleaderboardhistory.ts +103 -0
- package/src/models/components/index.ts +5 -1
- package/src/models/components/{v1app.ts → v1accountapp.ts} +15 -11
- package/src/models/components/v1accountfriend.ts +307 -0
- package/src/models/components/v1accountfriendsresponsebody.ts +71 -0
- package/src/models/components/v1accountleaderboardhistoryresponsebody.ts +71 -0
- package/src/models/components/v1accountsappsresponsebody.ts +10 -5
- package/src/models/operations/accountv1getfriends.ts +134 -0
- package/src/models/operations/accountv1getleaderboardhistory.ts +138 -0
- package/src/models/operations/index.ts +2 -0
- package/src/sdk/account.ts +22 -0
- package/src/sdk/data.ts +22 -0
- package/src/sdk/public.ts +22 -0
- package/models/components/v1app.d.ts +0 -53
- package/models/components/v1app.d.ts.map +0 -1
- package/models/components/v1app.js.map +0 -1
package/README.md
CHANGED
|
@@ -89,7 +89,9 @@ run();
|
|
|
89
89
|
* [accountV1SettingsGenerateApiKey](docs/sdks/account/README.md#accountv1settingsgenerateapikey) - Generate a new API key for the account
|
|
90
90
|
* [accountV1GetApps](docs/sdks/account/README.md#accountv1getapps) - Get Account Apps
|
|
91
91
|
* [accountV1GetBadges](docs/sdks/account/README.md#accountv1getbadges) - Get Account Badges
|
|
92
|
+
* [accountV1GetFriends](docs/sdks/account/README.md#accountv1getfriends) - Get Account Friends
|
|
92
93
|
* [accountV1GetInfo](docs/sdks/account/README.md#accountv1getinfo) - Get Account Info
|
|
94
|
+
* [accountV1GetLeaderboardHistory](docs/sdks/account/README.md#accountv1getleaderboardhistory) - Get Account Leaderboard History
|
|
93
95
|
* [accountV1SessionGet](docs/sdks/account/README.md#accountv1sessionget) - Gets all session data
|
|
94
96
|
* [accountV1SettingsGet](docs/sdks/account/README.md#accountv1settingsget) - Gets all settings for the account
|
|
95
97
|
* [accountV1GetStaff](docs/sdks/account/README.md#accountv1getstaff) - Get Staff Members and their info
|
|
@@ -131,14 +133,18 @@ run();
|
|
|
131
133
|
|
|
132
134
|
* [accountV1GetApps](docs/sdks/data/README.md#accountv1getapps) - Get Account Apps
|
|
133
135
|
* [accountV1GetBadges](docs/sdks/data/README.md#accountv1getbadges) - Get Account Badges
|
|
136
|
+
* [accountV1GetFriends](docs/sdks/data/README.md#accountv1getfriends) - Get Account Friends
|
|
134
137
|
* [accountV1GetInfo](docs/sdks/data/README.md#accountv1getinfo) - Get Account Info
|
|
138
|
+
* [accountV1GetLeaderboardHistory](docs/sdks/data/README.md#accountv1getleaderboardhistory) - Get Account Leaderboard History
|
|
135
139
|
* [accountV1GetStaff](docs/sdks/data/README.md#accountv1getstaff) - Get Staff Members and their info
|
|
136
140
|
|
|
137
141
|
### [public](docs/sdks/public/README.md)
|
|
138
142
|
|
|
139
143
|
* [accountV1GetApps](docs/sdks/public/README.md#accountv1getapps) - Get Account Apps
|
|
140
144
|
* [accountV1GetBadges](docs/sdks/public/README.md#accountv1getbadges) - Get Account Badges
|
|
145
|
+
* [accountV1GetFriends](docs/sdks/public/README.md#accountv1getfriends) - Get Account Friends
|
|
141
146
|
* [accountV1GetInfo](docs/sdks/public/README.md#accountv1getinfo) - Get Account Info
|
|
147
|
+
* [accountV1GetLeaderboardHistory](docs/sdks/public/README.md#accountv1getleaderboardhistory) - Get Account Leaderboard History
|
|
142
148
|
|
|
143
149
|
### [liveness](docs/sdks/liveness/README.md)
|
|
144
150
|
|
|
@@ -458,7 +464,9 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
458
464
|
- [accountAccountV1ConnectionVerifyConnection](docs/sdks/account/README.md#accountv1connectionverifyconnection)
|
|
459
465
|
- [accountAccountV1GetApps](docs/sdks/account/README.md#accountv1getapps)
|
|
460
466
|
- [accountAccountV1GetBadges](docs/sdks/account/README.md#accountv1getbadges)
|
|
467
|
+
- [accountAccountV1GetFriends](docs/sdks/account/README.md#accountv1getfriends)
|
|
461
468
|
- [accountAccountV1GetInfo](docs/sdks/account/README.md#accountv1getinfo)
|
|
469
|
+
- [accountAccountV1GetLeaderboardHistory](docs/sdks/account/README.md#accountv1getleaderboardhistory)
|
|
462
470
|
- [accountAccountV1GetStaff](docs/sdks/account/README.md#accountv1getstaff)
|
|
463
471
|
- [accountAccountV1SessionCreate](docs/sdks/account/README.md#accountv1sessioncreate)
|
|
464
472
|
- [accountAccountV1SessionDelete](docs/sdks/account/README.md#accountv1sessiondelete)
|
|
@@ -478,13 +486,17 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
478
486
|
- [connectionAccountV1ConnectionVerifyConnection](docs/sdks/connection/README.md#accountv1connectionverifyconnection)
|
|
479
487
|
- [dataAccountV1GetApps](docs/sdks/data/README.md#accountv1getapps)
|
|
480
488
|
- [dataAccountV1GetBadges](docs/sdks/data/README.md#accountv1getbadges)
|
|
489
|
+
- [dataAccountV1GetFriends](docs/sdks/data/README.md#accountv1getfriends)
|
|
481
490
|
- [dataAccountV1GetInfo](docs/sdks/data/README.md#accountv1getinfo)
|
|
491
|
+
- [dataAccountV1GetLeaderboardHistory](docs/sdks/data/README.md#accountv1getleaderboardhistory)
|
|
482
492
|
- [dataAccountV1GetStaff](docs/sdks/data/README.md#accountv1getstaff)
|
|
483
493
|
- [livenessLiveness](docs/sdks/liveness/README.md#liveness)
|
|
484
494
|
- [locationLocation](docs/sdks/location/README.md#location)
|
|
485
495
|
- [publicAccountV1GetApps](docs/sdks/public/README.md#accountv1getapps)
|
|
486
496
|
- [publicAccountV1GetBadges](docs/sdks/public/README.md#accountv1getbadges)
|
|
497
|
+
- [publicAccountV1GetFriends](docs/sdks/public/README.md#accountv1getfriends)
|
|
487
498
|
- [publicAccountV1GetInfo](docs/sdks/public/README.md#accountv1getinfo)
|
|
499
|
+
- [publicAccountV1GetLeaderboardHistory](docs/sdks/public/README.md#accountv1getleaderboardhistory)
|
|
488
500
|
- [sessionAccountV1SessionCreate](docs/sdks/session/README.md#accountv1sessioncreate)
|
|
489
501
|
- [sessionAccountV1SessionDelete](docs/sdks/session/README.md#accountv1sessiondelete)
|
|
490
502
|
- [sessionAccountV1SessionGet](docs/sdks/session/README.md#accountv1sessionget)
|
|
@@ -15,7 +15,9 @@ Account related operations
|
|
|
15
15
|
* [accountV1SettingsGenerateApiKey](#accountv1settingsgenerateapikey) - Generate a new API key for the account
|
|
16
16
|
* [accountV1GetApps](#accountv1getapps) - Get Account Apps
|
|
17
17
|
* [accountV1GetBadges](#accountv1getbadges) - Get Account Badges
|
|
18
|
+
* [accountV1GetFriends](#accountv1getfriends) - Get Account Friends
|
|
18
19
|
* [accountV1GetInfo](#accountv1getinfo) - Get Account Info
|
|
20
|
+
* [accountV1GetLeaderboardHistory](#accountv1getleaderboardhistory) - Get Account Leaderboard History
|
|
19
21
|
* [accountV1SessionGet](#accountv1sessionget) - Gets all session data
|
|
20
22
|
* [accountV1SettingsGet](#accountv1settingsget) - Gets all settings for the account
|
|
21
23
|
* [accountV1GetStaff](#accountv1getstaff) - Get Staff Members and their info
|
|
@@ -573,7 +575,7 @@ run();
|
|
|
573
575
|
|
|
574
576
|
| Error Object | Status Code | Content Type |
|
|
575
577
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
576
|
-
| errors.ErrorModel | 400,422,500
|
|
578
|
+
| errors.ErrorModel | 400,404,422,500 | application/problem+json |
|
|
577
579
|
| errors.SDKError | 4xx-5xx | */* |
|
|
578
580
|
|
|
579
581
|
|
|
@@ -651,7 +653,85 @@ run();
|
|
|
651
653
|
|
|
652
654
|
| Error Object | Status Code | Content Type |
|
|
653
655
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
654
|
-
| errors.ErrorModel | 400,422,500
|
|
656
|
+
| errors.ErrorModel | 400,404,422,500 | application/problem+json |
|
|
657
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
## accountV1GetFriends
|
|
661
|
+
|
|
662
|
+
Get Account Friends
|
|
663
|
+
|
|
664
|
+
### Example Usage
|
|
665
|
+
|
|
666
|
+
```typescript
|
|
667
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
668
|
+
|
|
669
|
+
const steamSets = new SteamSets({
|
|
670
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
671
|
+
});
|
|
672
|
+
|
|
673
|
+
async function run() {
|
|
674
|
+
const result = await steamSets.account.accountV1GetFriends({
|
|
675
|
+
accountSearch: {},
|
|
676
|
+
});
|
|
677
|
+
|
|
678
|
+
// Handle the result
|
|
679
|
+
console.log(result)
|
|
680
|
+
}
|
|
681
|
+
|
|
682
|
+
run();
|
|
683
|
+
```
|
|
684
|
+
|
|
685
|
+
### Standalone function
|
|
686
|
+
|
|
687
|
+
The standalone function version of this method:
|
|
688
|
+
|
|
689
|
+
```typescript
|
|
690
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
691
|
+
import { accountAccountV1GetFriends } from "@steamsets/client-ts/funcs/accountAccountV1GetFriends.js";
|
|
692
|
+
|
|
693
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
694
|
+
// You can create one instance of it to use across an application.
|
|
695
|
+
const steamSets = new SteamSetsCore({
|
|
696
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
697
|
+
});
|
|
698
|
+
|
|
699
|
+
async function run() {
|
|
700
|
+
const res = await accountAccountV1GetFriends(steamSets, {
|
|
701
|
+
accountSearch: {},
|
|
702
|
+
});
|
|
703
|
+
|
|
704
|
+
if (!res.ok) {
|
|
705
|
+
throw res.error;
|
|
706
|
+
}
|
|
707
|
+
|
|
708
|
+
const { value: result } = res;
|
|
709
|
+
|
|
710
|
+
// Handle the result
|
|
711
|
+
console.log(result)
|
|
712
|
+
}
|
|
713
|
+
|
|
714
|
+
run();
|
|
715
|
+
```
|
|
716
|
+
|
|
717
|
+
### Parameters
|
|
718
|
+
|
|
719
|
+
| Parameter | Type | Required | Description |
|
|
720
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
721
|
+
| `request` | [operations.AccountV1GetFriendsRequest](../../models/operations/accountv1getfriendsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
722
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
723
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
724
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
725
|
+
|
|
726
|
+
### Response
|
|
727
|
+
|
|
728
|
+
**Promise\<[operations.AccountV1GetFriendsResponse](../../models/operations/accountv1getfriendsresponse.md)\>**
|
|
729
|
+
|
|
730
|
+
### Errors
|
|
731
|
+
|
|
732
|
+
| Error Object | Status Code | Content Type |
|
|
733
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
734
|
+
| errors.ErrorModel | 400,404,422,500 | application/problem+json |
|
|
655
735
|
| errors.SDKError | 4xx-5xx | */* |
|
|
656
736
|
|
|
657
737
|
|
|
@@ -729,6 +809,84 @@ run();
|
|
|
729
809
|
| errors.SDKError | 4xx-5xx | */* |
|
|
730
810
|
|
|
731
811
|
|
|
812
|
+
## accountV1GetLeaderboardHistory
|
|
813
|
+
|
|
814
|
+
Get Account Leaderboard History
|
|
815
|
+
|
|
816
|
+
### Example Usage
|
|
817
|
+
|
|
818
|
+
```typescript
|
|
819
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
820
|
+
|
|
821
|
+
const steamSets = new SteamSets({
|
|
822
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
823
|
+
});
|
|
824
|
+
|
|
825
|
+
async function run() {
|
|
826
|
+
const result = await steamSets.account.accountV1GetLeaderboardHistory({
|
|
827
|
+
accountSearch: {},
|
|
828
|
+
});
|
|
829
|
+
|
|
830
|
+
// Handle the result
|
|
831
|
+
console.log(result)
|
|
832
|
+
}
|
|
833
|
+
|
|
834
|
+
run();
|
|
835
|
+
```
|
|
836
|
+
|
|
837
|
+
### Standalone function
|
|
838
|
+
|
|
839
|
+
The standalone function version of this method:
|
|
840
|
+
|
|
841
|
+
```typescript
|
|
842
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
843
|
+
import { accountAccountV1GetLeaderboardHistory } from "@steamsets/client-ts/funcs/accountAccountV1GetLeaderboardHistory.js";
|
|
844
|
+
|
|
845
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
846
|
+
// You can create one instance of it to use across an application.
|
|
847
|
+
const steamSets = new SteamSetsCore({
|
|
848
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
849
|
+
});
|
|
850
|
+
|
|
851
|
+
async function run() {
|
|
852
|
+
const res = await accountAccountV1GetLeaderboardHistory(steamSets, {
|
|
853
|
+
accountSearch: {},
|
|
854
|
+
});
|
|
855
|
+
|
|
856
|
+
if (!res.ok) {
|
|
857
|
+
throw res.error;
|
|
858
|
+
}
|
|
859
|
+
|
|
860
|
+
const { value: result } = res;
|
|
861
|
+
|
|
862
|
+
// Handle the result
|
|
863
|
+
console.log(result)
|
|
864
|
+
}
|
|
865
|
+
|
|
866
|
+
run();
|
|
867
|
+
```
|
|
868
|
+
|
|
869
|
+
### Parameters
|
|
870
|
+
|
|
871
|
+
| Parameter | Type | Required | Description |
|
|
872
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
873
|
+
| `request` | [operations.AccountV1GetLeaderboardHistoryRequest](../../models/operations/accountv1getleaderboardhistoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
874
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
875
|
+
| `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. |
|
|
876
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
877
|
+
|
|
878
|
+
### Response
|
|
879
|
+
|
|
880
|
+
**Promise\<[operations.AccountV1GetLeaderboardHistoryResponse](../../models/operations/accountv1getleaderboardhistoryresponse.md)\>**
|
|
881
|
+
|
|
882
|
+
### Errors
|
|
883
|
+
|
|
884
|
+
| Error Object | Status Code | Content Type |
|
|
885
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
886
|
+
| errors.ErrorModel | 400,404,422,500 | application/problem+json |
|
|
887
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
888
|
+
|
|
889
|
+
|
|
732
890
|
## accountV1SessionGet
|
|
733
891
|
|
|
734
892
|
Gets all session data
|
package/docs/sdks/data/README.md
CHANGED
|
@@ -9,7 +9,9 @@ This is actual data seen by others then yourself
|
|
|
9
9
|
|
|
10
10
|
* [accountV1GetApps](#accountv1getapps) - Get Account Apps
|
|
11
11
|
* [accountV1GetBadges](#accountv1getbadges) - Get Account Badges
|
|
12
|
+
* [accountV1GetFriends](#accountv1getfriends) - Get Account Friends
|
|
12
13
|
* [accountV1GetInfo](#accountv1getinfo) - Get Account Info
|
|
14
|
+
* [accountV1GetLeaderboardHistory](#accountv1getleaderboardhistory) - Get Account Leaderboard History
|
|
13
15
|
* [accountV1GetStaff](#accountv1getstaff) - Get Staff Members and their info
|
|
14
16
|
|
|
15
17
|
## accountV1GetApps
|
|
@@ -86,7 +88,7 @@ run();
|
|
|
86
88
|
|
|
87
89
|
| Error Object | Status Code | Content Type |
|
|
88
90
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
89
|
-
| errors.ErrorModel | 400,422,500
|
|
91
|
+
| errors.ErrorModel | 400,404,422,500 | application/problem+json |
|
|
90
92
|
| errors.SDKError | 4xx-5xx | */* |
|
|
91
93
|
|
|
92
94
|
|
|
@@ -164,7 +166,85 @@ run();
|
|
|
164
166
|
|
|
165
167
|
| Error Object | Status Code | Content Type |
|
|
166
168
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
167
|
-
| errors.ErrorModel | 400,422,500
|
|
169
|
+
| errors.ErrorModel | 400,404,422,500 | application/problem+json |
|
|
170
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
## accountV1GetFriends
|
|
174
|
+
|
|
175
|
+
Get Account Friends
|
|
176
|
+
|
|
177
|
+
### Example Usage
|
|
178
|
+
|
|
179
|
+
```typescript
|
|
180
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
181
|
+
|
|
182
|
+
const steamSets = new SteamSets({
|
|
183
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
184
|
+
});
|
|
185
|
+
|
|
186
|
+
async function run() {
|
|
187
|
+
const result = await steamSets.data.accountV1GetFriends({
|
|
188
|
+
accountSearch: {},
|
|
189
|
+
});
|
|
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 { dataAccountV1GetFriends } from "@steamsets/client-ts/funcs/dataAccountV1GetFriends.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
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
210
|
+
});
|
|
211
|
+
|
|
212
|
+
async function run() {
|
|
213
|
+
const res = await dataAccountV1GetFriends(steamSets, {
|
|
214
|
+
accountSearch: {},
|
|
215
|
+
});
|
|
216
|
+
|
|
217
|
+
if (!res.ok) {
|
|
218
|
+
throw res.error;
|
|
219
|
+
}
|
|
220
|
+
|
|
221
|
+
const { value: result } = res;
|
|
222
|
+
|
|
223
|
+
// Handle the result
|
|
224
|
+
console.log(result)
|
|
225
|
+
}
|
|
226
|
+
|
|
227
|
+
run();
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
### Parameters
|
|
231
|
+
|
|
232
|
+
| Parameter | Type | Required | Description |
|
|
233
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
234
|
+
| `request` | [operations.AccountV1GetFriendsRequest](../../models/operations/accountv1getfriendsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
235
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
236
|
+
| `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. |
|
|
237
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
238
|
+
|
|
239
|
+
### Response
|
|
240
|
+
|
|
241
|
+
**Promise\<[operations.AccountV1GetFriendsResponse](../../models/operations/accountv1getfriendsresponse.md)\>**
|
|
242
|
+
|
|
243
|
+
### Errors
|
|
244
|
+
|
|
245
|
+
| Error Object | Status Code | Content Type |
|
|
246
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
247
|
+
| errors.ErrorModel | 400,404,422,500 | application/problem+json |
|
|
168
248
|
| errors.SDKError | 4xx-5xx | */* |
|
|
169
249
|
|
|
170
250
|
|
|
@@ -242,6 +322,84 @@ run();
|
|
|
242
322
|
| errors.SDKError | 4xx-5xx | */* |
|
|
243
323
|
|
|
244
324
|
|
|
325
|
+
## accountV1GetLeaderboardHistory
|
|
326
|
+
|
|
327
|
+
Get Account Leaderboard History
|
|
328
|
+
|
|
329
|
+
### Example Usage
|
|
330
|
+
|
|
331
|
+
```typescript
|
|
332
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
333
|
+
|
|
334
|
+
const steamSets = new SteamSets({
|
|
335
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
336
|
+
});
|
|
337
|
+
|
|
338
|
+
async function run() {
|
|
339
|
+
const result = await steamSets.data.accountV1GetLeaderboardHistory({
|
|
340
|
+
accountSearch: {},
|
|
341
|
+
});
|
|
342
|
+
|
|
343
|
+
// Handle the result
|
|
344
|
+
console.log(result)
|
|
345
|
+
}
|
|
346
|
+
|
|
347
|
+
run();
|
|
348
|
+
```
|
|
349
|
+
|
|
350
|
+
### Standalone function
|
|
351
|
+
|
|
352
|
+
The standalone function version of this method:
|
|
353
|
+
|
|
354
|
+
```typescript
|
|
355
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
356
|
+
import { dataAccountV1GetLeaderboardHistory } from "@steamsets/client-ts/funcs/dataAccountV1GetLeaderboardHistory.js";
|
|
357
|
+
|
|
358
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
359
|
+
// You can create one instance of it to use across an application.
|
|
360
|
+
const steamSets = new SteamSetsCore({
|
|
361
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
362
|
+
});
|
|
363
|
+
|
|
364
|
+
async function run() {
|
|
365
|
+
const res = await dataAccountV1GetLeaderboardHistory(steamSets, {
|
|
366
|
+
accountSearch: {},
|
|
367
|
+
});
|
|
368
|
+
|
|
369
|
+
if (!res.ok) {
|
|
370
|
+
throw res.error;
|
|
371
|
+
}
|
|
372
|
+
|
|
373
|
+
const { value: result } = res;
|
|
374
|
+
|
|
375
|
+
// Handle the result
|
|
376
|
+
console.log(result)
|
|
377
|
+
}
|
|
378
|
+
|
|
379
|
+
run();
|
|
380
|
+
```
|
|
381
|
+
|
|
382
|
+
### Parameters
|
|
383
|
+
|
|
384
|
+
| Parameter | Type | Required | Description |
|
|
385
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
386
|
+
| `request` | [operations.AccountV1GetLeaderboardHistoryRequest](../../models/operations/accountv1getleaderboardhistoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
387
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
388
|
+
| `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. |
|
|
389
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
390
|
+
|
|
391
|
+
### Response
|
|
392
|
+
|
|
393
|
+
**Promise\<[operations.AccountV1GetLeaderboardHistoryResponse](../../models/operations/accountv1getleaderboardhistoryresponse.md)\>**
|
|
394
|
+
|
|
395
|
+
### Errors
|
|
396
|
+
|
|
397
|
+
| Error Object | Status Code | Content Type |
|
|
398
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
399
|
+
| errors.ErrorModel | 400,404,422,500 | application/problem+json |
|
|
400
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
401
|
+
|
|
402
|
+
|
|
245
403
|
## accountV1GetStaff
|
|
246
404
|
|
|
247
405
|
Get Staff Members and their info
|
|
@@ -9,7 +9,9 @@ This API can be accessed by anyone with an API Key
|
|
|
9
9
|
|
|
10
10
|
* [accountV1GetApps](#accountv1getapps) - Get Account Apps
|
|
11
11
|
* [accountV1GetBadges](#accountv1getbadges) - Get Account Badges
|
|
12
|
+
* [accountV1GetFriends](#accountv1getfriends) - Get Account Friends
|
|
12
13
|
* [accountV1GetInfo](#accountv1getinfo) - Get Account Info
|
|
14
|
+
* [accountV1GetLeaderboardHistory](#accountv1getleaderboardhistory) - Get Account Leaderboard History
|
|
13
15
|
|
|
14
16
|
## accountV1GetApps
|
|
15
17
|
|
|
@@ -85,7 +87,7 @@ run();
|
|
|
85
87
|
|
|
86
88
|
| Error Object | Status Code | Content Type |
|
|
87
89
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
88
|
-
| errors.ErrorModel | 400,422,500
|
|
90
|
+
| errors.ErrorModel | 400,404,422,500 | application/problem+json |
|
|
89
91
|
| errors.SDKError | 4xx-5xx | */* |
|
|
90
92
|
|
|
91
93
|
|
|
@@ -163,7 +165,85 @@ run();
|
|
|
163
165
|
|
|
164
166
|
| Error Object | Status Code | Content Type |
|
|
165
167
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
166
|
-
| errors.ErrorModel | 400,422,500
|
|
168
|
+
| errors.ErrorModel | 400,404,422,500 | application/problem+json |
|
|
169
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
## accountV1GetFriends
|
|
173
|
+
|
|
174
|
+
Get Account Friends
|
|
175
|
+
|
|
176
|
+
### Example Usage
|
|
177
|
+
|
|
178
|
+
```typescript
|
|
179
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
180
|
+
|
|
181
|
+
const steamSets = new SteamSets({
|
|
182
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
183
|
+
});
|
|
184
|
+
|
|
185
|
+
async function run() {
|
|
186
|
+
const result = await steamSets.public.accountV1GetFriends({
|
|
187
|
+
accountSearch: {},
|
|
188
|
+
});
|
|
189
|
+
|
|
190
|
+
// Handle the result
|
|
191
|
+
console.log(result)
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
run();
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
### Standalone function
|
|
198
|
+
|
|
199
|
+
The standalone function version of this method:
|
|
200
|
+
|
|
201
|
+
```typescript
|
|
202
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
203
|
+
import { publicAccountV1GetFriends } from "@steamsets/client-ts/funcs/publicAccountV1GetFriends.js";
|
|
204
|
+
|
|
205
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
206
|
+
// You can create one instance of it to use across an application.
|
|
207
|
+
const steamSets = new SteamSetsCore({
|
|
208
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
209
|
+
});
|
|
210
|
+
|
|
211
|
+
async function run() {
|
|
212
|
+
const res = await publicAccountV1GetFriends(steamSets, {
|
|
213
|
+
accountSearch: {},
|
|
214
|
+
});
|
|
215
|
+
|
|
216
|
+
if (!res.ok) {
|
|
217
|
+
throw res.error;
|
|
218
|
+
}
|
|
219
|
+
|
|
220
|
+
const { value: result } = res;
|
|
221
|
+
|
|
222
|
+
// Handle the result
|
|
223
|
+
console.log(result)
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
run();
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
### Parameters
|
|
230
|
+
|
|
231
|
+
| Parameter | Type | Required | Description |
|
|
232
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
233
|
+
| `request` | [operations.AccountV1GetFriendsRequest](../../models/operations/accountv1getfriendsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
234
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
235
|
+
| `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. |
|
|
236
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
237
|
+
|
|
238
|
+
### Response
|
|
239
|
+
|
|
240
|
+
**Promise\<[operations.AccountV1GetFriendsResponse](../../models/operations/accountv1getfriendsresponse.md)\>**
|
|
241
|
+
|
|
242
|
+
### Errors
|
|
243
|
+
|
|
244
|
+
| Error Object | Status Code | Content Type |
|
|
245
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
246
|
+
| errors.ErrorModel | 400,404,422,500 | application/problem+json |
|
|
167
247
|
| errors.SDKError | 4xx-5xx | */* |
|
|
168
248
|
|
|
169
249
|
|
|
@@ -239,3 +319,81 @@ run();
|
|
|
239
319
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
240
320
|
| errors.ErrorModel | 404,422,429,500 | application/problem+json |
|
|
241
321
|
| errors.SDKError | 4xx-5xx | */* |
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
## accountV1GetLeaderboardHistory
|
|
325
|
+
|
|
326
|
+
Get Account Leaderboard History
|
|
327
|
+
|
|
328
|
+
### Example Usage
|
|
329
|
+
|
|
330
|
+
```typescript
|
|
331
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
332
|
+
|
|
333
|
+
const steamSets = new SteamSets({
|
|
334
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
335
|
+
});
|
|
336
|
+
|
|
337
|
+
async function run() {
|
|
338
|
+
const result = await steamSets.public.accountV1GetLeaderboardHistory({
|
|
339
|
+
accountSearch: {},
|
|
340
|
+
});
|
|
341
|
+
|
|
342
|
+
// Handle the result
|
|
343
|
+
console.log(result)
|
|
344
|
+
}
|
|
345
|
+
|
|
346
|
+
run();
|
|
347
|
+
```
|
|
348
|
+
|
|
349
|
+
### Standalone function
|
|
350
|
+
|
|
351
|
+
The standalone function version of this method:
|
|
352
|
+
|
|
353
|
+
```typescript
|
|
354
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
355
|
+
import { publicAccountV1GetLeaderboardHistory } from "@steamsets/client-ts/funcs/publicAccountV1GetLeaderboardHistory.js";
|
|
356
|
+
|
|
357
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
358
|
+
// You can create one instance of it to use across an application.
|
|
359
|
+
const steamSets = new SteamSetsCore({
|
|
360
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
361
|
+
});
|
|
362
|
+
|
|
363
|
+
async function run() {
|
|
364
|
+
const res = await publicAccountV1GetLeaderboardHistory(steamSets, {
|
|
365
|
+
accountSearch: {},
|
|
366
|
+
});
|
|
367
|
+
|
|
368
|
+
if (!res.ok) {
|
|
369
|
+
throw res.error;
|
|
370
|
+
}
|
|
371
|
+
|
|
372
|
+
const { value: result } = res;
|
|
373
|
+
|
|
374
|
+
// Handle the result
|
|
375
|
+
console.log(result)
|
|
376
|
+
}
|
|
377
|
+
|
|
378
|
+
run();
|
|
379
|
+
```
|
|
380
|
+
|
|
381
|
+
### Parameters
|
|
382
|
+
|
|
383
|
+
| Parameter | Type | Required | Description |
|
|
384
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
385
|
+
| `request` | [operations.AccountV1GetLeaderboardHistoryRequest](../../models/operations/accountv1getleaderboardhistoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
386
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
387
|
+
| `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. |
|
|
388
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
389
|
+
|
|
390
|
+
### Response
|
|
391
|
+
|
|
392
|
+
**Promise\<[operations.AccountV1GetLeaderboardHistoryResponse](../../models/operations/accountv1getleaderboardhistoryresponse.md)\>**
|
|
393
|
+
|
|
394
|
+
### Errors
|
|
395
|
+
|
|
396
|
+
| Error Object | Status Code | Content Type |
|
|
397
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
398
|
+
| errors.ErrorModel | 400,404,422,500 | application/problem+json |
|
|
399
|
+
| errors.SDKError | 4xx-5xx | */* |
|