ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.587.1

Author: speakeasybot

.gitignore

@@ -1,3 +1,7 @@
+/examples/node_modules
+.env
+.env.local
+.env.*.local
 /mcp-server
 /bin
 /.eslintcache

.speakeasy/gen.lock

@@ -3,19 +3,19 @@ id: 9b971081-3d7e-4f4a-97fe-f59e6a07657d
 management:
   docChecksum: 0e2bfa208d98ff70011a9d69b38e42cb
   docVersion: 0.1.0
-  speakeasyVersion: 1.546.1
-  generationVersion: 2.604.2
-  releaseVersion: 0.2.1
-  configChecksum: f7620bedecfe0806bd0d6319356aa63f
+  speakeasyVersion: 1.587.1
+  generationVersion: 2.662.0
+  releaseVersion: 0.3.0
+  configChecksum: f4d12066ed5c361309a9fcf7d417afdc
   repoURL: https://github.com/iris-networks/iris-sdk.git
   installationURL: https://github.com/iris-networks/iris-sdk
 features:
   typescript:
     acceptHeaders: 2.81.2
     additionalDependencies: 0.1.0
     additionalProperties: 0.1.1
-    constsAndDefaults: 0.1.11
-    core: 3.21.8
+    constsAndDefaults: 0.1.12
+    core: 3.21.15
     defaultEnabledRetries: 0.1.0
     devContainers: 2.90.0
     downloadStreams: 0.1.1
@@ -24,11 +24,11 @@ features:
     globalSecurityCallbacks: 0.1.0
     globalServerURLs: 2.82.5
     groups: 2.81.2
-    mcpServer: 0.9.2
+    mcpServer: 0.9.3
     nameOverrides: 2.81.2
     responseFormat: 0.2.3
     retries: 2.83.0
-    sdkHooks: 0.2.0
+    sdkHooks: 0.3.0
     uploadStreams: 0.1.0
 generatedFiles:
   - .devcontainer/README.md
@@ -139,6 +139,10 @@ generatedFiles:
   - docs/sdks/videoediting/README.md
   - docs/sdks/videos/README.md
   - eslint.config.mjs
+  - examples/.env.template
+  - examples/README.md
+  - examples/configGet.example.ts
+  - examples/package.json
   - jsr.json
   - package.json
   - src/core.ts
@@ -287,6 +291,8 @@ generatedFiles:
   - src/models/errors/apierror.ts
   - src/models/errors/httpclienterrors.ts
   - src/models/errors/index.ts
+  - src/models/errors/irissdkerror.ts
+  - src/models/errors/responsevalidationerror.ts
   - src/models/errors/sdkvalidationerror.ts
   - src/models/operations/approverequest.ts
   - src/models/operations/deletefile.ts
@@ -395,7 +401,7 @@ examples:
     speakeasy-default-get-current-session-video-data:
       responses:
         "200":
-          application/json: {"success": true, "videoData": {"frames": ["data:image/png;base64,iVBORw0KGgo..."], "captions": [{"timestamp": 1651234567890, "conversation": {}, "frameIndex": 0}]}}
+          application/json: {"success": true, "videoData": {"frames": ["base64string1", "base64string2"], "captions": [{"timestamp": 1651234567890, "conversation": {}, "frameIndex": 0}]}}
   getRecordingVideoData:
     speakeasy-default-get-recording-video-data:
       parameters:
@@ -461,7 +467,7 @@ examples:
           id: "<id>"
           frameIndex: 2353.28
       requestBody:
-        application/json: {"text": "New caption text here"}
+        application/json: {"caption": {}, "text": "New caption text here"}
       responses:
         "200":
           application/json: {"success": true}
@@ -481,7 +487,7 @@ examples:
   startExecution:
     speakeasy-default-start-execution:
       requestBody:
-        application/json: {"recordingId": "a1b2c3d4-e5f6-7g8h-9i0j-k1l2m3n4o5p6", "actionDelay": 1500}
+        application/json: {"recordingId": "a1b2c3d4-e5f6-7g8h-9i0j-k1l2m3n4o5p6", "actionDelay": 1500, "parameterOverrides": {}}
       responses:
         "201":
           application/json: {"executionId": "rpa_1695872345678", "recordingId": "a1b2c3d4-e5f6-7g8h-9i0j-k1l2m3n4o5p6", "status": "running", "currentActionIndex": 3, "totalActions": 15, "startedAt": 1695872345678, "operatorType": "browser", "errorMessage": "Failed to execute click action: Element not found"}
@@ -519,7 +525,7 @@ examples:
   uploadVideo:
     speakeasy-default-upload-video:
       requestBody:
-        multipart/form-data: {"file": {"": "x-file: example.file"}}
+        multipart/form-data: {"file": "x-file: example.file"}
       responses:
         "200":
           application/json: {"analysisId": "1682598432741", "originalVideo": "recording-1682598432741.mp4", "processedVideo": "processed-recording-1682598432741.mp4", "message": "Video uploaded and analyzed successfully"}
@@ -549,7 +555,7 @@ examples:
   uploadFile:
     speakeasy-default-upload-file:
       requestBody:
-        multipart/form-data: {"file": {"": "x-file: example.file"}}
+        multipart/form-data: {"file": "x-file: example.file"}
       responses:
         "200":
           application/json: {"fileId": "1682598432741", "fileName": "document-1682598432741.pdf", "filePath": "/Users/username/.iris/files/document-1682598432741.pdf", "fileUrl": "/api/files/download/document-1682598432741.pdf", "fileSize": 24560, "mimeType": "application/pdf", "message": "File uploaded successfully"}

.speakeasy/gen.yaml

@@ -7,6 +7,7 @@ generation:
   maintainOpenAPIOrder: true
   usageSnippets:
     optionalPropertyRendering: withExample
+    sdkInitStyle: constructor
   useClassNamesForArrayFields: true
   fixes:
     nameResolutionDec2023: true
@@ -16,17 +17,23 @@ generation:
     securityFeb2025: false
     sharedErrorComponentsApr2025: false
   auth:
-    oAuth2ClientCredentialsEnabled: true
-    oAuth2PasswordEnabled: true
+    oAuth2ClientCredentialsEnabled: false
+    oAuth2PasswordEnabled: false
+  tests:
+    generateTests: true
+    generateNewTests: false
+    skipResponseBodyAssertions: false
 typescript:
-  version: 0.2.1
+  version: 0.3.0
   additionalDependencies:
     dependencies: {}
     devDependencies: {}
     peerDependencies: {}
   additionalPackageJSON: {}
   author: Speakeasy
+  baseErrorName: IrisSDKError
   clientServerStatusCodesAsErrors: true
+  constFieldsAlwaysOptional: true
   defaultErrorName: APIError
   enableCustomCodeRegions: false
   enableMCPServer: true
@@ -35,6 +42,7 @@ typescript:
   envVarPrefix: IRISSDK
   flattenGlobalSecurity: true
   flatteningOrder: parameters-first
+  generateExamples: true
   imports:
     option: openapi
     paths:

.speakeasy/workflow.lock

@@ -1,21 +1,21 @@
-speakeasyVersion: 1.546.1
+speakeasyVersion: 1.587.1
 sources:
     Zenobia Intelligent Automation Platform API:
         sourceNamespace: zenobia-intelligent-automation-platform-api
-        sourceRevisionDigest: sha256:a15d5da61636ad8a483d17cd642ec2f118a0dfe06cf0fffc513162d3cbc5867e
-        sourceBlobDigest: sha256:0c8d7bd4c35bf5b9ffa4817986135614df2bde763eaece2e154c49865c8ef6c5
+        sourceRevisionDigest: sha256:5691d4cf2db75dd9126cd0d8b6c05c473d64a9d4cdf4750f63464098dad55d61
+        sourceBlobDigest: sha256:ea2887935810946fbc2bda55b3cdf90fdcbf3a01cc47ae45ecf5556872db5cd8
         tags:
             - latest
-            - speakeasy-sdk-regen-1747505453
+            - speakeasy-sdk-regen-1752111786
             - 0.1.0
 targets:
     iris-sdk:
         source: Zenobia Intelligent Automation Platform API
         sourceNamespace: zenobia-intelligent-automation-platform-api
-        sourceRevisionDigest: sha256:a15d5da61636ad8a483d17cd642ec2f118a0dfe06cf0fffc513162d3cbc5867e
-        sourceBlobDigest: sha256:0c8d7bd4c35bf5b9ffa4817986135614df2bde763eaece2e154c49865c8ef6c5
+        sourceRevisionDigest: sha256:5691d4cf2db75dd9126cd0d8b6c05c473d64a9d4cdf4750f63464098dad55d61
+        sourceBlobDigest: sha256:ea2887935810946fbc2bda55b3cdf90fdcbf3a01cc47ae45ecf5556872db5cd8
         codeSamplesNamespace: zenobia-intelligent-automation-platform-api-typescript-code-samples
-        codeSamplesRevisionDigest: sha256:9ce126259d3c32437284a0100c9f9c3a8bdfcd54a630d6642b752ccaa7f356ba
+        codeSamplesRevisionDigest: sha256:b5c0efb7dd999be0d0ef0e9aa84431202142d5942b21cd5433b06e872147780a
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest

FUNCTIONS.md

@@ -21,36 +21,19 @@ specific category of applications.
 ```typescript
 import { IrisSDKCore } from "iris-sdk/core.js";
 import { configGet } from "iris-sdk/funcs/configGet.js";
-import { SDKValidationError } from "iris-sdk/models/errors/sdkvalidationerror.js";
 
 // Use `IrisSDKCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const irisSDK = new IrisSDKCore();
 
 async function run() {
   const res = await configGet(irisSDK);
-
-  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("configGet failed:", res.error);
   }
-
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

README.md

@@ -192,7 +192,6 @@ const irisSDK = new IrisSDK();
 async function run() {
   const result = await irisSDK.config.get();
 
-  // Handle the result
   console.log(result);
 }
 
@@ -358,7 +357,6 @@ async function run() {
     file: await openAsBlob("example.file"),
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -392,7 +390,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -420,7 +417,6 @@ const irisSDK = new IrisSDK({
 async function run() {
   const result = await irisSDK.config.get();
 
-  // Handle the result
   console.log(result);
 }
 
@@ -432,47 +428,34 @@ run();
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
-If the request fails due to, for example 4XX or 5XX status codes, it will throw a `APIError`.
+[`IrisSDKError`](./src/models/errors/irissdkerror.ts) is the base class for all HTTP error responses. It has the following properties:
 
-| Error Type      | Status Code | Content Type |
-| --------------- | ----------- | ------------ |
-| errors.APIError | 4XX, 5XX    | \*/\*        |
+| 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                                      |
 
+### Example
 ```typescript
 import { IrisSDK } from "iris-sdk";
-import { SDKValidationError } from "iris-sdk/models/errors";
+import * as errors from "iris-sdk/models/errors";
 
 const irisSDK = new IrisSDK();
 
 async function run() {
-  let result;
   try {
-    result = await irisSDK.config.get();
+    const result = await irisSDK.config.get();
 
-    // 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;
-        }
-        apierror.js;
-      // Server returned an error status code or an unknown content type
-      case (err instanceof APIError): {
-        console.error(err.statusCode);
-        console.error(err.rawResponse.body);
-        return;
-      }
-      default: {
-        // Other errors such as network errors, see HTTPClientErrors for more details
-        throw err;
-      }
+  } catch (error) {
+    if (error instanceof errors.IrisSDKError) {
+      console.log(error.message);
+      console.log(error.statusCode);
+      console.log(error.body);
+      console.log(error.headers);
     }
   }
 }
@@ -481,17 +464,26 @@ 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 error:**
+* [`IrisSDKError`](./src/models/errors/irissdkerror.ts): The base class for HTTP error responses.
+
+<details><summary>Less common errors (6)</summary>
+
+<br />
 
-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:
+**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.
 
-| 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                     |
+
+**Inherit from [`IrisSDKError`](./src/models/errors/irissdkerror.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 Server Selection [server] -->
@@ -510,7 +502,6 @@ const irisSDK = new IrisSDK({
 async function run() {
   const result = await irisSDK.config.get();
 
-  // Handle the result
   console.log(result);
 }
 

RELEASES.md

@@ -14,4 +14,12 @@ Based on:
 - OpenAPI Doc  
 - Speakeasy CLI 1.546.1 (2.604.2) https://github.com/speakeasy-api/speakeasy
 ### Generated
-- [typescript v0.2.1] .
+- [typescript v0.2.1] .
+
+## 2025-07-24 01:46:37
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.587.1 (2.662.0) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.3.0] .

USAGE.md

@@ -7,7 +7,6 @@ const irisSDK = new IrisSDK();
 async function run() {
   const result = await irisSDK.config.get();
 
-  // Handle the result
   console.log(result);
 }
 

docs/models/components/batchexecuterpadto.md

@@ -7,6 +7,7 @@ import { BatchExecuteRpaDto } from "iris-sdk/models/components";
 
 let value: BatchExecuteRpaDto = {
   recordingId: "a1b2c3d4-e5f6-7g8h-9i0j-k1l2m3n4o5p6",
+  actionDelay: 1500,
   parameterSets: [
     "{\"name\":\"Run 1\",\"parameterOverrides\":{\"2.action_inputs.content\":\"First search term\"}}",
     "{\"name\":\"Run 2\",\"parameterOverrides\":{\"2.action_inputs.content\":\"Second search term\"}}",