@steamsets/client-ts 0.6.0 → 0.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. package/README.md +71 -50
  2. package/docs/sdks/account/README.md +46 -138
  3. package/docs/sdks/app/README.md +4 -12
  4. package/docs/sdks/connection/README.md +8 -24
  5. package/docs/sdks/data/README.md +16 -48
  6. package/docs/sdks/liveness/README.md +2 -6
  7. package/docs/sdks/location/README.md +2 -6
  8. package/docs/sdks/public/README.md +14 -42
  9. package/docs/sdks/session/README.md +8 -24
  10. package/docs/sdks/settings/README.md +16 -48
  11. package/funcs/accountAccountV1SessionCreate.js +1 -1
  12. package/funcs/accountAccountV1SessionCreate.js.map +1 -1
  13. package/funcs/accountAccountV1SettingsSendEmailVerification.js +1 -1
  14. package/funcs/accountAccountV1SettingsSendEmailVerification.js.map +1 -1
  15. package/funcs/sessionAccountV1SessionCreate.js +1 -1
  16. package/funcs/sessionAccountV1SessionCreate.js.map +1 -1
  17. package/funcs/settingsAccountV1SettingsSendEmailVerification.js +1 -1
  18. package/funcs/settingsAccountV1SettingsSendEmailVerification.js.map +1 -1
  19. package/lib/config.d.ts +3 -3
  20. package/lib/config.js +3 -3
  21. package/models/components/security.d.ts +2 -2
  22. package/models/components/security.d.ts.map +1 -1
  23. package/models/components/security.js +2 -2
  24. package/models/components/security.js.map +1 -1
  25. package/models/components/v1appdetail.d.ts +5 -0
  26. package/models/components/v1appdetail.d.ts.map +1 -1
  27. package/models/components/v1appdetail.js +2 -0
  28. package/models/components/v1appdetail.js.map +1 -1
  29. package/package.json +2 -2
  30. package/src/funcs/accountAccountV1SessionCreate.ts +1 -1
  31. package/src/funcs/accountAccountV1SettingsSendEmailVerification.ts +1 -1
  32. package/src/funcs/sessionAccountV1SessionCreate.ts +1 -1
  33. package/src/funcs/settingsAccountV1SettingsSendEmailVerification.ts +1 -1
  34. package/src/lib/config.ts +3 -3
  35. package/src/models/components/security.ts +4 -4
  36. package/src/models/components/v1appdetail.ts +7 -0
package/README.md CHANGED
@@ -7,16 +7,6 @@
7
7
  </a>
8
8
  </div>
9
9
 
10
-
11
- ## 🏗 **Welcome to your new SDK!** 🏗
12
-
13
- It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:
14
- - [ ] 🛠 Make your SDK feel handcrafted by [customizing it](https://www.speakeasy.com/docs/customize-sdks)
15
- - [ ] ♻️ Refine your SDK quickly by iterating locally with the [Speakeasy CLI](https://github.com/speakeasy-api/speakeasy)
16
- - [ ] 🎁 Publish your SDK to package managers by [configuring automatic publishing](https://www.speakeasy.com/docs/advanced-setup/publish-sdks)
17
- - [ ] ✨ When ready to productionize, delete this section from the README
18
-
19
- <!-- Start SDK Installation [installation] -->
20
10
  ## SDK Installation
21
11
 
22
12
  The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
@@ -47,6 +37,7 @@ yarn add @steamsets/client-ts zod
47
37
  # Note that Yarn does not install peer dependencies automatically. You will need
48
38
  # to install zod as shown above.
49
39
  ```
40
+
50
41
  <!-- End SDK Installation [installation] -->
51
42
 
52
43
  <!-- Start SDK Example Usage [usage] -->
@@ -57,9 +48,7 @@ yarn add @steamsets/client-ts zod
57
48
  ```typescript
58
49
  import { SteamSets } from "@steamsets/client-ts";
59
50
 
60
- const steamSets = new SteamSets({
61
- session: "<YOUR_BEARER_TOKEN_HERE>",
62
- });
51
+ const steamSets = new SteamSets();
63
52
 
64
53
  async function run() {
65
54
  const result = await steamSets.account.accountV1ConnectionConnect({
@@ -79,6 +68,9 @@ run();
79
68
  <!-- Start Available Resources and Operations [operations] -->
80
69
  ## Available Resources and Operations
81
70
 
71
+ <details open>
72
+ <summary>Available methods</summary>
73
+
82
74
  ### [account](docs/sdks/account/README.md)
83
75
 
84
76
  * [accountV1ConnectionConnect](docs/sdks/account/README.md#accountv1connectionconnect) - Connect a new Social Provider
@@ -105,6 +97,11 @@ run();
105
97
  * [accountV1ConnectionVerifyConnection](docs/sdks/account/README.md#accountv1connectionverifyconnection) - Verify a domain connection only atm
106
98
  * [accountV1SettingsVerfyEmail](docs/sdks/account/README.md#accountv1settingsverfyemail) - Verify the email by passing in the code the user should've gotten
107
99
 
100
+ ### [app](docs/sdks/app/README.md)
101
+
102
+ * [appV1Get](docs/sdks/app/README.md#appv1get) - Get details about an app
103
+ * [accountV1Queue](docs/sdks/app/README.md#accountv1queue) - Queue a app for processing
104
+
108
105
  ### [connection](docs/sdks/connection/README.md)
109
106
 
110
107
  * [accountV1ConnectionConnect](docs/sdks/connection/README.md#accountv1connectionconnect) - Connect a new Social Provider
@@ -112,24 +109,6 @@ run();
112
109
  * [accountV1ConnectionUpdateConnection](docs/sdks/connection/README.md#accountv1connectionupdateconnection) - Make a connection visible/invisible
113
110
  * [accountV1ConnectionVerifyConnection](docs/sdks/connection/README.md#accountv1connectionverifyconnection) - Verify a domain connection only atm
114
111
 
115
- ### [session](docs/sdks/session/README.md)
116
-
117
- * [accountV1SessionCreate](docs/sdks/session/README.md#accountv1sessioncreate) - Create a new session for non logged in users
118
- * [accountV1SessionDelete](docs/sdks/session/README.md#accountv1sessiondelete) - Deletes a session, can also be used to logout
119
- * [accountV1SessionGet](docs/sdks/session/README.md#accountv1sessionget) - Gets all session data
120
- * [accountV1SessionLogin](docs/sdks/session/README.md#accountv1sessionlogin) - Logs a user in and creates a new session
121
-
122
- ### [settings](docs/sdks/settings/README.md)
123
-
124
- * [accountV1SettingsDeleteImages](docs/sdks/settings/README.md#accountv1settingsdeleteimages) - Delete mulitple imagest
125
- * [accountV1SettingsGenerateApiKey](docs/sdks/settings/README.md#accountv1settingsgenerateapikey) - Generate a new API key for the account
126
- * [accountV1SettingsGet](docs/sdks/settings/README.md#accountv1settingsget) - Gets all settings for the account
127
- * [accountV1SettingsSendEmailVerification](docs/sdks/settings/README.md#accountv1settingssendemailverification) - Resend the verification code for an email
128
- * [accountV1SettingsUpdateImage](docs/sdks/settings/README.md#accountv1settingsupdateimage) - Update one of the uploaded images
129
- * [accountV1SettingsUpdate](docs/sdks/settings/README.md#accountv1settingsupdate) - Update settings for the logged in account
130
- * [accountV1SettingsUploadImages](docs/sdks/settings/README.md#accountv1settingsuploadimages) - Multi Upload Endpoint for images
131
- * [accountV1SettingsVerfyEmail](docs/sdks/settings/README.md#accountv1settingsverfyemail) - Verify the email by passing in the code the user should've gotten
132
-
133
112
  ### [data](docs/sdks/data/README.md)
134
113
 
135
114
  * [accountV1GetApps](docs/sdks/data/README.md#accountv1getapps) - Get Account Apps
@@ -141,6 +120,14 @@ run();
141
120
  * [accountV1GetStaff](docs/sdks/data/README.md#accountv1getstaff) - Get Staff Members and their info
142
121
  * [accountV1Queue](docs/sdks/data/README.md#accountv1queue) - Queue a app for processing
143
122
 
123
+ ### [liveness](docs/sdks/liveness/README.md)
124
+
125
+ * [liveness](docs/sdks/liveness/README.md#liveness) - Liveness check
126
+
127
+ ### [location](docs/sdks/location/README.md)
128
+
129
+ * [location](docs/sdks/location/README.md#location) - Location List
130
+
144
131
  ### [public](docs/sdks/public/README.md)
145
132
 
146
133
  * [accountV1GetApps](docs/sdks/public/README.md#accountv1getapps) - Get Account Apps
@@ -151,18 +138,26 @@ run();
151
138
  * [accountV1GetLeaderboardHistory](docs/sdks/public/README.md#accountv1getleaderboardhistory) - Get Account Leaderboard History
152
139
  * [accountV1Queue](docs/sdks/public/README.md#accountv1queue) - Queue a app for processing
153
140
 
154
- ### [app](docs/sdks/app/README.md)
141
+ ### [session](docs/sdks/session/README.md)
155
142
 
156
- * [appV1Get](docs/sdks/app/README.md#appv1get) - Get details about an app
157
- * [accountV1Queue](docs/sdks/app/README.md#accountv1queue) - Queue a app for processing
143
+ * [accountV1SessionCreate](docs/sdks/session/README.md#accountv1sessioncreate) - Create a new session for non logged in users
144
+ * [accountV1SessionDelete](docs/sdks/session/README.md#accountv1sessiondelete) - Deletes a session, can also be used to logout
145
+ * [accountV1SessionGet](docs/sdks/session/README.md#accountv1sessionget) - Gets all session data
146
+ * [accountV1SessionLogin](docs/sdks/session/README.md#accountv1sessionlogin) - Logs a user in and creates a new session
158
147
 
159
- ### [liveness](docs/sdks/liveness/README.md)
148
+ ### [settings](docs/sdks/settings/README.md)
160
149
 
161
- * [liveness](docs/sdks/liveness/README.md#liveness) - Liveness check
150
+ * [accountV1SettingsDeleteImages](docs/sdks/settings/README.md#accountv1settingsdeleteimages) - Delete mulitple imagest
151
+ * [accountV1SettingsGenerateApiKey](docs/sdks/settings/README.md#accountv1settingsgenerateapikey) - Generate a new API key for the account
152
+ * [accountV1SettingsGet](docs/sdks/settings/README.md#accountv1settingsget) - Gets all settings for the account
153
+ * [accountV1SettingsSendEmailVerification](docs/sdks/settings/README.md#accountv1settingssendemailverification) - Resend the verification code for an email
154
+ * [accountV1SettingsUpdateImage](docs/sdks/settings/README.md#accountv1settingsupdateimage) - Update one of the uploaded images
155
+ * [accountV1SettingsUpdate](docs/sdks/settings/README.md#accountv1settingsupdate) - Update settings for the logged in account
156
+ * [accountV1SettingsUploadImages](docs/sdks/settings/README.md#accountv1settingsuploadimages) - Multi Upload Endpoint for images
157
+ * [accountV1SettingsVerfyEmail](docs/sdks/settings/README.md#accountv1settingsverfyemail) - Verify the email by passing in the code the user should've gotten
162
158
 
163
- ### [location](docs/sdks/location/README.md)
164
159
 
165
- * [location](docs/sdks/location/README.md#location) - Location List
160
+ </details>
166
161
  <!-- End Available Resources and Operations [operations] -->
167
162
 
168
163
  <!-- Start Retries [retries] -->
@@ -174,9 +169,7 @@ To change the default retry strategy for a single API call, simply provide a ret
174
169
  ```typescript
175
170
  import { SteamSets } from "@steamsets/client-ts";
176
171
 
177
- const steamSets = new SteamSets({
178
- session: "<YOUR_BEARER_TOKEN_HERE>",
179
- });
172
+ const steamSets = new SteamSets();
180
173
 
181
174
  async function run() {
182
175
  const result = await steamSets.account.accountV1ConnectionConnect({
@@ -218,7 +211,6 @@ const steamSets = new SteamSets({
218
211
  },
219
212
  retryConnectionErrors: false,
220
213
  },
221
- session: "<YOUR_BEARER_TOKEN_HERE>",
222
214
  });
223
215
 
224
216
  async function run() {
@@ -256,9 +248,7 @@ import {
256
248
  SDKValidationError,
257
249
  } from "@steamsets/client-ts/models/errors";
258
250
 
259
- const steamSets = new SteamSets({
260
- session: "<YOUR_BEARER_TOKEN_HERE>",
261
- });
251
+ const steamSets = new SteamSets();
262
252
 
263
253
  async function run() {
264
254
  let result;
@@ -313,7 +303,6 @@ import { SteamSets } from "@steamsets/client-ts";
313
303
 
314
304
  const steamSets = new SteamSets({
315
305
  serverIdx: 1,
316
- session: "<YOUR_BEARER_TOKEN_HERE>",
317
306
  });
318
307
 
319
308
  async function run() {
@@ -340,7 +329,6 @@ import { SteamSets } from "@steamsets/client-ts";
340
329
 
341
330
  const steamSets = new SteamSets({
342
331
  serverURL: "https://api.steamsets.com",
343
- session: "<YOUR_BEARER_TOKEN_HERE>",
344
332
  });
345
333
 
346
334
  async function run() {
@@ -442,11 +430,44 @@ run();
442
430
  <!-- End Authentication [security] -->
443
431
 
444
432
  <!-- Start Special Types [types] -->
445
- ## Special Types
446
433
 
434
+ ## Special Types
447
435
 
448
436
  <!-- End Special Types [types] -->
449
437
 
438
+ <!-- Start SDK Installation [installation] -->
439
+ ## SDK Installation
440
+
441
+ The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
442
+
443
+ ### NPM
444
+
445
+ ```bash
446
+ npm add @steamsets/client-ts
447
+ ```
448
+
449
+ ### PNPM
450
+
451
+ ```bash
452
+ pnpm add @steamsets/client-ts
453
+ ```
454
+
455
+ ### Bun
456
+
457
+ ```bash
458
+ bun add @steamsets/client-ts
459
+ ```
460
+
461
+ ### Yarn
462
+
463
+ ```bash
464
+ yarn add @steamsets/client-ts zod
465
+
466
+ # Note that Yarn does not install peer dependencies automatically. You will need
467
+ # to install zod as shown above.
468
+ ```
469
+ <!-- End SDK Installation [installation] -->
470
+
450
471
  <!-- Start Requirements [requirements] -->
451
472
  ## Requirements
452
473
 
@@ -582,7 +603,7 @@ looking for the latest version.
582
603
 
583
604
  ## Contributions
584
605
 
585
- While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation.
586
- We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
606
+ While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation.
607
+ We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
587
608
 
588
609
  ### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=<no value>&utm_campaign=go)