@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,1137 +0,0 @@
1
- # Internal
2
- (*internal*)
3
-
4
- ## Overview
5
-
6
- There requests are just document for documentations sake, they are not meant to be used. If you are looking to use one of these endpoints, please contact us.
7
-
8
- ### Available Operations
9
-
10
- * [createDeveloperApp](#createdeveloperapp)
11
- * [deleteDeveloperApp](#deletedeveloperapp)
12
- * [deleteImages](#deleteimages)
13
- * [updateApp](#updateapp)
14
- * [accountV1GetMeta](#accountv1getmeta)
15
- * [getStaff](#getstaff)
16
- * [uploadImages](#uploadimages)
17
- * [getAccount](#getaccount)
18
- * [adminV1RemoveVanity](#adminv1removevanity)
19
- * [getTags](#gettags)
20
- * [badgeV1SearchSuggest](#badgev1searchsuggest)
21
- * [badgeV1TagsSuggest](#badgev1tagssuggest)
22
- * [leaderboardV1GetLeaderboardAccountMeta](#leaderboardv1getleaderboardaccountmeta)
23
- * [check](#check) - Liveness check
24
-
25
- ## createDeveloperApp
26
-
27
- ### Example Usage
28
-
29
- ```typescript
30
- import { SteamSets } from "@steamsets/client-ts";
31
-
32
- const steamSets = new SteamSets({
33
- token: "<YOUR_BEARER_TOKEN_HERE>",
34
- });
35
-
36
- async function run() {
37
- const result = await steamSets.internal.createDeveloperApp({
38
- description: "Your App Description",
39
- environment: "production",
40
- generateKey: true,
41
- name: "Your App",
42
- });
43
-
44
- // Handle the result
45
- console.log(result);
46
- }
47
-
48
- run();
49
- ```
50
-
51
- ### Standalone function
52
-
53
- The standalone function version of this method:
54
-
55
- ```typescript
56
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
57
- import { internalCreateDeveloperApp } from "@steamsets/client-ts/funcs/internalCreateDeveloperApp.js";
58
-
59
- // Use `SteamSetsCore` for best tree-shaking performance.
60
- // You can create one instance of it to use across an application.
61
- const steamSets = new SteamSetsCore({
62
- token: "<YOUR_BEARER_TOKEN_HERE>",
63
- });
64
-
65
- async function run() {
66
- const res = await internalCreateDeveloperApp(steamSets, {
67
- description: "Your App Description",
68
- environment: "production",
69
- generateKey: true,
70
- name: "Your App",
71
- });
72
-
73
- if (!res.ok) {
74
- throw res.error;
75
- }
76
-
77
- const { value: result } = res;
78
-
79
- // Handle the result
80
- console.log(result);
81
- }
82
-
83
- run();
84
- ```
85
-
86
- ### Parameters
87
-
88
- | Parameter | Type | Required | Description |
89
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
90
- | `request` | [components.V1DeveloperAppCreateRequestBody](../../models/components/v1developerappcreaterequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
91
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
92
- | `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. |
93
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
94
-
95
- ### Response
96
-
97
- **Promise\<[operations.AccountV1SettingsDeveloperAppCreateResponse](../../models/operations/accountv1settingsdeveloperappcreateresponse.md)\>**
98
-
99
- ### Errors
100
-
101
- | Error Type | Status Code | Content Type |
102
- | ------------------------ | ------------------------ | ------------------------ |
103
- | errors.ErrorModel | 400, 404, 422 | application/problem+json |
104
- | errors.ErrorModel | 500 | application/problem+json |
105
- | errors.SDKError | 4XX, 5XX | \*/\* |
106
-
107
- ## deleteDeveloperApp
108
-
109
- ### Example Usage
110
-
111
- ```typescript
112
- import { SteamSets } from "@steamsets/client-ts";
113
-
114
- const steamSets = new SteamSets({
115
- token: "<YOUR_BEARER_TOKEN_HERE>",
116
- });
117
-
118
- async function run() {
119
- const result = await steamSets.internal.deleteDeveloperApp({
120
- developerAppId: "da_123456",
121
- });
122
-
123
- // Handle the result
124
- console.log(result);
125
- }
126
-
127
- run();
128
- ```
129
-
130
- ### Standalone function
131
-
132
- The standalone function version of this method:
133
-
134
- ```typescript
135
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
136
- import { internalDeleteDeveloperApp } from "@steamsets/client-ts/funcs/internalDeleteDeveloperApp.js";
137
-
138
- // Use `SteamSetsCore` for best tree-shaking performance.
139
- // You can create one instance of it to use across an application.
140
- const steamSets = new SteamSetsCore({
141
- token: "<YOUR_BEARER_TOKEN_HERE>",
142
- });
143
-
144
- async function run() {
145
- const res = await internalDeleteDeveloperApp(steamSets, {
146
- developerAppId: "da_123456",
147
- });
148
-
149
- if (!res.ok) {
150
- throw res.error;
151
- }
152
-
153
- const { value: result } = res;
154
-
155
- // Handle the result
156
- console.log(result);
157
- }
158
-
159
- run();
160
- ```
161
-
162
- ### Parameters
163
-
164
- | Parameter | Type | Required | Description |
165
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
166
- | `request` | [components.V1AccountDeveloperAppDeleteRequestBody](../../models/components/v1accountdeveloperappdeleterequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
167
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
168
- | `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. |
169
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
170
-
171
- ### Response
172
-
173
- **Promise\<[operations.AccountV1SettingsDeveloperAppDeleteResponse](../../models/operations/accountv1settingsdeveloperappdeleteresponse.md)\>**
174
-
175
- ### Errors
176
-
177
- | Error Type | Status Code | Content Type |
178
- | ------------------------ | ------------------------ | ------------------------ |
179
- | errors.ErrorModel | 404, 422, 429 | application/problem+json |
180
- | errors.ErrorModel | 500 | application/problem+json |
181
- | errors.SDKError | 4XX, 5XX | \*/\* |
182
-
183
- ## deleteImages
184
-
185
- ### Example Usage
186
-
187
- ```typescript
188
- import { SteamSets } from "@steamsets/client-ts";
189
-
190
- const steamSets = new SteamSets({
191
- token: "<YOUR_BEARER_TOKEN_HERE>",
192
- });
193
-
194
- async function run() {
195
- const result = await steamSets.internal.deleteImages({
196
- imageIds: [
197
- "<value>",
198
- "<value>",
199
- ],
200
- });
201
-
202
- // Handle the result
203
- console.log(result);
204
- }
205
-
206
- run();
207
- ```
208
-
209
- ### Standalone function
210
-
211
- The standalone function version of this method:
212
-
213
- ```typescript
214
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
215
- import { internalDeleteImages } from "@steamsets/client-ts/funcs/internalDeleteImages.js";
216
-
217
- // Use `SteamSetsCore` for best tree-shaking performance.
218
- // You can create one instance of it to use across an application.
219
- const steamSets = new SteamSetsCore({
220
- token: "<YOUR_BEARER_TOKEN_HERE>",
221
- });
222
-
223
- async function run() {
224
- const res = await internalDeleteImages(steamSets, {
225
- imageIds: [
226
- "<value>",
227
- "<value>",
228
- ],
229
- });
230
-
231
- if (!res.ok) {
232
- throw res.error;
233
- }
234
-
235
- const { value: result } = res;
236
-
237
- // Handle the result
238
- console.log(result);
239
- }
240
-
241
- run();
242
- ```
243
-
244
- ### Parameters
245
-
246
- | Parameter | Type | Required | Description |
247
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
248
- | `request` | [components.V1DeleteImagesRequestBody](../../models/components/v1deleteimagesrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
249
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
250
- | `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. |
251
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
252
-
253
- ### Response
254
-
255
- **Promise\<[operations.AccountV1ImagesDeleteResponse](../../models/operations/accountv1imagesdeleteresponse.md)\>**
256
-
257
- ### Errors
258
-
259
- | Error Type | Status Code | Content Type |
260
- | ------------------------ | ------------------------ | ------------------------ |
261
- | errors.ErrorModel | 404, 422 | application/problem+json |
262
- | errors.ErrorModel | 500 | application/problem+json |
263
- | errors.SDKError | 4XX, 5XX | \*/\* |
264
-
265
- ## updateApp
266
-
267
- ### Example Usage
268
-
269
- ```typescript
270
- import { SteamSets } from "@steamsets/client-ts";
271
-
272
- const steamSets = new SteamSets({
273
- token: "<YOUR_BEARER_TOKEN_HERE>",
274
- });
275
-
276
- async function run() {
277
- const result = await steamSets.internal.updateApp({
278
- description: "My App Description",
279
- developerAppId: "da_123456",
280
- name: "My App",
281
- regenerate: true,
282
- });
283
-
284
- // Handle the result
285
- console.log(result);
286
- }
287
-
288
- run();
289
- ```
290
-
291
- ### Standalone function
292
-
293
- The standalone function version of this method:
294
-
295
- ```typescript
296
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
297
- import { internalUpdateApp } from "@steamsets/client-ts/funcs/internalUpdateApp.js";
298
-
299
- // Use `SteamSetsCore` for best tree-shaking performance.
300
- // You can create one instance of it to use across an application.
301
- const steamSets = new SteamSetsCore({
302
- token: "<YOUR_BEARER_TOKEN_HERE>",
303
- });
304
-
305
- async function run() {
306
- const res = await internalUpdateApp(steamSets, {
307
- description: "My App Description",
308
- developerAppId: "da_123456",
309
- name: "My App",
310
- regenerate: true,
311
- });
312
-
313
- if (!res.ok) {
314
- throw res.error;
315
- }
316
-
317
- const { value: result } = res;
318
-
319
- // Handle the result
320
- console.log(result);
321
- }
322
-
323
- run();
324
- ```
325
-
326
- ### Parameters
327
-
328
- | Parameter | Type | Required | Description |
329
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
330
- | `request` | [components.V1AccountDeveloperAppUpdateRequestBody](../../models/components/v1accountdeveloperappupdaterequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
331
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
332
- | `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. |
333
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
334
-
335
- ### Response
336
-
337
- **Promise\<[operations.AccountV1SettingsDeveloperAppUpdateResponse](../../models/operations/accountv1settingsdeveloperappupdateresponse.md)\>**
338
-
339
- ### Errors
340
-
341
- | Error Type | Status Code | Content Type |
342
- | ------------------------ | ------------------------ | ------------------------ |
343
- | errors.ErrorModel | 404, 422, 429 | application/problem+json |
344
- | errors.ErrorModel | 500 | application/problem+json |
345
- | errors.SDKError | 4XX, 5XX | \*/\* |
346
-
347
- ## accountV1GetMeta
348
-
349
- ### Example Usage
350
-
351
- ```typescript
352
- import { SteamSets } from "@steamsets/client-ts";
353
-
354
- const steamSets = new SteamSets({
355
- token: "<YOUR_BEARER_TOKEN_HERE>",
356
- });
357
-
358
- async function run() {
359
- const result = await steamSets.internal.accountV1GetMeta({});
360
-
361
- // Handle the result
362
- console.log(result);
363
- }
364
-
365
- run();
366
- ```
367
-
368
- ### Standalone function
369
-
370
- The standalone function version of this method:
371
-
372
- ```typescript
373
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
374
- import { internalAccountV1GetMeta } from "@steamsets/client-ts/funcs/internalAccountV1GetMeta.js";
375
-
376
- // Use `SteamSetsCore` for best tree-shaking performance.
377
- // You can create one instance of it to use across an application.
378
- const steamSets = new SteamSetsCore({
379
- token: "<YOUR_BEARER_TOKEN_HERE>",
380
- });
381
-
382
- async function run() {
383
- const res = await internalAccountV1GetMeta(steamSets, {});
384
-
385
- if (!res.ok) {
386
- throw res.error;
387
- }
388
-
389
- const { value: result } = res;
390
-
391
- // Handle the result
392
- console.log(result);
393
- }
394
-
395
- run();
396
- ```
397
-
398
- ### Parameters
399
-
400
- | Parameter | Type | Required | Description |
401
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
402
- | `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
403
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
404
- | `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. |
405
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
406
-
407
- ### Response
408
-
409
- **Promise\<[operations.AccountV1GetMetaResponse](../../models/operations/accountv1getmetaresponse.md)\>**
410
-
411
- ### Errors
412
-
413
- | Error Type | Status Code | Content Type |
414
- | ------------------------ | ------------------------ | ------------------------ |
415
- | errors.ErrorModel | 404, 422 | application/problem+json |
416
- | errors.ErrorModel | 500 | application/problem+json |
417
- | errors.SDKError | 4XX, 5XX | \*/\* |
418
-
419
- ## getStaff
420
-
421
- ### Example Usage
422
-
423
- ```typescript
424
- import { SteamSets } from "@steamsets/client-ts";
425
-
426
- const steamSets = new SteamSets({
427
- token: "<YOUR_BEARER_TOKEN_HERE>",
428
- });
429
-
430
- async function run() {
431
- const result = await steamSets.internal.getStaff();
432
-
433
- // Handle the result
434
- console.log(result);
435
- }
436
-
437
- run();
438
- ```
439
-
440
- ### Standalone function
441
-
442
- The standalone function version of this method:
443
-
444
- ```typescript
445
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
446
- import { internalGetStaff } from "@steamsets/client-ts/funcs/internalGetStaff.js";
447
-
448
- // Use `SteamSetsCore` for best tree-shaking performance.
449
- // You can create one instance of it to use across an application.
450
- const steamSets = new SteamSetsCore({
451
- token: "<YOUR_BEARER_TOKEN_HERE>",
452
- });
453
-
454
- async function run() {
455
- const res = await internalGetStaff(steamSets);
456
-
457
- if (!res.ok) {
458
- throw res.error;
459
- }
460
-
461
- const { value: result } = res;
462
-
463
- // Handle the result
464
- console.log(result);
465
- }
466
-
467
- run();
468
- ```
469
-
470
- ### Parameters
471
-
472
- | Parameter | Type | Required | Description |
473
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
474
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
475
- | `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. |
476
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
477
-
478
- ### Response
479
-
480
- **Promise\<[operations.AccountV1GetStaffResponse](../../models/operations/accountv1getstaffresponse.md)\>**
481
-
482
- ### Errors
483
-
484
- | Error Type | Status Code | Content Type |
485
- | ------------------------ | ------------------------ | ------------------------ |
486
- | errors.ErrorModel | 404, 429 | application/problem+json |
487
- | errors.ErrorModel | 500 | application/problem+json |
488
- | errors.SDKError | 4XX, 5XX | \*/\* |
489
-
490
- ## uploadImages
491
-
492
- ### Example Usage
493
-
494
- ```typescript
495
- import { SteamSets } from "@steamsets/client-ts";
496
-
497
- const steamSets = new SteamSets({
498
- token: "<YOUR_BEARER_TOKEN_HERE>",
499
- });
500
-
501
- async function run() {
502
- const result = await steamSets.internal.uploadImages({
503
- images: [
504
-
505
- ],
506
- });
507
-
508
- // Handle the result
509
- console.log(result);
510
- }
511
-
512
- run();
513
- ```
514
-
515
- ### Standalone function
516
-
517
- The standalone function version of this method:
518
-
519
- ```typescript
520
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
521
- import { internalUploadImages } from "@steamsets/client-ts/funcs/internalUploadImages.js";
522
-
523
- // Use `SteamSetsCore` for best tree-shaking performance.
524
- // You can create one instance of it to use across an application.
525
- const steamSets = new SteamSetsCore({
526
- token: "<YOUR_BEARER_TOKEN_HERE>",
527
- });
528
-
529
- async function run() {
530
- const res = await internalUploadImages(steamSets, {
531
- images: [
532
-
533
- ],
534
- });
535
-
536
- if (!res.ok) {
537
- throw res.error;
538
- }
539
-
540
- const { value: result } = res;
541
-
542
- // Handle the result
543
- console.log(result);
544
- }
545
-
546
- run();
547
- ```
548
-
549
- ### Parameters
550
-
551
- | Parameter | Type | Required | Description |
552
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
553
- | `request` | [components.V1UploadImagesRequestBody](../../models/components/v1uploadimagesrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
554
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
555
- | `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. |
556
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
557
-
558
- ### Response
559
-
560
- **Promise\<[operations.AccountV1ImagesUploadResponse](../../models/operations/accountv1imagesuploadresponse.md)\>**
561
-
562
- ### Errors
563
-
564
- | Error Type | Status Code | Content Type |
565
- | ------------------------ | ------------------------ | ------------------------ |
566
- | errors.ErrorModel | 422 | application/problem+json |
567
- | errors.ErrorModel | 500 | application/problem+json |
568
- | errors.SDKError | 4XX, 5XX | \*/\* |
569
-
570
- ## getAccount
571
-
572
- ### Example Usage
573
-
574
- ```typescript
575
- import { SteamSets } from "@steamsets/client-ts";
576
-
577
- const steamSets = new SteamSets({
578
- token: "<YOUR_BEARER_TOKEN_HERE>",
579
- });
580
-
581
- async function run() {
582
- const result = await steamSets.internal.getAccount({});
583
-
584
- // Handle the result
585
- console.log(result);
586
- }
587
-
588
- run();
589
- ```
590
-
591
- ### Standalone function
592
-
593
- The standalone function version of this method:
594
-
595
- ```typescript
596
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
597
- import { internalGetAccount } from "@steamsets/client-ts/funcs/internalGetAccount.js";
598
-
599
- // Use `SteamSetsCore` for best tree-shaking performance.
600
- // You can create one instance of it to use across an application.
601
- const steamSets = new SteamSetsCore({
602
- token: "<YOUR_BEARER_TOKEN_HERE>",
603
- });
604
-
605
- async function run() {
606
- const res = await internalGetAccount(steamSets, {});
607
-
608
- if (!res.ok) {
609
- throw res.error;
610
- }
611
-
612
- const { value: result } = res;
613
-
614
- // Handle the result
615
- console.log(result);
616
- }
617
-
618
- run();
619
- ```
620
-
621
- ### Parameters
622
-
623
- | Parameter | Type | Required | Description |
624
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
625
- | `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
626
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
627
- | `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. |
628
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
629
-
630
- ### Response
631
-
632
- **Promise\<[operations.AdminV1GetAccountResponse](../../models/operations/adminv1getaccountresponse.md)\>**
633
-
634
- ### Errors
635
-
636
- | Error Type | Status Code | Content Type |
637
- | ------------------------ | ------------------------ | ------------------------ |
638
- | errors.ErrorModel | 403, 404, 422, 429 | application/problem+json |
639
- | errors.ErrorModel | 500 | application/problem+json |
640
- | errors.SDKError | 4XX, 5XX | \*/\* |
641
-
642
- ## adminV1RemoveVanity
643
-
644
- ### Example Usage
645
-
646
- ```typescript
647
- import { SteamSets } from "@steamsets/client-ts";
648
-
649
- const steamSets = new SteamSets({
650
- token: "<YOUR_BEARER_TOKEN_HERE>",
651
- });
652
-
653
- async function run() {
654
- const result = await steamSets.internal.adminV1RemoveVanity({});
655
-
656
- // Handle the result
657
- console.log(result);
658
- }
659
-
660
- run();
661
- ```
662
-
663
- ### Standalone function
664
-
665
- The standalone function version of this method:
666
-
667
- ```typescript
668
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
669
- import { internalAdminV1RemoveVanity } from "@steamsets/client-ts/funcs/internalAdminV1RemoveVanity.js";
670
-
671
- // Use `SteamSetsCore` for best tree-shaking performance.
672
- // You can create one instance of it to use across an application.
673
- const steamSets = new SteamSetsCore({
674
- token: "<YOUR_BEARER_TOKEN_HERE>",
675
- });
676
-
677
- async function run() {
678
- const res = await internalAdminV1RemoveVanity(steamSets, {});
679
-
680
- if (!res.ok) {
681
- throw res.error;
682
- }
683
-
684
- const { value: result } = res;
685
-
686
- // Handle the result
687
- console.log(result);
688
- }
689
-
690
- run();
691
- ```
692
-
693
- ### Parameters
694
-
695
- | Parameter | Type | Required | Description |
696
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
697
- | `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
698
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
699
- | `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. |
700
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
701
-
702
- ### Response
703
-
704
- **Promise\<[operations.AdminV1RemoveVanityResponse](../../models/operations/adminv1removevanityresponse.md)\>**
705
-
706
- ### Errors
707
-
708
- | Error Type | Status Code | Content Type |
709
- | ------------------------ | ------------------------ | ------------------------ |
710
- | errors.ErrorModel | 403, 404, 422, 429 | application/problem+json |
711
- | errors.ErrorModel | 500 | application/problem+json |
712
- | errors.SDKError | 4XX, 5XX | \*/\* |
713
-
714
- ## getTags
715
-
716
- ### Example Usage
717
-
718
- ```typescript
719
- import { SteamSets } from "@steamsets/client-ts";
720
-
721
- const steamSets = new SteamSets({
722
- token: "<YOUR_BEARER_TOKEN_HERE>",
723
- });
724
-
725
- async function run() {
726
- const result = await steamSets.internal.getTags();
727
-
728
- // Handle the result
729
- console.log(result);
730
- }
731
-
732
- run();
733
- ```
734
-
735
- ### Standalone function
736
-
737
- The standalone function version of this method:
738
-
739
- ```typescript
740
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
741
- import { internalGetTags } from "@steamsets/client-ts/funcs/internalGetTags.js";
742
-
743
- // Use `SteamSetsCore` for best tree-shaking performance.
744
- // You can create one instance of it to use across an application.
745
- const steamSets = new SteamSetsCore({
746
- token: "<YOUR_BEARER_TOKEN_HERE>",
747
- });
748
-
749
- async function run() {
750
- const res = await internalGetTags(steamSets);
751
-
752
- if (!res.ok) {
753
- throw res.error;
754
- }
755
-
756
- const { value: result } = res;
757
-
758
- // Handle the result
759
- console.log(result);
760
- }
761
-
762
- run();
763
- ```
764
-
765
- ### Parameters
766
-
767
- | Parameter | Type | Required | Description |
768
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
769
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
770
- | `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. |
771
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
772
-
773
- ### Response
774
-
775
- **Promise\<[operations.BadgeV1TagsResponse](../../models/operations/badgev1tagsresponse.md)\>**
776
-
777
- ### Errors
778
-
779
- | Error Type | Status Code | Content Type |
780
- | ------------------------ | ------------------------ | ------------------------ |
781
- | errors.ErrorModel | 403, 404 | application/problem+json |
782
- | errors.ErrorModel | 500 | application/problem+json |
783
- | errors.SDKError | 4XX, 5XX | \*/\* |
784
-
785
- ## badgeV1SearchSuggest
786
-
787
- ### Example Usage
788
-
789
- ```typescript
790
- import { SteamSets } from "@steamsets/client-ts";
791
-
792
- const steamSets = new SteamSets({
793
- token: "<YOUR_BEARER_TOKEN_HERE>",
794
- });
795
-
796
- async function run() {
797
- const result = await steamSets.internal.badgeV1SearchSuggest({
798
- query: "<value>",
799
- });
800
-
801
- // Handle the result
802
- console.log(result);
803
- }
804
-
805
- run();
806
- ```
807
-
808
- ### Standalone function
809
-
810
- The standalone function version of this method:
811
-
812
- ```typescript
813
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
814
- import { internalBadgeV1SearchSuggest } from "@steamsets/client-ts/funcs/internalBadgeV1SearchSuggest.js";
815
-
816
- // Use `SteamSetsCore` for best tree-shaking performance.
817
- // You can create one instance of it to use across an application.
818
- const steamSets = new SteamSetsCore({
819
- token: "<YOUR_BEARER_TOKEN_HERE>",
820
- });
821
-
822
- async function run() {
823
- const res = await internalBadgeV1SearchSuggest(steamSets, {
824
- query: "<value>",
825
- });
826
-
827
- if (!res.ok) {
828
- throw res.error;
829
- }
830
-
831
- const { value: result } = res;
832
-
833
- // Handle the result
834
- console.log(result);
835
- }
836
-
837
- run();
838
- ```
839
-
840
- ### Parameters
841
-
842
- | Parameter | Type | Required | Description |
843
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
844
- | `request` | [components.V1BadgeSearchSuggesttRequestBody](../../models/components/v1badgesearchsuggesttrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
845
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
846
- | `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. |
847
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
848
-
849
- ### Response
850
-
851
- **Promise\<[operations.BadgeV1SearchSuggestResponse](../../models/operations/badgev1searchsuggestresponse.md)\>**
852
-
853
- ### Errors
854
-
855
- | Error Type | Status Code | Content Type |
856
- | ------------------------ | ------------------------ | ------------------------ |
857
- | errors.ErrorModel | 403, 404, 422 | application/problem+json |
858
- | errors.ErrorModel | 500 | application/problem+json |
859
- | errors.SDKError | 4XX, 5XX | \*/\* |
860
-
861
- ## badgeV1TagsSuggest
862
-
863
- ### Example Usage
864
-
865
- ```typescript
866
- import { SteamSets } from "@steamsets/client-ts";
867
-
868
- const steamSets = new SteamSets({
869
- token: "<YOUR_BEARER_TOKEN_HERE>",
870
- });
871
-
872
- async function run() {
873
- const result = await steamSets.internal.badgeV1TagsSuggest({
874
- badgeId: "<id>",
875
- });
876
-
877
- // Handle the result
878
- console.log(result);
879
- }
880
-
881
- run();
882
- ```
883
-
884
- ### Standalone function
885
-
886
- The standalone function version of this method:
887
-
888
- ```typescript
889
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
890
- import { internalBadgeV1TagsSuggest } from "@steamsets/client-ts/funcs/internalBadgeV1TagsSuggest.js";
891
-
892
- // Use `SteamSetsCore` for best tree-shaking performance.
893
- // You can create one instance of it to use across an application.
894
- const steamSets = new SteamSetsCore({
895
- token: "<YOUR_BEARER_TOKEN_HERE>",
896
- });
897
-
898
- async function run() {
899
- const res = await internalBadgeV1TagsSuggest(steamSets, {
900
- badgeId: "<id>",
901
- });
902
-
903
- if (!res.ok) {
904
- throw res.error;
905
- }
906
-
907
- const { value: result } = res;
908
-
909
- // Handle the result
910
- console.log(result);
911
- }
912
-
913
- run();
914
- ```
915
-
916
- ### Parameters
917
-
918
- | Parameter | Type | Required | Description |
919
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
920
- | `request` | [components.V1BadgeTagsSuggestRequestBody](../../models/components/v1badgetagssuggestrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
921
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
922
- | `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. |
923
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
924
-
925
- ### Response
926
-
927
- **Promise\<[operations.BadgeV1TagsSuggestResponse](../../models/operations/badgev1tagssuggestresponse.md)\>**
928
-
929
- ### Errors
930
-
931
- | Error Type | Status Code | Content Type |
932
- | ------------------------ | ------------------------ | ------------------------ |
933
- | errors.ErrorModel | 403, 404, 422 | application/problem+json |
934
- | errors.ErrorModel | 500 | application/problem+json |
935
- | errors.SDKError | 4XX, 5XX | \*/\* |
936
-
937
- ## leaderboardV1GetLeaderboardAccountMeta
938
-
939
- ### Example Usage
940
-
941
- ```typescript
942
- import { SteamSets } from "@steamsets/client-ts";
943
-
944
- const steamSets = new SteamSets({
945
- token: "<YOUR_BEARER_TOKEN_HERE>",
946
- });
947
-
948
- async function run() {
949
- const result = await steamSets.internal.leaderboardV1GetLeaderboardAccountMeta({
950
- app: {
951
- appId: 730,
952
- },
953
- badge: {
954
- id: 75458,
955
- isFoil: true,
956
- },
957
- leaderboard: "xp",
958
- location: [
959
- {
960
- city: "Bad Krozingen",
961
- country: "Germany",
962
- region: "Europe",
963
- state: "Baden-Wurttemberg",
964
- },
965
- {
966
- city: "Bad Krozingen",
967
- country: "Germany",
968
- region: "Europe",
969
- state: "Baden-Wurttemberg",
970
- },
971
- {
972
- city: "Bad Krozingen",
973
- country: "Germany",
974
- region: "Europe",
975
- state: "Baden-Wurttemberg",
976
- },
977
- ],
978
- });
979
-
980
- // Handle the result
981
- console.log(result);
982
- }
983
-
984
- run();
985
- ```
986
-
987
- ### Standalone function
988
-
989
- The standalone function version of this method:
990
-
991
- ```typescript
992
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
993
- import { internalLeaderboardV1GetLeaderboardAccountMeta } from "@steamsets/client-ts/funcs/internalLeaderboardV1GetLeaderboardAccountMeta.js";
994
-
995
- // Use `SteamSetsCore` for best tree-shaking performance.
996
- // You can create one instance of it to use across an application.
997
- const steamSets = new SteamSetsCore({
998
- token: "<YOUR_BEARER_TOKEN_HERE>",
999
- });
1000
-
1001
- async function run() {
1002
- const res = await internalLeaderboardV1GetLeaderboardAccountMeta(steamSets, {
1003
- app: {
1004
- appId: 730,
1005
- },
1006
- badge: {
1007
- id: 75458,
1008
- isFoil: true,
1009
- },
1010
- leaderboard: "xp",
1011
- location: [
1012
- {
1013
- city: "Bad Krozingen",
1014
- country: "Germany",
1015
- region: "Europe",
1016
- state: "Baden-Wurttemberg",
1017
- },
1018
- {
1019
- city: "Bad Krozingen",
1020
- country: "Germany",
1021
- region: "Europe",
1022
- state: "Baden-Wurttemberg",
1023
- },
1024
- {
1025
- city: "Bad Krozingen",
1026
- country: "Germany",
1027
- region: "Europe",
1028
- state: "Baden-Wurttemberg",
1029
- },
1030
- ],
1031
- });
1032
-
1033
- if (!res.ok) {
1034
- throw res.error;
1035
- }
1036
-
1037
- const { value: result } = res;
1038
-
1039
- // Handle the result
1040
- console.log(result);
1041
- }
1042
-
1043
- run();
1044
- ```
1045
-
1046
- ### Parameters
1047
-
1048
- | Parameter | Type | Required | Description |
1049
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1050
- | `request` | [components.V1LeaderboardAccountMetaRequestBody](../../models/components/v1leaderboardaccountmetarequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
1051
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1052
- | `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. |
1053
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1054
-
1055
- ### Response
1056
-
1057
- **Promise\<[operations.LeaderboardV1GetLeaderboardAccountMetaResponse](../../models/operations/leaderboardv1getleaderboardaccountmetaresponse.md)\>**
1058
-
1059
- ### Errors
1060
-
1061
- | Error Type | Status Code | Content Type |
1062
- | ------------------------ | ------------------------ | ------------------------ |
1063
- | errors.ErrorModel | 404, 422 | application/problem+json |
1064
- | errors.ErrorModel | 500 | application/problem+json |
1065
- | errors.SDKError | 4XX, 5XX | \*/\* |
1066
-
1067
- ## check
1068
-
1069
- This endpoint checks if the service is alive.
1070
-
1071
- ### Example Usage
1072
-
1073
- ```typescript
1074
- import { SteamSets } from "@steamsets/client-ts";
1075
-
1076
- const steamSets = new SteamSets({
1077
- token: "<YOUR_BEARER_TOKEN_HERE>",
1078
- });
1079
-
1080
- async function run() {
1081
- const result = await steamSets.internal.check();
1082
-
1083
- // Handle the result
1084
- console.log(result);
1085
- }
1086
-
1087
- run();
1088
- ```
1089
-
1090
- ### Standalone function
1091
-
1092
- The standalone function version of this method:
1093
-
1094
- ```typescript
1095
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
1096
- import { internalCheck } from "@steamsets/client-ts/funcs/internalCheck.js";
1097
-
1098
- // Use `SteamSetsCore` for best tree-shaking performance.
1099
- // You can create one instance of it to use across an application.
1100
- const steamSets = new SteamSetsCore({
1101
- token: "<YOUR_BEARER_TOKEN_HERE>",
1102
- });
1103
-
1104
- async function run() {
1105
- const res = await internalCheck(steamSets);
1106
-
1107
- if (!res.ok) {
1108
- throw res.error;
1109
- }
1110
-
1111
- const { value: result } = res;
1112
-
1113
- // Handle the result
1114
- console.log(result);
1115
- }
1116
-
1117
- run();
1118
- ```
1119
-
1120
- ### Parameters
1121
-
1122
- | Parameter | Type | Required | Description |
1123
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1124
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1125
- | `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. |
1126
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1127
-
1128
- ### Response
1129
-
1130
- **Promise\<[operations.LivenessResponse](../../models/operations/livenessresponse.md)\>**
1131
-
1132
- ### Errors
1133
-
1134
- | Error Type | Status Code | Content Type |
1135
- | ------------------------ | ------------------------ | ------------------------ |
1136
- | errors.ErrorModel | 500 | application/problem+json |
1137
- | errors.SDKError | 4XX, 5XX | \*/\* |