@steamsets/client-ts 0.13.7 → 0.14.0

package/FUNCTIONS.md

@@ -0,0 +1,107 @@
+# Standalone Functions
+
+> [!NOTE]
+> This section is useful if you are using a bundler and targetting browsers and
+> runtimes where the size of an application affects performance and load times. 
+
+Every method in this SDK is also available as a standalone function. This
+alternative API is suitable when targetting the browser or serverless runtimes
+and using a bundler to build your application since all unused functionality
+will be tree-shaken away. This includes code for unused methods, Zod schemas,
+encoding helpers and response handlers. The result is dramatically smaller
+impact on the application's final bundle size which grows very slowly as you use
+more and more functionality from this SDK.
+
+Calling methods through the main SDK class remains a valid and generally more
+more ergonomic option. Standalone functions represent an optimisation for a
+specific category of applications.
+
+## Example
+
+```typescript
+import { SteamSetsCore } from "@steamsets/client-ts/core.js";
+import { badgeAccountV1BookmarkBadge } from "@steamsets/client-ts/funcs/badgeAccountV1BookmarkBadge.js";
+import { SDKValidationError } from "@steamsets/client-ts/models/errors/sdkvalidationerror.js";
+
+// Use `SteamSetsCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const steamSets = new SteamSetsCore({
+  token: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const res = await badgeAccountV1BookmarkBadge(steamSets, {
+    badgeId: "bdg_123",
+    bookmark: true,
+  });
+
+  switch (true) {
+    case res.ok:
+      // The success case will be handled outside of the switch block
+      break;
+    case res.error instanceof SDKValidationError:
+      // Pretty-print validation errors.
+      return console.log(res.error.pretty());
+    case res.error instanceof Error:
+      return console.log(res.error);
+    default:
+      // TypeScript's type checking will fail on the following line if the above
+      // cases were not exhaustive.
+      res.error satisfies never;
+      throw new Error("Assertion failed: expected error checks to be exhaustive: " + res.error);
+  }
+
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+## Result types
+
+Standalone functions differ from SDK methods in that they return a
+`Result<Value, Error>` type to capture _known errors_ and document them using
+the type system. By avoiding throwing errors, application code maintains clear
+control flow and error-handling become part of the regular flow of application
+code.
+
+> We use the term "known errors" because standalone functions, and JavaScript
+> code in general, can still throw unexpected errors such as `TypeError`s,
+> `RangeError`s and `DOMException`s. Exhaustively catching all errors may be
+> something this SDK addresses in the future. Nevertheless, there is still a lot
+> of benefit from capturing most errors and turning them into values.
+
+The second reason for this style of programming is because these functions will
+typically be used in front-end applications where exception throwing is
+sometimes discouraged or considered unidiomatic. React and similar ecosystems
+and libraries tend to promote this style of programming so that components
+render useful content under all states (loading, success, error and so on).
+
+The general pattern when calling standalone functions looks like this:
+
+```typescript
+import { Core } from "<sdk-package-name>";
+import { fetchSomething } from "<sdk-package-name>/funcs/fetchSomething.js";
+
+const client = new Core();
+
+async function run() {
+  const result = await fetchSomething(client, { id: "123" });
+  if (!result.ok) {
+    // You can throw the error or handle it. It's your choice now.
+    throw result.error;
+  }
+
+  console.log(result.value);
+}
+
+run();
+```
+
+Notably, `result.error` above will have an explicit type compared to a try-catch
+variation where the error in the catch block can only be of type `unknown` (or
+`any` depending on your TypeScript settings).

package/README.md

@@ -81,11 +81,12 @@ run();
 * [getBadges](docs/sdks/account/README.md#getbadges)
 * [getDataPoints](docs/sdks/account/README.md#getdatapoints)
 * [getFriends](docs/sdks/account/README.md#getfriends)
+* [accountV1ImagesGet](docs/sdks/account/README.md#accountv1imagesget)
 * [getInfo](docs/sdks/account/README.md#getinfo)
 * [getLeaderboardHistory](docs/sdks/account/README.md#getleaderboardhistory)
 * [getStaff](docs/sdks/account/README.md#getstaff)
 * [sendEmailVerification](docs/sdks/account/README.md#sendemailverification)
-* [updateImage](docs/sdks/account/README.md#updateimage)
+* [accountV1ImagesUpdate](docs/sdks/account/README.md#accountv1imagesupdate)
 * [uploadImages](docs/sdks/account/README.md#uploadimages)
 * [verifyEmail](docs/sdks/account/README.md#verifyemail)
 
@@ -137,6 +138,13 @@ run();
 * [deleteDeveloperApp](docs/sdks/developer/README.md#deletedeveloperapp)
 * [updateApp](docs/sdks/developer/README.md#updateapp)
 
+### [images](docs/sdks/images/README.md)
+
+* [deleteImages](docs/sdks/images/README.md#deleteimages)
+* [accountV1ImagesGet](docs/sdks/images/README.md#accountv1imagesget)
+* [accountV1ImagesUpdate](docs/sdks/images/README.md#accountv1imagesupdate)
+* [uploadImages](docs/sdks/images/README.md#uploadimages)
+
 ### [leaderboard](docs/sdks/leaderboard/README.md)
 
 * [getAccount](docs/sdks/leaderboard/README.md#getaccount)
@@ -177,12 +185,9 @@ run();
 
 ### [settings](docs/sdks/settings/README.md)
 
-* [deleteImages](docs/sdks/settings/README.md#deleteimages)
 * [get](docs/sdks/settings/README.md#get)
 * [sendEmailVerification](docs/sdks/settings/README.md#sendemailverification)
-* [updateImage](docs/sdks/settings/README.md#updateimage)
 * [update](docs/sdks/settings/README.md#update)
-* [uploadImages](docs/sdks/settings/README.md#uploadimages)
 * [verifyEmail](docs/sdks/settings/README.md#verifyemail)
 
 
@@ -537,6 +542,8 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 <summary>Available standalone functions</summary>
 
 - [`accountAccountV1GetBadgeBookmarks`](docs/sdks/account/README.md#accountv1getbadgebookmarks)
+- [`accountAccountV1ImagesGet`](docs/sdks/account/README.md#accountv1imagesget)
+- [`accountAccountV1ImagesUpdate`](docs/sdks/account/README.md#accountv1imagesupdate)
 - [`accountDeleteImages`](docs/sdks/account/README.md#deleteimages)
 - [`accountGetApps`](docs/sdks/account/README.md#getapps)
 - [`accountGetBadges`](docs/sdks/account/README.md#getbadges)
@@ -547,7 +554,6 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`accountGetStaff`](docs/sdks/account/README.md#getstaff)
 - [`accountSendEmailVerification`](docs/sdks/account/README.md#sendemailverification)
 - [`accountsQueue`](docs/sdks/accounts/README.md#queue)
-- [`accountUpdateImage`](docs/sdks/account/README.md#updateimage)
 - [`accountUploadImages`](docs/sdks/account/README.md#uploadimages)
 - [`accountVerifyEmail`](docs/sdks/account/README.md#verifyemail)
 - [`adminAdminV1GetEvents`](docs/sdks/admin/README.md#adminv1getevents)
@@ -573,6 +579,10 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`developerCreateDeveloperApp`](docs/sdks/developer/README.md#createdeveloperapp)
 - [`developerDeleteDeveloperApp`](docs/sdks/developer/README.md#deletedeveloperapp)
 - [`developerUpdateApp`](docs/sdks/developer/README.md#updateapp)
+- [`imagesAccountV1ImagesGet`](docs/sdks/images/README.md#accountv1imagesget)
+- [`imagesAccountV1ImagesUpdate`](docs/sdks/images/README.md#accountv1imagesupdate)
+- [`imagesDeleteImages`](docs/sdks/images/README.md#deleteimages)
+- [`imagesUploadImages`](docs/sdks/images/README.md#uploadimages)
 - [`leaderboardGetAccount`](docs/sdks/leaderboard/README.md#getaccount)
 - [`leaderboardGetBadges`](docs/sdks/leaderboard/README.md#getbadges)
 - [`leaderboardGetGroup`](docs/sdks/leaderboard/README.md#getgroup)
@@ -590,12 +600,9 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`sessionLogin`](docs/sdks/session/README.md#login)
 - [`sessionsDelete`](docs/sdks/sessions/README.md#delete)
 - [`sessionsGet`](docs/sdks/sessions/README.md#get)
-- [`settingsDeleteImages`](docs/sdks/settings/README.md#deleteimages)
 - [`settingsGet`](docs/sdks/settings/README.md#get)
 - [`settingsSendEmailVerification`](docs/sdks/settings/README.md#sendemailverification)
 - [`settingsUpdate`](docs/sdks/settings/README.md#update)
-- [`settingsUpdateImage`](docs/sdks/settings/README.md#updateimage)
-- [`settingsUploadImages`](docs/sdks/settings/README.md#uploadimages)
 - [`settingsVerifyEmail`](docs/sdks/settings/README.md#verifyemail)
 
 </details>
@@ -626,18 +633,25 @@ const sdk = new SteamSets({ debugLogger: console });
 
 <!-- Start Table of Contents [toc] -->
 ## Table of Contents
+<!-- $toc-max-depth=2 -->
+* [openapi](#openapi)
+  * [SDK Installation](#sdk-installation)
+  * [SDK Example Usage](#sdk-example-usage)
+  * [Available Resources and Operations](#available-resources-and-operations)
+  * [Retries](#retries)
+  * [Error Handling](#error-handling)
+  * [Server Selection](#server-selection)
+  * [Custom HTTP Client](#custom-http-client)
+  * [Authentication](#authentication)
+  * [Special Types](#special-types)
+  * [SDK Installation](#sdk-installation-1)
+  * [Requirements](#requirements)
+  * [Standalone functions](#standalone-functions)
+  * [Debugging](#debugging)
+* [Development](#development)
+  * [Maturity](#maturity)
+  * [Contributions](#contributions)
 
-* [SDK Installation](#sdk-installation)
-* [Requirements](#requirements)
-* [SDK Example Usage](#sdk-example-usage)
-* [Available Resources and Operations](#available-resources-and-operations)
-* [Standalone functions](#standalone-functions)
-* [Retries](#retries)
-* [Error Handling](#error-handling)
-* [Server Selection](#server-selection)
-* [Custom HTTP Client](#custom-http-client)
-* [Authentication](#authentication)
-* [Debugging](#debugging)
 <!-- End Table of Contents [toc] -->
 
 <!-- Placeholder for Future Speakeasy SDK Sections -->

package/RUNTIMES.md

@@ -0,0 +1,22 @@
+# Supported JavaScript runtimes
+
+This SDK is intended to be used in JavaScript runtimes that support the following features:
+
+* [Web Fetch API][web-fetch]
+* [Web Streams API][web-streams] and in particular `ReadableStream`
+* [Async iterables][async-iter] using `Symbol.asyncIterator`
+
+[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
+[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
+[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols
+
+Runtime environments that are explicitly supported are:
+
+- Evergreen browsers which include: Chrome, Safari, Edge, Firefox
+- Node.js active and maintenance LTS releases
+  - Currently, this is v18 and v20
+- Bun v1 and above
+- Deno v1.39
+  - Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
+
+[deno-file-streaming]: https://github.com/denoland/deno/issues/11018

package/docs/sdks/account/README.md

@@ -13,11 +13,12 @@ Account related operations
 * [getBadges](#getbadges)
 * [getDataPoints](#getdatapoints)
 * [getFriends](#getfriends)
+* [accountV1ImagesGet](#accountv1imagesget)
 * [getInfo](#getinfo)
 * [getLeaderboardHistory](#getleaderboardhistory)
 * [getStaff](#getstaff)
 * [sendEmailVerification](#sendemailverification)
-* [updateImage](#updateimage)
+* [accountV1ImagesUpdate](#accountv1imagesupdate)
 * [uploadImages](#uploadimages)
 * [verifyEmail](#verifyemail)
 
@@ -36,6 +37,7 @@ async function run() {
   const result = await steamSets.account.deleteImages({
     imageIds: [
       "<value>",
+      "<value>",
     ],
   });
 
@@ -64,6 +66,7 @@ async function run() {
   const res = await accountDeleteImages(steamSets, {
     imageIds: [
       "<value>",
+      "<value>",
     ],
   });
 
@@ -91,7 +94,7 @@ run();
 
 ### Response
 
-**Promise\<[operations.AccountV1SettingsDeleteImagesResponse](../../models/operations/accountv1settingsdeleteimagesresponse.md)\>**
+**Promise\<[operations.AccountV1ImagesDeleteResponse](../../models/operations/accountv1imagesdeleteresponse.md)\>**
 
 ### Errors
 
@@ -455,6 +458,76 @@ run();
 | errors.ErrorModel        | 400, 403, 404, 422, 500  | application/problem+json |
 | errors.SDKError          | 4XX, 5XX                 | \*/\*                    |
 
+## accountV1ImagesGet
+
+### Example Usage
+
+```typescript
+import { SteamSets } from "@steamsets/client-ts";
+
+const steamSets = new SteamSets({
+  token: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const result = await steamSets.account.accountV1ImagesGet();
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { SteamSetsCore } from "@steamsets/client-ts/core.js";
+import { accountAccountV1ImagesGet } from "@steamsets/client-ts/funcs/accountAccountV1ImagesGet.js";
+
+// Use `SteamSetsCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const steamSets = new SteamSetsCore({
+  token: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const res = await accountAccountV1ImagesGet(steamSets);
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `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. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.AccountV1ImagesGetResponse](../../models/operations/accountv1imagesgetresponse.md)\>**
+
+### Errors
+
+| Error Type               | Status Code              | Content Type             |
+| ------------------------ | ------------------------ | ------------------------ |
+| errors.ErrorModel        | 500                      | application/problem+json |
+| errors.SDKError          | 4XX, 5XX                 | \*/\*                    |
+
 ## getInfo
 
 ### Example Usage
@@ -738,7 +811,7 @@ run();
 | errors.ErrorModel        | 404, 422, 429, 500       | application/problem+json |
 | errors.SDKError          | 4XX, 5XX                 | \*/\*                    |
 
-## updateImage
+## accountV1ImagesUpdate
 
 ### Example Usage
 
@@ -750,9 +823,13 @@ const steamSets = new SteamSets({
 });
 
 async function run() {
-  const result = await steamSets.account.updateImage({
-    active: true,
-    imageId: "123456",
+  const result = await steamSets.account.accountV1ImagesUpdate({
+    images: [
+      {
+        active: true,
+        imageId: "123456",
+      },
+    ],
   });
 
   // Handle the result
@@ -768,7 +845,7 @@ The standalone function version of this method:
 
 ```typescript
 import { SteamSetsCore } from "@steamsets/client-ts/core.js";
-import { accountUpdateImage } from "@steamsets/client-ts/funcs/accountUpdateImage.js";
+import { accountAccountV1ImagesUpdate } from "@steamsets/client-ts/funcs/accountAccountV1ImagesUpdate.js";
 
 // Use `SteamSetsCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -777,9 +854,13 @@ const steamSets = new SteamSetsCore({
 });
 
 async function run() {
-  const res = await accountUpdateImage(steamSets, {
-    active: true,
-    imageId: "123456",
+  const res = await accountAccountV1ImagesUpdate(steamSets, {
+    images: [
+      {
+        active: true,
+        imageId: "123456",
+      },
+    ],
   });
 
   if (!res.ok) {
@@ -806,7 +887,7 @@ run();
 
 ### Response
 
-**Promise\<[operations.AccountV1SettingsUpdateImageResponse](../../models/operations/accountv1settingsupdateimageresponse.md)\>**
+**Promise\<[operations.AccountV1ImagesUpdateResponse](../../models/operations/accountv1imagesupdateresponse.md)\>**
 
 ### Errors
 
@@ -891,7 +972,7 @@ run();
 
 ### Response
 
-**Promise\<[operations.AccountV1SettingsUploadImagesResponse](../../models/operations/accountv1settingsuploadimagesresponse.md)\>**
+**Promise\<[operations.AccountV1ImagesUploadResponse](../../models/operations/accountv1imagesuploadresponse.md)\>**
 
 ### Errors