@leonardo-ai/sdk 4.5.4 → 4.5.6

package/.speakeasy/gen.lock

@@ -1,12 +1,12 @@
 lockVersion: 2.0.0
 id: edadaac9-e645-4ef4-a6c7-a1f73bc19385
 management:
-  docChecksum: 3bbd53494ed6e7e5f86367ecb9fb6ef9
+  docChecksum: 7ed8337867845a822448a6a9ffcca211
   docVersion: v1.0.0
-  speakeasyVersion: 1.241.0
-  generationVersion: 2.300.0
-  releaseVersion: 4.5.4
-  configChecksum: b8c0bb6be4da92d7caba03ead4bf89dd
+  speakeasyVersion: 1.251.0
+  generationVersion: 2.305.1
+  releaseVersion: 4.5.6
+  configChecksum: 91a90cc4b1519c0d7b4f1fd4f22e213c
   repoURL: https://github.com/Leonardo-Interactive/leonardo-ts-sdk.git
   repoSubDirectory: .
   installationURL: https://github.com/Leonardo-Interactive/leonardo-ts-sdk
@@ -14,7 +14,7 @@ management:
 features:
   typescript:
     constsAndDefaults: 0.1.5
-    core: 3.7.0
+    core: 3.7.1
     devContainers: 2.90.0
     flattening: 2.81.1
     globalSecurity: 2.82.9

package/README.md

@@ -35,12 +35,12 @@ To get access to the API and fetch an API key, please sign up for [access](https
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-    const sdk = new Leonardo({
-        bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-    });
+const leonardo = new Leonardo({
+    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
-    const result = await sdk.dataset.createDataset({
+async function run() {
+    const result = await leonardo.dataset.createDataset({
         name: "<value>",
     });
 
@@ -136,14 +136,14 @@ Validation errors can also occur when either method arguments or data returned f
 import { Leonardo } from "@leonardo-ai/sdk";
 import * as errors from "@leonardo-ai/sdk/sdk/models/errors";
 
-async function run() {
-    const sdk = new Leonardo({
-        bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-    });
+const leonardo = new Leonardo({
+    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
+async function run() {
     let result;
     try {
-        result = await sdk.dataset.createDataset({
+        result = await leonardo.dataset.createDataset({
             name: "<value>",
         });
     } catch (err) {
@@ -237,13 +237,13 @@ You can override the default server globally by passing a server index to the `s
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-    const sdk = new Leonardo({
-        serverIdx: 0,
-        bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-    });
+const leonardo = new Leonardo({
+    serverIdx: 0,
+    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
-    const result = await sdk.dataset.createDataset({
+async function run() {
+    const result = await leonardo.dataset.createDataset({
         name: "<value>",
     });
 
@@ -263,13 +263,13 @@ The default server can also be overridden globally by passing a URL to the `serv
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-    const sdk = new Leonardo({
-        serverURL: "https://cloud.leonardo.ai/api/rest/v1",
-        bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-    });
+const leonardo = new Leonardo({
+    serverURL: "https://cloud.leonardo.ai/api/rest/v1",
+    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
-    const result = await sdk.dataset.createDataset({
+async function run() {
+    const result = await leonardo.dataset.createDataset({
         name: "<value>",
     });
 
@@ -299,12 +299,12 @@ To authenticate with the API the `bearerAuth` parameter must be set when initial
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-    const sdk = new Leonardo({
-        bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-    });
+const leonardo = new Leonardo({
+    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
-    const result = await sdk.dataset.createDataset({
+async function run() {
+    const result = await leonardo.dataset.createDataset({
         name: "<value>",
     });
 

package/docs/sdks/dataset/README.md

@@ -18,12 +18,12 @@ This endpoint creates a new dataset
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-  const sdk = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-  });
+const leonardo = new Leonardo({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
-  const result = await sdk.dataset.createDataset({
+async function run() {
+  const result = await leonardo.dataset.createDataset({
     name: "<value>",
   });
 
@@ -61,14 +61,14 @@ This endpoint deletes the specific dataset
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-  const sdk = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-  });
+const leonardo = new Leonardo({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
+async function run() {
   const id = "<value>";
   
-  const result = await sdk.dataset.deleteDatasetById(id);
+  const result = await leonardo.dataset.deleteDatasetById(id);
 
   // Handle the result
   console.log(result)
@@ -104,14 +104,14 @@ This endpoint gets the specific dataset
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-  const sdk = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-  });
+const leonardo = new Leonardo({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
+async function run() {
   const id = "<value>";
   
-  const result = await sdk.dataset.getDatasetById(id);
+  const result = await leonardo.dataset.getDatasetById(id);
 
   // Handle the result
   console.log(result)
@@ -147,17 +147,17 @@ This endpoint returns presigned details to upload a dataset image to S3
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-  const sdk = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-  });
+const leonardo = new Leonardo({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
+async function run() {
   const requestBody = {
     extension: "mpg4",
   };
   const datasetId = "<value>";
   
-  const result = await sdk.dataset.uploadDatasetImage(requestBody, datasetId);
+  const result = await leonardo.dataset.uploadDatasetImage(requestBody, datasetId);
 
   // Handle the result
   console.log(result)
@@ -194,17 +194,17 @@ This endpoint will upload a previously generated image to the dataset
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-  const sdk = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-  });
+const leonardo = new Leonardo({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
+async function run() {
   const requestBody = {
     generatedImageId: "<value>",
   };
   const datasetId = "<value>";
   
-  const result = await sdk.dataset.uploadDatasetImageFromGen(requestBody, datasetId);
+  const result = await leonardo.dataset.uploadDatasetImageFromGen(requestBody, datasetId);
 
   // Handle the result
   console.log(result)

package/docs/sdks/element/README.md

@@ -14,12 +14,12 @@ Get a list of public Elements available for use with generations.
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-  const sdk = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-  });
+const leonardo = new Leonardo({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
-  const result = await sdk.element.listElements();
+async function run() {
+  const result = await leonardo.element.listElements();
 
   // Handle the result
   console.log(result)

package/docs/sdks/generation/README.md

@@ -24,12 +24,12 @@ This endpoint will generate images
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-  const sdk = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-  });
+const leonardo = new Leonardo({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
-  const result = await sdk.generation.createGeneration({
+async function run() {
+  const result = await leonardo.generation.createGeneration({
     elements: [
       {},
     ],
@@ -72,12 +72,12 @@ This endpoint will generate a LCM image generation.
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-  const sdk = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-  });
+const leonardo = new Leonardo({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
-  const result = await sdk.generation.createLCMGeneration({
+async function run() {
+  const result = await leonardo.generation.createLCMGeneration({
     imageDataUrl: "<value>",
     prompt: "<value>",
   });
@@ -116,12 +116,12 @@ This endpoint will generate a SVD motion generation.
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-  const sdk = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-  });
+const leonardo = new Leonardo({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
-  const result = await sdk.generation.createSVDMotionGeneration({
+async function run() {
+  const result = await leonardo.generation.createSVDMotionGeneration({
     imageId: "<value>",
   });
 
@@ -159,12 +159,12 @@ This endpoint will generate a texture generation.
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-  const sdk = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-  });
+const leonardo = new Leonardo({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
-  const result = await sdk.generation.createTextureGeneration({});
+async function run() {
+  const result = await leonardo.generation.createTextureGeneration({});
 
   // Handle the result
   console.log(result)
@@ -200,14 +200,14 @@ This endpoint deletes a specific generation
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-  const sdk = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-  });
+const leonardo = new Leonardo({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
+async function run() {
   const id = "<value>";
   
-  const result = await sdk.generation.deleteGenerationById(id);
+  const result = await leonardo.generation.deleteGenerationById(id);
 
   // Handle the result
   console.log(result)
@@ -243,15 +243,15 @@ This endpoint deletes the specific texture generation.
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-  const sdk = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-  });
+const leonardo = new Leonardo({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
+async function run() {
   const id = "<value>";
   const requestBody = {};
   
-  const result = await sdk.generation.deleteTextureGenerationById(id, requestBody);
+  const result = await leonardo.generation.deleteTextureGenerationById(id, requestBody);
 
   // Handle the result
   console.log(result)
@@ -288,14 +288,14 @@ This endpoint will provide information about a specific generation
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-  const sdk = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-  });
+const leonardo = new Leonardo({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
+async function run() {
   const id = "<value>";
   
-  const result = await sdk.generation.getGenerationById(id);
+  const result = await leonardo.generation.getGenerationById(id);
 
   // Handle the result
   console.log(result)
@@ -331,16 +331,16 @@ This endpoint returns all generations by a specific user
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-  const sdk = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-  });
+const leonardo = new Leonardo({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
+async function run() {
   const userId = "<value>";
   const limit = 10;
   const offset = 0;
   
-  const result = await sdk.generation.getGenerationsByUserId(userId, limit, offset);
+  const result = await leonardo.generation.getGenerationsByUserId(userId, limit, offset);
 
   // Handle the result
   console.log(result)
@@ -378,12 +378,12 @@ This endpoint will perform Alchemy Upscale on a LCM image
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-  const sdk = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-  });
+const leonardo = new Leonardo({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
-  const result = await sdk.generation.performAlchemyUpscaleLCM({
+async function run() {
+  const result = await leonardo.generation.performAlchemyUpscaleLCM({
     imageDataUrl: "<value>",
     prompt: "<value>",
   });
@@ -422,12 +422,12 @@ This endpoint will perform a inpainting on a LCM image
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-  const sdk = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-  });
+const leonardo = new Leonardo({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
-  const result = await sdk.generation.performInpaintingLCM({
+async function run() {
+  const result = await leonardo.generation.performInpaintingLCM({
     imageDataUrl: "<value>",
     maskDataUrl: "<value>",
     prompt: "<value>",
@@ -467,12 +467,12 @@ This endpoint will perform instant refine on a LCM image
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-  const sdk = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-  });
+const leonardo = new Leonardo({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
-  const result = await sdk.generation.performInstantRefine({
+async function run() {
+  const result = await leonardo.generation.performInstantRefine({
     imageDataUrl: "<value>",
     prompt: "<value>",
   });

package/docs/sdks/initimage/README.md

@@ -16,14 +16,14 @@ This endpoint deletes an init image
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-  const sdk = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-  });
+const leonardo = new Leonardo({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
+async function run() {
   const id = "<value>";
   
-  const result = await sdk.initImage.deleteInitImageById(id);
+  const result = await leonardo.initImage.deleteInitImageById(id);
 
   // Handle the result
   console.log(result)
@@ -59,14 +59,14 @@ This endpoint will return a single init image
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-  const sdk = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-  });
+const leonardo = new Leonardo({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
+async function run() {
   const id = "<value>";
   
-  const result = await sdk.initImage.getInitImageById(id);
+  const result = await leonardo.initImage.getInitImageById(id);
 
   // Handle the result
   console.log(result)
@@ -102,12 +102,12 @@ This endpoint returns presigned details to upload an init image to S3
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-  const sdk = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-  });
+const leonardo = new Leonardo({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
-  const result = await sdk.initImage.uploadInitImage({
+async function run() {
+  const result = await leonardo.initImage.uploadInitImage({
     extension: "png",
   });
 

package/docs/sdks/model/README.md

@@ -19,12 +19,12 @@ This endpoint will train a new custom model
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-  const sdk = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-  });
+const leonardo = new Leonardo({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
-  const result = await sdk.model.createModel({
+async function run() {
+  const result = await leonardo.model.createModel({
     datasetId: "<value>",
     instancePrompt: "<value>",
     name: "<value>",
@@ -64,15 +64,15 @@ This endpoint deletes the specific 3D Model
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-  const sdk = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-  });
+const leonardo = new Leonardo({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
+async function run() {
   const id = "<value>";
   const requestBody = {};
   
-  const result = await sdk.model.delete3DModelById(id, requestBody);
+  const result = await leonardo.model.delete3DModelById(id, requestBody);
 
   // Handle the result
   console.log(result)
@@ -109,14 +109,14 @@ This endpoint will delete a specific custom model
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-  const sdk = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-  });
+const leonardo = new Leonardo({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
+async function run() {
   const id = "<value>";
   
-  const result = await sdk.model.deleteModelById(id);
+  const result = await leonardo.model.deleteModelById(id);
 
   // Handle the result
   console.log(result)
@@ -152,14 +152,14 @@ This endpoint gets the specific custom model
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-  const sdk = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-  });
+const leonardo = new Leonardo({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
+async function run() {
   const id = "<value>";
   
-  const result = await sdk.model.getModelById(id);
+  const result = await leonardo.model.getModelById(id);
 
   // Handle the result
   console.log(result)
@@ -195,12 +195,12 @@ Get a list of public Platform Models available for use with generations.
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-  const sdk = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-  });
+const leonardo = new Leonardo({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
-  const result = await sdk.model.listPlatformModels();
+async function run() {
+  const result = await leonardo.model.listPlatformModels();
 
   // Handle the result
   console.log(result)
@@ -235,12 +235,12 @@ This endpoint returns presigned details to upload a 3D model to S3
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-  const sdk = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-  });
+const leonardo = new Leonardo({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
-  const result = await sdk.model.uploadModelAsset({});
+async function run() {
+  const result = await leonardo.model.uploadModelAsset({});
 
   // Handle the result
   console.log(result)

package/docs/sdks/prompt/README.md

@@ -15,12 +15,12 @@ This endpoint returns a improved prompt
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-  const sdk = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-  });
+const leonardo = new Leonardo({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
-  const result = await sdk.prompt.promptImprove({
+async function run() {
+  const result = await leonardo.prompt.promptImprove({
     prompt: "<value>",
   });
 
@@ -58,12 +58,12 @@ This endpoint returns a random prompt
 ```typescript
 import { Leonardo } from "@leonardo-ai/sdk";
 
-async function run() {
-  const sdk = new Leonardo({
-    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
-  });
+const leonardo = new Leonardo({
+  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
+});
 
-  const result = await sdk.prompt.promptRandom();
+async function run() {
+  const result = await leonardo.prompt.promptRandom();
 
   // Handle the result
   console.log(result)