@steamsets/client-ts 0.5.0 → 0.5.1

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 (203) hide show
  1. package/README.md +63 -9
  2. package/docs/sdks/account/README.md +225 -76
  3. package/docs/sdks/data/README.md +315 -0
  4. package/docs/sdks/location/README.md +80 -0
  5. package/docs/sdks/public/README.md +241 -0
  6. package/docs/sdks/session/README.md +62 -62
  7. package/funcs/accountAccountV1GetApps.d.ts.map +1 -1
  8. package/funcs/accountAccountV1GetApps.js +4 -0
  9. package/funcs/accountAccountV1GetApps.js.map +1 -1
  10. package/funcs/accountAccountV1GetBadges.d.ts.map +1 -1
  11. package/funcs/accountAccountV1GetBadges.js +4 -0
  12. package/funcs/accountAccountV1GetBadges.js.map +1 -1
  13. package/funcs/accountAccountV1GetInfo.d.ts +14 -0
  14. package/funcs/accountAccountV1GetInfo.d.ts.map +1 -0
  15. package/funcs/accountAccountV1GetInfo.js +96 -0
  16. package/funcs/accountAccountV1GetInfo.js.map +1 -0
  17. package/funcs/accountAccountV1GetStaff.d.ts +13 -0
  18. package/funcs/accountAccountV1GetStaff.d.ts.map +1 -0
  19. package/funcs/accountAccountV1GetStaff.js +86 -0
  20. package/funcs/accountAccountV1GetStaff.js.map +1 -0
  21. package/funcs/accountAccountV1SessionCreate.js +1 -1
  22. package/funcs/accountAccountV1SessionLogin.js +2 -2
  23. package/funcs/accountAccountV1SessionLogin.js.map +1 -1
  24. package/funcs/dataAccountV1GetApps.d.ts +13 -0
  25. package/funcs/dataAccountV1GetApps.d.ts.map +1 -0
  26. package/funcs/dataAccountV1GetApps.js +105 -0
  27. package/funcs/dataAccountV1GetApps.js.map +1 -0
  28. package/funcs/dataAccountV1GetBadges.d.ts +13 -0
  29. package/funcs/dataAccountV1GetBadges.d.ts.map +1 -0
  30. package/funcs/dataAccountV1GetBadges.js +105 -0
  31. package/funcs/dataAccountV1GetBadges.js.map +1 -0
  32. package/funcs/dataAccountV1GetInfo.d.ts +14 -0
  33. package/funcs/dataAccountV1GetInfo.d.ts.map +1 -0
  34. package/funcs/dataAccountV1GetInfo.js +96 -0
  35. package/funcs/dataAccountV1GetInfo.js.map +1 -0
  36. package/funcs/dataAccountV1GetStaff.d.ts +13 -0
  37. package/funcs/dataAccountV1GetStaff.d.ts.map +1 -0
  38. package/funcs/dataAccountV1GetStaff.js +86 -0
  39. package/funcs/dataAccountV1GetStaff.js.map +1 -0
  40. package/funcs/locationLocation.d.ts +16 -0
  41. package/funcs/locationLocation.d.ts.map +1 -0
  42. package/funcs/locationLocation.js +87 -0
  43. package/funcs/locationLocation.js.map +1 -0
  44. package/funcs/publicAccountV1GetApps.d.ts +13 -0
  45. package/funcs/publicAccountV1GetApps.d.ts.map +1 -0
  46. package/funcs/publicAccountV1GetApps.js +105 -0
  47. package/funcs/publicAccountV1GetApps.js.map +1 -0
  48. package/funcs/publicAccountV1GetBadges.d.ts +13 -0
  49. package/funcs/publicAccountV1GetBadges.d.ts.map +1 -0
  50. package/funcs/publicAccountV1GetBadges.js +105 -0
  51. package/funcs/publicAccountV1GetBadges.js.map +1 -0
  52. package/funcs/publicAccountV1GetInfo.d.ts +14 -0
  53. package/funcs/publicAccountV1GetInfo.d.ts.map +1 -0
  54. package/funcs/publicAccountV1GetInfo.js +96 -0
  55. package/funcs/publicAccountV1GetInfo.js.map +1 -0
  56. package/funcs/sessionAccountV1SessionCreate.js +1 -1
  57. package/funcs/sessionAccountV1SessionLogin.js +2 -2
  58. package/funcs/sessionAccountV1SessionLogin.js.map +1 -1
  59. package/lib/config.d.ts +3 -3
  60. package/lib/config.js +3 -3
  61. package/lib/security.d.ts +6 -1
  62. package/lib/security.d.ts.map +1 -1
  63. package/lib/security.js +5 -0
  64. package/lib/security.js.map +1 -1
  65. package/models/components/accountinfobody.d.ts +379 -0
  66. package/models/components/accountinfobody.d.ts.map +1 -0
  67. package/models/components/accountinfobody.js +254 -0
  68. package/models/components/accountinfobody.js.map +1 -0
  69. package/models/components/bestleaderboardrank.d.ts +110 -0
  70. package/models/components/bestleaderboardrank.d.ts.map +1 -0
  71. package/models/components/bestleaderboardrank.js +89 -0
  72. package/models/components/bestleaderboardrank.js.map +1 -0
  73. package/models/components/city.d.ts +28 -0
  74. package/models/components/city.d.ts.map +1 -0
  75. package/models/components/city.js +50 -0
  76. package/models/components/city.js.map +1 -0
  77. package/models/components/country.d.ts +43 -0
  78. package/models/components/country.d.ts.map +1 -0
  79. package/models/components/country.js +55 -0
  80. package/models/components/country.js.map +1 -0
  81. package/models/components/index.d.ts +9 -0
  82. package/models/components/index.d.ts.map +1 -1
  83. package/models/components/index.js +9 -0
  84. package/models/components/index.js.map +1 -1
  85. package/models/components/leaderboardaccount.d.ts +196 -0
  86. package/models/components/leaderboardaccount.d.ts.map +1 -0
  87. package/models/components/leaderboardaccount.js +128 -0
  88. package/models/components/leaderboardaccount.js.map +1 -0
  89. package/models/components/leaderboardbadgeinfo.d.ts +33 -0
  90. package/models/components/leaderboardbadgeinfo.d.ts.map +1 -0
  91. package/models/components/leaderboardbadgeinfo.js +55 -0
  92. package/models/components/leaderboardbadgeinfo.js.map +1 -0
  93. package/models/components/location.d.ts +38 -0
  94. package/models/components/location.d.ts.map +1 -0
  95. package/models/components/location.js +54 -0
  96. package/models/components/location.js.map +1 -0
  97. package/models/components/region.d.ts +38 -0
  98. package/models/components/region.d.ts.map +1 -0
  99. package/models/components/region.js +53 -0
  100. package/models/components/region.js.map +1 -0
  101. package/models/components/role.d.ts +2 -2
  102. package/models/components/role.d.ts.map +1 -1
  103. package/models/components/role.js +4 -17
  104. package/models/components/role.js.map +1 -1
  105. package/models/components/state.d.ts +43 -0
  106. package/models/components/state.d.ts.map +1 -0
  107. package/models/components/state.js +55 -0
  108. package/models/components/state.js.map +1 -0
  109. package/models/errors/errormodel.d.ts +5 -5
  110. package/models/errors/errormodel.d.ts.map +1 -1
  111. package/models/errors/errormodel.js +4 -2
  112. package/models/errors/errormodel.js.map +1 -1
  113. package/models/operations/accountv1getapps.d.ts +2 -0
  114. package/models/operations/accountv1getapps.d.ts.map +1 -1
  115. package/models/operations/accountv1getapps.js +4 -0
  116. package/models/operations/accountv1getapps.js.map +1 -1
  117. package/models/operations/accountv1getbadges.d.ts +2 -0
  118. package/models/operations/accountv1getbadges.d.ts.map +1 -1
  119. package/models/operations/accountv1getbadges.js +4 -0
  120. package/models/operations/accountv1getbadges.js.map +1 -1
  121. package/models/operations/accountv1getinfo.d.ts +31 -0
  122. package/models/operations/accountv1getinfo.d.ts.map +1 -0
  123. package/models/operations/accountv1getinfo.js +68 -0
  124. package/models/operations/accountv1getinfo.js.map +1 -0
  125. package/models/operations/accountv1getstaff.d.ts +31 -0
  126. package/models/operations/accountv1getstaff.d.ts.map +1 -0
  127. package/models/operations/accountv1getstaff.js +72 -0
  128. package/models/operations/accountv1getstaff.js.map +1 -0
  129. package/models/operations/index.d.ts +3 -0
  130. package/models/operations/index.d.ts.map +1 -1
  131. package/models/operations/index.js +3 -0
  132. package/models/operations/index.js.map +1 -1
  133. package/models/operations/location.d.ts +31 -0
  134. package/models/operations/location.d.ts.map +1 -0
  135. package/models/operations/location.js +68 -0
  136. package/models/operations/location.js.map +1 -0
  137. package/package.json +1 -1
  138. package/sdk/account.d.ts +12 -4
  139. package/sdk/account.d.ts.map +1 -1
  140. package/sdk/account.js +20 -6
  141. package/sdk/account.js.map +1 -1
  142. package/sdk/data.d.ts +22 -0
  143. package/sdk/data.d.ts.map +1 -0
  144. package/sdk/data.js +40 -0
  145. package/sdk/data.js.map +1 -0
  146. package/sdk/location.d.ts +12 -0
  147. package/sdk/location.d.ts.map +1 -0
  148. package/sdk/location.js +22 -0
  149. package/sdk/location.js.map +1 -0
  150. package/sdk/public.d.ts +18 -0
  151. package/sdk/public.d.ts.map +1 -0
  152. package/sdk/public.js +33 -0
  153. package/sdk/public.js.map +1 -0
  154. package/sdk/sdk.d.ts +11 -2
  155. package/sdk/sdk.d.ts.map +1 -1
  156. package/sdk/sdk.js +17 -2
  157. package/sdk/sdk.js.map +1 -1
  158. package/sdk/session.d.ts +4 -4
  159. package/sdk/session.d.ts.map +1 -1
  160. package/sdk/session.js +6 -6
  161. package/sdk/session.js.map +1 -1
  162. package/src/funcs/accountAccountV1GetApps.ts +4 -0
  163. package/src/funcs/accountAccountV1GetBadges.ts +4 -0
  164. package/src/funcs/accountAccountV1GetInfo.ts +130 -0
  165. package/src/funcs/accountAccountV1GetStaff.ts +113 -0
  166. package/src/funcs/accountAccountV1SessionCreate.ts +1 -1
  167. package/src/funcs/accountAccountV1SessionLogin.ts +2 -2
  168. package/src/funcs/dataAccountV1GetApps.ts +139 -0
  169. package/src/funcs/dataAccountV1GetBadges.ts +139 -0
  170. package/src/funcs/dataAccountV1GetInfo.ts +130 -0
  171. package/src/funcs/dataAccountV1GetStaff.ts +113 -0
  172. package/src/funcs/locationLocation.ts +114 -0
  173. package/src/funcs/publicAccountV1GetApps.ts +139 -0
  174. package/src/funcs/publicAccountV1GetBadges.ts +139 -0
  175. package/src/funcs/publicAccountV1GetInfo.ts +130 -0
  176. package/src/funcs/sessionAccountV1SessionCreate.ts +1 -1
  177. package/src/funcs/sessionAccountV1SessionLogin.ts +2 -2
  178. package/src/lib/config.ts +3 -3
  179. package/src/lib/security.ts +12 -1
  180. package/src/models/components/accountinfobody.ts +532 -0
  181. package/src/models/components/bestleaderboardrank.ts +102 -0
  182. package/src/models/components/city.ts +40 -0
  183. package/src/models/components/country.ts +55 -0
  184. package/src/models/components/index.ts +9 -0
  185. package/src/models/components/leaderboardaccount.ts +301 -0
  186. package/src/models/components/leaderboardbadgeinfo.ts +58 -0
  187. package/src/models/components/location.ts +55 -0
  188. package/src/models/components/region.ts +53 -0
  189. package/src/models/components/role.ts +14 -27
  190. package/src/models/components/state.ts +55 -0
  191. package/src/models/errors/errormodel.ts +8 -6
  192. package/src/models/operations/accountv1getapps.ts +6 -0
  193. package/src/models/operations/accountv1getbadges.ts +6 -0
  194. package/src/models/operations/accountv1getinfo.ts +68 -0
  195. package/src/models/operations/accountv1getstaff.ts +72 -0
  196. package/src/models/operations/index.ts +3 -0
  197. package/src/models/operations/location.ts +64 -0
  198. package/src/sdk/account.ts +31 -10
  199. package/src/sdk/data.ts +53 -0
  200. package/src/sdk/location.ts +20 -0
  201. package/src/sdk/public.ts +43 -0
  202. package/src/sdk/sdk.ts +21 -3
  203. package/src/sdk/session.ts +10 -10
@@ -0,0 +1,315 @@
1
+ # Data
2
+ (*data*)
3
+
4
+ ## Overview
5
+
6
+ This is actual data seen by others then yourself
7
+
8
+ ### Available Operations
9
+
10
+ * [accountV1GetApps](#accountv1getapps) - Get Account Apps
11
+ * [accountV1GetBadges](#accountv1getbadges) - Get Account Badges
12
+ * [accountV1GetInfo](#accountv1getinfo) - Get Account Info
13
+ * [accountV1GetStaff](#accountv1getstaff) - Get Staff Members and their info
14
+
15
+ ## accountV1GetApps
16
+
17
+ Get Account Apps
18
+
19
+ ### Example Usage
20
+
21
+ ```typescript
22
+ import { SteamSets } from "@steamsets/client-ts";
23
+
24
+ const steamSets = new SteamSets({
25
+ session: "<YOUR_BEARER_TOKEN_HERE>",
26
+ });
27
+
28
+ async function run() {
29
+ const result = await steamSets.data.accountV1GetApps({
30
+ accountSearch: {},
31
+ });
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 { dataAccountV1GetApps } from "@steamsets/client-ts/funcs/dataAccountV1GetApps.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
+ session: "<YOUR_BEARER_TOKEN_HERE>",
52
+ });
53
+
54
+ async function run() {
55
+ const res = await dataAccountV1GetApps(steamSets, {
56
+ accountSearch: {},
57
+ });
58
+
59
+ if (!res.ok) {
60
+ throw res.error;
61
+ }
62
+
63
+ const { value: result } = res;
64
+
65
+ // Handle the result
66
+ console.log(result)
67
+ }
68
+
69
+ run();
70
+ ```
71
+
72
+ ### Parameters
73
+
74
+ | Parameter | Type | Required | Description |
75
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
76
+ | `request` | [operations.AccountV1GetAppsRequest](../../models/operations/accountv1getappsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
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.AccountV1GetAppsResponse](../../models/operations/accountv1getappsresponse.md)\>**
84
+
85
+ ### Errors
86
+
87
+ | Error Object | Status Code | Content Type |
88
+ | ------------------------ | ------------------------ | ------------------------ |
89
+ | errors.ErrorModel | 400,422,500 | application/problem+json |
90
+ | errors.SDKError | 4xx-5xx | */* |
91
+
92
+
93
+ ## accountV1GetBadges
94
+
95
+ Get Account Badges
96
+
97
+ ### Example Usage
98
+
99
+ ```typescript
100
+ import { SteamSets } from "@steamsets/client-ts";
101
+
102
+ const steamSets = new SteamSets({
103
+ session: "<YOUR_BEARER_TOKEN_HERE>",
104
+ });
105
+
106
+ async function run() {
107
+ const result = await steamSets.data.accountV1GetBadges({
108
+ accountSearch: {},
109
+ });
110
+
111
+ // Handle the result
112
+ console.log(result)
113
+ }
114
+
115
+ run();
116
+ ```
117
+
118
+ ### Standalone function
119
+
120
+ The standalone function version of this method:
121
+
122
+ ```typescript
123
+ import { SteamSetsCore } from "@steamsets/client-ts/core.js";
124
+ import { dataAccountV1GetBadges } from "@steamsets/client-ts/funcs/dataAccountV1GetBadges.js";
125
+
126
+ // Use `SteamSetsCore` for best tree-shaking performance.
127
+ // You can create one instance of it to use across an application.
128
+ const steamSets = new SteamSetsCore({
129
+ session: "<YOUR_BEARER_TOKEN_HERE>",
130
+ });
131
+
132
+ async function run() {
133
+ const res = await dataAccountV1GetBadges(steamSets, {
134
+ accountSearch: {},
135
+ });
136
+
137
+ if (!res.ok) {
138
+ throw res.error;
139
+ }
140
+
141
+ const { value: result } = res;
142
+
143
+ // Handle the result
144
+ console.log(result)
145
+ }
146
+
147
+ run();
148
+ ```
149
+
150
+ ### Parameters
151
+
152
+ | Parameter | Type | Required | Description |
153
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
154
+ | `request` | [operations.AccountV1GetBadgesRequest](../../models/operations/accountv1getbadgesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
155
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
156
+ | `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. |
157
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
158
+
159
+ ### Response
160
+
161
+ **Promise\<[operations.AccountV1GetBadgesResponse](../../models/operations/accountv1getbadgesresponse.md)\>**
162
+
163
+ ### Errors
164
+
165
+ | Error Object | Status Code | Content Type |
166
+ | ------------------------ | ------------------------ | ------------------------ |
167
+ | errors.ErrorModel | 400,422,500 | application/problem+json |
168
+ | errors.SDKError | 4xx-5xx | */* |
169
+
170
+
171
+ ## accountV1GetInfo
172
+
173
+ Get Account Info
174
+
175
+ ### Example Usage
176
+
177
+ ```typescript
178
+ import { SteamSets } from "@steamsets/client-ts";
179
+
180
+ const steamSets = new SteamSets({
181
+ session: "<YOUR_BEARER_TOKEN_HERE>",
182
+ });
183
+
184
+ async function run() {
185
+ const result = await steamSets.data.accountV1GetInfo({});
186
+
187
+ // Handle the result
188
+ console.log(result)
189
+ }
190
+
191
+ run();
192
+ ```
193
+
194
+ ### Standalone function
195
+
196
+ The standalone function version of this method:
197
+
198
+ ```typescript
199
+ import { SteamSetsCore } from "@steamsets/client-ts/core.js";
200
+ import { dataAccountV1GetInfo } from "@steamsets/client-ts/funcs/dataAccountV1GetInfo.js";
201
+
202
+ // Use `SteamSetsCore` for best tree-shaking performance.
203
+ // You can create one instance of it to use across an application.
204
+ const steamSets = new SteamSetsCore({
205
+ session: "<YOUR_BEARER_TOKEN_HERE>",
206
+ });
207
+
208
+ async function run() {
209
+ const res = await dataAccountV1GetInfo(steamSets, {});
210
+
211
+ if (!res.ok) {
212
+ throw res.error;
213
+ }
214
+
215
+ const { value: result } = res;
216
+
217
+ // Handle the result
218
+ console.log(result)
219
+ }
220
+
221
+ run();
222
+ ```
223
+
224
+ ### Parameters
225
+
226
+ | Parameter | Type | Required | Description |
227
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
228
+ | `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
229
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
230
+ | `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. |
231
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
232
+
233
+ ### Response
234
+
235
+ **Promise\<[operations.AccountV1GetInfoResponse](../../models/operations/accountv1getinforesponse.md)\>**
236
+
237
+ ### Errors
238
+
239
+ | Error Object | Status Code | Content Type |
240
+ | ------------------------ | ------------------------ | ------------------------ |
241
+ | errors.ErrorModel | 404,422,429,500 | application/problem+json |
242
+ | errors.SDKError | 4xx-5xx | */* |
243
+
244
+
245
+ ## accountV1GetStaff
246
+
247
+ Get Staff Members and their info
248
+
249
+ ### Example Usage
250
+
251
+ ```typescript
252
+ import { SteamSets } from "@steamsets/client-ts";
253
+
254
+ const steamSets = new SteamSets({
255
+ session: "<YOUR_BEARER_TOKEN_HERE>",
256
+ });
257
+
258
+ async function run() {
259
+ const result = await steamSets.data.accountV1GetStaff();
260
+
261
+ // Handle the result
262
+ console.log(result)
263
+ }
264
+
265
+ run();
266
+ ```
267
+
268
+ ### Standalone function
269
+
270
+ The standalone function version of this method:
271
+
272
+ ```typescript
273
+ import { SteamSetsCore } from "@steamsets/client-ts/core.js";
274
+ import { dataAccountV1GetStaff } from "@steamsets/client-ts/funcs/dataAccountV1GetStaff.js";
275
+
276
+ // Use `SteamSetsCore` for best tree-shaking performance.
277
+ // You can create one instance of it to use across an application.
278
+ const steamSets = new SteamSetsCore({
279
+ session: "<YOUR_BEARER_TOKEN_HERE>",
280
+ });
281
+
282
+ async function run() {
283
+ const res = await dataAccountV1GetStaff(steamSets);
284
+
285
+ if (!res.ok) {
286
+ throw res.error;
287
+ }
288
+
289
+ const { value: result } = res;
290
+
291
+ // Handle the result
292
+ console.log(result)
293
+ }
294
+
295
+ run();
296
+ ```
297
+
298
+ ### Parameters
299
+
300
+ | Parameter | Type | Required | Description |
301
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
302
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
303
+ | `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. |
304
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
305
+
306
+ ### Response
307
+
308
+ **Promise\<[operations.AccountV1GetStaffResponse](../../models/operations/accountv1getstaffresponse.md)\>**
309
+
310
+ ### Errors
311
+
312
+ | Error Object | Status Code | Content Type |
313
+ | ------------------------ | ------------------------ | ------------------------ |
314
+ | errors.ErrorModel | 404,429,500 | application/problem+json |
315
+ | errors.SDKError | 4xx-5xx | */* |
@@ -0,0 +1,80 @@
1
+ # Location
2
+ (*location*)
3
+
4
+ ## Overview
5
+
6
+ ### Available Operations
7
+
8
+ * [location](#location) - Location List
9
+
10
+ ## location
11
+
12
+ Get all of our available locations
13
+
14
+ ### Example Usage
15
+
16
+ ```typescript
17
+ import { SteamSets } from "@steamsets/client-ts";
18
+
19
+ const steamSets = new SteamSets({
20
+ session: "<YOUR_BEARER_TOKEN_HERE>",
21
+ });
22
+
23
+ async function run() {
24
+ const result = await steamSets.location.location();
25
+
26
+ // Handle the result
27
+ console.log(result)
28
+ }
29
+
30
+ run();
31
+ ```
32
+
33
+ ### Standalone function
34
+
35
+ The standalone function version of this method:
36
+
37
+ ```typescript
38
+ import { SteamSetsCore } from "@steamsets/client-ts/core.js";
39
+ import { locationLocation } from "@steamsets/client-ts/funcs/locationLocation.js";
40
+
41
+ // Use `SteamSetsCore` for best tree-shaking performance.
42
+ // You can create one instance of it to use across an application.
43
+ const steamSets = new SteamSetsCore({
44
+ session: "<YOUR_BEARER_TOKEN_HERE>",
45
+ });
46
+
47
+ async function run() {
48
+ const res = await locationLocation(steamSets);
49
+
50
+ if (!res.ok) {
51
+ throw res.error;
52
+ }
53
+
54
+ const { value: result } = res;
55
+
56
+ // Handle the result
57
+ console.log(result)
58
+ }
59
+
60
+ run();
61
+ ```
62
+
63
+ ### Parameters
64
+
65
+ | Parameter | Type | Required | Description |
66
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
67
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
68
+ | `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. |
69
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
70
+
71
+ ### Response
72
+
73
+ **Promise\<[operations.LocationResponse](../../models/operations/locationresponse.md)\>**
74
+
75
+ ### Errors
76
+
77
+ | Error Object | Status Code | Content Type |
78
+ | ------------------------ | ------------------------ | ------------------------ |
79
+ | errors.ErrorModel | 401,500 | application/problem+json |
80
+ | errors.SDKError | 4xx-5xx | */* |
@@ -0,0 +1,241 @@
1
+ # Public
2
+ (*public*)
3
+
4
+ ## Overview
5
+
6
+ This API can be accessed by anyone with an API Key
7
+
8
+ ### Available Operations
9
+
10
+ * [accountV1GetApps](#accountv1getapps) - Get Account Apps
11
+ * [accountV1GetBadges](#accountv1getbadges) - Get Account Badges
12
+ * [accountV1GetInfo](#accountv1getinfo) - Get Account Info
13
+
14
+ ## accountV1GetApps
15
+
16
+ Get Account Apps
17
+
18
+ ### Example Usage
19
+
20
+ ```typescript
21
+ import { SteamSets } from "@steamsets/client-ts";
22
+
23
+ const steamSets = new SteamSets({
24
+ session: "<YOUR_BEARER_TOKEN_HERE>",
25
+ });
26
+
27
+ async function run() {
28
+ const result = await steamSets.public.accountV1GetApps({
29
+ accountSearch: {},
30
+ });
31
+
32
+ // Handle the result
33
+ console.log(result)
34
+ }
35
+
36
+ run();
37
+ ```
38
+
39
+ ### Standalone function
40
+
41
+ The standalone function version of this method:
42
+
43
+ ```typescript
44
+ import { SteamSetsCore } from "@steamsets/client-ts/core.js";
45
+ import { publicAccountV1GetApps } from "@steamsets/client-ts/funcs/publicAccountV1GetApps.js";
46
+
47
+ // Use `SteamSetsCore` for best tree-shaking performance.
48
+ // You can create one instance of it to use across an application.
49
+ const steamSets = new SteamSetsCore({
50
+ session: "<YOUR_BEARER_TOKEN_HERE>",
51
+ });
52
+
53
+ async function run() {
54
+ const res = await publicAccountV1GetApps(steamSets, {
55
+ accountSearch: {},
56
+ });
57
+
58
+ if (!res.ok) {
59
+ throw res.error;
60
+ }
61
+
62
+ const { value: result } = res;
63
+
64
+ // Handle the result
65
+ console.log(result)
66
+ }
67
+
68
+ run();
69
+ ```
70
+
71
+ ### Parameters
72
+
73
+ | Parameter | Type | Required | Description |
74
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
75
+ | `request` | [operations.AccountV1GetAppsRequest](../../models/operations/accountv1getappsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
76
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
77
+ | `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. |
78
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
79
+
80
+ ### Response
81
+
82
+ **Promise\<[operations.AccountV1GetAppsResponse](../../models/operations/accountv1getappsresponse.md)\>**
83
+
84
+ ### Errors
85
+
86
+ | Error Object | Status Code | Content Type |
87
+ | ------------------------ | ------------------------ | ------------------------ |
88
+ | errors.ErrorModel | 400,422,500 | application/problem+json |
89
+ | errors.SDKError | 4xx-5xx | */* |
90
+
91
+
92
+ ## accountV1GetBadges
93
+
94
+ Get Account Badges
95
+
96
+ ### Example Usage
97
+
98
+ ```typescript
99
+ import { SteamSets } from "@steamsets/client-ts";
100
+
101
+ const steamSets = new SteamSets({
102
+ session: "<YOUR_BEARER_TOKEN_HERE>",
103
+ });
104
+
105
+ async function run() {
106
+ const result = await steamSets.public.accountV1GetBadges({
107
+ accountSearch: {},
108
+ });
109
+
110
+ // Handle the result
111
+ console.log(result)
112
+ }
113
+
114
+ run();
115
+ ```
116
+
117
+ ### Standalone function
118
+
119
+ The standalone function version of this method:
120
+
121
+ ```typescript
122
+ import { SteamSetsCore } from "@steamsets/client-ts/core.js";
123
+ import { publicAccountV1GetBadges } from "@steamsets/client-ts/funcs/publicAccountV1GetBadges.js";
124
+
125
+ // Use `SteamSetsCore` for best tree-shaking performance.
126
+ // You can create one instance of it to use across an application.
127
+ const steamSets = new SteamSetsCore({
128
+ session: "<YOUR_BEARER_TOKEN_HERE>",
129
+ });
130
+
131
+ async function run() {
132
+ const res = await publicAccountV1GetBadges(steamSets, {
133
+ accountSearch: {},
134
+ });
135
+
136
+ if (!res.ok) {
137
+ throw res.error;
138
+ }
139
+
140
+ const { value: result } = res;
141
+
142
+ // Handle the result
143
+ console.log(result)
144
+ }
145
+
146
+ run();
147
+ ```
148
+
149
+ ### Parameters
150
+
151
+ | Parameter | Type | Required | Description |
152
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
153
+ | `request` | [operations.AccountV1GetBadgesRequest](../../models/operations/accountv1getbadgesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
154
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
155
+ | `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. |
156
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
157
+
158
+ ### Response
159
+
160
+ **Promise\<[operations.AccountV1GetBadgesResponse](../../models/operations/accountv1getbadgesresponse.md)\>**
161
+
162
+ ### Errors
163
+
164
+ | Error Object | Status Code | Content Type |
165
+ | ------------------------ | ------------------------ | ------------------------ |
166
+ | errors.ErrorModel | 400,422,500 | application/problem+json |
167
+ | errors.SDKError | 4xx-5xx | */* |
168
+
169
+
170
+ ## accountV1GetInfo
171
+
172
+ Get Account Info
173
+
174
+ ### Example Usage
175
+
176
+ ```typescript
177
+ import { SteamSets } from "@steamsets/client-ts";
178
+
179
+ const steamSets = new SteamSets({
180
+ session: "<YOUR_BEARER_TOKEN_HERE>",
181
+ });
182
+
183
+ async function run() {
184
+ const result = await steamSets.public.accountV1GetInfo({});
185
+
186
+ // Handle the result
187
+ console.log(result)
188
+ }
189
+
190
+ run();
191
+ ```
192
+
193
+ ### Standalone function
194
+
195
+ The standalone function version of this method:
196
+
197
+ ```typescript
198
+ import { SteamSetsCore } from "@steamsets/client-ts/core.js";
199
+ import { publicAccountV1GetInfo } from "@steamsets/client-ts/funcs/publicAccountV1GetInfo.js";
200
+
201
+ // Use `SteamSetsCore` for best tree-shaking performance.
202
+ // You can create one instance of it to use across an application.
203
+ const steamSets = new SteamSetsCore({
204
+ session: "<YOUR_BEARER_TOKEN_HERE>",
205
+ });
206
+
207
+ async function run() {
208
+ const res = await publicAccountV1GetInfo(steamSets, {});
209
+
210
+ if (!res.ok) {
211
+ throw res.error;
212
+ }
213
+
214
+ const { value: result } = res;
215
+
216
+ // Handle the result
217
+ console.log(result)
218
+ }
219
+
220
+ run();
221
+ ```
222
+
223
+ ### Parameters
224
+
225
+ | Parameter | Type | Required | Description |
226
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
227
+ | `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
228
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
229
+ | `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. |
230
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
231
+
232
+ ### Response
233
+
234
+ **Promise\<[operations.AccountV1GetInfoResponse](../../models/operations/accountv1getinforesponse.md)\>**
235
+
236
+ ### Errors
237
+
238
+ | Error Object | Status Code | Content Type |
239
+ | ------------------------ | ------------------------ | ------------------------ |
240
+ | errors.ErrorModel | 404,422,429,500 | application/problem+json |
241
+ | errors.SDKError | 4xx-5xx | */* |