@steamsets/client-ts 0.19.4 → 0.19.5

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.
Files changed (238) hide show
  1. package/README.md +0 -89
  2. package/docs/sdks/account/README.md +0 -204
  3. package/docs/sdks/images/README.md +0 -164
  4. package/jsr.json +1 -1
  5. package/lib/config.d.ts +2 -2
  6. package/lib/config.js +2 -2
  7. package/package.json +1 -1
  8. package/sdk/account.d.ts +0 -2
  9. package/sdk/account.d.ts.map +1 -1
  10. package/sdk/account.js +0 -8
  11. package/sdk/account.js.map +1 -1
  12. package/sdk/images.d.ts +0 -2
  13. package/sdk/images.d.ts.map +1 -1
  14. package/sdk/images.js +0 -8
  15. package/sdk/images.js.map +1 -1
  16. package/sdk/sdk.d.ts +2 -17
  17. package/sdk/sdk.d.ts.map +1 -1
  18. package/sdk/sdk.js +2 -22
  19. package/sdk/sdk.js.map +1 -1
  20. package/src/lib/config.ts +2 -2
  21. package/src/sdk/account.ts +0 -24
  22. package/src/sdk/images.ts +0 -24
  23. package/src/sdk/sdk.ts +3 -33
  24. package/docs/sdks/data/README.md +0 -520
  25. package/docs/sdks/developer/README.md +0 -252
  26. package/docs/sdks/event/README.md +0 -80
  27. package/docs/sdks/external/README.md +0 -596
  28. package/docs/sdks/internal/README.md +0 -1137
  29. package/funcs/accountGetAccount.d.ts +0 -12
  30. package/funcs/accountGetAccount.d.ts.map +0 -1
  31. package/funcs/accountGetAccount.js +0 -118
  32. package/funcs/accountGetAccount.js.map +0 -1
  33. package/funcs/accountLeaderboardV1GetLeaderboardAccountMeta.d.ts +0 -12
  34. package/funcs/accountLeaderboardV1GetLeaderboardAccountMeta.d.ts.map +0 -1
  35. package/funcs/accountLeaderboardV1GetLeaderboardAccountMeta.js +0 -116
  36. package/funcs/accountLeaderboardV1GetLeaderboardAccountMeta.js.map +0 -1
  37. package/funcs/dataAccountV1GetMeta.d.ts +0 -12
  38. package/funcs/dataAccountV1GetMeta.d.ts.map +0 -1
  39. package/funcs/dataAccountV1GetMeta.js +0 -118
  40. package/funcs/dataAccountV1GetMeta.js.map +0 -1
  41. package/funcs/dataGetApps.d.ts +0 -12
  42. package/funcs/dataGetApps.d.ts.map +0 -1
  43. package/funcs/dataGetApps.js +0 -118
  44. package/funcs/dataGetApps.js.map +0 -1
  45. package/funcs/dataGetBadges.d.ts +0 -12
  46. package/funcs/dataGetBadges.d.ts.map +0 -1
  47. package/funcs/dataGetBadges.js +0 -118
  48. package/funcs/dataGetBadges.js.map +0 -1
  49. package/funcs/dataGetDataPoints.d.ts +0 -12
  50. package/funcs/dataGetDataPoints.d.ts.map +0 -1
  51. package/funcs/dataGetDataPoints.js +0 -118
  52. package/funcs/dataGetDataPoints.js.map +0 -1
  53. package/funcs/dataGetFriends.d.ts +0 -12
  54. package/funcs/dataGetFriends.d.ts.map +0 -1
  55. package/funcs/dataGetFriends.js +0 -118
  56. package/funcs/dataGetFriends.js.map +0 -1
  57. package/funcs/dataGetInfo.d.ts +0 -12
  58. package/funcs/dataGetInfo.d.ts.map +0 -1
  59. package/funcs/dataGetInfo.js +0 -118
  60. package/funcs/dataGetInfo.js.map +0 -1
  61. package/funcs/dataGetLeaderboardHistory.d.ts +0 -12
  62. package/funcs/dataGetLeaderboardHistory.d.ts.map +0 -1
  63. package/funcs/dataGetLeaderboardHistory.js +0 -116
  64. package/funcs/dataGetLeaderboardHistory.js.map +0 -1
  65. package/funcs/developerCreateDeveloperApp.d.ts +0 -12
  66. package/funcs/developerCreateDeveloperApp.d.ts.map +0 -1
  67. package/funcs/developerCreateDeveloperApp.js +0 -116
  68. package/funcs/developerCreateDeveloperApp.js.map +0 -1
  69. package/funcs/developerDeleteDeveloperApp.d.ts +0 -12
  70. package/funcs/developerDeleteDeveloperApp.d.ts.map +0 -1
  71. package/funcs/developerDeleteDeveloperApp.js +0 -116
  72. package/funcs/developerDeleteDeveloperApp.js.map +0 -1
  73. package/funcs/developerUpdateApp.d.ts +0 -12
  74. package/funcs/developerUpdateApp.d.ts.map +0 -1
  75. package/funcs/developerUpdateApp.js +0 -116
  76. package/funcs/developerUpdateApp.js.map +0 -1
  77. package/funcs/eventAdminV1RemoveVanity.d.ts +0 -12
  78. package/funcs/eventAdminV1RemoveVanity.d.ts.map +0 -1
  79. package/funcs/eventAdminV1RemoveVanity.js +0 -118
  80. package/funcs/eventAdminV1RemoveVanity.js.map +0 -1
  81. package/funcs/externalAppV1ListBadges.d.ts +0 -12
  82. package/funcs/externalAppV1ListBadges.d.ts.map +0 -1
  83. package/funcs/externalAppV1ListBadges.js +0 -118
  84. package/funcs/externalAppV1ListBadges.js.map +0 -1
  85. package/funcs/externalGet.d.ts +0 -11
  86. package/funcs/externalGet.d.ts.map +0 -1
  87. package/funcs/externalGet.js +0 -107
  88. package/funcs/externalGet.js.map +0 -1
  89. package/funcs/externalGetApps.d.ts +0 -12
  90. package/funcs/externalGetApps.d.ts.map +0 -1
  91. package/funcs/externalGetApps.js +0 -118
  92. package/funcs/externalGetApps.js.map +0 -1
  93. package/funcs/externalGetBadges.d.ts +0 -12
  94. package/funcs/externalGetBadges.d.ts.map +0 -1
  95. package/funcs/externalGetBadges.js +0 -118
  96. package/funcs/externalGetBadges.js.map +0 -1
  97. package/funcs/externalGetDataPoints.d.ts +0 -12
  98. package/funcs/externalGetDataPoints.d.ts.map +0 -1
  99. package/funcs/externalGetDataPoints.js +0 -118
  100. package/funcs/externalGetDataPoints.js.map +0 -1
  101. package/funcs/externalGetFriends.d.ts +0 -12
  102. package/funcs/externalGetFriends.d.ts.map +0 -1
  103. package/funcs/externalGetFriends.js +0 -118
  104. package/funcs/externalGetFriends.js.map +0 -1
  105. package/funcs/externalGetInfo.d.ts +0 -12
  106. package/funcs/externalGetInfo.d.ts.map +0 -1
  107. package/funcs/externalGetInfo.js +0 -118
  108. package/funcs/externalGetInfo.js.map +0 -1
  109. package/funcs/externalGetLeaderboardHistory.d.ts +0 -12
  110. package/funcs/externalGetLeaderboardHistory.d.ts.map +0 -1
  111. package/funcs/externalGetLeaderboardHistory.js +0 -116
  112. package/funcs/externalGetLeaderboardHistory.js.map +0 -1
  113. package/funcs/imagesDeleteImages.d.ts +0 -12
  114. package/funcs/imagesDeleteImages.d.ts.map +0 -1
  115. package/funcs/imagesDeleteImages.js +0 -118
  116. package/funcs/imagesDeleteImages.js.map +0 -1
  117. package/funcs/imagesUploadImages.d.ts +0 -12
  118. package/funcs/imagesUploadImages.d.ts.map +0 -1
  119. package/funcs/imagesUploadImages.js +0 -118
  120. package/funcs/imagesUploadImages.js.map +0 -1
  121. package/funcs/internalAccountV1GetMeta.d.ts +0 -12
  122. package/funcs/internalAccountV1GetMeta.d.ts.map +0 -1
  123. package/funcs/internalAccountV1GetMeta.js +0 -118
  124. package/funcs/internalAccountV1GetMeta.js.map +0 -1
  125. package/funcs/internalAdminV1RemoveVanity.d.ts +0 -12
  126. package/funcs/internalAdminV1RemoveVanity.d.ts.map +0 -1
  127. package/funcs/internalAdminV1RemoveVanity.js +0 -118
  128. package/funcs/internalAdminV1RemoveVanity.js.map +0 -1
  129. package/funcs/internalBadgeV1SearchSuggest.d.ts +0 -12
  130. package/funcs/internalBadgeV1SearchSuggest.d.ts.map +0 -1
  131. package/funcs/internalBadgeV1SearchSuggest.js +0 -118
  132. package/funcs/internalBadgeV1SearchSuggest.js.map +0 -1
  133. package/funcs/internalBadgeV1TagsSuggest.d.ts +0 -12
  134. package/funcs/internalBadgeV1TagsSuggest.d.ts.map +0 -1
  135. package/funcs/internalBadgeV1TagsSuggest.js +0 -118
  136. package/funcs/internalBadgeV1TagsSuggest.js.map +0 -1
  137. package/funcs/internalCheck.d.ts +0 -17
  138. package/funcs/internalCheck.d.ts.map +0 -1
  139. package/funcs/internalCheck.js +0 -111
  140. package/funcs/internalCheck.js.map +0 -1
  141. package/funcs/internalCreateDeveloperApp.d.ts +0 -12
  142. package/funcs/internalCreateDeveloperApp.d.ts.map +0 -1
  143. package/funcs/internalCreateDeveloperApp.js +0 -116
  144. package/funcs/internalCreateDeveloperApp.js.map +0 -1
  145. package/funcs/internalDeleteDeveloperApp.d.ts +0 -12
  146. package/funcs/internalDeleteDeveloperApp.d.ts.map +0 -1
  147. package/funcs/internalDeleteDeveloperApp.js +0 -116
  148. package/funcs/internalDeleteDeveloperApp.js.map +0 -1
  149. package/funcs/internalDeleteImages.d.ts +0 -12
  150. package/funcs/internalDeleteImages.d.ts.map +0 -1
  151. package/funcs/internalDeleteImages.js +0 -118
  152. package/funcs/internalDeleteImages.js.map +0 -1
  153. package/funcs/internalGetAccount.d.ts +0 -12
  154. package/funcs/internalGetAccount.d.ts.map +0 -1
  155. package/funcs/internalGetAccount.js +0 -118
  156. package/funcs/internalGetAccount.js.map +0 -1
  157. package/funcs/internalGetStaff.d.ts +0 -11
  158. package/funcs/internalGetStaff.d.ts.map +0 -1
  159. package/funcs/internalGetStaff.js +0 -107
  160. package/funcs/internalGetStaff.js.map +0 -1
  161. package/funcs/internalGetTags.d.ts +0 -11
  162. package/funcs/internalGetTags.d.ts.map +0 -1
  163. package/funcs/internalGetTags.js +0 -107
  164. package/funcs/internalGetTags.js.map +0 -1
  165. package/funcs/internalLeaderboardV1GetLeaderboardAccountMeta.d.ts +0 -12
  166. package/funcs/internalLeaderboardV1GetLeaderboardAccountMeta.d.ts.map +0 -1
  167. package/funcs/internalLeaderboardV1GetLeaderboardAccountMeta.js +0 -116
  168. package/funcs/internalLeaderboardV1GetLeaderboardAccountMeta.js.map +0 -1
  169. package/funcs/internalUpdateApp.d.ts +0 -12
  170. package/funcs/internalUpdateApp.d.ts.map +0 -1
  171. package/funcs/internalUpdateApp.js +0 -116
  172. package/funcs/internalUpdateApp.js.map +0 -1
  173. package/funcs/internalUploadImages.d.ts +0 -12
  174. package/funcs/internalUploadImages.d.ts.map +0 -1
  175. package/funcs/internalUploadImages.js +0 -118
  176. package/funcs/internalUploadImages.js.map +0 -1
  177. package/sdk/data.d.ts +0 -13
  178. package/sdk/data.d.ts.map +0 -1
  179. package/sdk/data.js +0 -40
  180. package/sdk/data.js.map +0 -1
  181. package/sdk/developer.d.ts +0 -9
  182. package/sdk/developer.d.ts.map +0 -1
  183. package/sdk/developer.js +0 -24
  184. package/sdk/developer.js.map +0 -1
  185. package/sdk/event.d.ts +0 -7
  186. package/sdk/event.d.ts.map +0 -1
  187. package/sdk/event.js +0 -16
  188. package/sdk/event.js.map +0 -1
  189. package/sdk/external.d.ts +0 -14
  190. package/sdk/external.d.ts.map +0 -1
  191. package/sdk/external.js +0 -44
  192. package/sdk/external.js.map +0 -1
  193. package/sdk/internal.d.ts +0 -26
  194. package/sdk/internal.d.ts.map +0 -1
  195. package/sdk/internal.js +0 -74
  196. package/sdk/internal.js.map +0 -1
  197. package/src/funcs/accountGetAccount.ts +0 -179
  198. package/src/funcs/accountLeaderboardV1GetLeaderboardAccountMeta.ts +0 -186
  199. package/src/funcs/dataAccountV1GetMeta.ts +0 -179
  200. package/src/funcs/dataGetApps.ts +0 -179
  201. package/src/funcs/dataGetBadges.ts +0 -179
  202. package/src/funcs/dataGetDataPoints.ts +0 -179
  203. package/src/funcs/dataGetFriends.ts +0 -179
  204. package/src/funcs/dataGetInfo.ts +0 -179
  205. package/src/funcs/dataGetLeaderboardHistory.ts +0 -181
  206. package/src/funcs/developerCreateDeveloperApp.ts +0 -182
  207. package/src/funcs/developerDeleteDeveloperApp.ts +0 -184
  208. package/src/funcs/developerUpdateApp.ts +0 -184
  209. package/src/funcs/eventAdminV1RemoveVanity.ts +0 -179
  210. package/src/funcs/externalAppV1ListBadges.ts +0 -179
  211. package/src/funcs/externalGet.ts +0 -160
  212. package/src/funcs/externalGetApps.ts +0 -179
  213. package/src/funcs/externalGetBadges.ts +0 -179
  214. package/src/funcs/externalGetDataPoints.ts +0 -179
  215. package/src/funcs/externalGetFriends.ts +0 -179
  216. package/src/funcs/externalGetInfo.ts +0 -179
  217. package/src/funcs/externalGetLeaderboardHistory.ts +0 -181
  218. package/src/funcs/imagesDeleteImages.ts +0 -179
  219. package/src/funcs/imagesUploadImages.ts +0 -179
  220. package/src/funcs/internalAccountV1GetMeta.ts +0 -179
  221. package/src/funcs/internalAdminV1RemoveVanity.ts +0 -179
  222. package/src/funcs/internalBadgeV1SearchSuggest.ts +0 -180
  223. package/src/funcs/internalBadgeV1TagsSuggest.ts +0 -180
  224. package/src/funcs/internalCheck.ts +0 -160
  225. package/src/funcs/internalCreateDeveloperApp.ts +0 -182
  226. package/src/funcs/internalDeleteDeveloperApp.ts +0 -184
  227. package/src/funcs/internalDeleteImages.ts +0 -179
  228. package/src/funcs/internalGetAccount.ts +0 -179
  229. package/src/funcs/internalGetStaff.ts +0 -160
  230. package/src/funcs/internalGetTags.ts +0 -160
  231. package/src/funcs/internalLeaderboardV1GetLeaderboardAccountMeta.ts +0 -186
  232. package/src/funcs/internalUpdateApp.ts +0 -184
  233. package/src/funcs/internalUploadImages.ts +0 -179
  234. package/src/sdk/data.ts +0 -94
  235. package/src/sdk/developer.ts +0 -46
  236. package/src/sdk/event.ts +0 -22
  237. package/src/sdk/external.ts +0 -104
  238. package/src/sdk/internal.ts +0 -178
@@ -1,596 +0,0 @@
1
- # External
2
- (*external*)
3
-
4
- ## Overview
5
-
6
- Any requests here may be accessed by anyone with an API Key.
7
-
8
- ### Available Operations
9
-
10
- * [getApps](#getapps)
11
- * [getBadges](#getbadges)
12
- * [getDataPoints](#getdatapoints)
13
- * [getFriends](#getfriends)
14
- * [getInfo](#getinfo)
15
- * [getLeaderboardHistory](#getleaderboardhistory)
16
- * [appV1ListBadges](#appv1listbadges)
17
- * [get](#get)
18
-
19
- ## getApps
20
-
21
- ### Example Usage
22
-
23
- ```typescript
24
- import { SteamSets } from "@steamsets/client-ts";
25
-
26
- const steamSets = new SteamSets({
27
- token: "<YOUR_BEARER_TOKEN_HERE>",
28
- });
29
-
30
- async function run() {
31
- const result = await steamSets.external.getApps({});
32
-
33
- // Handle the result
34
- console.log(result);
35
- }
36
-
37
- run();
38
- ```
39
-
40
- ### Standalone function
41
-
42
- The standalone function version of this method:
43
-
44
- ```typescript
45
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
46
- import { externalGetApps } from "@steamsets/client-ts/funcs/externalGetApps.js";
47
-
48
- // Use `SteamSetsCore` for best tree-shaking performance.
49
- // You can create one instance of it to use across an application.
50
- const steamSets = new SteamSetsCore({
51
- token: "<YOUR_BEARER_TOKEN_HERE>",
52
- });
53
-
54
- async function run() {
55
- const res = await externalGetApps(steamSets, {});
56
-
57
- if (!res.ok) {
58
- throw res.error;
59
- }
60
-
61
- const { value: result } = res;
62
-
63
- // Handle the result
64
- console.log(result);
65
- }
66
-
67
- run();
68
- ```
69
-
70
- ### Parameters
71
-
72
- | Parameter | Type | Required | Description |
73
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
74
- | `request` | [components.V1AccountsAppsRequestBody](../../models/components/v1accountsappsrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
75
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
76
- | `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. |
77
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
78
-
79
- ### Response
80
-
81
- **Promise\<[operations.AccountV1GetAppsResponse](../../models/operations/accountv1getappsresponse.md)\>**
82
-
83
- ### Errors
84
-
85
- | Error Type | Status Code | Content Type |
86
- | ------------------------ | ------------------------ | ------------------------ |
87
- | errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
88
- | errors.ErrorModel | 500 | application/problem+json |
89
- | errors.SDKError | 4XX, 5XX | \*/\* |
90
-
91
- ## getBadges
92
-
93
- ### Example Usage
94
-
95
- ```typescript
96
- import { SteamSets } from "@steamsets/client-ts";
97
-
98
- const steamSets = new SteamSets({
99
- token: "<YOUR_BEARER_TOKEN_HERE>",
100
- });
101
-
102
- async function run() {
103
- const result = await steamSets.external.getBadges({});
104
-
105
- // Handle the result
106
- console.log(result);
107
- }
108
-
109
- run();
110
- ```
111
-
112
- ### Standalone function
113
-
114
- The standalone function version of this method:
115
-
116
- ```typescript
117
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
118
- import { externalGetBadges } from "@steamsets/client-ts/funcs/externalGetBadges.js";
119
-
120
- // Use `SteamSetsCore` for best tree-shaking performance.
121
- // You can create one instance of it to use across an application.
122
- const steamSets = new SteamSetsCore({
123
- token: "<YOUR_BEARER_TOKEN_HERE>",
124
- });
125
-
126
- async function run() {
127
- const res = await externalGetBadges(steamSets, {});
128
-
129
- if (!res.ok) {
130
- throw res.error;
131
- }
132
-
133
- const { value: result } = res;
134
-
135
- // Handle the result
136
- console.log(result);
137
- }
138
-
139
- run();
140
- ```
141
-
142
- ### Parameters
143
-
144
- | Parameter | Type | Required | Description |
145
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
146
- | `request` | [components.V1BadgesRequestBody](../../models/components/v1badgesrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
147
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
148
- | `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. |
149
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
150
-
151
- ### Response
152
-
153
- **Promise\<[operations.AccountV1GetBadgesResponse](../../models/operations/accountv1getbadgesresponse.md)\>**
154
-
155
- ### Errors
156
-
157
- | Error Type | Status Code | Content Type |
158
- | ------------------------ | ------------------------ | ------------------------ |
159
- | errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
160
- | errors.ErrorModel | 500 | application/problem+json |
161
- | errors.SDKError | 4XX, 5XX | \*/\* |
162
-
163
- ## getDataPoints
164
-
165
- ### Example Usage
166
-
167
- ```typescript
168
- import { SteamSets } from "@steamsets/client-ts";
169
-
170
- const steamSets = new SteamSets({
171
- token: "<YOUR_BEARER_TOKEN_HERE>",
172
- });
173
-
174
- async function run() {
175
- const result = await steamSets.external.getDataPoints({});
176
-
177
- // Handle the result
178
- console.log(result);
179
- }
180
-
181
- run();
182
- ```
183
-
184
- ### Standalone function
185
-
186
- The standalone function version of this method:
187
-
188
- ```typescript
189
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
190
- import { externalGetDataPoints } from "@steamsets/client-ts/funcs/externalGetDataPoints.js";
191
-
192
- // Use `SteamSetsCore` for best tree-shaking performance.
193
- // You can create one instance of it to use across an application.
194
- const steamSets = new SteamSetsCore({
195
- token: "<YOUR_BEARER_TOKEN_HERE>",
196
- });
197
-
198
- async function run() {
199
- const res = await externalGetDataPoints(steamSets, {});
200
-
201
- if (!res.ok) {
202
- throw res.error;
203
- }
204
-
205
- const { value: result } = res;
206
-
207
- // Handle the result
208
- console.log(result);
209
- }
210
-
211
- run();
212
- ```
213
-
214
- ### Parameters
215
-
216
- | Parameter | Type | Required | Description |
217
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
218
- | `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
219
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
220
- | `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. |
221
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
222
-
223
- ### Response
224
-
225
- **Promise\<[operations.AccountV1GetDataPointsResponse](../../models/operations/accountv1getdatapointsresponse.md)\>**
226
-
227
- ### Errors
228
-
229
- | Error Type | Status Code | Content Type |
230
- | ------------------------ | ------------------------ | ------------------------ |
231
- | errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
232
- | errors.ErrorModel | 500 | application/problem+json |
233
- | errors.SDKError | 4XX, 5XX | \*/\* |
234
-
235
- ## getFriends
236
-
237
- ### Example Usage
238
-
239
- ```typescript
240
- import { SteamSets } from "@steamsets/client-ts";
241
-
242
- const steamSets = new SteamSets({
243
- token: "<YOUR_BEARER_TOKEN_HERE>",
244
- });
245
-
246
- async function run() {
247
- const result = await steamSets.external.getFriends({});
248
-
249
- // Handle the result
250
- console.log(result);
251
- }
252
-
253
- run();
254
- ```
255
-
256
- ### Standalone function
257
-
258
- The standalone function version of this method:
259
-
260
- ```typescript
261
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
262
- import { externalGetFriends } from "@steamsets/client-ts/funcs/externalGetFriends.js";
263
-
264
- // Use `SteamSetsCore` for best tree-shaking performance.
265
- // You can create one instance of it to use across an application.
266
- const steamSets = new SteamSetsCore({
267
- token: "<YOUR_BEARER_TOKEN_HERE>",
268
- });
269
-
270
- async function run() {
271
- const res = await externalGetFriends(steamSets, {});
272
-
273
- if (!res.ok) {
274
- throw res.error;
275
- }
276
-
277
- const { value: result } = res;
278
-
279
- // Handle the result
280
- console.log(result);
281
- }
282
-
283
- run();
284
- ```
285
-
286
- ### Parameters
287
-
288
- | Parameter | Type | Required | Description |
289
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
290
- | `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
291
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
292
- | `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. |
293
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
294
-
295
- ### Response
296
-
297
- **Promise\<[operations.AccountV1GetFriendsResponse](../../models/operations/accountv1getfriendsresponse.md)\>**
298
-
299
- ### Errors
300
-
301
- | Error Type | Status Code | Content Type |
302
- | ------------------------ | ------------------------ | ------------------------ |
303
- | errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
304
- | errors.ErrorModel | 500 | application/problem+json |
305
- | errors.SDKError | 4XX, 5XX | \*/\* |
306
-
307
- ## getInfo
308
-
309
- ### Example Usage
310
-
311
- ```typescript
312
- import { SteamSets } from "@steamsets/client-ts";
313
-
314
- const steamSets = new SteamSets({
315
- token: "<YOUR_BEARER_TOKEN_HERE>",
316
- });
317
-
318
- async function run() {
319
- const result = await steamSets.external.getInfo({});
320
-
321
- // Handle the result
322
- console.log(result);
323
- }
324
-
325
- run();
326
- ```
327
-
328
- ### Standalone function
329
-
330
- The standalone function version of this method:
331
-
332
- ```typescript
333
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
334
- import { externalGetInfo } from "@steamsets/client-ts/funcs/externalGetInfo.js";
335
-
336
- // Use `SteamSetsCore` for best tree-shaking performance.
337
- // You can create one instance of it to use across an application.
338
- const steamSets = new SteamSetsCore({
339
- token: "<YOUR_BEARER_TOKEN_HERE>",
340
- });
341
-
342
- async function run() {
343
- const res = await externalGetInfo(steamSets, {});
344
-
345
- if (!res.ok) {
346
- throw res.error;
347
- }
348
-
349
- const { value: result } = res;
350
-
351
- // Handle the result
352
- console.log(result);
353
- }
354
-
355
- run();
356
- ```
357
-
358
- ### Parameters
359
-
360
- | Parameter | Type | Required | Description |
361
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
362
- | `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
363
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
364
- | `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. |
365
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
366
-
367
- ### Response
368
-
369
- **Promise\<[operations.AccountV1GetInfoResponse](../../models/operations/accountv1getinforesponse.md)\>**
370
-
371
- ### Errors
372
-
373
- | Error Type | Status Code | Content Type |
374
- | ------------------------ | ------------------------ | ------------------------ |
375
- | errors.ErrorModel | 403, 404, 422, 429 | application/problem+json |
376
- | errors.ErrorModel | 500 | application/problem+json |
377
- | errors.SDKError | 4XX, 5XX | \*/\* |
378
-
379
- ## getLeaderboardHistory
380
-
381
- ### Example Usage
382
-
383
- ```typescript
384
- import { SteamSets } from "@steamsets/client-ts";
385
-
386
- const steamSets = new SteamSets({
387
- token: "<YOUR_BEARER_TOKEN_HERE>",
388
- });
389
-
390
- async function run() {
391
- const result = await steamSets.external.getLeaderboardHistory({});
392
-
393
- // Handle the result
394
- console.log(result);
395
- }
396
-
397
- run();
398
- ```
399
-
400
- ### Standalone function
401
-
402
- The standalone function version of this method:
403
-
404
- ```typescript
405
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
406
- import { externalGetLeaderboardHistory } from "@steamsets/client-ts/funcs/externalGetLeaderboardHistory.js";
407
-
408
- // Use `SteamSetsCore` for best tree-shaking performance.
409
- // You can create one instance of it to use across an application.
410
- const steamSets = new SteamSetsCore({
411
- token: "<YOUR_BEARER_TOKEN_HERE>",
412
- });
413
-
414
- async function run() {
415
- const res = await externalGetLeaderboardHistory(steamSets, {});
416
-
417
- if (!res.ok) {
418
- throw res.error;
419
- }
420
-
421
- const { value: result } = res;
422
-
423
- // Handle the result
424
- console.log(result);
425
- }
426
-
427
- run();
428
- ```
429
-
430
- ### Parameters
431
-
432
- | Parameter | Type | Required | Description |
433
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
434
- | `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
435
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
436
- | `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. |
437
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
438
-
439
- ### Response
440
-
441
- **Promise\<[operations.AccountV1GetLeaderboardHistoryResponse](../../models/operations/accountv1getleaderboardhistoryresponse.md)\>**
442
-
443
- ### Errors
444
-
445
- | Error Type | Status Code | Content Type |
446
- | ------------------------ | ------------------------ | ------------------------ |
447
- | errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
448
- | errors.ErrorModel | 500 | application/problem+json |
449
- | errors.SDKError | 4XX, 5XX | \*/\* |
450
-
451
- ## appV1ListBadges
452
-
453
- ### Example Usage
454
-
455
- ```typescript
456
- import { SteamSets } from "@steamsets/client-ts";
457
-
458
- const steamSets = new SteamSets({
459
- token: "<YOUR_BEARER_TOKEN_HERE>",
460
- });
461
-
462
- async function run() {
463
- const result = await steamSets.external.appV1ListBadges({
464
- appId: 701216,
465
- });
466
-
467
- // Handle the result
468
- console.log(result);
469
- }
470
-
471
- run();
472
- ```
473
-
474
- ### Standalone function
475
-
476
- The standalone function version of this method:
477
-
478
- ```typescript
479
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
480
- import { externalAppV1ListBadges } from "@steamsets/client-ts/funcs/externalAppV1ListBadges.js";
481
-
482
- // Use `SteamSetsCore` for best tree-shaking performance.
483
- // You can create one instance of it to use across an application.
484
- const steamSets = new SteamSetsCore({
485
- token: "<YOUR_BEARER_TOKEN_HERE>",
486
- });
487
-
488
- async function run() {
489
- const res = await externalAppV1ListBadges(steamSets, {
490
- appId: 701216,
491
- });
492
-
493
- if (!res.ok) {
494
- throw res.error;
495
- }
496
-
497
- const { value: result } = res;
498
-
499
- // Handle the result
500
- console.log(result);
501
- }
502
-
503
- run();
504
- ```
505
-
506
- ### Parameters
507
-
508
- | Parameter | Type | Required | Description |
509
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
510
- | `request` | [components.V1AppBadgeListRequestBody](../../models/components/v1appbadgelistrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
511
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
512
- | `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. |
513
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
514
-
515
- ### Response
516
-
517
- **Promise\<[operations.AppV1ListBadgesResponse](../../models/operations/appv1listbadgesresponse.md)\>**
518
-
519
- ### Errors
520
-
521
- | Error Type | Status Code | Content Type |
522
- | ------------------------ | ------------------------ | ------------------------ |
523
- | errors.ErrorModel | 403, 404, 422 | application/problem+json |
524
- | errors.ErrorModel | 500 | application/problem+json |
525
- | errors.SDKError | 4XX, 5XX | \*/\* |
526
-
527
- ## get
528
-
529
- ### Example Usage
530
-
531
- ```typescript
532
- import { SteamSets } from "@steamsets/client-ts";
533
-
534
- const steamSets = new SteamSets({
535
- token: "<YOUR_BEARER_TOKEN_HERE>",
536
- });
537
-
538
- async function run() {
539
- const result = await steamSets.external.get();
540
-
541
- // Handle the result
542
- console.log(result);
543
- }
544
-
545
- run();
546
- ```
547
-
548
- ### Standalone function
549
-
550
- The standalone function version of this method:
551
-
552
- ```typescript
553
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
554
- import { externalGet } from "@steamsets/client-ts/funcs/externalGet.js";
555
-
556
- // Use `SteamSetsCore` for best tree-shaking performance.
557
- // You can create one instance of it to use across an application.
558
- const steamSets = new SteamSetsCore({
559
- token: "<YOUR_BEARER_TOKEN_HERE>",
560
- });
561
-
562
- async function run() {
563
- const res = await externalGet(steamSets);
564
-
565
- if (!res.ok) {
566
- throw res.error;
567
- }
568
-
569
- const { value: result } = res;
570
-
571
- // Handle the result
572
- console.log(result);
573
- }
574
-
575
- run();
576
- ```
577
-
578
- ### Parameters
579
-
580
- | Parameter | Type | Required | Description |
581
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
582
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
583
- | `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. |
584
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
585
-
586
- ### Response
587
-
588
- **Promise\<[operations.StatsV1StatsGetResponse](../../models/operations/statsv1statsgetresponse.md)\>**
589
-
590
- ### Errors
591
-
592
- | Error Type | Status Code | Content Type |
593
- | ------------------------ | ------------------------ | ------------------------ |
594
- | errors.ErrorModel | 404, 429 | application/problem+json |
595
- | errors.ErrorModel | 500 | application/problem+json |
596
- | errors.SDKError | 4XX, 5XX | \*/\* |