@leonardo-ai/sdk 4.14.2 → 4.16.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
@@ -51,14 +75,14 @@ To get access to the API and fetch an API key, please sign up for [access](https
 import { Leonardo } from "@leonardo-ai/sdk";
 
 const leonardo = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
 });
 
 async function run() {
-    const result = await leonardo.initImages.deleteInitImageById("<value>");
+  const result = await leonardo.initImages.deleteInitImageById("<id>");
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -69,12 +93,8 @@ run();
 <!-- Start Available Resources and Operations [operations] -->
 ## Available Resources and Operations
 
-### [initImages](docs/sdks/initimages/README.md)
-
-* [deleteInitImageById](docs/sdks/initimages/README.md#deleteinitimagebyid) - Delete init image
-* [getInitImageById](docs/sdks/initimages/README.md#getinitimagebyid) - Get single init image
-* [uploadCanvasInitImage](docs/sdks/initimages/README.md#uploadcanvasinitimage) - Upload Canvas Editor init and mask image
-* [uploadInitImage](docs/sdks/initimages/README.md#uploadinitimage) - Upload init image
+<details open>
+<summary>Available methods</summary>
 
 ### [dataset](docs/sdks/dataset/README.md)
 
@@ -95,25 +115,13 @@ run();
 * [getGenerationById](docs/sdks/image/README.md#getgenerationbyid) - Get a Single Generation
 * [getGenerationsByUserId](docs/sdks/image/README.md#getgenerationsbyuserid) - Get generations by user ID
 
-### [realtimeCanvas](docs/sdks/realtimecanvas/README.md)
-
-* [createLCMGeneration](docs/sdks/realtimecanvas/README.md#createlcmgeneration) - Create LCM Generation
-* [performAlchemyUpscaleLCM](docs/sdks/realtimecanvas/README.md#performalchemyupscalelcm) - Perform Alchemy Upscale on a LCM image
-* [performInpaintingLCM](docs/sdks/realtimecanvas/README.md#performinpaintinglcm) - Perform inpainting on a LCM image
-* [performInstantRefine](docs/sdks/realtimecanvas/README.md#performinstantrefine) - Perform instant refine on a LCM image
-
-### [motion](docs/sdks/motion/README.md)
-
-* [createSVDMotionGeneration](docs/sdks/motion/README.md#createsvdmotiongeneration) - Create SVD Motion Generation
-
-### [texture](docs/sdks/texture/README.md)
-
-* [createTextureGeneration](docs/sdks/texture/README.md#createtexturegeneration) - Create Texture Generation
-* [deleteTextureGenerationById](docs/sdks/texture/README.md#deletetexturegenerationbyid) - Delete Texture Generation by ID
+### [initImages](docs/sdks/initimages/README.md)
 
-### [user](docs/sdks/user/README.md)
+* [deleteInitImageById](docs/sdks/initimages/README.md#deleteinitimagebyid) - Delete init image
+* [getInitImageById](docs/sdks/initimages/README.md#getinitimagebyid) - Get single init image
+* [uploadCanvasInitImage](docs/sdks/initimages/README.md#uploadcanvasinitimage) - Upload Canvas Editor init and mask image
+* [uploadInitImage](docs/sdks/initimages/README.md#uploadinitimage) - Upload init image
 
-* [getUserSelf](docs/sdks/user/README.md#getuserself) - Get user information
 
 ### [models](docs/sdks/models/README.md)
 
@@ -122,10 +130,9 @@ run();
 * [getModelById](docs/sdks/models/README.md#getmodelbyid) - Get a Single Custom Model by ID
 * [listPlatformModels](docs/sdks/models/README.md#listplatformmodels) - List Platform Models
 
-### [threeDModelAssets](docs/sdks/threedmodelassets/README.md)
+### [motion](docs/sdks/motion/README.md)
 
-* [delete3DModelById](docs/sdks/threedmodelassets/README.md#delete3dmodelbyid) - Delete 3D Model by ID
-* [uploadModelAsset](docs/sdks/threedmodelassets/README.md#uploadmodelasset) - Upload 3D Model
+* [createSVDMotionGeneration](docs/sdks/motion/README.md#createsvdmotiongeneration) - Create SVD Motion Generation
 
 ### [pricingCalculator](docs/sdks/pricingcalculator/README.md)
 
@@ -136,6 +143,27 @@ run();
 * [promptImprove](docs/sdks/prompt/README.md#promptimprove) - Improve a Prompt
 * [promptRandom](docs/sdks/prompt/README.md#promptrandom) - Generate a Random prompt
 
+### [realtimeCanvas](docs/sdks/realtimecanvas/README.md)
+
+* [createLCMGeneration](docs/sdks/realtimecanvas/README.md#createlcmgeneration) - Create LCM Generation
+* [performAlchemyUpscaleLCM](docs/sdks/realtimecanvas/README.md#performalchemyupscalelcm) - Perform Alchemy Upscale on a LCM image
+* [performInpaintingLCM](docs/sdks/realtimecanvas/README.md#performinpaintinglcm) - Perform inpainting on a LCM image
+* [performInstantRefine](docs/sdks/realtimecanvas/README.md#performinstantrefine) - Perform instant refine on a LCM image
+
+### [texture](docs/sdks/texture/README.md)
+
+* [createTextureGeneration](docs/sdks/texture/README.md#createtexturegeneration) - Create Texture Generation
+* [deleteTextureGenerationById](docs/sdks/texture/README.md#deletetexturegenerationbyid) - Delete Texture Generation by ID
+
+### [threeDModelAssets](docs/sdks/threedmodelassets/README.md)
+
+* [delete3DModelById](docs/sdks/threedmodelassets/README.md#delete3dmodelbyid) - Delete 3D Model by ID
+* [uploadModelAsset](docs/sdks/threedmodelassets/README.md#uploadmodelasset) - Upload 3D Model
+
+### [user](docs/sdks/user/README.md)
+
+* [getUserSelf](docs/sdks/user/README.md#getuserself) - Get user information
+
 ### [variation](docs/sdks/variation/README.md)
 
 * [createUniversalUpscalerJob](docs/sdks/variation/README.md#createuniversalupscalerjob) - Create using Universal Upscaler
@@ -143,6 +171,8 @@ run();
 * [createVariationUnzoom](docs/sdks/variation/README.md#createvariationunzoom) - Create unzoom
 * [createVariationUpscale](docs/sdks/variation/README.md#createvariationupscale) - Create upscale
 * [getVariationById](docs/sdks/variation/README.md#getvariationbyid) - Get variation by ID
+
+</details>
 <!-- End Available Resources and Operations [operations] -->
 
 
@@ -168,30 +198,30 @@ import { Leonardo } from "@leonardo-ai/sdk";
 import { SDKValidationError } from "@leonardo-ai/sdk/sdk/models/errors";
 
 const leonardo = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
 });
 
 async function run() {
-    let result;
-    try {
-        result = await leonardo.initImages.deleteInitImageById("<value>");
-    } catch (err) {
-        switch (true) {
-            case err instanceof SDKValidationError: {
-                // Validation errors can be pretty-printed
-                console.error(err.pretty());
-                // Raw value may also be inspected
-                console.error(err.rawValue);
-                return;
-            }
-            default: {
-                throw err;
-            }
-        }
-    }
+  let result;
+  try {
+    result = await leonardo.initImages.deleteInitImageById("<id>");
 
     // Handle the result
     console.log(result);
+  } catch (err) {
+    switch (true) {
+      case (err instanceof SDKValidationError): {
+        // Validation errors can be pretty-printed
+        console.error(err.pretty());
+        // Raw value may also be inspected
+        console.error(err.rawValue);
+        return;
+      }
+      default: {
+        throw err;
+      }
+    }
+  }
 }
 
 run();
@@ -267,15 +297,15 @@ You can override the default server globally by passing a server index to the `s
 import { Leonardo } from "@leonardo-ai/sdk";
 
 const leonardo = new Leonardo({
-    serverIdx: 0,
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+  serverIdx: 0,
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
 });
 
 async function run() {
-    const result = await leonardo.initImages.deleteInitImageById("<value>");
+  const result = await leonardo.initImages.deleteInitImageById("<id>");
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -291,15 +321,15 @@ The default server can also be overridden globally by passing a URL to the `serv
 import { Leonardo } from "@leonardo-ai/sdk";
 
 const leonardo = new Leonardo({
-    serverURL: "https://cloud.leonardo.ai/api/rest/v1",
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+  serverURL: "https://cloud.leonardo.ai/api/rest/v1",
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
 });
 
 async function run() {
-    const result = await leonardo.initImages.deleteInitImageById("<value>");
+  const result = await leonardo.initImages.deleteInitImageById("<id>");
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -325,14 +355,14 @@ To authenticate with the API the `bearerAuth` parameter must be set when initial
 import { Leonardo } from "@leonardo-ai/sdk";
 
 const leonardo = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
 });
 
 async function run() {
-    const result = await leonardo.initImages.deleteInitImageById("<value>");
+  const result = await leonardo.initImages.deleteInitImageById("<id>");
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -346,6 +376,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
 
@@ -356,25 +442,25 @@ To change the default retry strategy for a single API call, simply provide a ret
 import { Leonardo } from "@leonardo-ai/sdk";
 
 const leonardo = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
 });
 
 async function run() {
-    const result = await leonardo.initImages.deleteInitImageById("<value>", {
-        retries: {
-            strategy: "backoff",
-            backoff: {
-                initialInterval: 1,
-                maxInterval: 50,
-                exponent: 1.1,
-                maxElapsedTime: 100,
-            },
-            retryConnectionErrors: false,
-        },
-    });
+  const result = await leonardo.initImages.deleteInitImageById("<id>", {
+    retries: {
+      strategy: "backoff",
+      backoff: {
+        initialInterval: 1,
+        maxInterval: 50,
+        exponent: 1.1,
+        maxElapsedTime: 100,
+      },
+      retryConnectionErrors: false,
+    },
+  });
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -386,24 +472,24 @@ If you'd like to override the default retry strategy for all operations that sup
 import { Leonardo } from "@leonardo-ai/sdk";
 
 const leonardo = new Leonardo({
-    retryConfig: {
-        strategy: "backoff",
-        backoff: {
-            initialInterval: 1,
-            maxInterval: 50,
-            exponent: 1.1,
-            maxElapsedTime: 100,
-        },
-        retryConnectionErrors: false,
+  retryConfig: {
+    strategy: "backoff",
+    backoff: {
+      initialInterval: 1,
+      maxInterval: 50,
+      exponent: 1.1,
+      maxElapsedTime: 100,
     },
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+    retryConnectionErrors: false,
+  },
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
 });
 
 async function run() {
-    const result = await leonardo.initImages.deleteInitImageById("<value>");
+  const result = await leonardo.initImages.deleteInitImageById("<id>");
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -411,6 +497,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"}