npm - @steamsets/client-ts - Versions diffs - 0.2.0 → 0.3.0 - Mend

@steamsets/client-ts 0.2.0 → 0.3.0

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 (207) hide show

package/README.md CHANGED Viewed

@@ -56,7 +56,7 @@ yarn add @steamsets/client-ts zod
 import { SteamSets } from "@steamsets/client-ts";
 const steamSets = new SteamSets({
-    session: "<YOUR_API_KEY_HERE>",
+    session: "<YOUR_BEARER_TOKEN_HERE>",
 });
 async function run() {
@@ -81,15 +81,20 @@ run();
 * [accountV1ConnectionConnect](docs/sdks/account/README.md#accountv1connectionconnect) - Connect a new Social Provider
 * [accountV1ConnectionDeleteConnection](docs/sdks/account/README.md#accountv1connectiondeleteconnection) - Remove a connection
+* [accountV1SettingsDeleteImages](docs/sdks/account/README.md#accountv1settingsdeleteimages) - Delete mulitple imagest
 * [accountV1SessionDelete](docs/sdks/account/README.md#accountv1sessiondelete) - Deletes a session, can also be used to logout
+* [accountV1SettingsGenerateApiKey](docs/sdks/account/README.md#accountv1settingsgenerateapikey) - Generate a new API key for the account
 * [accountV1GetApps](docs/sdks/account/README.md#accountv1getapps) - Get Account Apps
 * [accountV1GetBadges](docs/sdks/account/README.md#accountv1getbadges) - Get Account Badges
 * [accountV1SessionGet](docs/sdks/account/README.md#accountv1sessionget) - Gets all session data
 * [accountV1SettingsGet](docs/sdks/account/README.md#accountv1settingsget) - Gets all settings for the account
 * [accountV1SessionLogin](docs/sdks/account/README.md#accountv1sessionlogin) - Logs a user in and creates a new session
+* [accountV1SettingsSendEmailVerification](docs/sdks/account/README.md#accountv1settingssendemailverification) - Resend the verification code for an email
 * [accountV1ConnectionUpdateConnection](docs/sdks/account/README.md#accountv1connectionupdateconnection) - Make a connection visible/invisible
+* [accountV1SettingsUpdateImage](docs/sdks/account/README.md#accountv1settingsupdateimage) - Update one of the uploaded images
 * [accountV1SettingsUpdate](docs/sdks/account/README.md#accountv1settingsupdate) - Update settings for the logged in account
 * [accountV1ConnectionVerifyConnection](docs/sdks/account/README.md#accountv1connectionverifyconnection) - Verify a domain connection only atm
+* [accountV1SettingsVerfyEmail](docs/sdks/account/README.md#accountv1settingsverfyemail) - Verify the email by passing in the code the user should've gotten
 ### [connection](docs/sdks/connection/README.md)
@@ -98,17 +103,22 @@ run();
 * [accountV1ConnectionUpdateConnection](docs/sdks/connection/README.md#accountv1connectionupdateconnection) - Make a connection visible/invisible
 * [accountV1ConnectionVerifyConnection](docs/sdks/connection/README.md#accountv1connectionverifyconnection) - Verify a domain connection only atm
+### [settings](docs/sdks/settings/README.md)
+* [accountV1SettingsDeleteImages](docs/sdks/settings/README.md#accountv1settingsdeleteimages) - Delete mulitple imagest
+* [accountV1SettingsGenerateApiKey](docs/sdks/settings/README.md#accountv1settingsgenerateapikey) - Generate a new API key for the account
+* [accountV1SettingsGet](docs/sdks/settings/README.md#accountv1settingsget) - Gets all settings for the account
+* [accountV1SettingsSendEmailVerification](docs/sdks/settings/README.md#accountv1settingssendemailverification) - Resend the verification code for an email
+* [accountV1SettingsUpdateImage](docs/sdks/settings/README.md#accountv1settingsupdateimage) - Update one of the uploaded images
+* [accountV1SettingsUpdate](docs/sdks/settings/README.md#accountv1settingsupdate) - Update settings for the logged in account
+* [accountV1SettingsVerfyEmail](docs/sdks/settings/README.md#accountv1settingsverfyemail) - Verify the email by passing in the code the user should've gotten
 ### [session](docs/sdks/session/README.md)
 * [accountV1SessionDelete](docs/sdks/session/README.md#accountv1sessiondelete) - Deletes a session, can also be used to logout
 * [accountV1SessionGet](docs/sdks/session/README.md#accountv1sessionget) - Gets all session data
 * [accountV1SessionLogin](docs/sdks/session/README.md#accountv1sessionlogin) - Logs a user in and creates a new session
-### [settings](docs/sdks/settings/README.md)
-* [accountV1SettingsGet](docs/sdks/settings/README.md#accountv1settingsget) - Gets all settings for the account
-* [accountV1SettingsUpdate](docs/sdks/settings/README.md#accountv1settingsupdate) - Update settings for the logged in account
 ### [liveness](docs/sdks/liveness/README.md)
 * [liveness](docs/sdks/liveness/README.md#liveness) - Liveness check
@@ -124,7 +134,7 @@ To change the default retry strategy for a single API call, simply provide a ret
 import { SteamSets } from "@steamsets/client-ts";
 const steamSets = new SteamSets({
-    session: "<YOUR_API_KEY_HERE>",
+    session: "<YOUR_BEARER_TOKEN_HERE>",
 });
 async function run() {
@@ -170,7 +180,7 @@ const steamSets = new SteamSets({
         },
         retryConnectionErrors: false,
     },
-    session: "<YOUR_API_KEY_HERE>",
+    session: "<YOUR_BEARER_TOKEN_HERE>",
 });
 async function run() {
@@ -206,7 +216,7 @@ import { SteamSets } from "@steamsets/client-ts";
 import { SDKValidationError } from "@steamsets/client-ts/models/errors";
 const steamSets = new SteamSets({
-    session: "<YOUR_API_KEY_HERE>",
+    session: "<YOUR_BEARER_TOKEN_HERE>",
 });
 async function run() {
@@ -253,14 +263,15 @@ You can override the default server globally by passing a server index to the `s
 | # | Server | Variables |
 | - | ------ | --------- |
-| 0 | `https://api.steamsets.com` | None |
+| 0 | `http://localhost:8080` | None |
+| 1 | `https://api.steamsets.com` | None |
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 const steamSets = new SteamSets({
-    serverIdx: 0,
-    session: "<YOUR_API_KEY_HERE>",
+    serverIdx: 1,
+    session: "<YOUR_BEARER_TOKEN_HERE>",
 });
 async function run() {
@@ -286,8 +297,8 @@ The default server can also be overridden globally by passing a URL to the `serv
 import { SteamSets } from "@steamsets/client-ts";
 const steamSets = new SteamSets({
-    serverURL: "https://api.steamsets.com",
-    session: "<YOUR_API_KEY_HERE>",
+    serverURL: "http://localhost:8080",
+    session: "<YOUR_BEARER_TOKEN_HERE>",
 });
 async function run() {
@@ -361,16 +372,16 @@ const sdk = new SteamSets({ httpClient });
 This SDK supports the following security scheme globally:
-| Name      | Type      | Scheme    |
-| --------- | --------- | --------- |
-| `session` | apiKey    | API key   |
+| Name        | Type        | Scheme      |
+| ----------- | ----------- | ----------- |
+| `session`   | http        | HTTP Bearer |
 To authenticate with the API the `session` parameter must be set when initializing the SDK client instance. For example:
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 const steamSets = new SteamSets({
-    session: "<YOUR_API_KEY_HERE>",
+    session: "<YOUR_BEARER_TOKEN_HERE>",
 });
 async function run() {
@@ -424,8 +435,13 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [accountAccountV1SessionDelete](docs/sdks/account/README.md#accountv1sessiondelete)
 - [accountAccountV1SessionGet](docs/sdks/account/README.md#accountv1sessionget)
 - [accountAccountV1SessionLogin](docs/sdks/account/README.md#accountv1sessionlogin)
+- [accountAccountV1SettingsDeleteImages](docs/sdks/account/README.md#accountv1settingsdeleteimages)
+- [accountAccountV1SettingsGenerateApiKey](docs/sdks/account/README.md#accountv1settingsgenerateapikey)
 - [accountAccountV1SettingsGet](docs/sdks/account/README.md#accountv1settingsget)
+- [accountAccountV1SettingsSendEmailVerification](docs/sdks/account/README.md#accountv1settingssendemailverification)
+- [accountAccountV1SettingsUpdateImage](docs/sdks/account/README.md#accountv1settingsupdateimage)
 - [accountAccountV1SettingsUpdate](docs/sdks/account/README.md#accountv1settingsupdate)
+- [accountAccountV1SettingsVerfyEmail](docs/sdks/account/README.md#accountv1settingsverfyemail)
 - [connectionAccountV1ConnectionConnect](docs/sdks/connection/README.md#accountv1connectionconnect)
 - [connectionAccountV1ConnectionDeleteConnection](docs/sdks/connection/README.md#accountv1connectiondeleteconnection)
 - [connectionAccountV1ConnectionUpdateConnection](docs/sdks/connection/README.md#accountv1connectionupdateconnection)
@@ -434,8 +450,13 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [sessionAccountV1SessionDelete](docs/sdks/session/README.md#accountv1sessiondelete)
 - [sessionAccountV1SessionGet](docs/sdks/session/README.md#accountv1sessionget)
 - [sessionAccountV1SessionLogin](docs/sdks/session/README.md#accountv1sessionlogin)
+- [settingsAccountV1SettingsDeleteImages](docs/sdks/settings/README.md#accountv1settingsdeleteimages)
+- [settingsAccountV1SettingsGenerateApiKey](docs/sdks/settings/README.md#accountv1settingsgenerateapikey)
 - [settingsAccountV1SettingsGet](docs/sdks/settings/README.md#accountv1settingsget)
+- [settingsAccountV1SettingsSendEmailVerification](docs/sdks/settings/README.md#accountv1settingssendemailverification)
+- [settingsAccountV1SettingsUpdateImage](docs/sdks/settings/README.md#accountv1settingsupdateimage)
 - [settingsAccountV1SettingsUpdate](docs/sdks/settings/README.md#accountv1settingsupdate)
+- [settingsAccountV1SettingsVerfyEmail](docs/sdks/settings/README.md#accountv1settingsverfyemail)
 </details>
@@ -444,7 +465,9 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 <!-- Start Debugging [debug] -->
 ## Debugging
-To log HTTP requests and responses, you can pass a logger that matches `console`'s interface as an SDK option.
+You can setup your SDK to emit debug logs for SDK requests and responses.
+You can pass a logger that matches `console`'s interface as an SDK option.
 > [!WARNING]
 > Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.