@aui.io/aui-client 1.2.34 → 1.2.35

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 (47) hide show
  1. package/README.md +36 -50
  2. package/dist/cjs/Client.js +2 -2
  3. package/dist/cjs/api/resources/controllerApi/client/Client.d.ts +20 -0
  4. package/dist/cjs/api/resources/controllerApi/client/Client.js +73 -0
  5. package/dist/cjs/api/resources/controllerApi/client/requests/ExternalWidgetRenderRequest.d.ts +21 -0
  6. package/dist/cjs/api/resources/controllerApi/client/requests/ExternalWidgetRenderRequest.js +3 -0
  7. package/dist/cjs/api/resources/controllerApi/client/requests/index.d.ts +1 -0
  8. package/dist/cjs/api/types/TraceDecisionParamsCheck.d.ts +4 -1
  9. package/dist/cjs/api/types/TraceDecisionRuleTriggered.d.ts +1 -1
  10. package/dist/cjs/api/types/TraceDecisionToolTextResponse.d.ts +0 -1
  11. package/dist/cjs/api/types/TraceParamsCheckStatus.d.ts +2 -1
  12. package/dist/cjs/api/types/TraceParamsCheckStatus.js +2 -1
  13. package/dist/cjs/api/types/TraceRuleAction.d.ts +4 -1
  14. package/dist/cjs/api/types/TraceRuleAction.js +4 -1
  15. package/dist/cjs/api/types/TraceRuleMissingInfo.d.ts +10 -0
  16. package/dist/cjs/api/types/TraceRuleMissingInfo.js +3 -0
  17. package/dist/cjs/api/types/TraceRuleParamsMissing.d.ts +6 -1
  18. package/dist/cjs/api/types/WidgetRenderResponse.d.ts +3 -0
  19. package/dist/cjs/api/types/WidgetRenderResponse.js +3 -0
  20. package/dist/cjs/api/types/index.d.ts +2 -0
  21. package/dist/cjs/api/types/index.js +2 -0
  22. package/dist/cjs/version.d.ts +1 -1
  23. package/dist/cjs/version.js +1 -1
  24. package/dist/esm/Client.mjs +2 -2
  25. package/dist/esm/api/resources/controllerApi/client/Client.d.mts +20 -0
  26. package/dist/esm/api/resources/controllerApi/client/Client.mjs +73 -0
  27. package/dist/esm/api/resources/controllerApi/client/requests/ExternalWidgetRenderRequest.d.mts +21 -0
  28. package/dist/esm/api/resources/controllerApi/client/requests/ExternalWidgetRenderRequest.mjs +2 -0
  29. package/dist/esm/api/resources/controllerApi/client/requests/index.d.mts +1 -0
  30. package/dist/esm/api/types/TraceDecisionParamsCheck.d.mts +4 -1
  31. package/dist/esm/api/types/TraceDecisionRuleTriggered.d.mts +1 -1
  32. package/dist/esm/api/types/TraceDecisionToolTextResponse.d.mts +0 -1
  33. package/dist/esm/api/types/TraceParamsCheckStatus.d.mts +2 -1
  34. package/dist/esm/api/types/TraceParamsCheckStatus.mjs +2 -1
  35. package/dist/esm/api/types/TraceRuleAction.d.mts +4 -1
  36. package/dist/esm/api/types/TraceRuleAction.mjs +4 -1
  37. package/dist/esm/api/types/TraceRuleMissingInfo.d.mts +10 -0
  38. package/dist/esm/api/types/TraceRuleMissingInfo.mjs +2 -0
  39. package/dist/esm/api/types/TraceRuleParamsMissing.d.mts +6 -1
  40. package/dist/esm/api/types/WidgetRenderResponse.d.mts +3 -0
  41. package/dist/esm/api/types/WidgetRenderResponse.mjs +2 -0
  42. package/dist/esm/api/types/index.d.mts +2 -0
  43. package/dist/esm/api/types/index.mjs +2 -0
  44. package/dist/esm/version.d.mts +1 -1
  45. package/dist/esm/version.mjs +1 -1
  46. package/package.json +1 -1
  47. package/reference.md +70 -0
package/README.md CHANGED
@@ -271,15 +271,16 @@ Submit a new message to an existing task (non-streaming).
271
271
 
272
272
  ```typescript
273
273
  const messageResponse = await client.controllerApi.sendMessage({
274
- task_id: string, // Task identifier
275
- text: string, // Message text
276
- is_external_api?: boolean, // Optional: mark as external API call
277
- context?: { // Optional: additional context
274
+ task_id: string, // Task identifier
275
+ text: string, // Message text
276
+ is_external_api?: boolean, // Optional: mark as external API call
277
+ include_trace_info?: boolean, // Optional: include trace/debug info in response (NEW)
278
+ context?: { // Optional: additional context
278
279
  url?: string,
279
280
  lead_details?: Record<string, any>,
280
281
  welcome_message?: string
281
282
  },
282
- agent_variables?: Record<string, unknown> // Optional: custom agent variables (NEW in v1.2.28)
283
+ agent_variables?: Record<string, unknown> // Optional: custom agent variables
283
284
  });
284
285
 
285
286
  // Returns: Message - Complete agent response with optional product cards
@@ -325,35 +326,29 @@ const metadata = await client.controllerApi.getProductMetadata({
325
326
  // Returns: Record<string, any> - Product metadata object
326
327
  ```
327
328
 
328
- #### `getAgentContext(request)` - Get Agent Context (NEW in v1.2.28)
329
- Retrieve the agent's context configuration including parameters, entities, and static context.
329
+ #### `getTraceInfo(taskId, messageId)` - Get Trace Info (NEW)
330
+ Retrieve trace/debug information for a specific message. Useful for debugging agent responses and understanding the processing pipeline.
330
331
 
331
332
  ```typescript
332
- const agentContext = await client.controllerApi.getAgentContext({
333
- task_id: 'your-task-id',
334
- query: 'test context'
335
- });
333
+ const traceInfo = await client.controllerApi.getTraceInfo('your-task-id', 'your-message-id');
336
334
 
337
- // Returns: CreateTopicRequestBody - Agent context with:
338
- // - title: string
339
- // - params: TaskParameter[]
340
- // - entities: TaskTopicEntity[]
341
- // - static_context: string
335
+ // Returns: Record<string, any> - Trace information object
342
336
  ```
343
337
 
344
338
  **Example:**
345
339
 
346
340
  ```typescript
347
- // Get agent context to understand available parameters
348
- const context = await client.controllerApi.getAgentContext({
341
+ // First, send a message with trace info enabled
342
+ const message = await client.controllerApi.sendMessage({
349
343
  task_id: 'your-task-id',
350
- query: 'test context'
344
+ text: 'What products do you recommend?',
345
+ is_external_api: true,
346
+ include_trace_info: true
351
347
  });
352
348
 
353
- console.log('Agent Title:', context.title);
354
- console.log('Available Parameters:', context.params?.length);
355
- console.log('Entities:', context.entities?.length);
356
- console.log('Static Context:', context.static_context);
349
+ // Then retrieve the full trace info for that message
350
+ const traceInfo = await client.controllerApi.getTraceInfo('your-task-id', message.id);
351
+ console.log('Trace Info:', traceInfo);
357
352
  ```
358
353
 
359
354
  #### `getDirectFollowupSuggestions(taskId)` - Get Direct Followup Suggestions (NEW in v1.2.28)
@@ -626,7 +621,7 @@ sendContextualMessage('task-123', 'What do you recommend?', {
626
621
  });
627
622
  ```
628
623
 
629
- ### Get Agent Context (NEW in v1.2.28)
624
+ ### Get Trace Info (NEW)
630
625
 
631
626
  ```typescript
632
627
  import { ApolloClient } from '@aui.io/aui-client';
@@ -635,39 +630,30 @@ const client = new ApolloClient({
635
630
  networkApiKey: 'API_KEY_YOUR_KEY_HERE'
636
631
  });
637
632
 
638
- async function exploreAgentCapabilities() {
633
+ async function debugAgentResponse(taskId: string) {
639
634
  try {
640
- // Get the agent's context configuration
641
- const context = await client.controllerApi.getAgentContext({
642
- task_id: 'your-task-id',
643
- query: 'test context'
635
+ // Send a message with trace info enabled
636
+ const message = await client.controllerApi.sendMessage({
637
+ task_id: taskId,
638
+ text: 'What products do you recommend?',
639
+ is_external_api: true,
640
+ include_trace_info: true
644
641
  });
645
-
646
- console.log('Agent Configuration:');
647
- console.log(' Title:', context.title);
648
- console.log(' Static Context:', context.static_context);
649
-
650
- // Explore available parameters
651
- if (context.params && context.params.length > 0) {
652
- console.log('\nAvailable Parameters:');
653
- context.params.forEach(param => {
654
- console.log(` - ${param.title}: ${param.param}`);
655
- });
656
- }
657
-
658
- // Explore entities
659
- if (context.entities && context.entities.length > 0) {
660
- console.log('\nConfigured Entities:', context.entities.length);
661
- }
662
-
663
- return context;
642
+
643
+ console.log('Agent Response:', message.text);
644
+
645
+ // Retrieve the full trace info for debugging
646
+ const traceInfo = await client.controllerApi.getTraceInfo(taskId, message.id);
647
+ console.log('Trace Info:', traceInfo);
648
+
649
+ return traceInfo;
664
650
  } catch (error) {
665
- console.error('Error getting agent context:', error);
651
+ console.error('Error getting trace info:', error);
666
652
  throw error;
667
653
  }
668
654
  }
669
655
 
670
- exploreAgentCapabilities();
656
+ debugAgentResponse('task-123');
671
657
  ```
672
658
 
673
659
  ### Get Direct Followup Suggestions (NEW in v1.2.28)
@@ -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.34",
49
- "User-Agent": "@aui.io/aui-client/1.2.34",
48
+ "X-Fern-SDK-Version": "1.2.35",
49
+ "User-Agent": "@aui.io/aui-client/1.2.35",
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) });
@@ -156,4 +156,24 @@ export declare class ControllerApi {
156
156
  */
157
157
  startTextConversation(request: Apollo.TextConversationInitiateRequest, requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Apollo.TextConversationInitiateResponse>;
158
158
  private __startTextConversation;
159
+ /**
160
+ * Render a widget card from integration data. Authenticates via network API key.
161
+ *
162
+ * @param {Apollo.ExternalWidgetRenderRequest} request
163
+ * @param {ControllerApi.RequestOptions} requestOptions - Request-specific configuration.
164
+ *
165
+ * @throws {@link Apollo.UnprocessableEntityError}
166
+ *
167
+ * @example
168
+ * await client.controllerApi.renderWidget({
169
+ * task_id: "task_id",
170
+ * integration_code: "integration_code",
171
+ * card_template_code: "card_template_code",
172
+ * variables: {
173
+ * "key": "value"
174
+ * }
175
+ * })
176
+ */
177
+ renderWidget(request: Apollo.ExternalWidgetRenderRequest, requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Apollo.WidgetRenderResponse>;
178
+ private __renderWidget;
159
179
  }
@@ -798,5 +798,78 @@ class ControllerApi {
798
798
  }
799
799
  });
800
800
  }
801
+ /**
802
+ * Render a widget card from integration data. Authenticates via network API key.
803
+ *
804
+ * @param {Apollo.ExternalWidgetRenderRequest} request
805
+ * @param {ControllerApi.RequestOptions} requestOptions - Request-specific configuration.
806
+ *
807
+ * @throws {@link Apollo.UnprocessableEntityError}
808
+ *
809
+ * @example
810
+ * await client.controllerApi.renderWidget({
811
+ * task_id: "task_id",
812
+ * integration_code: "integration_code",
813
+ * card_template_code: "card_template_code",
814
+ * variables: {
815
+ * "key": "value"
816
+ * }
817
+ * })
818
+ */
819
+ renderWidget(request, requestOptions) {
820
+ return core.HttpResponsePromise.fromPromise(this.__renderWidget(request, requestOptions));
821
+ }
822
+ __renderWidget(request, requestOptions) {
823
+ return __awaiter(this, void 0, void 0, function* () {
824
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
825
+ const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
826
+ "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,
827
+ }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
828
+ const _response = yield core.fetcher({
829
+ 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/widgets"),
830
+ method: "POST",
831
+ headers: _headers,
832
+ contentType: "application/json",
833
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
834
+ requestType: "json",
835
+ body: request,
836
+ 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,
837
+ 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,
838
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
839
+ fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
840
+ logging: this._options.logging,
841
+ });
842
+ if (_response.ok) {
843
+ return { data: _response.body, rawResponse: _response.rawResponse };
844
+ }
845
+ if (_response.error.reason === "status-code") {
846
+ switch (_response.error.statusCode) {
847
+ case 422:
848
+ throw new Apollo.UnprocessableEntityError(_response.error.body, _response.rawResponse);
849
+ default:
850
+ throw new errors.ApolloError({
851
+ statusCode: _response.error.statusCode,
852
+ body: _response.error.body,
853
+ rawResponse: _response.rawResponse,
854
+ });
855
+ }
856
+ }
857
+ switch (_response.error.reason) {
858
+ case "non-json":
859
+ throw new errors.ApolloError({
860
+ statusCode: _response.error.statusCode,
861
+ body: _response.error.rawBody,
862
+ rawResponse: _response.rawResponse,
863
+ });
864
+ case "timeout":
865
+ throw new errors.ApolloTimeoutError("Timeout exceeded when calling POST /api/v1/external/widgets.");
866
+ case "unknown":
867
+ throw new errors.ApolloError({
868
+ message: _response.error.errorMessage,
869
+ rawResponse: _response.rawResponse,
870
+ });
871
+ }
872
+ });
873
+ }
801
874
  }
802
875
  exports.ControllerApi = ControllerApi;
@@ -0,0 +1,21 @@
1
+ /**
2
+ * @example
3
+ * {
4
+ * task_id: "task_id",
5
+ * integration_code: "integration_code",
6
+ * card_template_code: "card_template_code",
7
+ * variables: {
8
+ * "key": "value"
9
+ * }
10
+ * }
11
+ */
12
+ export interface ExternalWidgetRenderRequest {
13
+ /** Task ID for looking up stored interaction data */
14
+ task_id: string;
15
+ /** Integration name/code (e.g., INVENTORY_SEARCH) */
16
+ integration_code: string;
17
+ /** Card template name for direct lookup */
18
+ card_template_code: string;
19
+ /** Key-value pairs matching integration settings.variables[].key */
20
+ variables: Record<string, unknown>;
21
+ }
@@ -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,4 +1,5 @@
1
1
  export type { CreateTaskRequest } from "./CreateTaskRequest.js";
2
+ export type { ExternalWidgetRenderRequest } from "./ExternalWidgetRenderRequest.js";
2
3
  export type { GetProductMetadataRequest } from "./GetProductMetadataRequest.js";
3
4
  export type { ListUserTasksRequest } from "./ListUserTasksRequest.js";
4
5
  export type { SubmitMessageRequest } from "./SubmitMessageRequest.js";
@@ -3,6 +3,9 @@ export interface TraceDecisionParamsCheck {
3
3
  type?: Apollo.TraceDecisionType;
4
4
  tool: string;
5
5
  status: Apollo.TraceParamsCheckStatus;
6
- missing_params?: string[];
6
+ /** Per mandatory (required) group; inner list = unfilled param codes for that group. */
7
+ required_missing_params_by_group?: string[][];
8
+ /** Per optional group; inner list = unfilled param codes for that group. */
9
+ optional_missing_params_by_group?: string[][];
7
10
  track_id?: string;
8
11
  }
@@ -6,5 +6,5 @@ export interface TraceDecisionRuleTriggered {
6
6
  track_id?: string;
7
7
  }
8
8
  export declare namespace TraceDecisionRuleTriggered {
9
- type Rule = Apollo.TraceRuleBase | Apollo.TraceRuleParamsMissing;
9
+ type Rule = Apollo.TraceRuleBase | Apollo.TraceRuleParamsMissing | Apollo.TraceRuleMissingInfo;
10
10
  }
@@ -7,5 +7,4 @@ export interface TraceDecisionToolTextResponse {
7
7
  track_id?: string;
8
8
  tone_of_voice?: string;
9
9
  brevity?: string;
10
- guideline?: string;
11
10
  }
@@ -1,8 +1,9 @@
1
- /** Schema: all_filled | missing_required | missing_optional_ask_once. */
1
+ /** Schema: all_filled | missing_required | missing_optional | missing_optional_and_required | missing_optional_ask_once. */
2
2
  export declare const TraceParamsCheckStatus: {
3
3
  readonly AllFilled: "all_filled";
4
4
  readonly MissingRequired: "missing_required";
5
5
  readonly MissingOptional: "missing_optional";
6
6
  readonly MissingOptionalAskOnce: "missing_optional_ask_once";
7
+ readonly MissingOptionalAndRequired: "missing_optional_and_required";
7
8
  };
8
9
  export type TraceParamsCheckStatus = (typeof TraceParamsCheckStatus)[keyof typeof TraceParamsCheckStatus];
@@ -2,10 +2,11 @@
2
2
  // This file was auto-generated by Fern from our API Definition.
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.TraceParamsCheckStatus = void 0;
5
- /** Schema: all_filled | missing_required | missing_optional_ask_once. */
5
+ /** Schema: all_filled | missing_required | missing_optional | missing_optional_and_required | missing_optional_ask_once. */
6
6
  exports.TraceParamsCheckStatus = {
7
7
  AllFilled: "all_filled",
8
8
  MissingRequired: "missing_required",
9
9
  MissingOptional: "missing_optional",
10
10
  MissingOptionalAskOnce: "missing_optional_ask_once",
11
+ MissingOptionalAndRequired: "missing_optional_and_required",
11
12
  };
@@ -3,7 +3,10 @@ export declare const TraceRuleAction: {
3
3
  readonly AddRequiredParam: "ADD_REQUIRED_PARAM";
4
4
  readonly AskAQuestion: "ASK_A_QUESTION";
5
5
  readonly Block: "BLOCK";
6
+ readonly PartialBlock: "PARTIAL_BLOCK";
6
7
  readonly Text: "TEXT";
7
- readonly ActivateAnotherTool: "ACTIVATE_ANOTHER_TOOL";
8
+ readonly BlockAndActivateAnotherTool: "BLOCK_AND_ACTIVATE_ANOTHER_TOOL";
9
+ readonly ActivateSubTool: "ACTIVATE_SUB_TOOL";
10
+ readonly Integration: "INTEGRATION";
8
11
  };
9
12
  export type TraceRuleAction = (typeof TraceRuleAction)[keyof typeof TraceRuleAction];
@@ -7,6 +7,9 @@ exports.TraceRuleAction = {
7
7
  AddRequiredParam: "ADD_REQUIRED_PARAM",
8
8
  AskAQuestion: "ASK_A_QUESTION",
9
9
  Block: "BLOCK",
10
+ PartialBlock: "PARTIAL_BLOCK",
10
11
  Text: "TEXT",
11
- ActivateAnotherTool: "ACTIVATE_ANOTHER_TOOL",
12
+ BlockAndActivateAnotherTool: "BLOCK_AND_ACTIVATE_ANOTHER_TOOL",
13
+ ActivateSubTool: "ACTIVATE_SUB_TOOL",
14
+ Integration: "INTEGRATION",
12
15
  };
@@ -0,0 +1,10 @@
1
+ import type * as Apollo from "../index.js";
2
+ export interface TraceRuleMissingInfo {
3
+ type: Apollo.TraceRuleType;
4
+ action?: Apollo.TraceRuleAction;
5
+ reason?: string;
6
+ params_added?: Record<string, unknown>;
7
+ excluded_entities?: string[];
8
+ code?: string;
9
+ required_missing_params_by_group?: string[][];
10
+ }
@@ -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 });
@@ -2,6 +2,11 @@ import type * as Apollo from "../index.js";
2
2
  export interface TraceRuleParamsMissing {
3
3
  type?: Apollo.TraceRuleType;
4
4
  action?: Apollo.TraceRuleAction;
5
- missing_params?: string[];
5
+ status: Apollo.TraceParamsCheckStatus;
6
+ /** Per mandatory group (workflow order); inner list = unfilled param codes. */
7
+ required_missing_params_by_group?: string[][];
8
+ /** Per optional group (workflow order); inner list = unfilled param codes. */
9
+ optional_missing_params_by_group?: string[][];
6
10
  reason?: string;
11
+ code?: string;
7
12
  }
@@ -0,0 +1,3 @@
1
+ export interface WidgetRenderResponse {
2
+ rendered_jsx: string;
3
+ }
@@ -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 });
@@ -75,6 +75,7 @@ export * from "./TraceResponseType.js";
75
75
  export * from "./TraceRestIntegration.js";
76
76
  export * from "./TraceRuleAction.js";
77
77
  export * from "./TraceRuleBase.js";
78
+ export * from "./TraceRuleMissingInfo.js";
78
79
  export * from "./TraceRuleParamsMissing.js";
79
80
  export * from "./TraceRuleType.js";
80
81
  export * from "./TraceSelfReviewEntity.js";
@@ -87,6 +88,7 @@ export * from "./TracSelfReviewSubEntity.js";
87
88
  export * from "./UserMessagePayload.js";
88
89
  export * from "./ValidationError.js";
89
90
  export * from "./VectorSearchTaskInteractionQaAnswerScoreLabel.js";
91
+ export * from "./WidgetRenderResponse.js";
90
92
  export * from "./WorkflowCheckStatus.js";
91
93
  export * from "./WorkflowMetadata.js";
92
94
  export * from "./WorkflowsMetadataResponse.js";
@@ -91,6 +91,7 @@ __exportStar(require("./TraceResponseType.js"), exports);
91
91
  __exportStar(require("./TraceRestIntegration.js"), exports);
92
92
  __exportStar(require("./TraceRuleAction.js"), exports);
93
93
  __exportStar(require("./TraceRuleBase.js"), exports);
94
+ __exportStar(require("./TraceRuleMissingInfo.js"), exports);
94
95
  __exportStar(require("./TraceRuleParamsMissing.js"), exports);
95
96
  __exportStar(require("./TraceRuleType.js"), exports);
96
97
  __exportStar(require("./TraceSelfReviewEntity.js"), exports);
@@ -103,6 +104,7 @@ __exportStar(require("./TracSelfReviewSubEntity.js"), exports);
103
104
  __exportStar(require("./UserMessagePayload.js"), exports);
104
105
  __exportStar(require("./ValidationError.js"), exports);
105
106
  __exportStar(require("./VectorSearchTaskInteractionQaAnswerScoreLabel.js"), exports);
107
+ __exportStar(require("./WidgetRenderResponse.js"), exports);
106
108
  __exportStar(require("./WorkflowCheckStatus.js"), exports);
107
109
  __exportStar(require("./WorkflowMetadata.js"), exports);
108
110
  __exportStar(require("./WorkflowsMetadataResponse.js"), exports);
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "1.2.34";
1
+ export declare const SDK_VERSION = "1.2.35";
@@ -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.34";
4
+ exports.SDK_VERSION = "1.2.35";
@@ -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.34",
13
- "User-Agent": "@aui.io/aui-client/1.2.34",
12
+ "X-Fern-SDK-Version": "1.2.35",
13
+ "User-Agent": "@aui.io/aui-client/1.2.35",
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) });
@@ -156,4 +156,24 @@ export declare class ControllerApi {
156
156
  */
157
157
  startTextConversation(request: Apollo.TextConversationInitiateRequest, requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Apollo.TextConversationInitiateResponse>;
158
158
  private __startTextConversation;
159
+ /**
160
+ * Render a widget card from integration data. Authenticates via network API key.
161
+ *
162
+ * @param {Apollo.ExternalWidgetRenderRequest} request
163
+ * @param {ControllerApi.RequestOptions} requestOptions - Request-specific configuration.
164
+ *
165
+ * @throws {@link Apollo.UnprocessableEntityError}
166
+ *
167
+ * @example
168
+ * await client.controllerApi.renderWidget({
169
+ * task_id: "task_id",
170
+ * integration_code: "integration_code",
171
+ * card_template_code: "card_template_code",
172
+ * variables: {
173
+ * "key": "value"
174
+ * }
175
+ * })
176
+ */
177
+ renderWidget(request: Apollo.ExternalWidgetRenderRequest, requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Apollo.WidgetRenderResponse>;
178
+ private __renderWidget;
159
179
  }
@@ -762,4 +762,77 @@ export class ControllerApi {
762
762
  }
763
763
  });
764
764
  }
765
+ /**
766
+ * Render a widget card from integration data. Authenticates via network API key.
767
+ *
768
+ * @param {Apollo.ExternalWidgetRenderRequest} request
769
+ * @param {ControllerApi.RequestOptions} requestOptions - Request-specific configuration.
770
+ *
771
+ * @throws {@link Apollo.UnprocessableEntityError}
772
+ *
773
+ * @example
774
+ * await client.controllerApi.renderWidget({
775
+ * task_id: "task_id",
776
+ * integration_code: "integration_code",
777
+ * card_template_code: "card_template_code",
778
+ * variables: {
779
+ * "key": "value"
780
+ * }
781
+ * })
782
+ */
783
+ renderWidget(request, requestOptions) {
784
+ return core.HttpResponsePromise.fromPromise(this.__renderWidget(request, requestOptions));
785
+ }
786
+ __renderWidget(request, requestOptions) {
787
+ return __awaiter(this, void 0, void 0, function* () {
788
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
789
+ const _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({
790
+ "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,
791
+ }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
792
+ const _response = yield core.fetcher({
793
+ 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/widgets"),
794
+ method: "POST",
795
+ headers: _headers,
796
+ contentType: "application/json",
797
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
798
+ requestType: "json",
799
+ body: request,
800
+ 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,
801
+ 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,
802
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
803
+ fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
804
+ logging: this._options.logging,
805
+ });
806
+ if (_response.ok) {
807
+ return { data: _response.body, rawResponse: _response.rawResponse };
808
+ }
809
+ if (_response.error.reason === "status-code") {
810
+ switch (_response.error.statusCode) {
811
+ case 422:
812
+ throw new Apollo.UnprocessableEntityError(_response.error.body, _response.rawResponse);
813
+ default:
814
+ throw new errors.ApolloError({
815
+ statusCode: _response.error.statusCode,
816
+ body: _response.error.body,
817
+ rawResponse: _response.rawResponse,
818
+ });
819
+ }
820
+ }
821
+ switch (_response.error.reason) {
822
+ case "non-json":
823
+ throw new errors.ApolloError({
824
+ statusCode: _response.error.statusCode,
825
+ body: _response.error.rawBody,
826
+ rawResponse: _response.rawResponse,
827
+ });
828
+ case "timeout":
829
+ throw new errors.ApolloTimeoutError("Timeout exceeded when calling POST /api/v1/external/widgets.");
830
+ case "unknown":
831
+ throw new errors.ApolloError({
832
+ message: _response.error.errorMessage,
833
+ rawResponse: _response.rawResponse,
834
+ });
835
+ }
836
+ });
837
+ }
765
838
  }
@@ -0,0 +1,21 @@
1
+ /**
2
+ * @example
3
+ * {
4
+ * task_id: "task_id",
5
+ * integration_code: "integration_code",
6
+ * card_template_code: "card_template_code",
7
+ * variables: {
8
+ * "key": "value"
9
+ * }
10
+ * }
11
+ */
12
+ export interface ExternalWidgetRenderRequest {
13
+ /** Task ID for looking up stored interaction data */
14
+ task_id: string;
15
+ /** Integration name/code (e.g., INVENTORY_SEARCH) */
16
+ integration_code: string;
17
+ /** Card template name for direct lookup */
18
+ card_template_code: string;
19
+ /** Key-value pairs matching integration settings.variables[].key */
20
+ variables: Record<string, unknown>;
21
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -1,4 +1,5 @@
1
1
  export type { CreateTaskRequest } from "./CreateTaskRequest.mjs";
2
+ export type { ExternalWidgetRenderRequest } from "./ExternalWidgetRenderRequest.mjs";
2
3
  export type { GetProductMetadataRequest } from "./GetProductMetadataRequest.mjs";
3
4
  export type { ListUserTasksRequest } from "./ListUserTasksRequest.mjs";
4
5
  export type { SubmitMessageRequest } from "./SubmitMessageRequest.mjs";
@@ -3,6 +3,9 @@ export interface TraceDecisionParamsCheck {
3
3
  type?: Apollo.TraceDecisionType;
4
4
  tool: string;
5
5
  status: Apollo.TraceParamsCheckStatus;
6
- missing_params?: string[];
6
+ /** Per mandatory (required) group; inner list = unfilled param codes for that group. */
7
+ required_missing_params_by_group?: string[][];
8
+ /** Per optional group; inner list = unfilled param codes for that group. */
9
+ optional_missing_params_by_group?: string[][];
7
10
  track_id?: string;
8
11
  }
@@ -6,5 +6,5 @@ export interface TraceDecisionRuleTriggered {
6
6
  track_id?: string;
7
7
  }
8
8
  export declare namespace TraceDecisionRuleTriggered {
9
- type Rule = Apollo.TraceRuleBase | Apollo.TraceRuleParamsMissing;
9
+ type Rule = Apollo.TraceRuleBase | Apollo.TraceRuleParamsMissing | Apollo.TraceRuleMissingInfo;
10
10
  }
@@ -7,5 +7,4 @@ export interface TraceDecisionToolTextResponse {
7
7
  track_id?: string;
8
8
  tone_of_voice?: string;
9
9
  brevity?: string;
10
- guideline?: string;
11
10
  }
@@ -1,8 +1,9 @@
1
- /** Schema: all_filled | missing_required | missing_optional_ask_once. */
1
+ /** Schema: all_filled | missing_required | missing_optional | missing_optional_and_required | missing_optional_ask_once. */
2
2
  export declare const TraceParamsCheckStatus: {
3
3
  readonly AllFilled: "all_filled";
4
4
  readonly MissingRequired: "missing_required";
5
5
  readonly MissingOptional: "missing_optional";
6
6
  readonly MissingOptionalAskOnce: "missing_optional_ask_once";
7
+ readonly MissingOptionalAndRequired: "missing_optional_and_required";
7
8
  };
8
9
  export type TraceParamsCheckStatus = (typeof TraceParamsCheckStatus)[keyof typeof TraceParamsCheckStatus];
@@ -1,8 +1,9 @@
1
1
  // This file was auto-generated by Fern from our API Definition.
2
- /** Schema: all_filled | missing_required | missing_optional_ask_once. */
2
+ /** Schema: all_filled | missing_required | missing_optional | missing_optional_and_required | missing_optional_ask_once. */
3
3
  export const TraceParamsCheckStatus = {
4
4
  AllFilled: "all_filled",
5
5
  MissingRequired: "missing_required",
6
6
  MissingOptional: "missing_optional",
7
7
  MissingOptionalAskOnce: "missing_optional_ask_once",
8
+ MissingOptionalAndRequired: "missing_optional_and_required",
8
9
  };
@@ -3,7 +3,10 @@ export declare const TraceRuleAction: {
3
3
  readonly AddRequiredParam: "ADD_REQUIRED_PARAM";
4
4
  readonly AskAQuestion: "ASK_A_QUESTION";
5
5
  readonly Block: "BLOCK";
6
+ readonly PartialBlock: "PARTIAL_BLOCK";
6
7
  readonly Text: "TEXT";
7
- readonly ActivateAnotherTool: "ACTIVATE_ANOTHER_TOOL";
8
+ readonly BlockAndActivateAnotherTool: "BLOCK_AND_ACTIVATE_ANOTHER_TOOL";
9
+ readonly ActivateSubTool: "ACTIVATE_SUB_TOOL";
10
+ readonly Integration: "INTEGRATION";
8
11
  };
9
12
  export type TraceRuleAction = (typeof TraceRuleAction)[keyof typeof TraceRuleAction];
@@ -4,6 +4,9 @@ export const TraceRuleAction = {
4
4
  AddRequiredParam: "ADD_REQUIRED_PARAM",
5
5
  AskAQuestion: "ASK_A_QUESTION",
6
6
  Block: "BLOCK",
7
+ PartialBlock: "PARTIAL_BLOCK",
7
8
  Text: "TEXT",
8
- ActivateAnotherTool: "ACTIVATE_ANOTHER_TOOL",
9
+ BlockAndActivateAnotherTool: "BLOCK_AND_ACTIVATE_ANOTHER_TOOL",
10
+ ActivateSubTool: "ACTIVATE_SUB_TOOL",
11
+ Integration: "INTEGRATION",
9
12
  };
@@ -0,0 +1,10 @@
1
+ import type * as Apollo from "../index.mjs";
2
+ export interface TraceRuleMissingInfo {
3
+ type: Apollo.TraceRuleType;
4
+ action?: Apollo.TraceRuleAction;
5
+ reason?: string;
6
+ params_added?: Record<string, unknown>;
7
+ excluded_entities?: string[];
8
+ code?: string;
9
+ required_missing_params_by_group?: string[][];
10
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -2,6 +2,11 @@ import type * as Apollo from "../index.mjs";
2
2
  export interface TraceRuleParamsMissing {
3
3
  type?: Apollo.TraceRuleType;
4
4
  action?: Apollo.TraceRuleAction;
5
- missing_params?: string[];
5
+ status: Apollo.TraceParamsCheckStatus;
6
+ /** Per mandatory group (workflow order); inner list = unfilled param codes. */
7
+ required_missing_params_by_group?: string[][];
8
+ /** Per optional group (workflow order); inner list = unfilled param codes. */
9
+ optional_missing_params_by_group?: string[][];
6
10
  reason?: string;
11
+ code?: string;
7
12
  }
@@ -0,0 +1,3 @@
1
+ export interface WidgetRenderResponse {
2
+ rendered_jsx: string;
3
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -75,6 +75,7 @@ export * from "./TraceResponseType.mjs";
75
75
  export * from "./TraceRestIntegration.mjs";
76
76
  export * from "./TraceRuleAction.mjs";
77
77
  export * from "./TraceRuleBase.mjs";
78
+ export * from "./TraceRuleMissingInfo.mjs";
78
79
  export * from "./TraceRuleParamsMissing.mjs";
79
80
  export * from "./TraceRuleType.mjs";
80
81
  export * from "./TraceSelfReviewEntity.mjs";
@@ -87,6 +88,7 @@ export * from "./TracSelfReviewSubEntity.mjs";
87
88
  export * from "./UserMessagePayload.mjs";
88
89
  export * from "./ValidationError.mjs";
89
90
  export * from "./VectorSearchTaskInteractionQaAnswerScoreLabel.mjs";
91
+ export * from "./WidgetRenderResponse.mjs";
90
92
  export * from "./WorkflowCheckStatus.mjs";
91
93
  export * from "./WorkflowMetadata.mjs";
92
94
  export * from "./WorkflowsMetadataResponse.mjs";
@@ -75,6 +75,7 @@ export * from "./TraceResponseType.mjs";
75
75
  export * from "./TraceRestIntegration.mjs";
76
76
  export * from "./TraceRuleAction.mjs";
77
77
  export * from "./TraceRuleBase.mjs";
78
+ export * from "./TraceRuleMissingInfo.mjs";
78
79
  export * from "./TraceRuleParamsMissing.mjs";
79
80
  export * from "./TraceRuleType.mjs";
80
81
  export * from "./TraceSelfReviewEntity.mjs";
@@ -87,6 +88,7 @@ export * from "./TracSelfReviewSubEntity.mjs";
87
88
  export * from "./UserMessagePayload.mjs";
88
89
  export * from "./ValidationError.mjs";
89
90
  export * from "./VectorSearchTaskInteractionQaAnswerScoreLabel.mjs";
91
+ export * from "./WidgetRenderResponse.mjs";
90
92
  export * from "./WorkflowCheckStatus.mjs";
91
93
  export * from "./WorkflowMetadata.mjs";
92
94
  export * from "./WorkflowsMetadataResponse.mjs";
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "1.2.34";
1
+ export declare const SDK_VERSION = "1.2.35";
@@ -1 +1 @@
1
- export const SDK_VERSION = "1.2.34";
1
+ export const SDK_VERSION = "1.2.35";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aui.io/aui-client",
3
- "version": "1.2.34",
3
+ "version": "1.2.35",
4
4
  "private": false,
5
5
  "repository": "github:aui-io/aui-client-typescript",
6
6
  "type": "commonjs",
package/reference.md CHANGED
@@ -584,6 +584,76 @@ await client.controllerApi.startTextConversation({
584
584
  </dl>
585
585
 
586
586
 
587
+ </dd>
588
+ </dl>
589
+ </details>
590
+
591
+ <details><summary><code>client.controllerApi.<a href="/src/api/resources/controllerApi/client/Client.ts">renderWidget</a>({ ...params }) -> Apollo.WidgetRenderResponse</code></summary>
592
+ <dl>
593
+ <dd>
594
+
595
+ #### 📝 Description
596
+
597
+ <dl>
598
+ <dd>
599
+
600
+ <dl>
601
+ <dd>
602
+
603
+ Render a widget card from integration data. Authenticates via network API key.
604
+ </dd>
605
+ </dl>
606
+ </dd>
607
+ </dl>
608
+
609
+ #### 🔌 Usage
610
+
611
+ <dl>
612
+ <dd>
613
+
614
+ <dl>
615
+ <dd>
616
+
617
+ ```typescript
618
+ await client.controllerApi.renderWidget({
619
+ task_id: "task_id",
620
+ integration_code: "integration_code",
621
+ card_template_code: "card_template_code",
622
+ variables: {
623
+ "key": "value"
624
+ }
625
+ });
626
+
627
+ ```
628
+ </dd>
629
+ </dl>
630
+ </dd>
631
+ </dl>
632
+
633
+ #### ⚙️ Parameters
634
+
635
+ <dl>
636
+ <dd>
637
+
638
+ <dl>
639
+ <dd>
640
+
641
+ **request:** `Apollo.ExternalWidgetRenderRequest`
642
+
643
+ </dd>
644
+ </dl>
645
+
646
+ <dl>
647
+ <dd>
648
+
649
+ **requestOptions:** `ControllerApi.RequestOptions`
650
+
651
+ </dd>
652
+ </dl>
653
+ </dd>
654
+ </dl>
655
+
656
+
587
657
  </dd>
588
658
  </dl>
589
659
  </details>