@steamsets/client-ts 0.13.4 → 0.13.7

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 (148) hide show
  1. package/README.md +36 -26
  2. package/docs/sdks/account/README.md +72 -0
  3. package/docs/sdks/admin/README.md +159 -0
  4. package/docs/sdks/badge/README.md +150 -0
  5. package/funcs/accountAccountV1GetBadgeBookmarks.d.ts +11 -0
  6. package/funcs/accountAccountV1GetBadgeBookmarks.d.ts.map +1 -0
  7. package/funcs/accountAccountV1GetBadgeBookmarks.js +99 -0
  8. package/funcs/accountAccountV1GetBadgeBookmarks.js.map +1 -0
  9. package/funcs/adminAdminV1GetEvents.d.ts +10 -0
  10. package/funcs/adminAdminV1GetEvents.d.ts.map +1 -0
  11. package/funcs/adminAdminV1GetEvents.js +98 -0
  12. package/funcs/adminAdminV1GetEvents.js.map +1 -0
  13. package/funcs/adminAdminV1UpdateEvent.d.ts +11 -0
  14. package/funcs/adminAdminV1UpdateEvent.d.ts.map +1 -0
  15. package/funcs/adminAdminV1UpdateEvent.js +109 -0
  16. package/funcs/adminAdminV1UpdateEvent.js.map +1 -0
  17. package/funcs/badgeAccountV1BookmarkBadge.d.ts +11 -0
  18. package/funcs/badgeAccountV1BookmarkBadge.d.ts.map +1 -0
  19. package/funcs/badgeAccountV1BookmarkBadge.js +109 -0
  20. package/funcs/badgeAccountV1BookmarkBadge.js.map +1 -0
  21. package/funcs/badgeAccountV1GetBadgeBookmarks.d.ts +11 -0
  22. package/funcs/badgeAccountV1GetBadgeBookmarks.d.ts.map +1 -0
  23. package/funcs/badgeAccountV1GetBadgeBookmarks.js +99 -0
  24. package/funcs/badgeAccountV1GetBadgeBookmarks.js.map +1 -0
  25. package/lib/config.d.ts +3 -3
  26. package/lib/config.js +3 -3
  27. package/models/components/index.d.ts +11 -0
  28. package/models/components/index.d.ts.map +1 -1
  29. package/models/components/index.js +11 -0
  30. package/models/components/index.js.map +1 -1
  31. package/models/components/v1accountbadgebookmark.d.ts +37 -0
  32. package/models/components/v1accountbadgebookmark.d.ts.map +1 -0
  33. package/models/components/v1accountbadgebookmark.js +61 -0
  34. package/models/components/v1accountbadgebookmark.js.map +1 -0
  35. package/models/components/v1accountbadgebookmarkrequestbody.d.ts +37 -0
  36. package/models/components/v1accountbadgebookmarkrequestbody.d.ts.map +1 -0
  37. package/models/components/v1accountbadgebookmarkrequestbody.js +61 -0
  38. package/models/components/v1accountbadgebookmarkrequestbody.js.map +1 -0
  39. package/models/components/v1accountbadgebookmarkresponsebody.d.ts +32 -0
  40. package/models/components/v1accountbadgebookmarkresponsebody.d.ts.map +1 -0
  41. package/models/components/v1accountbadgebookmarkresponsebody.js +68 -0
  42. package/models/components/v1accountbadgebookmarkresponsebody.js.map +1 -0
  43. package/models/components/v1accountbadgebookmarksrequestbody.d.ts +25 -0
  44. package/models/components/v1accountbadgebookmarksrequestbody.d.ts.map +1 -0
  45. package/models/components/v1accountbadgebookmarksrequestbody.js +55 -0
  46. package/models/components/v1accountbadgebookmarksrequestbody.js.map +1 -0
  47. package/models/components/v1accountbadgebookmarksresponsebody.d.ts +35 -0
  48. package/models/components/v1accountbadgebookmarksresponsebody.d.ts.map +1 -0
  49. package/models/components/v1accountbadgebookmarksresponsebody.js +71 -0
  50. package/models/components/v1accountbadgebookmarksresponsebody.js.map +1 -0
  51. package/models/components/v1admingeteventsresponsebody.d.ts +35 -0
  52. package/models/components/v1admingeteventsresponsebody.d.ts.map +1 -0
  53. package/models/components/v1admingeteventsresponsebody.js +71 -0
  54. package/models/components/v1admingeteventsresponsebody.js.map +1 -0
  55. package/models/components/v1adminupdateeventrequestbody.d.ts +38 -0
  56. package/models/components/v1adminupdateeventrequestbody.d.ts.map +1 -0
  57. package/models/components/v1adminupdateeventrequestbody.js +62 -0
  58. package/models/components/v1adminupdateeventrequestbody.js.map +1 -0
  59. package/models/components/v1adminupdateeventresponsebody.d.ts +32 -0
  60. package/models/components/v1adminupdateeventresponsebody.d.ts.map +1 -0
  61. package/models/components/v1adminupdateeventresponsebody.js +68 -0
  62. package/models/components/v1adminupdateeventresponsebody.js.map +1 -0
  63. package/models/components/v1appeventmapping.d.ts +37 -0
  64. package/models/components/v1appeventmapping.d.ts.map +1 -0
  65. package/models/components/v1appeventmapping.js +61 -0
  66. package/models/components/v1appeventmapping.js.map +1 -0
  67. package/models/components/v1event.d.ts +88 -0
  68. package/models/components/v1event.d.ts.map +1 -0
  69. package/models/components/v1event.js +82 -0
  70. package/models/components/v1event.js.map +1 -0
  71. package/models/components/v1getsessionbody.d.ts +10 -0
  72. package/models/components/v1getsessionbody.d.ts.map +1 -1
  73. package/models/components/v1getsessionbody.js +4 -0
  74. package/models/components/v1getsessionbody.js.map +1 -1
  75. package/models/components/v1leaderboardbadge.d.ts +3 -0
  76. package/models/components/v1leaderboardbadge.d.ts.map +1 -1
  77. package/models/components/v1leaderboardbadge.js +3 -0
  78. package/models/components/v1leaderboardbadge.js.map +1 -1
  79. package/models/components/v1leaderboardbadgeevent.d.ts +77 -0
  80. package/models/components/v1leaderboardbadgeevent.d.ts.map +1 -0
  81. package/models/components/v1leaderboardbadgeevent.js +77 -0
  82. package/models/components/v1leaderboardbadgeevent.js.map +1 -0
  83. package/models/operations/accountv1bookmarkbadge.d.ts +35 -0
  84. package/models/operations/accountv1bookmarkbadge.d.ts.map +1 -0
  85. package/models/operations/accountv1bookmarkbadge.js +75 -0
  86. package/models/operations/accountv1bookmarkbadge.js.map +1 -0
  87. package/models/operations/accountv1getbadgebookmarks.d.ts +35 -0
  88. package/models/operations/accountv1getbadgebookmarks.d.ts.map +1 -0
  89. package/models/operations/accountv1getbadgebookmarks.js +75 -0
  90. package/models/operations/accountv1getbadgebookmarks.js.map +1 -0
  91. package/models/operations/adminv1getevents.d.ts +35 -0
  92. package/models/operations/adminv1getevents.d.ts.map +1 -0
  93. package/models/operations/adminv1getevents.js +75 -0
  94. package/models/operations/adminv1getevents.js.map +1 -0
  95. package/models/operations/adminv1updateevent.d.ts +35 -0
  96. package/models/operations/adminv1updateevent.d.ts.map +1 -0
  97. package/models/operations/adminv1updateevent.js +75 -0
  98. package/models/operations/adminv1updateevent.js.map +1 -0
  99. package/models/operations/index.d.ts +4 -0
  100. package/models/operations/index.d.ts.map +1 -1
  101. package/models/operations/index.js +4 -0
  102. package/models/operations/index.js.map +1 -1
  103. package/package.json +1 -1
  104. package/sdk/account.d.ts +1 -0
  105. package/sdk/account.d.ts.map +1 -1
  106. package/sdk/account.js +4 -0
  107. package/sdk/account.js.map +1 -1
  108. package/sdk/admin.d.ts +2 -0
  109. package/sdk/admin.d.ts.map +1 -1
  110. package/sdk/admin.js +8 -0
  111. package/sdk/admin.js.map +1 -1
  112. package/sdk/badge.d.ts +2 -0
  113. package/sdk/badge.d.ts.map +1 -1
  114. package/sdk/badge.js +8 -0
  115. package/sdk/badge.js.map +1 -1
  116. package/sdk/sdk.d.ts +2 -2
  117. package/sdk/sdk.d.ts.map +1 -1
  118. package/sdk/sdk.js +4 -4
  119. package/sdk/sdk.js.map +1 -1
  120. package/src/funcs/accountAccountV1GetBadgeBookmarks.ts +127 -0
  121. package/src/funcs/adminAdminV1GetEvents.ts +124 -0
  122. package/src/funcs/adminAdminV1UpdateEvent.ts +142 -0
  123. package/src/funcs/badgeAccountV1BookmarkBadge.ts +142 -0
  124. package/src/funcs/badgeAccountV1GetBadgeBookmarks.ts +127 -0
  125. package/src/lib/config.ts +3 -3
  126. package/src/models/components/index.ts +11 -0
  127. package/src/models/components/v1accountbadgebookmark.ts +78 -0
  128. package/src/models/components/v1accountbadgebookmarkrequestbody.ts +79 -0
  129. package/src/models/components/v1accountbadgebookmarkresponsebody.ts +82 -0
  130. package/src/models/components/v1accountbadgebookmarksrequestbody.ts +62 -0
  131. package/src/models/components/v1accountbadgebookmarksresponsebody.ts +93 -0
  132. package/src/models/components/v1admingeteventsresponsebody.ts +90 -0
  133. package/src/models/components/v1adminupdateeventrequestbody.ts +84 -0
  134. package/src/models/components/v1adminupdateeventresponsebody.ts +80 -0
  135. package/src/models/components/v1appeventmapping.ts +76 -0
  136. package/src/models/components/v1event.ts +145 -0
  137. package/src/models/components/v1getsessionbody.ts +14 -0
  138. package/src/models/components/v1leaderboardbadge.ts +10 -0
  139. package/src/models/components/v1leaderboardbadgeevent.ts +132 -0
  140. package/src/models/operations/accountv1bookmarkbadge.ts +93 -0
  141. package/src/models/operations/accountv1getbadgebookmarks.ts +96 -0
  142. package/src/models/operations/adminv1getevents.ts +91 -0
  143. package/src/models/operations/adminv1updateevent.ts +91 -0
  144. package/src/models/operations/index.ts +4 -0
  145. package/src/sdk/account.ts +12 -0
  146. package/src/sdk/admin.ts +22 -0
  147. package/src/sdk/badge.ts +24 -0
  148. package/src/sdk/sdk.ts +5 -5
package/README.md CHANGED
@@ -53,9 +53,9 @@ const steamSets = new SteamSets({
53
53
  });
54
54
 
55
55
  async function run() {
56
- const result = await steamSets.connections.connect({
57
- code: "123456",
58
- provider: "discord",
56
+ const result = await steamSets.badge.accountV1BookmarkBadge({
57
+ badgeId: "bdg_123",
58
+ bookmark: true,
59
59
  });
60
60
 
61
61
  // Handle the result
@@ -77,6 +77,7 @@ run();
77
77
 
78
78
  * [deleteImages](docs/sdks/account/README.md#deleteimages)
79
79
  * [getApps](docs/sdks/account/README.md#getapps)
80
+ * [accountV1GetBadgeBookmarks](docs/sdks/account/README.md#accountv1getbadgebookmarks)
80
81
  * [getBadges](docs/sdks/account/README.md#getbadges)
81
82
  * [getDataPoints](docs/sdks/account/README.md#getdatapoints)
82
83
  * [getFriends](docs/sdks/account/README.md#getfriends)
@@ -95,11 +96,15 @@ run();
95
96
  ### [admin](docs/sdks/admin/README.md)
96
97
 
97
98
  * [getAccount](docs/sdks/admin/README.md#getaccount)
99
+ * [adminV1GetEvents](docs/sdks/admin/README.md#adminv1getevents)
100
+ * [adminV1UpdateEvent](docs/sdks/admin/README.md#adminv1updateevent)
98
101
  * [adminV1UpdateResources](docs/sdks/admin/README.md#adminv1updateresources)
99
102
  * [adminV1UpdateRoles](docs/sdks/admin/README.md#adminv1updateroles)
100
103
 
101
104
  ### [badge](docs/sdks/badge/README.md)
102
105
 
106
+ * [accountV1BookmarkBadge](docs/sdks/badge/README.md#accountv1bookmarkbadge)
107
+ * [accountV1GetBadgeBookmarks](docs/sdks/badge/README.md#accountv1getbadgebookmarks)
103
108
  * [getTags](docs/sdks/badge/README.md#gettags)
104
109
 
105
110
  ### [badges](docs/sdks/badges/README.md)
@@ -198,9 +203,9 @@ const steamSets = new SteamSets({
198
203
  });
199
204
 
200
205
  async function run() {
201
- const result = await steamSets.connections.connect({
202
- code: "123456",
203
- provider: "discord",
206
+ const result = await steamSets.badge.accountV1BookmarkBadge({
207
+ badgeId: "bdg_123",
208
+ bookmark: true,
204
209
  }, {
205
210
  retries: {
206
211
  strategy: "backoff",
@@ -241,9 +246,9 @@ const steamSets = new SteamSets({
241
246
  });
242
247
 
243
248
  async function run() {
244
- const result = await steamSets.connections.connect({
245
- code: "123456",
246
- provider: "discord",
249
+ const result = await steamSets.badge.accountV1BookmarkBadge({
250
+ badgeId: "bdg_123",
251
+ bookmark: true,
247
252
  });
248
253
 
249
254
  // Handle the result
@@ -270,12 +275,12 @@ If a HTTP request fails, an operation my also throw an error from the `models/er
270
275
  | InvalidRequestError | Any input used to create a request is invalid |
271
276
  | UnexpectedClientError | Unrecognised or unexpected error |
272
277
 
273
- In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective *Errors* tables in SDK docs for more details on possible error types for each operation. For example, the `connect` method may throw the following errors:
278
+ In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective *Errors* tables in SDK docs for more details on possible error types for each operation. For example, the `accountV1BookmarkBadge` method may throw the following errors:
274
279
 
275
- | Error Type | Status Code | Content Type |
276
- | ----------------- | ------------- | ------------------------ |
277
- | errors.ErrorModel | 400, 422, 500 | application/problem+json |
278
- | errors.SDKError | 4XX, 5XX | \*/\* |
280
+ | Error Type | Status Code | Content Type |
281
+ | ----------------- | ------------------ | ------------------------ |
282
+ | errors.ErrorModel | 403, 404, 422, 500 | application/problem+json |
283
+ | errors.SDKError | 4XX, 5XX | \*/\* |
279
284
 
280
285
  ```typescript
281
286
  import { SteamSets } from "@steamsets/client-ts";
@@ -291,9 +296,9 @@ const steamSets = new SteamSets({
291
296
  async function run() {
292
297
  let result;
293
298
  try {
294
- result = await steamSets.connections.connect({
295
- code: "123456",
296
- provider: "discord",
299
+ result = await steamSets.badge.accountV1BookmarkBadge({
300
+ badgeId: "bdg_123",
301
+ bookmark: true,
297
302
  });
298
303
 
299
304
  // Handle the result
@@ -349,9 +354,9 @@ const steamSets = new SteamSets({
349
354
  });
350
355
 
351
356
  async function run() {
352
- const result = await steamSets.connections.connect({
353
- code: "123456",
354
- provider: "discord",
357
+ const result = await steamSets.badge.accountV1BookmarkBadge({
358
+ badgeId: "bdg_123",
359
+ bookmark: true,
355
360
  });
356
361
 
357
362
  // Handle the result
@@ -374,9 +379,9 @@ const steamSets = new SteamSets({
374
379
  });
375
380
 
376
381
  async function run() {
377
- const result = await steamSets.connections.connect({
378
- code: "123456",
379
- provider: "discord",
382
+ const result = await steamSets.badge.accountV1BookmarkBadge({
383
+ badgeId: "bdg_123",
384
+ bookmark: true,
380
385
  });
381
386
 
382
387
  // Handle the result
@@ -457,9 +462,9 @@ const steamSets = new SteamSets({
457
462
  });
458
463
 
459
464
  async function run() {
460
- const result = await steamSets.connections.connect({
461
- code: "123456",
462
- provider: "discord",
465
+ const result = await steamSets.badge.accountV1BookmarkBadge({
466
+ badgeId: "bdg_123",
467
+ bookmark: true,
463
468
  });
464
469
 
465
470
  // Handle the result
@@ -531,6 +536,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
531
536
 
532
537
  <summary>Available standalone functions</summary>
533
538
 
539
+ - [`accountAccountV1GetBadgeBookmarks`](docs/sdks/account/README.md#accountv1getbadgebookmarks)
534
540
  - [`accountDeleteImages`](docs/sdks/account/README.md#deleteimages)
535
541
  - [`accountGetApps`](docs/sdks/account/README.md#getapps)
536
542
  - [`accountGetBadges`](docs/sdks/account/README.md#getbadges)
@@ -544,9 +550,13 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
544
550
  - [`accountUpdateImage`](docs/sdks/account/README.md#updateimage)
545
551
  - [`accountUploadImages`](docs/sdks/account/README.md#uploadimages)
546
552
  - [`accountVerifyEmail`](docs/sdks/account/README.md#verifyemail)
553
+ - [`adminAdminV1GetEvents`](docs/sdks/admin/README.md#adminv1getevents)
554
+ - [`adminAdminV1UpdateEvent`](docs/sdks/admin/README.md#adminv1updateevent)
547
555
  - [`adminAdminV1UpdateResources`](docs/sdks/admin/README.md#adminv1updateresources)
548
556
  - [`adminAdminV1UpdateRoles`](docs/sdks/admin/README.md#adminv1updateroles)
549
557
  - [`adminGetAccount`](docs/sdks/admin/README.md#getaccount)
558
+ - [`badgeAccountV1BookmarkBadge`](docs/sdks/badge/README.md#accountv1bookmarkbadge)
559
+ - [`badgeAccountV1GetBadgeBookmarks`](docs/sdks/badge/README.md#accountv1getbadgebookmarks)
550
560
  - [`badgeGetTags`](docs/sdks/badge/README.md#gettags)
551
561
  - [`badgesTag`](docs/sdks/badges/README.md#tag)
552
562
  - [`connectionDelete`](docs/sdks/connection/README.md#delete)
@@ -9,6 +9,7 @@ Account related operations
9
9
 
10
10
  * [deleteImages](#deleteimages)
11
11
  * [getApps](#getapps)
12
+ * [accountV1GetBadgeBookmarks](#accountv1getbadgebookmarks)
12
13
  * [getBadges](#getbadges)
13
14
  * [getDataPoints](#getdatapoints)
14
15
  * [getFriends](#getfriends)
@@ -170,6 +171,77 @@ run();
170
171
  | errors.ErrorModel | 400, 403, 404, 422, 500 | application/problem+json |
171
172
  | errors.SDKError | 4XX, 5XX | \*/\* |
172
173
 
174
+ ## accountV1GetBadgeBookmarks
175
+
176
+ ### Example Usage
177
+
178
+ ```typescript
179
+ import { SteamSets } from "@steamsets/client-ts";
180
+
181
+ const steamSets = new SteamSets({
182
+ token: "<YOUR_BEARER_TOKEN_HERE>",
183
+ });
184
+
185
+ async function run() {
186
+ const result = await steamSets.account.accountV1GetBadgeBookmarks({});
187
+
188
+ // Handle the result
189
+ console.log(result);
190
+ }
191
+
192
+ run();
193
+ ```
194
+
195
+ ### Standalone function
196
+
197
+ The standalone function version of this method:
198
+
199
+ ```typescript
200
+ import { SteamSetsCore } from "@steamsets/client-ts/core.js";
201
+ import { accountAccountV1GetBadgeBookmarks } from "@steamsets/client-ts/funcs/accountAccountV1GetBadgeBookmarks.js";
202
+
203
+ // Use `SteamSetsCore` for best tree-shaking performance.
204
+ // You can create one instance of it to use across an application.
205
+ const steamSets = new SteamSetsCore({
206
+ token: "<YOUR_BEARER_TOKEN_HERE>",
207
+ });
208
+
209
+ async function run() {
210
+ const res = await accountAccountV1GetBadgeBookmarks(steamSets, {});
211
+
212
+ if (!res.ok) {
213
+ throw res.error;
214
+ }
215
+
216
+ const { value: result } = res;
217
+
218
+ // Handle the result
219
+ console.log(result);
220
+ }
221
+
222
+ run();
223
+ ```
224
+
225
+ ### Parameters
226
+
227
+ | Parameter | Type | Required | Description |
228
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
229
+ | `request` | [components.V1AccountBadgeBookmarksRequestBody](../../models/components/v1accountbadgebookmarksrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
230
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
231
+ | `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. |
232
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
233
+
234
+ ### Response
235
+
236
+ **Promise\<[operations.AccountV1GetBadgeBookmarksResponse](../../models/operations/accountv1getbadgebookmarksresponse.md)\>**
237
+
238
+ ### Errors
239
+
240
+ | Error Type | Status Code | Content Type |
241
+ | ------------------------ | ------------------------ | ------------------------ |
242
+ | errors.ErrorModel | 403, 404, 422, 500 | application/problem+json |
243
+ | errors.SDKError | 4XX, 5XX | \*/\* |
244
+
173
245
  ## getBadges
174
246
 
175
247
  ### Example Usage
@@ -8,6 +8,8 @@ Admin related operations
8
8
  ### Available Operations
9
9
 
10
10
  * [getAccount](#getaccount)
11
+ * [adminV1GetEvents](#adminv1getevents)
12
+ * [adminV1UpdateEvent](#adminv1updateevent)
11
13
  * [adminV1UpdateResources](#adminv1updateresources)
12
14
  * [adminV1UpdateRoles](#adminv1updateroles)
13
15
 
@@ -82,6 +84,163 @@ run();
82
84
  | errors.ErrorModel | 403, 404, 422, 429, 500 | application/problem+json |
83
85
  | errors.SDKError | 4XX, 5XX | \*/\* |
84
86
 
87
+ ## adminV1GetEvents
88
+
89
+ ### Example Usage
90
+
91
+ ```typescript
92
+ import { SteamSets } from "@steamsets/client-ts";
93
+
94
+ const steamSets = new SteamSets({
95
+ token: "<YOUR_BEARER_TOKEN_HERE>",
96
+ });
97
+
98
+ async function run() {
99
+ const result = await steamSets.admin.adminV1GetEvents();
100
+
101
+ // Handle the result
102
+ console.log(result);
103
+ }
104
+
105
+ run();
106
+ ```
107
+
108
+ ### Standalone function
109
+
110
+ The standalone function version of this method:
111
+
112
+ ```typescript
113
+ import { SteamSetsCore } from "@steamsets/client-ts/core.js";
114
+ import { adminAdminV1GetEvents } from "@steamsets/client-ts/funcs/adminAdminV1GetEvents.js";
115
+
116
+ // Use `SteamSetsCore` for best tree-shaking performance.
117
+ // You can create one instance of it to use across an application.
118
+ const steamSets = new SteamSetsCore({
119
+ token: "<YOUR_BEARER_TOKEN_HERE>",
120
+ });
121
+
122
+ async function run() {
123
+ const res = await adminAdminV1GetEvents(steamSets);
124
+
125
+ if (!res.ok) {
126
+ throw res.error;
127
+ }
128
+
129
+ const { value: result } = res;
130
+
131
+ // Handle the result
132
+ console.log(result);
133
+ }
134
+
135
+ run();
136
+ ```
137
+
138
+ ### Parameters
139
+
140
+ | Parameter | Type | Required | Description |
141
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
142
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
143
+ | `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. |
144
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
145
+
146
+ ### Response
147
+
148
+ **Promise\<[operations.AdminV1GetEventsResponse](../../models/operations/adminv1geteventsresponse.md)\>**
149
+
150
+ ### Errors
151
+
152
+ | Error Type | Status Code | Content Type |
153
+ | ------------------------ | ------------------------ | ------------------------ |
154
+ | errors.ErrorModel | 403, 404, 429, 500 | application/problem+json |
155
+ | errors.SDKError | 4XX, 5XX | \*/\* |
156
+
157
+ ## adminV1UpdateEvent
158
+
159
+ ### Example Usage
160
+
161
+ ```typescript
162
+ import { SteamSets } from "@steamsets/client-ts";
163
+
164
+ const steamSets = new SteamSets({
165
+ token: "<YOUR_BEARER_TOKEN_HERE>",
166
+ });
167
+
168
+ async function run() {
169
+ const result = await steamSets.admin.adminV1UpdateEvent({
170
+ eventId: "evt_123456",
171
+ mappings: [
172
+ {
173
+ appId: 730,
174
+ steamId: 76561198842603730,
175
+ },
176
+ ],
177
+ });
178
+
179
+ // Handle the result
180
+ console.log(result);
181
+ }
182
+
183
+ run();
184
+ ```
185
+
186
+ ### Standalone function
187
+
188
+ The standalone function version of this method:
189
+
190
+ ```typescript
191
+ import { SteamSetsCore } from "@steamsets/client-ts/core.js";
192
+ import { adminAdminV1UpdateEvent } from "@steamsets/client-ts/funcs/adminAdminV1UpdateEvent.js";
193
+
194
+ // Use `SteamSetsCore` for best tree-shaking performance.
195
+ // You can create one instance of it to use across an application.
196
+ const steamSets = new SteamSetsCore({
197
+ token: "<YOUR_BEARER_TOKEN_HERE>",
198
+ });
199
+
200
+ async function run() {
201
+ const res = await adminAdminV1UpdateEvent(steamSets, {
202
+ eventId: "evt_123456",
203
+ mappings: [
204
+ {
205
+ appId: 730,
206
+ steamId: 76561198842603730,
207
+ },
208
+ ],
209
+ });
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.V1AdminUpdateEventRequestBody](../../models/components/v1adminupdateeventrequestbody.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.AdminV1UpdateEventResponse](../../models/operations/adminv1updateeventresponse.md)\>**
236
+
237
+ ### Errors
238
+
239
+ | Error Type | Status Code | Content Type |
240
+ | ------------------------ | ------------------------ | ------------------------ |
241
+ | errors.ErrorModel | 403, 404, 422, 429, 500 | application/problem+json |
242
+ | errors.SDKError | 4XX, 5XX | \*/\* |
243
+
85
244
  ## adminV1UpdateResources
86
245
 
87
246
  ### Example Usage
@@ -5,8 +5,158 @@
5
5
 
6
6
  ### Available Operations
7
7
 
8
+ * [accountV1BookmarkBadge](#accountv1bookmarkbadge)
9
+ * [accountV1GetBadgeBookmarks](#accountv1getbadgebookmarks)
8
10
  * [getTags](#gettags)
9
11
 
12
+ ## accountV1BookmarkBadge
13
+
14
+ ### Example Usage
15
+
16
+ ```typescript
17
+ import { SteamSets } from "@steamsets/client-ts";
18
+
19
+ const steamSets = new SteamSets({
20
+ token: "<YOUR_BEARER_TOKEN_HERE>",
21
+ });
22
+
23
+ async function run() {
24
+ const result = await steamSets.badge.accountV1BookmarkBadge({
25
+ badgeId: "bdg_123",
26
+ bookmark: true,
27
+ });
28
+
29
+ // Handle the result
30
+ console.log(result);
31
+ }
32
+
33
+ run();
34
+ ```
35
+
36
+ ### Standalone function
37
+
38
+ The standalone function version of this method:
39
+
40
+ ```typescript
41
+ import { SteamSetsCore } from "@steamsets/client-ts/core.js";
42
+ import { badgeAccountV1BookmarkBadge } from "@steamsets/client-ts/funcs/badgeAccountV1BookmarkBadge.js";
43
+
44
+ // Use `SteamSetsCore` for best tree-shaking performance.
45
+ // You can create one instance of it to use across an application.
46
+ const steamSets = new SteamSetsCore({
47
+ token: "<YOUR_BEARER_TOKEN_HERE>",
48
+ });
49
+
50
+ async function run() {
51
+ const res = await badgeAccountV1BookmarkBadge(steamSets, {
52
+ badgeId: "bdg_123",
53
+ bookmark: true,
54
+ });
55
+
56
+ if (!res.ok) {
57
+ throw res.error;
58
+ }
59
+
60
+ const { value: result } = res;
61
+
62
+ // Handle the result
63
+ console.log(result);
64
+ }
65
+
66
+ run();
67
+ ```
68
+
69
+ ### Parameters
70
+
71
+ | Parameter | Type | Required | Description |
72
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
73
+ | `request` | [components.V1AccountBadgeBookmarkRequestBody](../../models/components/v1accountbadgebookmarkrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
74
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
75
+ | `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. |
76
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
77
+
78
+ ### Response
79
+
80
+ **Promise\<[operations.AccountV1BookmarkBadgeResponse](../../models/operations/accountv1bookmarkbadgeresponse.md)\>**
81
+
82
+ ### Errors
83
+
84
+ | Error Type | Status Code | Content Type |
85
+ | ------------------------ | ------------------------ | ------------------------ |
86
+ | errors.ErrorModel | 403, 404, 422, 500 | application/problem+json |
87
+ | errors.SDKError | 4XX, 5XX | \*/\* |
88
+
89
+ ## accountV1GetBadgeBookmarks
90
+
91
+ ### Example Usage
92
+
93
+ ```typescript
94
+ import { SteamSets } from "@steamsets/client-ts";
95
+
96
+ const steamSets = new SteamSets({
97
+ token: "<YOUR_BEARER_TOKEN_HERE>",
98
+ });
99
+
100
+ async function run() {
101
+ const result = await steamSets.badge.accountV1GetBadgeBookmarks({});
102
+
103
+ // Handle the result
104
+ console.log(result);
105
+ }
106
+
107
+ run();
108
+ ```
109
+
110
+ ### Standalone function
111
+
112
+ The standalone function version of this method:
113
+
114
+ ```typescript
115
+ import { SteamSetsCore } from "@steamsets/client-ts/core.js";
116
+ import { badgeAccountV1GetBadgeBookmarks } from "@steamsets/client-ts/funcs/badgeAccountV1GetBadgeBookmarks.js";
117
+
118
+ // Use `SteamSetsCore` for best tree-shaking performance.
119
+ // You can create one instance of it to use across an application.
120
+ const steamSets = new SteamSetsCore({
121
+ token: "<YOUR_BEARER_TOKEN_HERE>",
122
+ });
123
+
124
+ async function run() {
125
+ const res = await badgeAccountV1GetBadgeBookmarks(steamSets, {});
126
+
127
+ if (!res.ok) {
128
+ throw res.error;
129
+ }
130
+
131
+ const { value: result } = res;
132
+
133
+ // Handle the result
134
+ console.log(result);
135
+ }
136
+
137
+ run();
138
+ ```
139
+
140
+ ### Parameters
141
+
142
+ | Parameter | Type | Required | Description |
143
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
144
+ | `request` | [components.V1AccountBadgeBookmarksRequestBody](../../models/components/v1accountbadgebookmarksrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
145
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
146
+ | `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. |
147
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
148
+
149
+ ### Response
150
+
151
+ **Promise\<[operations.AccountV1GetBadgeBookmarksResponse](../../models/operations/accountv1getbadgebookmarksresponse.md)\>**
152
+
153
+ ### Errors
154
+
155
+ | Error Type | Status Code | Content Type |
156
+ | ------------------------ | ------------------------ | ------------------------ |
157
+ | errors.ErrorModel | 403, 404, 422, 500 | application/problem+json |
158
+ | errors.SDKError | 4XX, 5XX | \*/\* |
159
+
10
160
  ## getTags
11
161
 
12
162
  ### Example Usage
@@ -0,0 +1,11 @@
1
+ import { SteamSetsCore } from "../core.js";
2
+ import { RequestOptions } from "../lib/sdks.js";
3
+ import * as components from "../models/components/index.js";
4
+ import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
5
+ import * as errors from "../models/errors/index.js";
6
+ import { SDKError } from "../models/errors/sdkerror.js";
7
+ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
8
+ import * as operations from "../models/operations/index.js";
9
+ import { Result } from "../types/fp.js";
10
+ export declare function accountAccountV1GetBadgeBookmarks(client: SteamSetsCore, _request: components.V1AccountBadgeBookmarksRequestBody, options?: RequestOptions): Promise<Result<operations.AccountV1GetBadgeBookmarksResponse, errors.ErrorModel | SDKError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
11
+ //# sourceMappingURL=accountAccountV1GetBadgeBookmarks.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"accountAccountV1GetBadgeBookmarks.d.ts","sourceRoot":"","sources":["../src/funcs/accountAccountV1GetBadgeBookmarks.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAE3C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC,wBAAsB,iCAAiC,CACrD,MAAM,EAAE,aAAa,EACrB,QAAQ,EAAE,UAAU,CAAC,kCAAkC,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,MAAM,CACJ,UAAU,CAAC,kCAAkC,EAC3C,MAAM,CAAC,UAAU,GACjB,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAuFA"}