@aui.io/aui-client 1.2.16 → 1.2.17

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 (62) hide show
  1. package/dist/cjs/Client.js +2 -2
  2. package/dist/cjs/api/resources/controllerApi/client/Client.d.ts +13 -0
  3. package/dist/cjs/api/resources/controllerApi/client/Client.js +67 -0
  4. package/dist/cjs/api/resources/controllerApi/client/requests/GetProductMetadataRequest.d.ts +9 -0
  5. package/dist/cjs/api/resources/controllerApi/client/requests/GetProductMetadataRequest.js +3 -0
  6. package/dist/cjs/api/resources/controllerApi/client/requests/index.d.ts +1 -0
  7. package/dist/cjs/api/types/Card.d.ts +4 -0
  8. package/dist/cjs/api/types/CardParameter.d.ts +1 -0
  9. package/dist/cjs/api/types/Context.d.ts +1 -0
  10. package/dist/cjs/api/types/Message.d.ts +2 -0
  11. package/dist/cjs/api/types/MessageCardParameter.d.ts +8 -0
  12. package/dist/cjs/api/types/MessageCardParameter.js +3 -0
  13. package/dist/cjs/api/types/MessageCardSubEntity.d.ts +5 -0
  14. package/dist/cjs/api/types/MessageCardSubEntity.js +3 -0
  15. package/dist/cjs/api/types/MessageCardSubEntityItem.d.ts +5 -0
  16. package/dist/cjs/api/types/MessageCardSubEntityItem.js +3 -0
  17. package/dist/cjs/api/types/OptionsSearchSelfReviewMethod.d.ts +10 -0
  18. package/dist/cjs/api/types/OptionsSearchSelfReviewMethod.js +13 -0
  19. package/dist/cjs/api/types/TaskInteractionOptionSelfReview.d.ts +8 -0
  20. package/dist/cjs/api/types/TaskInteractionOptionSelfReview.js +3 -0
  21. package/dist/cjs/api/types/TaskInteractionOptionSelfReviewScore.d.ts +6 -0
  22. package/dist/cjs/api/types/TaskInteractionOptionSelfReviewScore.js +3 -0
  23. package/dist/cjs/api/types/TaskInteractionOptionSelfReviewScoreLabel.d.ts +6 -0
  24. package/dist/cjs/api/types/TaskInteractionOptionSelfReviewScoreLabel.js +9 -0
  25. package/dist/cjs/api/types/TaskInteractionOptionSelfReviewType.d.ts +1 -0
  26. package/dist/cjs/api/types/TaskInteractionOptionSelfReviewType.js +3 -0
  27. package/dist/cjs/api/types/index.d.ts +8 -0
  28. package/dist/cjs/api/types/index.js +8 -0
  29. package/dist/cjs/version.d.ts +1 -1
  30. package/dist/cjs/version.js +1 -1
  31. package/dist/esm/Client.mjs +2 -2
  32. package/dist/esm/api/resources/controllerApi/client/Client.d.mts +13 -0
  33. package/dist/esm/api/resources/controllerApi/client/Client.mjs +67 -0
  34. package/dist/esm/api/resources/controllerApi/client/requests/GetProductMetadataRequest.d.mts +9 -0
  35. package/dist/esm/api/resources/controllerApi/client/requests/GetProductMetadataRequest.mjs +2 -0
  36. package/dist/esm/api/resources/controllerApi/client/requests/index.d.mts +1 -0
  37. package/dist/esm/api/types/Card.d.mts +4 -0
  38. package/dist/esm/api/types/CardParameter.d.mts +1 -0
  39. package/dist/esm/api/types/Context.d.mts +1 -0
  40. package/dist/esm/api/types/Message.d.mts +2 -0
  41. package/dist/esm/api/types/MessageCardParameter.d.mts +8 -0
  42. package/dist/esm/api/types/MessageCardParameter.mjs +2 -0
  43. package/dist/esm/api/types/MessageCardSubEntity.d.mts +5 -0
  44. package/dist/esm/api/types/MessageCardSubEntity.mjs +2 -0
  45. package/dist/esm/api/types/MessageCardSubEntityItem.d.mts +5 -0
  46. package/dist/esm/api/types/MessageCardSubEntityItem.mjs +2 -0
  47. package/dist/esm/api/types/OptionsSearchSelfReviewMethod.d.mts +10 -0
  48. package/dist/esm/api/types/OptionsSearchSelfReviewMethod.mjs +10 -0
  49. package/dist/esm/api/types/TaskInteractionOptionSelfReview.d.mts +8 -0
  50. package/dist/esm/api/types/TaskInteractionOptionSelfReview.mjs +2 -0
  51. package/dist/esm/api/types/TaskInteractionOptionSelfReviewScore.d.mts +6 -0
  52. package/dist/esm/api/types/TaskInteractionOptionSelfReviewScore.mjs +2 -0
  53. package/dist/esm/api/types/TaskInteractionOptionSelfReviewScoreLabel.d.mts +6 -0
  54. package/dist/esm/api/types/TaskInteractionOptionSelfReviewScoreLabel.mjs +6 -0
  55. package/dist/esm/api/types/TaskInteractionOptionSelfReviewType.d.mts +1 -0
  56. package/dist/esm/api/types/TaskInteractionOptionSelfReviewType.mjs +2 -0
  57. package/dist/esm/api/types/index.d.mts +8 -0
  58. package/dist/esm/api/types/index.mjs +8 -0
  59. package/dist/esm/version.d.mts +1 -1
  60. package/dist/esm/version.mjs +1 -1
  61. package/package.json +1 -1
  62. package/reference.md +51 -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.16",
49
- "User-Agent": "@aui.io/aui-client/1.2.16",
48
+ "X-Fern-SDK-Version": "1.2.17",
49
+ "User-Agent": "@aui.io/aui-client/1.2.17",
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) });
@@ -64,4 +64,17 @@ export declare class ControllerApi {
64
64
  */
65
65
  sendMessage(request: Apollo.SubmitMessageRequest, requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Apollo.Message>;
66
66
  private __sendMessage;
67
+ /**
68
+ * @param {Apollo.GetProductMetadataRequest} request
69
+ * @param {ControllerApi.RequestOptions} requestOptions - Request-specific configuration.
70
+ *
71
+ * @throws {@link Apollo.UnprocessableEntityError}
72
+ *
73
+ * @example
74
+ * await client.controllerApi.getProductMetadata({
75
+ * link: "link"
76
+ * })
77
+ */
78
+ getProductMetadata(request: Apollo.GetProductMetadataRequest, requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Record<string, unknown>>;
79
+ private __getProductMetadata;
67
80
  }
@@ -342,5 +342,72 @@ class ControllerApi {
342
342
  }
343
343
  });
344
344
  }
345
+ /**
346
+ * @param {Apollo.GetProductMetadataRequest} request
347
+ * @param {ControllerApi.RequestOptions} requestOptions - Request-specific configuration.
348
+ *
349
+ * @throws {@link Apollo.UnprocessableEntityError}
350
+ *
351
+ * @example
352
+ * await client.controllerApi.getProductMetadata({
353
+ * link: "link"
354
+ * })
355
+ */
356
+ getProductMetadata(request, requestOptions) {
357
+ return core.HttpResponsePromise.fromPromise(this.__getProductMetadata(request, requestOptions));
358
+ }
359
+ __getProductMetadata(request, requestOptions) {
360
+ return __awaiter(this, void 0, void 0, function* () {
361
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
362
+ const { link } = request;
363
+ const _queryParams = {};
364
+ _queryParams.link = link;
365
+ const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
366
+ "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,
367
+ }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
368
+ const _response = yield core.fetcher({
369
+ 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.Default)
370
+ .base, "api/v1/external/product-metadata"),
371
+ method: "GET",
372
+ headers: _headers,
373
+ queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
374
+ 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,
375
+ 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,
376
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
377
+ fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
378
+ logging: this._options.logging,
379
+ });
380
+ if (_response.ok) {
381
+ return { data: _response.body, rawResponse: _response.rawResponse };
382
+ }
383
+ if (_response.error.reason === "status-code") {
384
+ switch (_response.error.statusCode) {
385
+ case 422:
386
+ throw new Apollo.UnprocessableEntityError(_response.error.body, _response.rawResponse);
387
+ default:
388
+ throw new errors.ApolloError({
389
+ statusCode: _response.error.statusCode,
390
+ body: _response.error.body,
391
+ rawResponse: _response.rawResponse,
392
+ });
393
+ }
394
+ }
395
+ switch (_response.error.reason) {
396
+ case "non-json":
397
+ throw new errors.ApolloError({
398
+ statusCode: _response.error.statusCode,
399
+ body: _response.error.rawBody,
400
+ rawResponse: _response.rawResponse,
401
+ });
402
+ case "timeout":
403
+ throw new errors.ApolloTimeoutError("Timeout exceeded when calling GET /api/v1/external/product-metadata.");
404
+ case "unknown":
405
+ throw new errors.ApolloError({
406
+ message: _response.error.errorMessage,
407
+ rawResponse: _response.rawResponse,
408
+ });
409
+ }
410
+ });
411
+ }
345
412
  }
346
413
  exports.ControllerApi = ControllerApi;
@@ -0,0 +1,9 @@
1
+ /**
2
+ * @example
3
+ * {
4
+ * link: "link"
5
+ * }
6
+ */
7
+ export interface GetProductMetadataRequest {
8
+ link: string;
9
+ }
@@ -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 });
@@ -1,3 +1,4 @@
1
1
  export type { CreateTaskRequest } from "./CreateTaskRequest.js";
2
+ export type { GetProductMetadataRequest } from "./GetProductMetadataRequest.js";
2
3
  export type { ListUserTasksRequest } from "./ListUserTasksRequest.js";
3
4
  export type { SubmitMessageRequest } from "./SubmitMessageRequest.js";
@@ -2,6 +2,10 @@ import type * as Apollo from "../index.js";
2
2
  export interface Card {
3
3
  id: string;
4
4
  name: string;
5
+ category: string;
6
+ query?: Record<string, unknown>;
5
7
  parameters: Apollo.CardParameter[];
8
+ sub_entities?: Apollo.MessageCardSubEntity[];
9
+ self_review?: Apollo.TaskInteractionOptionSelfReview;
6
10
  is_recommended: boolean;
7
11
  }
@@ -1,5 +1,6 @@
1
1
  import type * as Apollo from "../index.js";
2
2
  export interface CardParameter {
3
+ param: string;
3
4
  title: string;
4
5
  value?: unknown;
5
6
  type: Apollo.ParameterType;
@@ -1,4 +1,5 @@
1
1
  export interface Context {
2
2
  url?: string;
3
3
  lead_details?: Record<string, unknown>;
4
+ welcome_message?: string;
4
5
  }
@@ -6,5 +6,7 @@ export interface Message {
6
6
  sender: Apollo.MessageContactParty;
7
7
  receiver: Apollo.MessageContactParty;
8
8
  cards: Apollo.Card[];
9
+ welcome_message?: string;
9
10
  followup_suggestions: string[];
11
+ executed_workflows?: string[];
10
12
  }
@@ -0,0 +1,8 @@
1
+ import type * as Apollo from "../index.js";
2
+ export interface MessageCardParameter {
3
+ param: string;
4
+ title: string;
5
+ name?: string;
6
+ value?: unknown;
7
+ type?: Apollo.ParameterType;
8
+ }
@@ -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,5 @@
1
+ import type * as Apollo from "../index.js";
2
+ export interface MessageCardSubEntity {
3
+ name: string;
4
+ items: Apollo.MessageCardSubEntityItem[];
5
+ }
@@ -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,5 @@
1
+ import type * as Apollo from "../index.js";
2
+ export interface MessageCardSubEntityItem {
3
+ parameters: Apollo.MessageCardParameter[];
4
+ index?: number;
5
+ }
@@ -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,10 @@
1
+ export declare const OptionsSearchSelfReviewMethod: {
2
+ readonly InventoryClassification: "INVENTORY_CLASSIFICATION";
3
+ readonly Llm: "LLM";
4
+ readonly LlmPerOption: "LLM_PER_OPTION";
5
+ readonly CrossEncoderRanker: "CROSS_ENCODER_RANKER";
6
+ readonly CohereRanker: "COHERE_RANKER";
7
+ readonly ConstantScore: "CONSTANT_SCORE";
8
+ readonly ParamMatching: "PARAM_MATCHING";
9
+ };
10
+ export type OptionsSearchSelfReviewMethod = (typeof OptionsSearchSelfReviewMethod)[keyof typeof OptionsSearchSelfReviewMethod];
@@ -0,0 +1,13 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.OptionsSearchSelfReviewMethod = void 0;
5
+ exports.OptionsSearchSelfReviewMethod = {
6
+ InventoryClassification: "INVENTORY_CLASSIFICATION",
7
+ Llm: "LLM",
8
+ LlmPerOption: "LLM_PER_OPTION",
9
+ CrossEncoderRanker: "CROSS_ENCODER_RANKER",
10
+ CohereRanker: "COHERE_RANKER",
11
+ ConstantScore: "CONSTANT_SCORE",
12
+ ParamMatching: "PARAM_MATCHING",
13
+ };
@@ -0,0 +1,8 @@
1
+ import type * as Apollo from "../index.js";
2
+ export interface TaskInteractionOptionSelfReview {
3
+ score: Apollo.TaskInteractionOptionSelfReviewScore;
4
+ type: Apollo.TaskInteractionOptionSelfReviewType;
5
+ mismatches?: string[];
6
+ reasons?: string[];
7
+ order?: number;
8
+ }
@@ -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,6 @@
1
+ import type * as Apollo from "../index.js";
2
+ export interface TaskInteractionOptionSelfReviewScore {
3
+ value?: number;
4
+ label: Apollo.TaskInteractionOptionSelfReviewScoreLabel;
5
+ method: Apollo.OptionsSearchSelfReviewMethod;
6
+ }
@@ -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,6 @@
1
+ export declare const TaskInteractionOptionSelfReviewScoreLabel: {
2
+ readonly High: "HIGH";
3
+ readonly Medium: "MEDIUM";
4
+ readonly Low: "LOW";
5
+ };
6
+ export type TaskInteractionOptionSelfReviewScoreLabel = (typeof TaskInteractionOptionSelfReviewScoreLabel)[keyof typeof TaskInteractionOptionSelfReviewScoreLabel];
@@ -0,0 +1,9 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.TaskInteractionOptionSelfReviewScoreLabel = void 0;
5
+ exports.TaskInteractionOptionSelfReviewScoreLabel = {
6
+ High: "HIGH",
7
+ Medium: "MEDIUM",
8
+ Low: "LOW",
9
+ };
@@ -0,0 +1 @@
1
+ export type TaskInteractionOptionSelfReviewType = "WORKFLOW";
@@ -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 });
@@ -8,11 +8,19 @@ export * from "./FinalMessagePayload.js";
8
8
  export * from "./HttpValidationError.js";
9
9
  export * from "./ListTasksResponse.js";
10
10
  export * from "./Message.js";
11
+ export * from "./MessageCardParameter.js";
12
+ export * from "./MessageCardSubEntity.js";
13
+ export * from "./MessageCardSubEntityItem.js";
11
14
  export * from "./MessageContactParty.js";
15
+ export * from "./OptionsSearchSelfReviewMethod.js";
12
16
  export * from "./ParameterType.js";
13
17
  export * from "./ProductCard.js";
14
18
  export * from "./ProductParameter.js";
15
19
  export * from "./StreamingUpdatePayload.js";
20
+ export * from "./TaskInteractionOptionSelfReview.js";
21
+ export * from "./TaskInteractionOptionSelfReviewScore.js";
22
+ export * from "./TaskInteractionOptionSelfReviewScoreLabel.js";
23
+ export * from "./TaskInteractionOptionSelfReviewType.js";
16
24
  export * from "./UserMessagePayload.js";
17
25
  export * from "./ValidationError.js";
18
26
  export * from "./WsActor.js";
@@ -24,11 +24,19 @@ __exportStar(require("./FinalMessagePayload.js"), exports);
24
24
  __exportStar(require("./HttpValidationError.js"), exports);
25
25
  __exportStar(require("./ListTasksResponse.js"), exports);
26
26
  __exportStar(require("./Message.js"), exports);
27
+ __exportStar(require("./MessageCardParameter.js"), exports);
28
+ __exportStar(require("./MessageCardSubEntity.js"), exports);
29
+ __exportStar(require("./MessageCardSubEntityItem.js"), exports);
27
30
  __exportStar(require("./MessageContactParty.js"), exports);
31
+ __exportStar(require("./OptionsSearchSelfReviewMethod.js"), exports);
28
32
  __exportStar(require("./ParameterType.js"), exports);
29
33
  __exportStar(require("./ProductCard.js"), exports);
30
34
  __exportStar(require("./ProductParameter.js"), exports);
31
35
  __exportStar(require("./StreamingUpdatePayload.js"), exports);
36
+ __exportStar(require("./TaskInteractionOptionSelfReview.js"), exports);
37
+ __exportStar(require("./TaskInteractionOptionSelfReviewScore.js"), exports);
38
+ __exportStar(require("./TaskInteractionOptionSelfReviewScoreLabel.js"), exports);
39
+ __exportStar(require("./TaskInteractionOptionSelfReviewType.js"), exports);
32
40
  __exportStar(require("./UserMessagePayload.js"), exports);
33
41
  __exportStar(require("./ValidationError.js"), exports);
34
42
  __exportStar(require("./WsActor.js"), exports);
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "1.2.16";
1
+ export declare const SDK_VERSION = "1.2.17";
@@ -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.16";
4
+ exports.SDK_VERSION = "1.2.17";
@@ -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.16",
13
- "User-Agent": "@aui.io/aui-client/1.2.16",
12
+ "X-Fern-SDK-Version": "1.2.17",
13
+ "User-Agent": "@aui.io/aui-client/1.2.17",
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) });
@@ -64,4 +64,17 @@ export declare class ControllerApi {
64
64
  */
65
65
  sendMessage(request: Apollo.SubmitMessageRequest, requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Apollo.Message>;
66
66
  private __sendMessage;
67
+ /**
68
+ * @param {Apollo.GetProductMetadataRequest} request
69
+ * @param {ControllerApi.RequestOptions} requestOptions - Request-specific configuration.
70
+ *
71
+ * @throws {@link Apollo.UnprocessableEntityError}
72
+ *
73
+ * @example
74
+ * await client.controllerApi.getProductMetadata({
75
+ * link: "link"
76
+ * })
77
+ */
78
+ getProductMetadata(request: Apollo.GetProductMetadataRequest, requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Record<string, unknown>>;
79
+ private __getProductMetadata;
67
80
  }
@@ -306,4 +306,71 @@ export class ControllerApi {
306
306
  }
307
307
  });
308
308
  }
309
+ /**
310
+ * @param {Apollo.GetProductMetadataRequest} request
311
+ * @param {ControllerApi.RequestOptions} requestOptions - Request-specific configuration.
312
+ *
313
+ * @throws {@link Apollo.UnprocessableEntityError}
314
+ *
315
+ * @example
316
+ * await client.controllerApi.getProductMetadata({
317
+ * link: "link"
318
+ * })
319
+ */
320
+ getProductMetadata(request, requestOptions) {
321
+ return core.HttpResponsePromise.fromPromise(this.__getProductMetadata(request, requestOptions));
322
+ }
323
+ __getProductMetadata(request, requestOptions) {
324
+ return __awaiter(this, void 0, void 0, function* () {
325
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
326
+ const { link } = request;
327
+ const _queryParams = {};
328
+ _queryParams.link = link;
329
+ const _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({
330
+ "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,
331
+ }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
332
+ const _response = yield core.fetcher({
333
+ 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.Default)
334
+ .base, "api/v1/external/product-metadata"),
335
+ method: "GET",
336
+ headers: _headers,
337
+ queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
338
+ 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,
339
+ 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,
340
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
341
+ fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
342
+ logging: this._options.logging,
343
+ });
344
+ if (_response.ok) {
345
+ return { data: _response.body, rawResponse: _response.rawResponse };
346
+ }
347
+ if (_response.error.reason === "status-code") {
348
+ switch (_response.error.statusCode) {
349
+ case 422:
350
+ throw new Apollo.UnprocessableEntityError(_response.error.body, _response.rawResponse);
351
+ default:
352
+ throw new errors.ApolloError({
353
+ statusCode: _response.error.statusCode,
354
+ body: _response.error.body,
355
+ rawResponse: _response.rawResponse,
356
+ });
357
+ }
358
+ }
359
+ switch (_response.error.reason) {
360
+ case "non-json":
361
+ throw new errors.ApolloError({
362
+ statusCode: _response.error.statusCode,
363
+ body: _response.error.rawBody,
364
+ rawResponse: _response.rawResponse,
365
+ });
366
+ case "timeout":
367
+ throw new errors.ApolloTimeoutError("Timeout exceeded when calling GET /api/v1/external/product-metadata.");
368
+ case "unknown":
369
+ throw new errors.ApolloError({
370
+ message: _response.error.errorMessage,
371
+ rawResponse: _response.rawResponse,
372
+ });
373
+ }
374
+ });
375
+ }
309
376
  }
@@ -0,0 +1,9 @@
1
+ /**
2
+ * @example
3
+ * {
4
+ * link: "link"
5
+ * }
6
+ */
7
+ export interface GetProductMetadataRequest {
8
+ link: string;
9
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -1,3 +1,4 @@
1
1
  export type { CreateTaskRequest } from "./CreateTaskRequest.mjs";
2
+ export type { GetProductMetadataRequest } from "./GetProductMetadataRequest.mjs";
2
3
  export type { ListUserTasksRequest } from "./ListUserTasksRequest.mjs";
3
4
  export type { SubmitMessageRequest } from "./SubmitMessageRequest.mjs";
@@ -2,6 +2,10 @@ import type * as Apollo from "../index.mjs";
2
2
  export interface Card {
3
3
  id: string;
4
4
  name: string;
5
+ category: string;
6
+ query?: Record<string, unknown>;
5
7
  parameters: Apollo.CardParameter[];
8
+ sub_entities?: Apollo.MessageCardSubEntity[];
9
+ self_review?: Apollo.TaskInteractionOptionSelfReview;
6
10
  is_recommended: boolean;
7
11
  }
@@ -1,5 +1,6 @@
1
1
  import type * as Apollo from "../index.mjs";
2
2
  export interface CardParameter {
3
+ param: string;
3
4
  title: string;
4
5
  value?: unknown;
5
6
  type: Apollo.ParameterType;
@@ -1,4 +1,5 @@
1
1
  export interface Context {
2
2
  url?: string;
3
3
  lead_details?: Record<string, unknown>;
4
+ welcome_message?: string;
4
5
  }
@@ -6,5 +6,7 @@ export interface Message {
6
6
  sender: Apollo.MessageContactParty;
7
7
  receiver: Apollo.MessageContactParty;
8
8
  cards: Apollo.Card[];
9
+ welcome_message?: string;
9
10
  followup_suggestions: string[];
11
+ executed_workflows?: string[];
10
12
  }
@@ -0,0 +1,8 @@
1
+ import type * as Apollo from "../index.mjs";
2
+ export interface MessageCardParameter {
3
+ param: string;
4
+ title: string;
5
+ name?: string;
6
+ value?: unknown;
7
+ type?: Apollo.ParameterType;
8
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,5 @@
1
+ import type * as Apollo from "../index.mjs";
2
+ export interface MessageCardSubEntity {
3
+ name: string;
4
+ items: Apollo.MessageCardSubEntityItem[];
5
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,5 @@
1
+ import type * as Apollo from "../index.mjs";
2
+ export interface MessageCardSubEntityItem {
3
+ parameters: Apollo.MessageCardParameter[];
4
+ index?: number;
5
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,10 @@
1
+ export declare const OptionsSearchSelfReviewMethod: {
2
+ readonly InventoryClassification: "INVENTORY_CLASSIFICATION";
3
+ readonly Llm: "LLM";
4
+ readonly LlmPerOption: "LLM_PER_OPTION";
5
+ readonly CrossEncoderRanker: "CROSS_ENCODER_RANKER";
6
+ readonly CohereRanker: "COHERE_RANKER";
7
+ readonly ConstantScore: "CONSTANT_SCORE";
8
+ readonly ParamMatching: "PARAM_MATCHING";
9
+ };
10
+ export type OptionsSearchSelfReviewMethod = (typeof OptionsSearchSelfReviewMethod)[keyof typeof OptionsSearchSelfReviewMethod];
@@ -0,0 +1,10 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export const OptionsSearchSelfReviewMethod = {
3
+ InventoryClassification: "INVENTORY_CLASSIFICATION",
4
+ Llm: "LLM",
5
+ LlmPerOption: "LLM_PER_OPTION",
6
+ CrossEncoderRanker: "CROSS_ENCODER_RANKER",
7
+ CohereRanker: "COHERE_RANKER",
8
+ ConstantScore: "CONSTANT_SCORE",
9
+ ParamMatching: "PARAM_MATCHING",
10
+ };
@@ -0,0 +1,8 @@
1
+ import type * as Apollo from "../index.mjs";
2
+ export interface TaskInteractionOptionSelfReview {
3
+ score: Apollo.TaskInteractionOptionSelfReviewScore;
4
+ type: Apollo.TaskInteractionOptionSelfReviewType;
5
+ mismatches?: string[];
6
+ reasons?: string[];
7
+ order?: number;
8
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,6 @@
1
+ import type * as Apollo from "../index.mjs";
2
+ export interface TaskInteractionOptionSelfReviewScore {
3
+ value?: number;
4
+ label: Apollo.TaskInteractionOptionSelfReviewScoreLabel;
5
+ method: Apollo.OptionsSearchSelfReviewMethod;
6
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,6 @@
1
+ export declare const TaskInteractionOptionSelfReviewScoreLabel: {
2
+ readonly High: "HIGH";
3
+ readonly Medium: "MEDIUM";
4
+ readonly Low: "LOW";
5
+ };
6
+ export type TaskInteractionOptionSelfReviewScoreLabel = (typeof TaskInteractionOptionSelfReviewScoreLabel)[keyof typeof TaskInteractionOptionSelfReviewScoreLabel];
@@ -0,0 +1,6 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export const TaskInteractionOptionSelfReviewScoreLabel = {
3
+ High: "HIGH",
4
+ Medium: "MEDIUM",
5
+ Low: "LOW",
6
+ };
@@ -0,0 +1 @@
1
+ export type TaskInteractionOptionSelfReviewType = "WORKFLOW";
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -8,11 +8,19 @@ export * from "./FinalMessagePayload.mjs";
8
8
  export * from "./HttpValidationError.mjs";
9
9
  export * from "./ListTasksResponse.mjs";
10
10
  export * from "./Message.mjs";
11
+ export * from "./MessageCardParameter.mjs";
12
+ export * from "./MessageCardSubEntity.mjs";
13
+ export * from "./MessageCardSubEntityItem.mjs";
11
14
  export * from "./MessageContactParty.mjs";
15
+ export * from "./OptionsSearchSelfReviewMethod.mjs";
12
16
  export * from "./ParameterType.mjs";
13
17
  export * from "./ProductCard.mjs";
14
18
  export * from "./ProductParameter.mjs";
15
19
  export * from "./StreamingUpdatePayload.mjs";
20
+ export * from "./TaskInteractionOptionSelfReview.mjs";
21
+ export * from "./TaskInteractionOptionSelfReviewScore.mjs";
22
+ export * from "./TaskInteractionOptionSelfReviewScoreLabel.mjs";
23
+ export * from "./TaskInteractionOptionSelfReviewType.mjs";
16
24
  export * from "./UserMessagePayload.mjs";
17
25
  export * from "./ValidationError.mjs";
18
26
  export * from "./WsActor.mjs";
@@ -8,11 +8,19 @@ export * from "./FinalMessagePayload.mjs";
8
8
  export * from "./HttpValidationError.mjs";
9
9
  export * from "./ListTasksResponse.mjs";
10
10
  export * from "./Message.mjs";
11
+ export * from "./MessageCardParameter.mjs";
12
+ export * from "./MessageCardSubEntity.mjs";
13
+ export * from "./MessageCardSubEntityItem.mjs";
11
14
  export * from "./MessageContactParty.mjs";
15
+ export * from "./OptionsSearchSelfReviewMethod.mjs";
12
16
  export * from "./ParameterType.mjs";
13
17
  export * from "./ProductCard.mjs";
14
18
  export * from "./ProductParameter.mjs";
15
19
  export * from "./StreamingUpdatePayload.mjs";
20
+ export * from "./TaskInteractionOptionSelfReview.mjs";
21
+ export * from "./TaskInteractionOptionSelfReviewScore.mjs";
22
+ export * from "./TaskInteractionOptionSelfReviewScoreLabel.mjs";
23
+ export * from "./TaskInteractionOptionSelfReviewType.mjs";
16
24
  export * from "./UserMessagePayload.mjs";
17
25
  export * from "./ValidationError.mjs";
18
26
  export * from "./WsActor.mjs";
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "1.2.16";
1
+ export declare const SDK_VERSION = "1.2.17";
@@ -1 +1 @@
1
- export const SDK_VERSION = "1.2.16";
1
+ export const SDK_VERSION = "1.2.17";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aui.io/aui-client",
3
- "version": "1.2.16",
3
+ "version": "1.2.17",
4
4
  "private": false,
5
5
  "repository": "github:aui-io/aui-client-typescript",
6
6
  "type": "commonjs",
package/reference.md CHANGED
@@ -202,6 +202,57 @@ await client.controllerApi.sendMessage({
202
202
  </dl>
203
203
 
204
204
 
205
+ </dd>
206
+ </dl>
207
+ </details>
208
+
209
+ <details><summary><code>client.controllerApi.<a href="/src/api/resources/controllerApi/client/Client.ts">getProductMetadata</a>({ ...params }) -> Record<string, unknown></code></summary>
210
+ <dl>
211
+ <dd>
212
+
213
+ #### 🔌 Usage
214
+
215
+ <dl>
216
+ <dd>
217
+
218
+ <dl>
219
+ <dd>
220
+
221
+ ```typescript
222
+ await client.controllerApi.getProductMetadata({
223
+ link: "link"
224
+ });
225
+
226
+ ```
227
+ </dd>
228
+ </dl>
229
+ </dd>
230
+ </dl>
231
+
232
+ #### ⚙️ Parameters
233
+
234
+ <dl>
235
+ <dd>
236
+
237
+ <dl>
238
+ <dd>
239
+
240
+ **request:** `Apollo.GetProductMetadataRequest`
241
+
242
+ </dd>
243
+ </dl>
244
+
245
+ <dl>
246
+ <dd>
247
+
248
+ **requestOptions:** `ControllerApi.RequestOptions`
249
+
250
+ </dd>
251
+ </dl>
252
+ </dd>
253
+ </dl>
254
+
255
+
205
256
  </dd>
206
257
  </dl>
207
258
  </details>