@aui.io/aui-client 1.2.34 → 1.2.36

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 (67) 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 -13
  4. package/dist/cjs/api/resources/controllerApi/client/Client.js +45 -35
  5. package/dist/cjs/api/resources/controllerApi/client/requests/ExternalWidgetRenderRequest.d.ts +21 -0
  6. package/dist/cjs/api/resources/controllerApi/client/requests/index.d.ts +1 -0
  7. package/dist/cjs/api/types/OptionsSearchSelfReviewMethod.d.ts +0 -2
  8. package/dist/cjs/api/types/OptionsSearchSelfReviewMethod.js +0 -2
  9. package/dist/cjs/api/types/TaskParameter.d.ts +2 -2
  10. package/dist/cjs/api/types/TraceDecisionParamsCheck.d.ts +4 -1
  11. package/dist/cjs/api/types/TraceDecisionRuleTriggered.d.ts +1 -1
  12. package/dist/cjs/api/types/TraceDecisionToolTextResponse.d.ts +0 -1
  13. package/dist/cjs/api/types/TraceParamsCheckStatus.d.ts +2 -1
  14. package/dist/cjs/api/types/TraceParamsCheckStatus.js +2 -1
  15. package/dist/cjs/api/types/TraceRuleAction.d.ts +4 -1
  16. package/dist/cjs/api/types/TraceRuleAction.js +4 -1
  17. package/dist/cjs/api/types/TraceRuleMissingInfo.d.ts +10 -0
  18. package/dist/cjs/api/types/TraceRuleParamsMissing.d.ts +6 -1
  19. package/dist/cjs/api/types/WidgetRenderResponse.d.ts +3 -0
  20. package/dist/cjs/api/types/index.d.ts +2 -5
  21. package/dist/cjs/api/types/index.js +2 -5
  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 -13
  26. package/dist/esm/api/resources/controllerApi/client/Client.mjs +45 -35
  27. package/dist/esm/api/resources/controllerApi/client/requests/ExternalWidgetRenderRequest.d.mts +21 -0
  28. package/dist/esm/api/resources/controllerApi/client/requests/index.d.mts +1 -0
  29. package/dist/esm/api/types/OptionsSearchSelfReviewMethod.d.mts +0 -2
  30. package/dist/esm/api/types/OptionsSearchSelfReviewMethod.mjs +0 -2
  31. package/dist/esm/api/types/TaskParameter.d.mts +2 -2
  32. package/dist/esm/api/types/TraceDecisionParamsCheck.d.mts +4 -1
  33. package/dist/esm/api/types/TraceDecisionRuleTriggered.d.mts +1 -1
  34. package/dist/esm/api/types/TraceDecisionToolTextResponse.d.mts +0 -1
  35. package/dist/esm/api/types/TraceParamsCheckStatus.d.mts +2 -1
  36. package/dist/esm/api/types/TraceParamsCheckStatus.mjs +2 -1
  37. package/dist/esm/api/types/TraceRuleAction.d.mts +4 -1
  38. package/dist/esm/api/types/TraceRuleAction.mjs +4 -1
  39. package/dist/esm/api/types/TraceRuleMissingInfo.d.mts +10 -0
  40. package/dist/esm/api/types/TraceRuleParamsMissing.d.mts +6 -1
  41. package/dist/esm/api/types/WidgetRenderResponse.d.mts +3 -0
  42. package/dist/esm/api/types/index.d.mts +2 -5
  43. package/dist/esm/api/types/index.mjs +2 -5
  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 +44 -30
  48. package/dist/cjs/api/types/TaskParameterObjectNestedParam.d.ts +0 -7
  49. package/dist/cjs/api/types/TaskParameterObjectValue.d.ts +0 -6
  50. package/dist/cjs/api/types/TaskParameterObjectValueItem.d.ts +0 -4
  51. package/dist/cjs/api/types/WorkflowMetadata.d.ts +0 -7
  52. package/dist/cjs/api/types/WorkflowMetadata.js +0 -3
  53. package/dist/cjs/api/types/WorkflowsMetadataResponse.d.ts +0 -4
  54. package/dist/cjs/api/types/WorkflowsMetadataResponse.js +0 -3
  55. package/dist/esm/api/types/TaskParameterObjectNestedParam.d.mts +0 -7
  56. package/dist/esm/api/types/TaskParameterObjectValue.d.mts +0 -6
  57. package/dist/esm/api/types/TaskParameterObjectValueItem.d.mts +0 -4
  58. package/dist/esm/api/types/WorkflowMetadata.d.mts +0 -7
  59. package/dist/esm/api/types/WorkflowMetadata.mjs +0 -2
  60. package/dist/esm/api/types/WorkflowsMetadataResponse.d.mts +0 -4
  61. package/dist/esm/api/types/WorkflowsMetadataResponse.mjs +0 -2
  62. /package/dist/cjs/api/{types/TaskParameterObjectNestedParam.js → resources/controllerApi/client/requests/ExternalWidgetRenderRequest.js} +0 -0
  63. /package/dist/cjs/api/types/{TaskParameterObjectValue.js → TraceRuleMissingInfo.js} +0 -0
  64. /package/dist/cjs/api/types/{TaskParameterObjectValueItem.js → WidgetRenderResponse.js} +0 -0
  65. /package/dist/esm/api/{types/TaskParameterObjectNestedParam.mjs → resources/controllerApi/client/requests/ExternalWidgetRenderRequest.mjs} +0 -0
  66. /package/dist/esm/api/types/{TaskParameterObjectValue.mjs → TraceRuleMissingInfo.mjs} +0 -0
  67. /package/dist/esm/api/types/{TaskParameterObjectValueItem.mjs → WidgetRenderResponse.mjs} +0 -0
@@ -113,19 +113,6 @@ export declare class ControllerApi {
113
113
  */
114
114
  getDirectFollowupSuggestions(taskId: string, requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Apollo.DirectFollowupSuggestionsResponse>;
115
115
  private __getDirectFollowupSuggestions;
116
- /**
117
- * Get metadata for all workflows available for the authenticated network.
118
- * Returns a lean version with essential workflow information.
119
- *
120
- * @param {ControllerApi.RequestOptions} requestOptions - Request-specific configuration.
121
- *
122
- * @throws {@link Apollo.UnprocessableEntityError}
123
- *
124
- * @example
125
- * await client.controllerApi.getWorkflowsMetadata()
126
- */
127
- getWorkflowsMetadata(requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Apollo.WorkflowsMetadataResponse>;
128
- private __getWorkflowsMetadata;
129
116
  /**
130
117
  * @param {string} taskId
131
118
  * @param {string} messageId
@@ -156,4 +143,24 @@ export declare class ControllerApi {
156
143
  */
157
144
  startTextConversation(request: Apollo.TextConversationInitiateRequest, requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Apollo.TextConversationInitiateResponse>;
158
145
  private __startTextConversation;
146
+ /**
147
+ * Render a widget card from integration data. Authenticates via network API key.
148
+ *
149
+ * @param {Apollo.ExternalWidgetRenderRequest} request
150
+ * @param {ControllerApi.RequestOptions} requestOptions - Request-specific configuration.
151
+ *
152
+ * @throws {@link Apollo.UnprocessableEntityError}
153
+ *
154
+ * @example
155
+ * await client.controllerApi.renderWidget({
156
+ * task_id: "task_id",
157
+ * integration_code: "integration_code",
158
+ * card_template_code: "card_template_code",
159
+ * variables: {
160
+ * "key": "value"
161
+ * }
162
+ * })
163
+ */
164
+ renderWidget(request: Apollo.ExternalWidgetRenderRequest, requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Apollo.WidgetRenderResponse>;
165
+ private __renderWidget;
159
166
  }
@@ -564,27 +564,26 @@ export class ControllerApi {
564
564
  });
565
565
  }
566
566
  /**
567
- * Get metadata for all workflows available for the authenticated network.
568
- * Returns a lean version with essential workflow information.
569
- *
567
+ * @param {string} taskId
568
+ * @param {string} messageId
570
569
  * @param {ControllerApi.RequestOptions} requestOptions - Request-specific configuration.
571
570
  *
572
571
  * @throws {@link Apollo.UnprocessableEntityError}
573
572
  *
574
573
  * @example
575
- * await client.controllerApi.getWorkflowsMetadata()
574
+ * await client.controllerApi.getTraceInfo("task_id", "message_id")
576
575
  */
577
- getWorkflowsMetadata(requestOptions) {
578
- return core.HttpResponsePromise.fromPromise(this.__getWorkflowsMetadata(requestOptions));
576
+ getTraceInfo(taskId, messageId, requestOptions) {
577
+ return core.HttpResponsePromise.fromPromise(this.__getTraceInfo(taskId, messageId, requestOptions));
579
578
  }
580
- __getWorkflowsMetadata(requestOptions) {
579
+ __getTraceInfo(taskId, messageId, requestOptions) {
581
580
  return __awaiter(this, void 0, void 0, function* () {
582
581
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
583
582
  const _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({
584
583
  "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,
585
584
  }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
586
585
  const _response = yield core.fetcher({
587
- 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"),
586
+ 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/tasks/${core.url.encodePathParam(taskId)}/messages/${core.url.encodePathParam(messageId)}/trace-info`),
588
587
  method: "GET",
589
588
  headers: _headers,
590
589
  queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
@@ -617,7 +616,7 @@ export class ControllerApi {
617
616
  rawResponse: _response.rawResponse,
618
617
  });
619
618
  case "timeout":
620
- throw new errors.ApolloTimeoutError("Timeout exceeded when calling GET /api/v1/external/workflows/metadata.");
619
+ throw new errors.ApolloTimeoutError("Timeout exceeded when calling GET /api/v1/external/tasks/{task_id}/messages/{message_id}/trace-info.");
621
620
  case "unknown":
622
621
  throw new errors.ApolloError({
623
622
  message: _response.error.errorMessage,
@@ -627,29 +626,38 @@ export class ControllerApi {
627
626
  });
628
627
  }
629
628
  /**
630
- * @param {string} taskId
631
- * @param {string} messageId
629
+ * Start a text conversation (WhatsApp or SMS).
630
+ *
631
+ * Creates a task and then proxies to third-party-auth(BE) service to send the initial message.
632
+ *
633
+ * @param {Apollo.TextConversationInitiateRequest} request
632
634
  * @param {ControllerApi.RequestOptions} requestOptions - Request-specific configuration.
633
635
  *
634
636
  * @throws {@link Apollo.UnprocessableEntityError}
635
637
  *
636
638
  * @example
637
- * await client.controllerApi.getTraceInfo("task_id", "message_id")
639
+ * await client.controllerApi.startTextConversation({
640
+ * phoneNumber: "phoneNumber",
641
+ * channel: "channel"
642
+ * })
638
643
  */
639
- getTraceInfo(taskId, messageId, requestOptions) {
640
- return core.HttpResponsePromise.fromPromise(this.__getTraceInfo(taskId, messageId, requestOptions));
644
+ startTextConversation(request, requestOptions) {
645
+ return core.HttpResponsePromise.fromPromise(this.__startTextConversation(request, requestOptions));
641
646
  }
642
- __getTraceInfo(taskId, messageId, requestOptions) {
647
+ __startTextConversation(request, requestOptions) {
643
648
  return __awaiter(this, void 0, void 0, function* () {
644
649
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
645
650
  const _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({
646
651
  "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,
647
652
  }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
648
653
  const _response = yield core.fetcher({
649
- 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/tasks/${core.url.encodePathParam(taskId)}/messages/${core.url.encodePathParam(messageId)}/trace-info`),
650
- method: "GET",
654
+ 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/text/conversation"),
655
+ method: "POST",
651
656
  headers: _headers,
657
+ contentType: "application/json",
652
658
  queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
659
+ requestType: "json",
660
+ body: request,
653
661
  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,
654
662
  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,
655
663
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -657,7 +665,10 @@ export class ControllerApi {
657
665
  logging: this._options.logging,
658
666
  });
659
667
  if (_response.ok) {
660
- return { data: _response.body, rawResponse: _response.rawResponse };
668
+ return {
669
+ data: _response.body,
670
+ rawResponse: _response.rawResponse,
671
+ };
661
672
  }
662
673
  if (_response.error.reason === "status-code") {
663
674
  switch (_response.error.statusCode) {
@@ -679,7 +690,7 @@ export class ControllerApi {
679
690
  rawResponse: _response.rawResponse,
680
691
  });
681
692
  case "timeout":
682
- throw new errors.ApolloTimeoutError("Timeout exceeded when calling GET /api/v1/external/tasks/{task_id}/messages/{message_id}/trace-info.");
693
+ throw new errors.ApolloTimeoutError("Timeout exceeded when calling POST /api/v1/external/text/conversation.");
683
694
  case "unknown":
684
695
  throw new errors.ApolloError({
685
696
  message: _response.error.errorMessage,
@@ -689,32 +700,34 @@ export class ControllerApi {
689
700
  });
690
701
  }
691
702
  /**
692
- * Start a text conversation (WhatsApp or SMS).
693
- *
694
- * Creates a task and then proxies to third-party-auth(BE) service to send the initial message.
703
+ * Render a widget card from integration data. Authenticates via network API key.
695
704
  *
696
- * @param {Apollo.TextConversationInitiateRequest} request
705
+ * @param {Apollo.ExternalWidgetRenderRequest} request
697
706
  * @param {ControllerApi.RequestOptions} requestOptions - Request-specific configuration.
698
707
  *
699
708
  * @throws {@link Apollo.UnprocessableEntityError}
700
709
  *
701
710
  * @example
702
- * await client.controllerApi.startTextConversation({
703
- * phoneNumber: "phoneNumber",
704
- * channel: "channel"
711
+ * await client.controllerApi.renderWidget({
712
+ * task_id: "task_id",
713
+ * integration_code: "integration_code",
714
+ * card_template_code: "card_template_code",
715
+ * variables: {
716
+ * "key": "value"
717
+ * }
705
718
  * })
706
719
  */
707
- startTextConversation(request, requestOptions) {
708
- return core.HttpResponsePromise.fromPromise(this.__startTextConversation(request, requestOptions));
720
+ renderWidget(request, requestOptions) {
721
+ return core.HttpResponsePromise.fromPromise(this.__renderWidget(request, requestOptions));
709
722
  }
710
- __startTextConversation(request, requestOptions) {
723
+ __renderWidget(request, requestOptions) {
711
724
  return __awaiter(this, void 0, void 0, function* () {
712
725
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
713
726
  const _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({
714
727
  "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,
715
728
  }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
716
729
  const _response = yield core.fetcher({
717
- 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/text/conversation"),
730
+ 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"),
718
731
  method: "POST",
719
732
  headers: _headers,
720
733
  contentType: "application/json",
@@ -728,10 +741,7 @@ export class ControllerApi {
728
741
  logging: this._options.logging,
729
742
  });
730
743
  if (_response.ok) {
731
- return {
732
- data: _response.body,
733
- rawResponse: _response.rawResponse,
734
- };
744
+ return { data: _response.body, rawResponse: _response.rawResponse };
735
745
  }
736
746
  if (_response.error.reason === "status-code") {
737
747
  switch (_response.error.statusCode) {
@@ -753,7 +763,7 @@ export class ControllerApi {
753
763
  rawResponse: _response.rawResponse,
754
764
  });
755
765
  case "timeout":
756
- throw new errors.ApolloTimeoutError("Timeout exceeded when calling POST /api/v1/external/text/conversation.");
766
+ throw new errors.ApolloTimeoutError("Timeout exceeded when calling POST /api/v1/external/widgets.");
757
767
  case "unknown":
758
768
  throw new errors.ApolloError({
759
769
  message: _response.error.errorMessage,
@@ -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
+ }
@@ -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";
@@ -2,8 +2,6 @@ export declare const OptionsSearchSelfReviewMethod: {
2
2
  readonly InventoryClassification: "INVENTORY_CLASSIFICATION";
3
3
  readonly Llm: "LLM";
4
4
  readonly LlmPerOption: "LLM_PER_OPTION";
5
- readonly CrossEncoderRanker: "CROSS_ENCODER_RANKER";
6
- readonly CohereRanker: "COHERE_RANKER";
7
5
  readonly ConstantScore: "CONSTANT_SCORE";
8
6
  readonly ParamMatching: "PARAM_MATCHING";
9
7
  };
@@ -3,8 +3,6 @@ export const OptionsSearchSelfReviewMethod = {
3
3
  InventoryClassification: "INVENTORY_CLASSIFICATION",
4
4
  Llm: "LLM",
5
5
  LlmPerOption: "LLM_PER_OPTION",
6
- CrossEncoderRanker: "CROSS_ENCODER_RANKER",
7
- CohereRanker: "COHERE_RANKER",
8
6
  ConstantScore: "CONSTANT_SCORE",
9
7
  ParamMatching: "PARAM_MATCHING",
10
8
  };
@@ -14,9 +14,9 @@ export interface TaskParameter {
14
14
  code?: string;
15
15
  }
16
16
  export declare namespace TaskParameter {
17
- type Value = Apollo.TaskParameterValue | Apollo.TaskParameterRangeValue | Apollo.TaskParameterObjectValue;
17
+ type Value = Apollo.TaskParameterValue | Apollo.TaskParameterRangeValue;
18
18
  type ValueHistory = ValueHistory.Item[];
19
19
  namespace ValueHistory {
20
- type Item = Apollo.TaskParameterValue | Apollo.TaskParameterRangeValue | Apollo.TaskParameterObjectValue;
20
+ type Item = Apollo.TaskParameterValue | Apollo.TaskParameterRangeValue;
21
21
  }
22
22
  }
@@ -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
+ }
@@ -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
+ }
@@ -32,9 +32,6 @@ export * from "./TaskInteractionOptionSelfReviewScore.mjs";
32
32
  export * from "./TaskInteractionOptionSelfReviewScoreLabel.mjs";
33
33
  export * from "./TaskInteractionOptionSelfReviewType.mjs";
34
34
  export * from "./TaskParameter.mjs";
35
- export * from "./TaskParameterObjectNestedParam.mjs";
36
- export * from "./TaskParameterObjectValue.mjs";
37
- export * from "./TaskParameterObjectValueItem.mjs";
38
35
  export * from "./TaskParameterRangeValue.mjs";
39
36
  export * from "./TaskParameterType.mjs";
40
37
  export * from "./TaskParameterValue.mjs";
@@ -75,6 +72,7 @@ export * from "./TraceResponseType.mjs";
75
72
  export * from "./TraceRestIntegration.mjs";
76
73
  export * from "./TraceRuleAction.mjs";
77
74
  export * from "./TraceRuleBase.mjs";
75
+ export * from "./TraceRuleMissingInfo.mjs";
78
76
  export * from "./TraceRuleParamsMissing.mjs";
79
77
  export * from "./TraceRuleType.mjs";
80
78
  export * from "./TraceSelfReviewEntity.mjs";
@@ -87,7 +85,6 @@ export * from "./TracSelfReviewSubEntity.mjs";
87
85
  export * from "./UserMessagePayload.mjs";
88
86
  export * from "./ValidationError.mjs";
89
87
  export * from "./VectorSearchTaskInteractionQaAnswerScoreLabel.mjs";
88
+ export * from "./WidgetRenderResponse.mjs";
90
89
  export * from "./WorkflowCheckStatus.mjs";
91
- export * from "./WorkflowMetadata.mjs";
92
- export * from "./WorkflowsMetadataResponse.mjs";
93
90
  export * from "./WsActor.mjs";
@@ -32,9 +32,6 @@ export * from "./TaskInteractionOptionSelfReviewScore.mjs";
32
32
  export * from "./TaskInteractionOptionSelfReviewScoreLabel.mjs";
33
33
  export * from "./TaskInteractionOptionSelfReviewType.mjs";
34
34
  export * from "./TaskParameter.mjs";
35
- export * from "./TaskParameterObjectNestedParam.mjs";
36
- export * from "./TaskParameterObjectValue.mjs";
37
- export * from "./TaskParameterObjectValueItem.mjs";
38
35
  export * from "./TaskParameterRangeValue.mjs";
39
36
  export * from "./TaskParameterType.mjs";
40
37
  export * from "./TaskParameterValue.mjs";
@@ -75,6 +72,7 @@ export * from "./TraceResponseType.mjs";
75
72
  export * from "./TraceRestIntegration.mjs";
76
73
  export * from "./TraceRuleAction.mjs";
77
74
  export * from "./TraceRuleBase.mjs";
75
+ export * from "./TraceRuleMissingInfo.mjs";
78
76
  export * from "./TraceRuleParamsMissing.mjs";
79
77
  export * from "./TraceRuleType.mjs";
80
78
  export * from "./TraceSelfReviewEntity.mjs";
@@ -87,7 +85,6 @@ export * from "./TracSelfReviewSubEntity.mjs";
87
85
  export * from "./UserMessagePayload.mjs";
88
86
  export * from "./ValidationError.mjs";
89
87
  export * from "./VectorSearchTaskInteractionQaAnswerScoreLabel.mjs";
88
+ export * from "./WidgetRenderResponse.mjs";
90
89
  export * from "./WorkflowCheckStatus.mjs";
91
- export * from "./WorkflowMetadata.mjs";
92
- export * from "./WorkflowsMetadataResponse.mjs";
93
90
  export * from "./WsActor.mjs";
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "1.2.34";
1
+ export declare const SDK_VERSION = "1.2.36";
@@ -1 +1 @@
1
- export const SDK_VERSION = "1.2.34";
1
+ export const SDK_VERSION = "1.2.36";
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.36",
4
4
  "private": false,
5
5
  "repository": "github:aui-io/aui-client-typescript",
6
6
  "type": "commonjs",
package/reference.md CHANGED
@@ -407,11 +407,11 @@ await client.controllerApi.getDirectFollowupSuggestions("task_id");
407
407
  </dl>
408
408
  </details>
409
409
 
410
- <details><summary><code>client.controllerApi.<a href="/src/api/resources/controllerApi/client/Client.ts">getWorkflowsMetadata</a>() -> Apollo.WorkflowsMetadataResponse</code></summary>
410
+ <details><summary><code>client.controllerApi.<a href="/src/api/resources/controllerApi/client/Client.ts">getTraceInfo</a>(taskId, messageId) -> Record<string, unknown></code></summary>
411
411
  <dl>
412
412
  <dd>
413
413
 
414
- #### 📝 Description
414
+ #### 🔌 Usage
415
415
 
416
416
  <dl>
417
417
  <dd>
@@ -419,14 +419,16 @@ await client.controllerApi.getDirectFollowupSuggestions("task_id");
419
419
  <dl>
420
420
  <dd>
421
421
 
422
- Get metadata for all workflows available for the authenticated network.
423
- Returns a lean version with essential workflow information.
422
+ ```typescript
423
+ await client.controllerApi.getTraceInfo("task_id", "message_id");
424
+
425
+ ```
424
426
  </dd>
425
427
  </dl>
426
428
  </dd>
427
429
  </dl>
428
430
 
429
- #### 🔌 Usage
431
+ #### ⚙️ Parameters
430
432
 
431
433
  <dl>
432
434
  <dd>
@@ -434,20 +436,19 @@ Returns a lean version with essential workflow information.
434
436
  <dl>
435
437
  <dd>
436
438
 
437
- ```typescript
438
- await client.controllerApi.getWorkflowsMetadata();
439
-
440
- ```
441
- </dd>
442
- </dl>
439
+ **taskId:** `string`
440
+
443
441
  </dd>
444
442
  </dl>
445
443
 
446
- #### ⚙️ Parameters
447
-
448
444
  <dl>
449
445
  <dd>
450
446
 
447
+ **messageId:** `string`
448
+
449
+ </dd>
450
+ </dl>
451
+
451
452
  <dl>
452
453
  <dd>
453
454
 
@@ -463,11 +464,11 @@ await client.controllerApi.getWorkflowsMetadata();
463
464
  </dl>
464
465
  </details>
465
466
 
466
- <details><summary><code>client.controllerApi.<a href="/src/api/resources/controllerApi/client/Client.ts">getTraceInfo</a>(taskId, messageId) -> Record<string, unknown></code></summary>
467
+ <details><summary><code>client.controllerApi.<a href="/src/api/resources/controllerApi/client/Client.ts">startTextConversation</a>({ ...params }) -> Apollo.TextConversationInitiateResponse</code></summary>
467
468
  <dl>
468
469
  <dd>
469
470
 
470
- #### 🔌 Usage
471
+ #### 📝 Description
471
472
 
472
473
  <dl>
473
474
  <dd>
@@ -475,16 +476,15 @@ await client.controllerApi.getWorkflowsMetadata();
475
476
  <dl>
476
477
  <dd>
477
478
 
478
- ```typescript
479
- await client.controllerApi.getTraceInfo("task_id", "message_id");
479
+ Start a text conversation (WhatsApp or SMS).
480
480
 
481
- ```
481
+ Creates a task and then proxies to third-party-auth(BE) service to send the initial message.
482
482
  </dd>
483
483
  </dl>
484
484
  </dd>
485
485
  </dl>
486
486
 
487
- #### ⚙️ Parameters
487
+ #### 🔌 Usage
488
488
 
489
489
  <dl>
490
490
  <dd>
@@ -492,15 +492,27 @@ await client.controllerApi.getTraceInfo("task_id", "message_id");
492
492
  <dl>
493
493
  <dd>
494
494
 
495
- **taskId:** `string`
496
-
495
+ ```typescript
496
+ await client.controllerApi.startTextConversation({
497
+ phoneNumber: "phoneNumber",
498
+ channel: "channel"
499
+ });
500
+
501
+ ```
502
+ </dd>
503
+ </dl>
497
504
  </dd>
498
505
  </dl>
499
506
 
507
+ #### ⚙️ Parameters
508
+
500
509
  <dl>
501
510
  <dd>
502
511
 
503
- **messageId:** `string`
512
+ <dl>
513
+ <dd>
514
+
515
+ **request:** `Apollo.TextConversationInitiateRequest`
504
516
 
505
517
  </dd>
506
518
  </dl>
@@ -520,7 +532,7 @@ await client.controllerApi.getTraceInfo("task_id", "message_id");
520
532
  </dl>
521
533
  </details>
522
534
 
523
- <details><summary><code>client.controllerApi.<a href="/src/api/resources/controllerApi/client/Client.ts">startTextConversation</a>({ ...params }) -> Apollo.TextConversationInitiateResponse</code></summary>
535
+ <details><summary><code>client.controllerApi.<a href="/src/api/resources/controllerApi/client/Client.ts">renderWidget</a>({ ...params }) -> Apollo.WidgetRenderResponse</code></summary>
524
536
  <dl>
525
537
  <dd>
526
538
 
@@ -532,9 +544,7 @@ await client.controllerApi.getTraceInfo("task_id", "message_id");
532
544
  <dl>
533
545
  <dd>
534
546
 
535
- Start a text conversation (WhatsApp or SMS).
536
-
537
- Creates a task and then proxies to third-party-auth(BE) service to send the initial message.
547
+ Render a widget card from integration data. Authenticates via network API key.
538
548
  </dd>
539
549
  </dl>
540
550
  </dd>
@@ -549,9 +559,13 @@ Creates a task and then proxies to third-party-auth(BE) service to send the init
549
559
  <dd>
550
560
 
551
561
  ```typescript
552
- await client.controllerApi.startTextConversation({
553
- phoneNumber: "phoneNumber",
554
- channel: "channel"
562
+ await client.controllerApi.renderWidget({
563
+ task_id: "task_id",
564
+ integration_code: "integration_code",
565
+ card_template_code: "card_template_code",
566
+ variables: {
567
+ "key": "value"
568
+ }
555
569
  });
556
570
 
557
571
  ```
@@ -568,7 +582,7 @@ await client.controllerApi.startTextConversation({
568
582
  <dl>
569
583
  <dd>
570
584
 
571
- **request:** `Apollo.TextConversationInitiateRequest`
585
+ **request:** `Apollo.ExternalWidgetRenderRequest`
572
586
 
573
587
  </dd>
574
588
  </dl>
@@ -1,7 +0,0 @@
1
- import type * as Apollo from "../index.js";
2
- export interface TaskParameterObjectNestedParam {
3
- param: string;
4
- title: string;
5
- value?: string;
6
- param_type?: Apollo.ParameterType;
7
- }