@leonardo-ai/sdk 4.15.0 → 4.17.0

package/README.md

@@ -75,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("<id>");
+  const result = await leonardo.initImages.deleteInitImageById("<id>");
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -93,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)
 
@@ -119,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)
 
@@ -146,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)
 
@@ -160,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
@@ -167,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] -->
 
 
@@ -178,49 +184,60 @@ run();
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
-All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
+All SDK methods return a response object or throw an error. By default, an API error will throw a `errors.SDKError`.
 
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
+If a HTTP request fails, an operation my also throw an error from the `sdk/models/errors/httpclienterrors.ts` module:
+
+| HTTP Client Error                                    | Description                                          |
+| ---------------------------------------------------- | ---------------------------------------------------- |
+| RequestAbortedError                                  | HTTP request was aborted by the client               |
+| RequestTimeoutError                                  | HTTP request timed out due to an AbortSignal signal  |
+| ConnectionError                                      | HTTP client was unable to make a request to a server |
+| InvalidRequestError                                  | Any input used to create a request is invalid        |
+| UnexpectedClientError                                | Unrecognised or unexpected error                     |
 
-Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging. 
+In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective *Errors* tables in SDK docs for more details on possible error types for each operation. For example, the `deleteInitImageById` method may throw the following errors:
 
+| Error Type      | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 4XX, 5XX        | \*/\*           |
 
 ```typescript
 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("<id>");
-    } 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();
 
 ```
+
+Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
 <!-- End Error Handling [errors] -->
 
 
@@ -291,15 +308,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("<id>");
+  const result = await leonardo.initImages.deleteInitImageById("<id>");
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -315,15 +332,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("<id>");
+  const result = await leonardo.initImages.deleteInitImageById("<id>");
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -349,14 +366,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("<id>");
+  const result = await leonardo.initImages.deleteInitImageById("<id>");
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -436,25 +453,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("<id>", {
-        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();
@@ -466,24 +483,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("<id>");
+  const result = await leonardo.initImages.deleteInitImageById("<id>");
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();

package/docs/sdks/dataset/README.md

@@ -30,7 +30,7 @@ async function run() {
   });
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -62,7 +62,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -83,10 +83,9 @@ run();
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
+| errors.SDKError | 4XX, 5XX        | \*/\*           |
 
 ## deleteDatasetById
 
@@ -105,7 +104,7 @@ async function run() {
   const result = await leonardo.dataset.deleteDatasetById("<id>");
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -135,7 +134,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -156,10 +155,9 @@ run();
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
+| errors.SDKError | 4XX, 5XX        | \*/\*           |
 
 ## getDatasetById
 
@@ -178,7 +176,7 @@ async function run() {
   const result = await leonardo.dataset.getDatasetById("<id>");
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -208,7 +206,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -229,10 +227,9 @@ run();
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
+| errors.SDKError | 4XX, 5XX        | \*/\*           |
 
 ## uploadDatasetImage
 
@@ -253,7 +250,7 @@ async function run() {
   }, "<value>");
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -275,7 +272,7 @@ const leonardo = new LeonardoCore({
 
 async function run() {
   const res = await datasetUploadDatasetImage(leonardo, {
-    extension: "gif",
+    extension: "mpg4",
   }, "<value>");
 
   if (!res.ok) {
@@ -285,7 +282,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -307,10 +304,9 @@ run();
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
+| errors.SDKError | 4XX, 5XX        | \*/\*           |
 
 ## uploadDatasetImageFromGen
 
@@ -331,7 +327,7 @@ async function run() {
   }, "<value>");
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -363,7 +359,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -385,6 +381,6 @@ run();
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
+| errors.SDKError | 4XX, 5XX        | \*/\*           |

package/docs/sdks/elements/README.md

@@ -24,7 +24,7 @@ async function run() {
   const result = await leonardo.elements.listElements();
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -54,7 +54,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -74,6 +74,6 @@ run();
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
+| errors.SDKError | 4XX, 5XX        | \*/\*           |

package/docs/sdks/image/README.md

@@ -27,7 +27,7 @@ async function run() {
   const result = await leonardo.image.createGeneration({});
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -57,7 +57,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -78,10 +78,9 @@ run();
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
+| errors.SDKError | 4XX, 5XX        | \*/\*           |
 
 ## deleteGenerationById
 
@@ -100,7 +99,7 @@ async function run() {
   const result = await leonardo.image.deleteGenerationById("<id>");
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -130,7 +129,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -151,10 +150,9 @@ run();
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
+| errors.SDKError | 4XX, 5XX        | \*/\*           |
 
 ## getGenerationById
 
@@ -173,7 +171,7 @@ async function run() {
   const result = await leonardo.image.getGenerationById("<id>");
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -203,7 +201,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -224,10 +222,9 @@ run();
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
+| errors.SDKError | 4XX, 5XX        | \*/\*           |
 
 ## getGenerationsByUserId
 
@@ -246,7 +243,7 @@ async function run() {
   const result = await leonardo.image.getGenerationsByUserId("<value>");
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -276,7 +273,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -299,6 +296,6 @@ run();
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
+| errors.SDKError | 4XX, 5XX        | \*/\*           |