@leonardo-ai/sdk 4.6.0 → 4.14.1

package/README.md

@@ -16,10 +16,25 @@
 npm add @leonardo-ai/sdk
 ```
 
+### PNPM
+
+```bash
+pnpm add @leonardo-ai/sdk
+```
+
+### Bun
+
+```bash
+bun add @leonardo-ai/sdk
+```
+
 ### Yarn
 
 ```bash
-yarn add @leonardo-ai/sdk
+yarn add @leonardo-ai/sdk zod
+
+# Note that Yarn does not install peer dependencies automatically. You will need
+# to install zod as shown above.
 ```
 <!-- End SDK Installation [installation] -->
 
@@ -40,9 +55,7 @@ const leonardo = new Leonardo({
 });
 
 async function run() {
-    const result = await leonardo.dataset.createDataset({
-        name: "<value>",
-    });
+    const result = await leonardo.initImages.deleteInitImageById("<value>");
 
     // Handle the result
     console.log(result);
@@ -56,6 +69,13 @@ 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
+
 ### [dataset](docs/sdks/dataset/README.md)
 
 * [createDataset](docs/sdks/dataset/README.md#createdataset) - Create a Dataset
@@ -64,42 +84,52 @@ run();
 * [uploadDatasetImage](docs/sdks/dataset/README.md#uploaddatasetimage) - Upload dataset image
 * [uploadDatasetImageFromGen](docs/sdks/dataset/README.md#uploaddatasetimagefromgen) - Upload a Single Generated Image to a Dataset
 
-### [element](docs/sdks/element/README.md)
+### [elements](docs/sdks/elements/README.md)
+
+* [listElements](docs/sdks/elements/README.md#listelements) - List Elements
+
+### [image](docs/sdks/image/README.md)
+
+* [createGeneration](docs/sdks/image/README.md#creategeneration) - Create a Generation of Images
+* [deleteGenerationById](docs/sdks/image/README.md#deletegenerationbyid) - Delete a Single Generation
+* [getGenerationById](docs/sdks/image/README.md#getgenerationbyid) - Get a Single Generation
+* [getGenerationsByUserId](docs/sdks/image/README.md#getgenerationsbyuserid) - Get generations by user ID
 
-* [listElements](docs/sdks/element/README.md#listelements) - List Elements
+### [realtimeCanvas](docs/sdks/realtimecanvas/README.md)
 
-### [generation](docs/sdks/generation/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
 
-* [createGeneration](docs/sdks/generation/README.md#creategeneration) - Create a Generation of Images
-* [createLCMGeneration](docs/sdks/generation/README.md#createlcmgeneration) - Create LCM Generation
-* [createSVDMotionGeneration](docs/sdks/generation/README.md#createsvdmotiongeneration) - Create SVD Motion Generation
-* [createTextureGeneration](docs/sdks/generation/README.md#createtexturegeneration) - Create Texture Generation
-* [deleteGenerationById](docs/sdks/generation/README.md#deletegenerationbyid) - Delete a Single Generation
-* [deleteTextureGenerationById](docs/sdks/generation/README.md#deletetexturegenerationbyid) - Delete Texture Generation by ID
-* [getGenerationById](docs/sdks/generation/README.md#getgenerationbyid) - Get a Single Generation
-* [getGenerationsByUserId](docs/sdks/generation/README.md#getgenerationsbyuserid) - Get generations by user ID
-* [performAlchemyUpscaleLCM](docs/sdks/generation/README.md#performalchemyupscalelcm) - Perform Alchemy Upscale on a LCM image
-* [performInpaintingLCM](docs/sdks/generation/README.md#performinpaintinglcm) - Perform inpainting on a LCM image
-* [performInstantRefine](docs/sdks/generation/README.md#performinstantrefine) - Perform instant refine on a LCM image
+### [motion](docs/sdks/motion/README.md)
 
-### [initImage](docs/sdks/initimage/README.md)
+* [createSVDMotionGeneration](docs/sdks/motion/README.md#createsvdmotiongeneration) - Create SVD Motion Generation
 
-* [deleteInitImageById](docs/sdks/initimage/README.md#deleteinitimagebyid) - Delete init image
-* [getInitImageById](docs/sdks/initimage/README.md#getinitimagebyid) - Get single init image
-* [uploadInitImage](docs/sdks/initimage/README.md#uploadinitimage) - Upload init 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
 
 ### [user](docs/sdks/user/README.md)
 
 * [getUserSelf](docs/sdks/user/README.md#getuserself) - Get user information
 
-### [model](docs/sdks/model/README.md)
+### [models](docs/sdks/models/README.md)
+
+* [createModel](docs/sdks/models/README.md#createmodel) - Train a Custom Model
+* [deleteModelById](docs/sdks/models/README.md#deletemodelbyid) - Delete a Single Custom Model by ID
+* [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)
+
+* [delete3DModelById](docs/sdks/threedmodelassets/README.md#delete3dmodelbyid) - Delete 3D Model by ID
+* [uploadModelAsset](docs/sdks/threedmodelassets/README.md#uploadmodelasset) - Upload 3D Model
 
-* [createModel](docs/sdks/model/README.md#createmodel) - Train a Custom Model
-* [delete3DModelById](docs/sdks/model/README.md#delete3dmodelbyid) - Delete 3D Model by ID
-* [deleteModelById](docs/sdks/model/README.md#deletemodelbyid) - Delete a Single Custom Model by ID
-* [getModelById](docs/sdks/model/README.md#getmodelbyid) - Get a Single Custom Model by ID
-* [listPlatformModels](docs/sdks/model/README.md#listplatformmodels) - List Platform Models
-* [uploadModelAsset](docs/sdks/model/README.md#uploadmodelasset) - Upload 3D Model
+### [pricingCalculator](docs/sdks/pricingcalculator/README.md)
+
+* [pricingCalculator](docs/sdks/pricingcalculator/README.md#pricingcalculator) - Calculating API Cost
 
 ### [prompt](docs/sdks/prompt/README.md)
 
@@ -108,6 +138,7 @@ run();
 
 ### [variation](docs/sdks/variation/README.md)
 
+* [createUniversalUpscalerJob](docs/sdks/variation/README.md#createuniversalupscalerjob) - Create using Universal Upscaler
 * [createVariationNoBG](docs/sdks/variation/README.md#createvariationnobg) - Create no background
 * [createVariationUnzoom](docs/sdks/variation/README.md#createvariationunzoom) - Create unzoom
 * [createVariationUpscale](docs/sdks/variation/README.md#createvariationupscale) - Create upscale
@@ -134,7 +165,7 @@ Validation errors can also occur when either method arguments or data returned f
 
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
-import * as errors from "@leonardo-ai/sdk/sdk/models/errors";
+import { SDKValidationError } from "@leonardo-ai/sdk/sdk/models/errors";
 
 const leonardo = new Leonardo({
     bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
@@ -143,12 +174,10 @@ const leonardo = new Leonardo({
 async function run() {
     let result;
     try {
-        result = await leonardo.dataset.createDataset({
-            name: "<value>",
-        });
+        result = await leonardo.initImages.deleteInitImageById("<value>");
     } catch (err) {
         switch (true) {
-            case err instanceof errors.SDKValidationError: {
+            case err instanceof SDKValidationError: {
                 // Validation errors can be pretty-printed
                 console.error(err.pretty());
                 // Raw value may also be inspected
@@ -202,7 +231,7 @@ const httpClient = new HTTPClient({
 
 httpClient.addHook("beforeRequest", (request) => {
   const nextRequest = new Request(request, {
-    signal: request.signal || AbortSignal.timeout(5000);
+    signal: request.signal || AbortSignal.timeout(5000)
   });
 
   nextRequest.headers.set("x-custom-header", "custom value");
@@ -243,9 +272,7 @@ const leonardo = new Leonardo({
 });
 
 async function run() {
-    const result = await leonardo.dataset.createDataset({
-        name: "<value>",
-    });
+    const result = await leonardo.initImages.deleteInitImageById("<value>");
 
     // Handle the result
     console.log(result);
@@ -269,9 +296,7 @@ const leonardo = new Leonardo({
 });
 
 async function run() {
-    const result = await leonardo.dataset.createDataset({
-        name: "<value>",
-    });
+    const result = await leonardo.initImages.deleteInitImageById("<value>");
 
     // Handle the result
     console.log(result);
@@ -304,9 +329,7 @@ const leonardo = new Leonardo({
 });
 
 async function run() {
-    const result = await leonardo.dataset.createDataset({
-        name: "<value>",
-    });
+    const result = await leonardo.initImages.deleteInitImageById("<value>");
 
     // Handle the result
     console.log(result);
@@ -323,6 +346,71 @@ run();
 For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
 <!-- End Requirements [requirements] -->
 
+<!-- Start Retries [retries] -->
+## Retries
+
+Some of the endpoints in this SDK support retries.  If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API.  However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
+
+To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
+```typescript
+import { Leonardo } from "@leonardo-ai/sdk";
+
+const leonardo = new Leonardo({
+    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,
+        },
+    });
+
+    // Handle the result
+    console.log(result);
+}
+
+run();
+
+```
+
+If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
+```typescript
+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,
+    },
+    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+    const result = await leonardo.initImages.deleteInitImageById("<value>");
+
+    // Handle the result
+    console.log(result);
+}
+
+run();
+
+```
+<!-- End Retries [retries] -->
+
 <!-- Placeholder for Future Speakeasy SDK Sections -->
 
 

package/docs/sdks/dataset/README.md

@@ -41,11 +41,12 @@ run();
 | `request`                                                                                                                                                                      | [operations.CreateDatasetRequestBody](../../sdk/models/operations/createdatasetrequestbody.md)                                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `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.CreateDatasetResponse](../../sdk/models/operations/createdatasetresponse.md)>**
+**Promise\<[operations.CreateDatasetResponse](../../sdk/models/operations/createdatasetresponse.md)\>**
 ### Errors
 
 | Error Object    | Status Code     | Content Type    |
@@ -66,9 +67,7 @@ const leonardo = new Leonardo({
 });
 
 async function run() {
-  const id = "<value>";
-  
-  const result = await leonardo.dataset.deleteDatasetById(id);
+  const result = await leonardo.dataset.deleteDatasetById("<value>");
 
   // Handle the result
   console.log(result)
@@ -84,11 +83,12 @@ run();
 | `id`                                                                                                                                                                           | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | The ID of the dataset to delete.                                                                                                                                               |
 | `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.DeleteDatasetByIdResponse](../../sdk/models/operations/deletedatasetbyidresponse.md)>**
+**Promise\<[operations.DeleteDatasetByIdResponse](../../sdk/models/operations/deletedatasetbyidresponse.md)\>**
 ### Errors
 
 | Error Object    | Status Code     | Content Type    |
@@ -109,9 +109,7 @@ const leonardo = new Leonardo({
 });
 
 async function run() {
-  const id = "<value>";
-  
-  const result = await leonardo.dataset.getDatasetById(id);
+  const result = await leonardo.dataset.getDatasetById("<value>");
 
   // Handle the result
   console.log(result)
@@ -127,11 +125,12 @@ run();
 | `id`                                                                                                                                                                           | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | The ID of the dataset to return.                                                                                                                                               |
 | `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.GetDatasetByIdResponse](../../sdk/models/operations/getdatasetbyidresponse.md)>**
+**Promise\<[operations.GetDatasetByIdResponse](../../sdk/models/operations/getdatasetbyidresponse.md)\>**
 ### Errors
 
 | Error Object    | Status Code     | Content Type    |
@@ -152,12 +151,9 @@ const leonardo = new Leonardo({
 });
 
 async function run() {
-  const requestBody = {
+  const result = await leonardo.dataset.uploadDatasetImage({
     extension: "mpg4",
-  };
-  const datasetId = "<value>";
-  
-  const result = await leonardo.dataset.uploadDatasetImage(requestBody, datasetId);
+  }, "<value>");
 
   // Handle the result
   console.log(result)
@@ -174,11 +170,12 @@ run();
 | `datasetId`                                                                                                                                                                    | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | _"datasetId" is required                                                                                                                                                       |
 | `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.UploadDatasetImageResponse](../../sdk/models/operations/uploaddatasetimageresponse.md)>**
+**Promise\<[operations.UploadDatasetImageResponse](../../sdk/models/operations/uploaddatasetimageresponse.md)\>**
 ### Errors
 
 | Error Object    | Status Code     | Content Type    |
@@ -199,12 +196,9 @@ const leonardo = new Leonardo({
 });
 
 async function run() {
-  const requestBody = {
+  const result = await leonardo.dataset.uploadDatasetImageFromGen({
     generatedImageId: "<value>",
-  };
-  const datasetId = "<value>";
-  
-  const result = await leonardo.dataset.uploadDatasetImageFromGen(requestBody, datasetId);
+  }, "<value>");
 
   // Handle the result
   console.log(result)
@@ -221,11 +215,12 @@ run();
 | `datasetId`                                                                                                                                                                    | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | The ID of the dataset to upload the image to.                                                                                                                                  |
 | `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.UploadDatasetImageFromGenResponse](../../sdk/models/operations/uploaddatasetimagefromgenresponse.md)>**
+**Promise\<[operations.UploadDatasetImageFromGenResponse](../../sdk/models/operations/uploaddatasetimagefromgenresponse.md)\>**
 ### Errors
 
 | Error Object    | Status Code     | Content Type    |

package/docs/sdks/{element → elements}/README.md

@@ -1,5 +1,5 @@
-# Element
-(*element*)
+# Elements
+(*elements*)
 
 ### Available Operations
 
@@ -19,7 +19,7 @@ const leonardo = new Leonardo({
 });
 
 async function run() {
-  const result = await leonardo.element.listElements();
+  const result = await leonardo.elements.listElements();
 
   // Handle the result
   console.log(result)
@@ -34,11 +34,12 @@ run();
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | `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.ListElementsResponse](../../sdk/models/operations/listelementsresponse.md)>**
+**Promise\<[operations.ListElementsResponse](../../sdk/models/operations/listelementsresponse.md)\>**
 ### Errors
 
 | Error Object    | Status Code     | Content Type    |