@leonardo-ai/sdk 4.16.0 → 4.18.0

package/README.md

@@ -184,14 +184,23 @@ 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";
@@ -227,6 +236,8 @@ async function run() {
 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] -->
 
 
@@ -391,43 +402,42 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 
 <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)
-
+- [`datasetCreateDataset`](docs/sdks/dataset/README.md#createdataset) - Create a Dataset
+- [`datasetDeleteDatasetById`](docs/sdks/dataset/README.md#deletedatasetbyid) - Delete a Single Dataset by ID
+- [`datasetGetDatasetById`](docs/sdks/dataset/README.md#getdatasetbyid) - Get a Single Dataset by ID
+- [`datasetUploadDatasetImage`](docs/sdks/dataset/README.md#uploaddatasetimage) - Upload dataset image
+- [`datasetUploadDatasetImageFromGen`](docs/sdks/dataset/README.md#uploaddatasetimagefromgen) - Upload a Single Generated Image to a Dataset
+- [`elementsListElements`](docs/sdks/elements/README.md#listelements) - List Elements
+- [`imageCreateGeneration`](docs/sdks/image/README.md#creategeneration) - Create a Generation of Images
+- [`imageDeleteGenerationById`](docs/sdks/image/README.md#deletegenerationbyid) - Delete a Single Generation
+- [`imageGetGenerationById`](docs/sdks/image/README.md#getgenerationbyid) - Get a Single Generation
+- [`imageGetGenerationsByUserId`](docs/sdks/image/README.md#getgenerationsbyuserid) - Get generations by user ID
+- [`initImagesDeleteInitImageById`](docs/sdks/initimages/README.md#deleteinitimagebyid) - Delete init image
+- [`initImagesGetInitImageById`](docs/sdks/initimages/README.md#getinitimagebyid) - Get single init image
+- [`initImagesUploadCanvasInitImage`](docs/sdks/initimages/README.md#uploadcanvasinitimage) - Upload Canvas Editor init and mask image
+- [`initImagesUploadInitImage`](docs/sdks/initimages/README.md#uploadinitimage) - Upload init image
+- [`modelsCreateModel`](docs/sdks/models/README.md#createmodel) - Train a Custom Model
+- [`modelsDeleteModelById`](docs/sdks/models/README.md#deletemodelbyid) - Delete a Single Custom Model by ID
+- [`modelsGetModelById`](docs/sdks/models/README.md#getmodelbyid) - Get a Single Custom Model by ID
+- [`modelsListPlatformModels`](docs/sdks/models/README.md#listplatformmodels) - List Platform Models
+- [`motionCreateSVDMotionGeneration`](docs/sdks/motion/README.md#createsvdmotiongeneration) - Create SVD Motion Generation
+- [`pricingCalculatorPricingCalculator`](docs/sdks/pricingcalculator/README.md#pricingcalculator) - Calculating API Cost
+- [`promptPromptImprove`](docs/sdks/prompt/README.md#promptimprove) - Improve a Prompt
+- [`promptPromptRandom`](docs/sdks/prompt/README.md#promptrandom) - Generate a Random prompt
+- [`realtimeCanvasCreateLCMGeneration`](docs/sdks/realtimecanvas/README.md#createlcmgeneration) - Create LCM Generation
+- [`realtimeCanvasPerformAlchemyUpscaleLCM`](docs/sdks/realtimecanvas/README.md#performalchemyupscalelcm) - Perform Alchemy Upscale on a LCM image
+- [`realtimeCanvasPerformInpaintingLCM`](docs/sdks/realtimecanvas/README.md#performinpaintinglcm) - Perform inpainting on a LCM image
+- [`realtimeCanvasPerformInstantRefine`](docs/sdks/realtimecanvas/README.md#performinstantrefine) - Perform instant refine on a LCM image
+- [`textureCreateTextureGeneration`](docs/sdks/texture/README.md#createtexturegeneration) - Create Texture Generation
+- [`textureDeleteTextureGenerationById`](docs/sdks/texture/README.md#deletetexturegenerationbyid) - Delete Texture Generation by ID
+- [`threeDModelAssetsDelete3DModelById`](docs/sdks/threedmodelassets/README.md#delete3dmodelbyid) - Delete 3D Model by ID
+- [`threeDModelAssetsUploadModelAsset`](docs/sdks/threedmodelassets/README.md#uploadmodelasset) - Upload 3D Model
+- [`userGetUserSelf`](docs/sdks/user/README.md#getuserself) - Get user information
+- [`variationCreateUniversalUpscalerJob`](docs/sdks/variation/README.md#createuniversalupscalerjob) - Create using Universal Upscaler
+- [`variationCreateVariationNoBG`](docs/sdks/variation/README.md#createvariationnobg) - Create no background
+- [`variationCreateVariationUnzoom`](docs/sdks/variation/README.md#createvariationunzoom) - Create unzoom
+- [`variationCreateVariationUpscale`](docs/sdks/variation/README.md#createvariationupscale) - Create upscale
+- [`variationGetVariationById`](docs/sdks/variation/README.md#getvariationbyid) - Get variation by ID
 
 </details>
 <!-- End Standalone functions [standalone-funcs] -->

package/docs/sdks/dataset/README.md

@@ -28,9 +28,9 @@ async function run() {
   const result = await leonardo.dataset.createDataset({
     name: "<value>",
   });
-  
+
   // 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
 
@@ -103,9 +102,9 @@ const leonardo = new Leonardo({
 
 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
 
@@ -176,9 +174,9 @@ const leonardo = new Leonardo({
 
 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
 
@@ -251,9 +248,9 @@ async function run() {
   const result = await leonardo.dataset.uploadDatasetImage({
     extension: "mpg4",
   }, "<value>");
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -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
 
@@ -329,9 +325,9 @@ async function run() {
   const result = await leonardo.dataset.uploadDatasetImageFromGen({
     generatedImageId: "<value>",
   }, "<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

@@ -22,9 +22,9 @@ const leonardo = new Leonardo({
 
 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

@@ -25,9 +25,9 @@ const leonardo = new Leonardo({
 
 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
 
@@ -98,9 +97,9 @@ const leonardo = new Leonardo({
 
 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
 
@@ -171,9 +169,9 @@ const leonardo = new Leonardo({
 
 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
 
@@ -244,9 +241,9 @@ const leonardo = new Leonardo({
 
 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        | \*/\*           |

package/docs/sdks/initimages/README.md

@@ -25,9 +25,9 @@ const leonardo = new Leonardo({
 
 async function run() {
   const result = await leonardo.initImages.deleteInitImageById("<id>");
-  
+
   // 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        | \*/\*           |
 
 ## getInitImageById
 
@@ -98,9 +97,9 @@ const leonardo = new Leonardo({
 
 async function run() {
   const result = await leonardo.initImages.getInitImageById("<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        | \*/\*           |
 
 ## uploadCanvasInitImage
 
@@ -174,9 +172,9 @@ async function run() {
     initExtension: "<value>",
     maskExtension: "<value>",
   });
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -209,7 +207,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -230,10 +228,9 @@ run();
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
+| errors.SDKError | 4XX, 5XX        | \*/\*           |
 
 ## uploadInitImage
 
@@ -252,9 +249,9 @@ async function run() {
   const result = await leonardo.initImages.uploadInitImage({
     extension: "png",
   });
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -286,7 +283,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -307,6 +304,6 @@ run();
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
+| errors.SDKError | 4XX, 5XX        | \*/\*           |