@aui.io/aui-client 1.2.26 → 1.2.27

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/dist/cjs/Client.js +2 -2
  2. package/dist/cjs/api/resources/apolloWsSession/client/index.d.ts +1 -1
  3. package/dist/cjs/api/resources/apolloWsSession/client/index.js +3 -0
  4. package/dist/cjs/api/resources/controllerApi/client/Client.d.ts +13 -0
  5. package/dist/cjs/api/resources/controllerApi/client/Client.js +63 -0
  6. package/dist/cjs/api/types/WorkflowMetadata.d.ts +7 -0
  7. package/dist/cjs/api/types/WorkflowMetadata.js +3 -0
  8. package/dist/cjs/api/types/WorkflowsMetadataResponse.d.ts +4 -0
  9. package/dist/cjs/api/types/WorkflowsMetadataResponse.js +3 -0
  10. package/dist/cjs/api/types/index.d.ts +2 -0
  11. package/dist/cjs/api/types/index.js +2 -0
  12. package/dist/cjs/exports.d.ts +7 -1
  13. package/dist/cjs/exports.js +11 -15
  14. package/dist/cjs/version.d.ts +1 -1
  15. package/dist/cjs/version.js +1 -1
  16. package/dist/esm/Client.mjs +2 -2
  17. package/dist/esm/api/resources/apolloWsSession/client/index.d.mts +1 -1
  18. package/dist/esm/api/resources/apolloWsSession/client/index.mjs +1 -1
  19. package/dist/esm/api/resources/controllerApi/client/Client.d.mts +13 -0
  20. package/dist/esm/api/resources/controllerApi/client/Client.mjs +63 -0
  21. package/dist/esm/api/types/WorkflowMetadata.d.mts +7 -0
  22. package/dist/esm/api/types/WorkflowMetadata.mjs +2 -0
  23. package/dist/esm/api/types/WorkflowsMetadataResponse.d.mts +4 -0
  24. package/dist/esm/api/types/WorkflowsMetadataResponse.mjs +2 -0
  25. package/dist/esm/api/types/index.d.mts +2 -0
  26. package/dist/esm/api/types/index.mjs +2 -0
  27. package/dist/esm/exports.d.mts +7 -1
  28. package/dist/esm/exports.mjs +9 -1
  29. package/dist/esm/version.d.mts +1 -1
  30. package/dist/esm/version.mjs +1 -1
  31. package/package.json +1 -1
  32. package/reference.md +56 -0
@@ -45,8 +45,8 @@ class ApolloClient {
45
45
  "x-network-api-key": _options === null || _options === void 0 ? void 0 : _options.networkApiKey,
46
46
  "X-Fern-Language": "JavaScript",
47
47
  "X-Fern-SDK-Name": "@aui.io/aui-client",
48
- "X-Fern-SDK-Version": "1.2.26",
49
- "User-Agent": "@aui.io/aui-client/1.2.26",
48
+ "X-Fern-SDK-Version": "1.2.27",
49
+ "User-Agent": "@aui.io/aui-client/1.2.27",
50
50
  "X-Fern-Runtime": core.RUNTIME.type,
51
51
  "X-Fern-Runtime-Version": core.RUNTIME.version,
52
52
  }, _options === null || _options === void 0 ? void 0 : _options.headers) });
@@ -1 +1 @@
1
- export {};
1
+ export { ApolloWsSessionSocket } from "./Socket.js";
@@ -1,2 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ApolloWsSessionSocket = void 0;
4
+ var Socket_js_1 = require("./Socket.js");
5
+ Object.defineProperty(exports, "ApolloWsSessionSocket", { enumerable: true, get: function () { return Socket_js_1.ApolloWsSessionSocket; } });
@@ -78,4 +78,17 @@ export declare class ControllerApi {
78
78
  */
79
79
  getProductMetadata(request: Apollo.GetProductMetadataRequest, requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Record<string, unknown>>;
80
80
  private __getProductMetadata;
81
+ /**
82
+ * Get metadata for all workflows available for the authenticated network.
83
+ * Returns a lean version with essential workflow information.
84
+ *
85
+ * @param {ControllerApi.RequestOptions} requestOptions - Request-specific configuration.
86
+ *
87
+ * @throws {@link Apollo.UnprocessableEntityError}
88
+ *
89
+ * @example
90
+ * await client.controllerApi.getWorkflowsMetadata()
91
+ */
92
+ getWorkflowsMetadata(requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Apollo.WorkflowsMetadataResponse>;
93
+ private __getWorkflowsMetadata;
81
94
  }
@@ -405,5 +405,68 @@ class ControllerApi {
405
405
  }
406
406
  });
407
407
  }
408
+ /**
409
+ * Get metadata for all workflows available for the authenticated network.
410
+ * Returns a lean version with essential workflow information.
411
+ *
412
+ * @param {ControllerApi.RequestOptions} requestOptions - Request-specific configuration.
413
+ *
414
+ * @throws {@link Apollo.UnprocessableEntityError}
415
+ *
416
+ * @example
417
+ * await client.controllerApi.getWorkflowsMetadata()
418
+ */
419
+ getWorkflowsMetadata(requestOptions) {
420
+ return core.HttpResponsePromise.fromPromise(this.__getWorkflowsMetadata(requestOptions));
421
+ }
422
+ __getWorkflowsMetadata(requestOptions) {
423
+ return __awaiter(this, void 0, void 0, function* () {
424
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
425
+ const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
426
+ "x-network-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.networkApiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.networkApiKey,
427
+ }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
428
+ const _response = yield core.fetcher({
429
+ url: core.url.join((_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : ((_e = (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ApolloEnvironment.Gcp).base, "api/v1/external/workflows/metadata"),
430
+ method: "GET",
431
+ headers: _headers,
432
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
433
+ timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
434
+ maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
435
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
436
+ fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
437
+ logging: this._options.logging,
438
+ });
439
+ if (_response.ok) {
440
+ return { data: _response.body, rawResponse: _response.rawResponse };
441
+ }
442
+ if (_response.error.reason === "status-code") {
443
+ switch (_response.error.statusCode) {
444
+ case 422:
445
+ throw new Apollo.UnprocessableEntityError(_response.error.body, _response.rawResponse);
446
+ default:
447
+ throw new errors.ApolloError({
448
+ statusCode: _response.error.statusCode,
449
+ body: _response.error.body,
450
+ rawResponse: _response.rawResponse,
451
+ });
452
+ }
453
+ }
454
+ switch (_response.error.reason) {
455
+ case "non-json":
456
+ throw new errors.ApolloError({
457
+ statusCode: _response.error.statusCode,
458
+ body: _response.error.rawBody,
459
+ rawResponse: _response.rawResponse,
460
+ });
461
+ case "timeout":
462
+ throw new errors.ApolloTimeoutError("Timeout exceeded when calling GET /api/v1/external/workflows/metadata.");
463
+ case "unknown":
464
+ throw new errors.ApolloError({
465
+ message: _response.error.errorMessage,
466
+ rawResponse: _response.rawResponse,
467
+ });
468
+ }
469
+ });
470
+ }
408
471
  }
409
472
  exports.ControllerApi = ControllerApi;
@@ -0,0 +1,7 @@
1
+ export interface WorkflowMetadata {
2
+ id: string;
3
+ name: string;
4
+ metadata?: Record<string, unknown>;
5
+ produce_options?: boolean;
6
+ is_internal_context?: boolean;
7
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,4 @@
1
+ import type * as Apollo from "../index.js";
2
+ export interface WorkflowsMetadataResponse {
3
+ workflows?: Apollo.WorkflowMetadata[];
4
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -24,4 +24,6 @@ export * from "./TaskInteractionOptionSelfReviewScoreLabel.js";
24
24
  export * from "./TaskInteractionOptionSelfReviewType.js";
25
25
  export * from "./UserMessagePayload.js";
26
26
  export * from "./ValidationError.js";
27
+ export * from "./WorkflowMetadata.js";
28
+ export * from "./WorkflowsMetadataResponse.js";
27
29
  export * from "./WsActor.js";
@@ -40,4 +40,6 @@ __exportStar(require("./TaskInteractionOptionSelfReviewScoreLabel.js"), exports)
40
40
  __exportStar(require("./TaskInteractionOptionSelfReviewType.js"), exports);
41
41
  __exportStar(require("./UserMessagePayload.js"), exports);
42
42
  __exportStar(require("./ValidationError.js"), exports);
43
+ __exportStar(require("./WorkflowMetadata.js"), exports);
44
+ __exportStar(require("./WorkflowsMetadataResponse.js"), exports);
43
45
  __exportStar(require("./WsActor.js"), exports);
@@ -1 +1,7 @@
1
- export * from "./core/exports.js";
1
+ /**
2
+ * Custom exports for the Apollo SDK
3
+ *
4
+ * This file is in .fernignore and won't be overwritten by Fern generation.
5
+ * Add any custom exports here that need to be available at the package root.
6
+ */
7
+ export { ApolloWsSessionSocket } from "./api/resources/apolloWsSession/client/Socket.js";
@@ -1,17 +1,13 @@
1
1
  "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
2
+ /**
3
+ * Custom exports for the Apollo SDK
4
+ *
5
+ * This file is in .fernignore and won't be overwritten by Fern generation.
6
+ * Add any custom exports here that need to be available at the package root.
7
+ */
16
8
  Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./core/exports.js"), exports);
9
+ exports.ApolloWsSessionSocket = void 0;
10
+ // Direct export of WebSocket Socket class for TypeScript users
11
+ // This allows: import { ApolloWsSessionSocket } from '@aui.io/aui-client'
12
+ var Socket_js_1 = require("./api/resources/apolloWsSession/client/Socket.js");
13
+ Object.defineProperty(exports, "ApolloWsSessionSocket", { enumerable: true, get: function () { return Socket_js_1.ApolloWsSessionSocket; } });
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "1.2.26";
1
+ export declare const SDK_VERSION = "1.2.27";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "1.2.26";
4
+ exports.SDK_VERSION = "1.2.27";
@@ -9,8 +9,8 @@ export class ApolloClient {
9
9
  "x-network-api-key": _options === null || _options === void 0 ? void 0 : _options.networkApiKey,
10
10
  "X-Fern-Language": "JavaScript",
11
11
  "X-Fern-SDK-Name": "@aui.io/aui-client",
12
- "X-Fern-SDK-Version": "1.2.26",
13
- "User-Agent": "@aui.io/aui-client/1.2.26",
12
+ "X-Fern-SDK-Version": "1.2.27",
13
+ "User-Agent": "@aui.io/aui-client/1.2.27",
14
14
  "X-Fern-Runtime": core.RUNTIME.type,
15
15
  "X-Fern-Runtime-Version": core.RUNTIME.version,
16
16
  }, _options === null || _options === void 0 ? void 0 : _options.headers) });
@@ -1 +1 @@
1
- export {};
1
+ export { ApolloWsSessionSocket } from "./Socket.mjs";
@@ -1 +1 @@
1
- export {};
1
+ export { ApolloWsSessionSocket } from "./Socket.mjs";
@@ -78,4 +78,17 @@ export declare class ControllerApi {
78
78
  */
79
79
  getProductMetadata(request: Apollo.GetProductMetadataRequest, requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Record<string, unknown>>;
80
80
  private __getProductMetadata;
81
+ /**
82
+ * Get metadata for all workflows available for the authenticated network.
83
+ * Returns a lean version with essential workflow information.
84
+ *
85
+ * @param {ControllerApi.RequestOptions} requestOptions - Request-specific configuration.
86
+ *
87
+ * @throws {@link Apollo.UnprocessableEntityError}
88
+ *
89
+ * @example
90
+ * await client.controllerApi.getWorkflowsMetadata()
91
+ */
92
+ getWorkflowsMetadata(requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Apollo.WorkflowsMetadataResponse>;
93
+ private __getWorkflowsMetadata;
81
94
  }
@@ -369,4 +369,67 @@ export class ControllerApi {
369
369
  }
370
370
  });
371
371
  }
372
+ /**
373
+ * Get metadata for all workflows available for the authenticated network.
374
+ * Returns a lean version with essential workflow information.
375
+ *
376
+ * @param {ControllerApi.RequestOptions} requestOptions - Request-specific configuration.
377
+ *
378
+ * @throws {@link Apollo.UnprocessableEntityError}
379
+ *
380
+ * @example
381
+ * await client.controllerApi.getWorkflowsMetadata()
382
+ */
383
+ getWorkflowsMetadata(requestOptions) {
384
+ return core.HttpResponsePromise.fromPromise(this.__getWorkflowsMetadata(requestOptions));
385
+ }
386
+ __getWorkflowsMetadata(requestOptions) {
387
+ return __awaiter(this, void 0, void 0, function* () {
388
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
389
+ const _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({
390
+ "x-network-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.networkApiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.networkApiKey,
391
+ }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
392
+ const _response = yield core.fetcher({
393
+ url: core.url.join((_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : ((_e = (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ApolloEnvironment.Gcp).base, "api/v1/external/workflows/metadata"),
394
+ method: "GET",
395
+ headers: _headers,
396
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
397
+ timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
398
+ maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
399
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
400
+ fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
401
+ logging: this._options.logging,
402
+ });
403
+ if (_response.ok) {
404
+ return { data: _response.body, rawResponse: _response.rawResponse };
405
+ }
406
+ if (_response.error.reason === "status-code") {
407
+ switch (_response.error.statusCode) {
408
+ case 422:
409
+ throw new Apollo.UnprocessableEntityError(_response.error.body, _response.rawResponse);
410
+ default:
411
+ throw new errors.ApolloError({
412
+ statusCode: _response.error.statusCode,
413
+ body: _response.error.body,
414
+ rawResponse: _response.rawResponse,
415
+ });
416
+ }
417
+ }
418
+ switch (_response.error.reason) {
419
+ case "non-json":
420
+ throw new errors.ApolloError({
421
+ statusCode: _response.error.statusCode,
422
+ body: _response.error.rawBody,
423
+ rawResponse: _response.rawResponse,
424
+ });
425
+ case "timeout":
426
+ throw new errors.ApolloTimeoutError("Timeout exceeded when calling GET /api/v1/external/workflows/metadata.");
427
+ case "unknown":
428
+ throw new errors.ApolloError({
429
+ message: _response.error.errorMessage,
430
+ rawResponse: _response.rawResponse,
431
+ });
432
+ }
433
+ });
434
+ }
372
435
  }
@@ -0,0 +1,7 @@
1
+ export interface WorkflowMetadata {
2
+ id: string;
3
+ name: string;
4
+ metadata?: Record<string, unknown>;
5
+ produce_options?: boolean;
6
+ is_internal_context?: boolean;
7
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,4 @@
1
+ import type * as Apollo from "../index.mjs";
2
+ export interface WorkflowsMetadataResponse {
3
+ workflows?: Apollo.WorkflowMetadata[];
4
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -24,4 +24,6 @@ export * from "./TaskInteractionOptionSelfReviewScoreLabel.mjs";
24
24
  export * from "./TaskInteractionOptionSelfReviewType.mjs";
25
25
  export * from "./UserMessagePayload.mjs";
26
26
  export * from "./ValidationError.mjs";
27
+ export * from "./WorkflowMetadata.mjs";
28
+ export * from "./WorkflowsMetadataResponse.mjs";
27
29
  export * from "./WsActor.mjs";
@@ -24,4 +24,6 @@ export * from "./TaskInteractionOptionSelfReviewScoreLabel.mjs";
24
24
  export * from "./TaskInteractionOptionSelfReviewType.mjs";
25
25
  export * from "./UserMessagePayload.mjs";
26
26
  export * from "./ValidationError.mjs";
27
+ export * from "./WorkflowMetadata.mjs";
28
+ export * from "./WorkflowsMetadataResponse.mjs";
27
29
  export * from "./WsActor.mjs";
@@ -1 +1,7 @@
1
- export * from "./core/exports.mjs";
1
+ /**
2
+ * Custom exports for the Apollo SDK
3
+ *
4
+ * This file is in .fernignore and won't be overwritten by Fern generation.
5
+ * Add any custom exports here that need to be available at the package root.
6
+ */
7
+ export { ApolloWsSessionSocket } from "./api/resources/apolloWsSession/client/Socket.mjs";
@@ -1 +1,9 @@
1
- export * from "./core/exports.mjs";
1
+ /**
2
+ * Custom exports for the Apollo SDK
3
+ *
4
+ * This file is in .fernignore and won't be overwritten by Fern generation.
5
+ * Add any custom exports here that need to be available at the package root.
6
+ */
7
+ // Direct export of WebSocket Socket class for TypeScript users
8
+ // This allows: import { ApolloWsSessionSocket } from '@aui.io/aui-client'
9
+ export { ApolloWsSessionSocket } from "./api/resources/apolloWsSession/client/Socket.mjs";
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "1.2.26";
1
+ export declare const SDK_VERSION = "1.2.27";
@@ -1 +1 @@
1
- export const SDK_VERSION = "1.2.26";
1
+ export const SDK_VERSION = "1.2.27";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aui.io/aui-client",
3
- "version": "1.2.26",
3
+ "version": "1.2.27",
4
4
  "private": false,
5
5
  "repository": "github:aui-io/aui-client-typescript",
6
6
  "type": "commonjs",
package/reference.md CHANGED
@@ -254,6 +254,62 @@ await client.controllerApi.getProductMetadata({
254
254
  </dl>
255
255
 
256
256
 
257
+ </dd>
258
+ </dl>
259
+ </details>
260
+
261
+ <details><summary><code>client.controllerApi.<a href="/src/api/resources/controllerApi/client/Client.ts">getWorkflowsMetadata</a>() -> Apollo.WorkflowsMetadataResponse</code></summary>
262
+ <dl>
263
+ <dd>
264
+
265
+ #### 📝 Description
266
+
267
+ <dl>
268
+ <dd>
269
+
270
+ <dl>
271
+ <dd>
272
+
273
+ Get metadata for all workflows available for the authenticated network.
274
+ Returns a lean version with essential workflow information.
275
+ </dd>
276
+ </dl>
277
+ </dd>
278
+ </dl>
279
+
280
+ #### 🔌 Usage
281
+
282
+ <dl>
283
+ <dd>
284
+
285
+ <dl>
286
+ <dd>
287
+
288
+ ```typescript
289
+ await client.controllerApi.getWorkflowsMetadata();
290
+
291
+ ```
292
+ </dd>
293
+ </dl>
294
+ </dd>
295
+ </dl>
296
+
297
+ #### ⚙️ Parameters
298
+
299
+ <dl>
300
+ <dd>
301
+
302
+ <dl>
303
+ <dd>
304
+
305
+ **requestOptions:** `ControllerApi.RequestOptions`
306
+
307
+ </dd>
308
+ </dl>
309
+ </dd>
310
+ </dl>
311
+
312
+
257
313
  </dd>
258
314
  </dl>
259
315
  </details>