ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.561.0

Author: speakeasybot

.speakeasy/gen.lock

@@ -3,22 +3,23 @@ id: 2cbfefb5-ef48-4650-9f21-e38c7e05b9a9
 management:
  docChecksum: a65fdbfaf49bb322db3e3a5170b3aff3
  docVersion: 0.2.0
- speakeasyVersion: 1.551.0
- generationVersion: 2.610.0
- releaseVersion: 0.3.0
- configChecksum: 06c99e90b91b0d7e17234b3c63f41cae
+ speakeasyVersion: 1.561.0
+ generationVersion: 2.628.0
+ releaseVersion: 0.4.0
+ configChecksum: 6e89578a90ef051b9ed32adc6390c565
  repoURL: https://github.com/cloudinary/analysis-js.git
  installationURL: https://github.com/cloudinary/analysis-js
  published: true
 features:
  typescript:
  additionalDependencies: 0.1.0
- core: 3.21.9
+ core: 3.21.11
  customSecuritySchemes: 0.1.1
  defaultEnabledRetries: 0.1.0
  devContainers: 2.90.0
  enumUnions: 0.1.0
  envVarSecurityUsage: 0.1.2
+ flattening: 2.82.1
  globalSecurity: 2.82.13
  globalSecurityCallbacks: 0.1.0
  globalServerURLs: 2.82.5
@@ -27,8 +28,8 @@ features:
  nullables: 0.1.1
  responseFormat: 0.2.3
  retries: 2.83.0
- sdkHooks: 0.2.0
- unions: 2.85.8
+ sdkHooks: 0.3.0
+ unions: 2.85.9
 generatedFiles:
  - .devcontainer/README.md
  - .devcontainer/devcontainer.json
@@ -258,10 +259,12 @@ generatedFiles:
  - src/models/components/unidetanalysisdata.ts
  - src/models/components/watermarkdetectionanalysisdata.ts
  - src/models/errors/apierror.ts
+ - src/models/errors/cloudinaryanalysiserror.ts
  - src/models/errors/errorresponse.ts
  - src/models/errors/httpclienterrors.ts
  - src/models/errors/index.ts
  - src/models/errors/ratelimitedresponse.ts
+ - src/models/errors/responsevalidationerror.ts
  - src/models/errors/sdkvalidationerror.ts
  - src/models/operations/analyzeaivisiongeneral.ts
  - src/models/operations/analyzeaivisionmoderation.ts
@@ -739,5 +742,18 @@ examples:
  application/json: {"error": {"category": "user_error", "code": "MA_00001", "message": "missing parameters", "details": {}, "request_id": "17c3b70c5096df0e77e838323abb7029"}, "limits": {"items": [{"type": "ai_vision", "used_by_request": 123, "remaining": 500, "limit": 10000, "reset_time": "2024-01-20T12:34:56Z"}]}}
  "500":
  application/json: {"error": {"category": "user_error", "code": "MA_00001", "message": "missing parameters", "details": {}, "request_id": "17c3b70c5096df0e77e838323abb7029"}}
+ speakeasy-default-get-analysis-task-status:
+ parameters:
+ path:
+ task_id: "053f4bde4b933c8ecef23724ecde63b667c1ea21816d56c161c7ec1df6297da4b43109625650e9edf0f42152cc4cc32c8ad57824ac75ba8e05020f827c415559ac1248076a2d72c0a73af0479cca77eb"
+ responses:
+ "200":
+ application/json: {"data": {"task_id": "053f4bde4b933c8ecef23724ecde63b667c1ea21816d56c161c7ec1df6297da4b43109625650e9edf0f42152cc4cc32c8ad57824ac75ba8e05020f827c415559ac1248076a2d72c0a73af0479cca77eb", "status": "processing"}, "request_id": "17c3b70c5096df0e77e838323abb7029"}
+ "400":
+ application/json: {"error": {"category": "user_error", "code": "MA_00001", "message": "missing parameters", "details": {}, "request_id": "17c3b70c5096df0e77e838323abb7029"}}
+ "429":
+ application/json: {"error": {"category": "user_error", "code": "MA_00001", "message": "missing parameters", "details": {}, "request_id": "17c3b70c5096df0e77e838323abb7029"}, "limits": {"items": [{"type": "ai_vision", "used_by_request": 123, "remaining": 500, "limit": 10000, "reset_time": "2024-01-20T12:34:56Z"}]}}
+ "500":
+ application/json: {"error": {"category": "user_error", "code": "MA_00001", "message": "missing parameters", "details": {}, "request_id": "17c3b70c5096df0e77e838323abb7029"}}
 examplesVersion: 1.0.2
 generatedTests: {}

.speakeasy/gen.yaml

@@ -20,7 +20,7 @@ generation:
  oAuth2ClientCredentialsEnabled: true
  oAuth2PasswordEnabled: true
 typescript:
- version: 0.3.0
+ version: 0.4.0
  additionalDependencies:
  dependencies: {}
  devDependencies: {}

.speakeasy/workflow.lock

@@ -1,21 +1,21 @@
-speakeasyVersion: 1.551.0
+speakeasyVersion: 1.561.0
 sources:
  Analyze API (Beta):
  sourceNamespace: analyze-api
- sourceRevisionDigest: sha256:be35c55d5b30e9e957895225b8c5b9b322e2b038bf6377c705186f3f45740d47
+ sourceRevisionDigest: sha256:c5eaac5133fe2825895c06fb0dc50d8f46fd3657fc4aeda9ffa492c755efb1ee
  sourceBlobDigest: sha256:59c600a6e3404a529ff8de08a401719e928e90d8a5a6b0e60f1ab88ae541a073
  tags:
  - latest
- - speakeasy-sdk-regen-1748287281
+ - speakeasy-sdk-regen-1749759573
  - 0.2.0
 targets:
  analysis-js:
  source: Analyze API (Beta)
  sourceNamespace: analyze-api
- sourceRevisionDigest: sha256:be35c55d5b30e9e957895225b8c5b9b322e2b038bf6377c705186f3f45740d47
+ sourceRevisionDigest: sha256:c5eaac5133fe2825895c06fb0dc50d8f46fd3657fc4aeda9ffa492c755efb1ee
  sourceBlobDigest: sha256:59c600a6e3404a529ff8de08a401719e928e90d8a5a6b0e60f1ab88ae541a073
  codeSamplesNamespace: analyze-api-typescript-code-samples
- codeSamplesRevisionDigest: sha256:dd38c5915f7d40203fcbca733daa2506a42681e125e0c3d526dd473a31648de2
+ codeSamplesRevisionDigest: sha256:41ddae1cfe5c0b5be00531138e27511ecd38870c8ed28b1bb49c483bbbf88c10
 workflow:
  workflowVersion: 1.0.0
  speakeasyVersion: latest

FUNCTIONS.md

@@ -21,7 +21,6 @@ specific category of applications.
 ```typescript
 import { CloudinaryAnalysisCore } from "@cloudinary/analysis/core.js";
 import { analyzeAiVisionGeneral } from "@cloudinary/analysis/funcs/analyzeAiVisionGeneral.js";
-import { SDKValidationError } from "@cloudinary/analysis/models/errors/sdkvalidationerror.js";
 
 // Use `CloudinaryAnalysisCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -44,28 +43,12 @@ async function run() {
  "Does this image contain an insect?",
  ],
  });
-
- switch (true) {
- case res.ok:
- // The success case will be handled outside of the switch block
- break;
- case res.error instanceof SDKValidationError:
- // Pretty-print validation errors.
- return console.log(res.error.pretty());
- case res.error instanceof Error:
- return console.log(res.error);
- default:
- // TypeScript's type checking will fail on the following line if the above
- // cases were not exhaustive.
- res.error satisfies never;
- throw new Error("Assertion failed: expected error checks to be exhaustive: " + res.error);
+ if (res.ok) {
+ const { value: result } = res;
+ console.log(result);
+ } else {
+ console.log("analyzeAiVisionGeneral failed:", res.error);
  }
-
-
- const { value: result } = res;
-
- // Handle the result
- console.log(result);
 }
 
 run();

README.md

@@ -188,7 +188,6 @@ async function run() {
  ],
  });
 
- // Handle the result
  console.log(result);
 }
 
@@ -234,7 +233,6 @@ async function run() {
  ],
  });
 
- // Handle the result
  console.log(result);
 }
 
@@ -269,7 +267,6 @@ async function run() {
  ],
  });
 
- // Handle the result
  console.log(result);
 }
 
@@ -314,7 +311,6 @@ async function run() {
  ],
  });
 
- // Handle the result
  console.log(result);
 }
 
@@ -430,7 +426,6 @@ async function run() {
  },
  });
 
- // Handle the result
  console.log(result);
 }
 
@@ -472,7 +467,6 @@ async function run() {
  ],
  });
 
- // Handle the result
  console.log(result);
 }
 
@@ -484,24 +478,21 @@ run();
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
-Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `aiVisionGeneral` method may throw the following errors:
+[`CloudinaryAnalysisError`](./src/models/errors/cloudinaryanalysiserror.ts) is the base class for all HTTP error responses. It has the following properties:
 
-| Error Type   | Status Code | Content Type |
-| -------------------------- | ------------------ | ---------------- |
-| errors.ErrorResponse  | 400, 401, 403, 404 | application/json |
-| errors.RateLimitedResponse | 429   | application/json |
-| errors.ErrorResponse  | 500  | application/json |
-| errors.APIError   | 4XX, 5XX | \*/\* |
-
-If the method throws an error and it is not captured by the known errors, it will default to throwing a `APIError`.
+| Property  | Type  | Description    |
+| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
+| `error.message` | `string` | Error message  |
+| `error.statusCode` | `number` | HTTP response status code eg `404`   |
+| `error.headers` | `Headers` | HTTP response headers   |
+| `error.body` | `string` | HTTP body. Can be empty string if no body is returned.  |
+| `error.rawResponse` | `Response` | Raw HTTP response |
+| `error.data$` | | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |
 
+### Example
 ```typescript
 import { CloudinaryAnalysis } from "@cloudinary/analysis";
-import {
- ErrorResponse,
- RateLimitedResponse,
- SDKValidationError,
-} from "@cloudinary/analysis/models/errors";
+import * as errors from "@cloudinary/analysis/models/errors";
 
 const cloudinaryAnalysis = new CloudinaryAnalysis({
  security: {
@@ -513,9 +504,8 @@ const cloudinaryAnalysis = new CloudinaryAnalysis({
 });
 
 async function run() {
- let result;
  try {
- result = await cloudinaryAnalysis.analyze.aiVisionGeneral({
+ const result = await cloudinaryAnalysis.analyze.aiVisionGeneral({
  source: {
  uri: "https://res.cloudinary.com/demo/image/upload/sample.jpg",
  },
@@ -525,36 +515,18 @@ async function run() {
  ],
  });
 
- // Handle the result
  console.log(result);
- } catch (err) {
- switch (true) {
- // The server response does not match the expected SDK schema
- case (err instanceof SDKValidationError): {
- // Pretty-print will provide a human-readable multi-line error message
- console.error(err.pretty());
- // Raw value may also be inspected
- console.error(err.rawValue);
- return;
- }
- case (err instanceof ErrorResponse): {
- // Handle err.data$: ErrorResponseData
- console.error(err);
- return;
- }
- case (err instanceof RateLimitedResponse): {
- // Handle err.data$: RateLimitedResponseData
- console.error(err);
- return;
- }
- case (err instanceof ErrorResponse): {
- // Handle err.data$: ErrorResponseData
- console.error(err);
- return;
- }
- default: {
- // Other errors such as network errors, see HTTPClientErrors for more details
- throw err;
+ } catch (error) {
+ // The base class for HTTP error responses
+ if (error instanceof errors.CloudinaryAnalysisError) {
+ console.log(error.message);
+ console.log(error.statusCode);
+ console.log(error.body);
+ console.log(error.headers);
+
+ // Depending on the method different errors may be thrown
+ if (error instanceof errors.ErrorResponse) {
+ console.log(error.data$.error); // components.ErrorObject
  }
  }
  }
@@ -564,17 +536,28 @@ 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 multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.
+### Error Classes
+**Primary errors:**
+* [`CloudinaryAnalysisError`](./src/models/errors/cloudinaryanalysiserror.ts): The base class for HTTP error responses.
+ * [`ErrorResponse`](docs/models/errors/errorresponse.md): Bad request.
+ * [`RateLimitedResponse`](docs/models/errors/ratelimitedresponse.md): Rate limited. Status code `429`.
 
-In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the `models/errors/httpclienterrors.ts` module:
+<details><summary>Less common errors (6)</summary>
 
-| 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 |
+<br />
+
+**Network errors:**
+* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
+* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
+* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
+* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
+* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.
+
+
+**Inherit from [`CloudinaryAnalysisError`](./src/models/errors/cloudinaryanalysiserror.ts)**:
+* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
+
+</details>
 <!-- End Error Handling [errors] -->
 
 <!-- Start Custom HTTP Client [http-client] -->

RELEASES.md

@@ -8,4 +8,14 @@ Based on:
 ### Generated
 - [typescript v0.3.0] .
 ### Releases
-- [NPM v0.3.0] https://www.npmjs.com/package/@cloudinary/analysis/v/0.3.0 - .
+- [NPM v0.3.0] https://www.npmjs.com/package/@cloudinary/analysis/v/0.3.0 - .
+
+## 2025-06-12 20:19:17
+### Changes
+Based on:
+- OpenAPI Doc 
+- Speakeasy CLI 1.561.0 (2.628.0) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.4.0] .
+### Releases
+- [NPM v0.4.0] https://www.npmjs.com/package/@cloudinary/analysis/v/0.4.0 - .

USAGE.md

@@ -22,7 +22,6 @@ async function run() {
  ],
  });
 
- // Handle the result
  console.log(result);
 }