@leonardo-ai/sdk 4.14.2 → 4.15.0

package/README.md

@@ -7,9 +7,33 @@
    <a href="https://codespaces.new/Leonardo-Interactive/leonardo-ts-sdk.git/tree/main"><img src="https://github.com/codespaces/badge.svg" /></a>
 </div>
 
+<!-- Start Summary [summary] -->
+## Summary
+
+Rest Endpoints: Leonardo.Ai API OpenAPI specification.
+<!-- End Summary [summary] -->
+
+<!-- Start Table of Contents [toc] -->
+## Table of Contents
+
+* [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] -->
+
 <!-- Start SDK Installation [installation] -->
 ## SDK Installation
 
+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.
+
 ### NPM
 
 ```bash
@@ -55,7 +79,7 @@ const leonardo = new Leonardo({
 });
 
 async function run() {
-    const result = await leonardo.initImages.deleteInitImageById("<value>");
+    const result = await leonardo.initImages.deleteInitImageById("<id>");
 
     // Handle the result
     console.log(result);
@@ -174,7 +198,7 @@ const leonardo = new Leonardo({
 async function run() {
     let result;
     try {
-        result = await leonardo.initImages.deleteInitImageById("<value>");
+        result = await leonardo.initImages.deleteInitImageById("<id>");
     } catch (err) {
         switch (true) {
             case err instanceof SDKValidationError: {
@@ -272,7 +296,7 @@ const leonardo = new Leonardo({
 });
 
 async function run() {
-    const result = await leonardo.initImages.deleteInitImageById("<value>");
+    const result = await leonardo.initImages.deleteInitImageById("<id>");
 
     // Handle the result
     console.log(result);
@@ -296,7 +320,7 @@ const leonardo = new Leonardo({
 });
 
 async function run() {
-    const result = await leonardo.initImages.deleteInitImageById("<value>");
+    const result = await leonardo.initImages.deleteInitImageById("<id>");
 
     // Handle the result
     console.log(result);
@@ -329,7 +353,7 @@ const leonardo = new Leonardo({
 });
 
 async function run() {
-    const result = await leonardo.initImages.deleteInitImageById("<value>");
+    const result = await leonardo.initImages.deleteInitImageById("<id>");
 
     // Handle the result
     console.log(result);
@@ -346,6 +370,62 @@ run();
 For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
 <!-- End Requirements [requirements] -->
 
+<!-- Start Standalone functions [standalone-funcs] -->
+## Standalone functions
+
+All the methods listed above are available as standalone functions. These
+functions are ideal for use in applications running in the browser, serverless
+runtimes or other environments where application bundle size is a primary
+concern. When using a bundler to build your application, all unused
+functionality will be either excluded from the final bundle or tree-shaken away.
+
+To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
+
+<details>
+
+<summary>Available standalone functions</summary>
+
+- [datasetCreateDataset](docs/sdks/dataset/README.md#createdataset)
+- [datasetDeleteDatasetById](docs/sdks/dataset/README.md#deletedatasetbyid)
+- [datasetGetDatasetById](docs/sdks/dataset/README.md#getdatasetbyid)
+- [datasetUploadDatasetImageFromGen](docs/sdks/dataset/README.md#uploaddatasetimagefromgen)
+- [datasetUploadDatasetImage](docs/sdks/dataset/README.md#uploaddatasetimage)
+- [elementsListElements](docs/sdks/elements/README.md#listelements)
+- [imageCreateGeneration](docs/sdks/image/README.md#creategeneration)
+- [imageDeleteGenerationById](docs/sdks/image/README.md#deletegenerationbyid)
+- [imageGetGenerationById](docs/sdks/image/README.md#getgenerationbyid)
+- [imageGetGenerationsByUserId](docs/sdks/image/README.md#getgenerationsbyuserid)
+- [initImagesDeleteInitImageById](docs/sdks/initimages/README.md#deleteinitimagebyid)
+- [initImagesGetInitImageById](docs/sdks/initimages/README.md#getinitimagebyid)
+- [initImagesUploadCanvasInitImage](docs/sdks/initimages/README.md#uploadcanvasinitimage)
+- [initImagesUploadInitImage](docs/sdks/initimages/README.md#uploadinitimage)
+- [modelsCreateModel](docs/sdks/models/README.md#createmodel)
+- [modelsDeleteModelById](docs/sdks/models/README.md#deletemodelbyid)
+- [modelsGetModelById](docs/sdks/models/README.md#getmodelbyid)
+- [modelsListPlatformModels](docs/sdks/models/README.md#listplatformmodels)
+- [motionCreateSVDMotionGeneration](docs/sdks/motion/README.md#createsvdmotiongeneration)
+- [pricingCalculatorPricingCalculator](docs/sdks/pricingcalculator/README.md#pricingcalculator)
+- [promptPromptImprove](docs/sdks/prompt/README.md#promptimprove)
+- [promptPromptRandom](docs/sdks/prompt/README.md#promptrandom)
+- [realtimeCanvasCreateLCMGeneration](docs/sdks/realtimecanvas/README.md#createlcmgeneration)
+- [realtimeCanvasPerformAlchemyUpscaleLCM](docs/sdks/realtimecanvas/README.md#performalchemyupscalelcm)
+- [realtimeCanvasPerformInpaintingLCM](docs/sdks/realtimecanvas/README.md#performinpaintinglcm)
+- [realtimeCanvasPerformInstantRefine](docs/sdks/realtimecanvas/README.md#performinstantrefine)
+- [textureCreateTextureGeneration](docs/sdks/texture/README.md#createtexturegeneration)
+- [textureDeleteTextureGenerationById](docs/sdks/texture/README.md#deletetexturegenerationbyid)
+- [threeDModelAssetsDelete3DModelById](docs/sdks/threedmodelassets/README.md#delete3dmodelbyid)
+- [threeDModelAssetsUploadModelAsset](docs/sdks/threedmodelassets/README.md#uploadmodelasset)
+- [userGetUserSelf](docs/sdks/user/README.md#getuserself)
+- [variationCreateUniversalUpscalerJob](docs/sdks/variation/README.md#createuniversalupscalerjob)
+- [variationCreateVariationNoBG](docs/sdks/variation/README.md#createvariationnobg)
+- [variationCreateVariationUnzoom](docs/sdks/variation/README.md#createvariationunzoom)
+- [variationCreateVariationUpscale](docs/sdks/variation/README.md#createvariationupscale)
+- [variationGetVariationById](docs/sdks/variation/README.md#getvariationbyid)
+
+
+</details>
+<!-- End Standalone functions [standalone-funcs] -->
+
 <!-- Start Retries [retries] -->
 ## Retries
 
@@ -360,7 +440,7 @@ const leonardo = new Leonardo({
 });
 
 async function run() {
-    const result = await leonardo.initImages.deleteInitImageById("<value>", {
+    const result = await leonardo.initImages.deleteInitImageById("<id>", {
         retries: {
             strategy: "backoff",
             backoff: {
@@ -400,7 +480,7 @@ const leonardo = new Leonardo({
 });
 
 async function run() {
-    const result = await leonardo.initImages.deleteInitImageById("<value>");
+    const result = await leonardo.initImages.deleteInitImageById("<id>");
 
     // Handle the result
     console.log(result);
@@ -411,6 +491,23 @@ run();
 ```
 <!-- End Retries [retries] -->
 
+<!-- Start Debugging [debug] -->
+## Debugging
+
+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.
+
+```typescript
+import { Leonardo } from "@leonardo-ai/sdk";
+
+const sdk = new Leonardo({ debugLogger: console });
+```
+<!-- End Debugging [debug] -->
+
 <!-- Placeholder for Future Speakeasy SDK Sections -->
 
 

package/core.d.ts

@@ -0,0 +1,10 @@
+import { ClientSDK } from "./lib/sdks.js";
+/**
+ * A minimal client to use when calling standalone SDK functions. Typically, an
+ * instance of this class would be instantiated once at the start of an
+ * application and passed around through some dependency injection mechanism  to
+ * parts of an application that need to make SDK calls.
+ */
+export declare class LeonardoCore extends ClientSDK {
+}
+//# sourceMappingURL=core.d.ts.map

package/core.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["src/core.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C;;;;;GAKG;AACH,qBAAa,YAAa,SAAQ,SAAS;CAAG"}

package/core.js

@@ -0,0 +1,17 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LeonardoCore = void 0;
+const sdks_js_1 = require("./lib/sdks.js");
+/**
+ * A minimal client to use when calling standalone SDK functions. Typically, an
+ * instance of this class would be instantiated once at the start of an
+ * application and passed around through some dependency injection mechanism  to
+ * parts of an application that need to make SDK calls.
+ */
+class LeonardoCore extends sdks_js_1.ClientSDK {
+}
+exports.LeonardoCore = LeonardoCore;
+//# sourceMappingURL=core.js.map

package/core.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.js","sourceRoot":"","sources":["src/core.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,2CAA0C;AAE1C;;;;;GAKG;AACH,MAAa,YAAa,SAAQ,mBAAS;CAAG;AAA9C,oCAA8C"}

package/docs/sdks/dataset/README.md

@@ -1,6 +1,8 @@
 # Dataset
 (*dataset*)
 
+## Overview
+
 ### Available Operations
 
 * [createDataset](#createdataset) - Create a Dataset
@@ -34,6 +36,38 @@ async function run() {
 run();
 ```
 
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { LeonardoCore } from "@leonardo-ai/sdk/core.js";
+import { datasetCreateDataset } from "@leonardo-ai/sdk/funcs/datasetCreateDataset.js";
+
+// Use `LeonardoCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const leonardo = new LeonardoCore({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const res = await datasetCreateDataset(leonardo, {
+    name: "<value>",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result)
+}
+
+run();
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
@@ -43,16 +77,17 @@ run();
 | `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.CreateDatasetResponse](../../sdk/models/operations/createdatasetresponse.md)\>**
+
 ### Errors
 
 | Error Object    | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
 | errors.SDKError | 4xx-5xx         | */*             |
 
+
 ## deleteDatasetById
 
 This endpoint deletes the specific dataset
@@ -67,7 +102,37 @@ const leonardo = new Leonardo({
 });
 
 async function run() {
-  const result = await leonardo.dataset.deleteDatasetById("<value>");
+  const result = await leonardo.dataset.deleteDatasetById("<id>");
+
+  // Handle the result
+  console.log(result)
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { LeonardoCore } from "@leonardo-ai/sdk/core.js";
+import { datasetDeleteDatasetById } from "@leonardo-ai/sdk/funcs/datasetDeleteDatasetById.js";
+
+// Use `LeonardoCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const leonardo = new LeonardoCore({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const res = await datasetDeleteDatasetById(leonardo, "<id>");
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
 
   // Handle the result
   console.log(result)
@@ -85,16 +150,17 @@ run();
 | `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.DeleteDatasetByIdResponse](../../sdk/models/operations/deletedatasetbyidresponse.md)\>**
+
 ### Errors
 
 | Error Object    | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
 | errors.SDKError | 4xx-5xx         | */*             |
 
+
 ## getDatasetById
 
 This endpoint gets the specific dataset
@@ -109,7 +175,37 @@ const leonardo = new Leonardo({
 });
 
 async function run() {
-  const result = await leonardo.dataset.getDatasetById("<value>");
+  const result = await leonardo.dataset.getDatasetById("<id>");
+
+  // Handle the result
+  console.log(result)
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { LeonardoCore } from "@leonardo-ai/sdk/core.js";
+import { datasetGetDatasetById } from "@leonardo-ai/sdk/funcs/datasetGetDatasetById.js";
+
+// Use `LeonardoCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const leonardo = new LeonardoCore({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const res = await datasetGetDatasetById(leonardo, "<id>");
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
 
   // Handle the result
   console.log(result)
@@ -127,16 +223,17 @@ run();
 | `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.GetDatasetByIdResponse](../../sdk/models/operations/getdatasetbyidresponse.md)\>**
+
 ### Errors
 
 | Error Object    | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
 | errors.SDKError | 4xx-5xx         | */*             |
 
+
 ## uploadDatasetImage
 
 This endpoint returns presigned details to upload a dataset image to S3
@@ -162,6 +259,38 @@ async function run() {
 run();
 ```
 
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { LeonardoCore } from "@leonardo-ai/sdk/core.js";
+import { datasetUploadDatasetImage } from "@leonardo-ai/sdk/funcs/datasetUploadDatasetImage.js";
+
+// Use `LeonardoCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const leonardo = new LeonardoCore({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const res = await datasetUploadDatasetImage(leonardo, {
+    extension: "gif",
+  }, "<value>");
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result)
+}
+
+run();
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
@@ -172,16 +301,17 @@ run();
 | `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.UploadDatasetImageResponse](../../sdk/models/operations/uploaddatasetimageresponse.md)\>**
+
 ### Errors
 
 | Error Object    | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
 | errors.SDKError | 4xx-5xx         | */*             |
 
+
 ## uploadDatasetImageFromGen
 
 This endpoint will upload a previously generated image to the dataset
@@ -207,6 +337,38 @@ async function run() {
 run();
 ```
 
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { LeonardoCore } from "@leonardo-ai/sdk/core.js";
+import { datasetUploadDatasetImageFromGen } from "@leonardo-ai/sdk/funcs/datasetUploadDatasetImageFromGen.js";
+
+// Use `LeonardoCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const leonardo = new LeonardoCore({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const res = await datasetUploadDatasetImageFromGen(leonardo, {
+    generatedImageId: "<value>",
+  }, "<value>");
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result)
+}
+
+run();
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
@@ -217,10 +379,10 @@ run();
 | `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.UploadDatasetImageFromGenResponse](../../sdk/models/operations/uploaddatasetimagefromgenresponse.md)\>**
+
 ### Errors
 
 | Error Object    | Status Code     | Content Type    |

package/docs/sdks/elements/README.md

@@ -1,6 +1,8 @@
 # Elements
 (*elements*)
 
+## Overview
+
 ### Available Operations
 
 * [listElements](#listelements) - List Elements
@@ -28,6 +30,36 @@ async function run() {
 run();
 ```
 
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { LeonardoCore } from "@leonardo-ai/sdk/core.js";
+import { elementsListElements } from "@leonardo-ai/sdk/funcs/elementsListElements.js";
+
+// Use `LeonardoCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const leonardo = new LeonardoCore({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const res = await elementsListElements(leonardo);
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result)
+}
+
+run();
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
@@ -36,10 +68,10 @@ run();
 | `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.ListElementsResponse](../../sdk/models/operations/listelementsresponse.md)\>**
+
 ### Errors
 
 | Error Object    | Status Code     | Content Type    |