@aui.io/aui-client 1.2.16 → 1.2.18

package/README.md

@@ -31,7 +31,8 @@ const client = new ApolloClient({
 ```typescript
 // Create a new task
 const taskResponse = await client.controllerApi.createTask({
-    user_id: 'user123'
+    user_id: 'user123',
+    task_origin_type: 'web-widget'  // Required: identifies the source of the task
 });
 
 console.log('Task ID:', taskResponse.id);
@@ -165,12 +166,15 @@ Create a new task for the agent.
 
 ```typescript
 const taskResponse = await client.controllerApi.createTask({
-    user_id: string    // Unique user identifier
+    user_id: string,              // Unique user identifier
+    task_origin_type: string      // Required: origin type (e.g., 'web-widget', 'mobile-app', 'api')
 });
 
 // Returns: { id: string, user_id: string, title: string, welcome_message?: string }
 ```
 
+**Note:** `task_origin_type` is required in v1.2.17+. Common values: `'web-widget'`, `'mobile-app'`, `'api'`, `'internal-tool'`
+
 #### `getTaskMessages(taskId)` - Get Task Messages
 Retrieve all messages for a specific task.
 
@@ -206,6 +210,17 @@ const tasksResponse = await client.controllerApi.listUserTasks({
 // Returns: { tasks: Task[], total: number, page: number, size: number }
 ```
 
+#### `getProductMetadata(link)` - Get Product Metadata
+Retrieve metadata for a product from a given URL/link.
+
+```typescript
+const metadata = await client.controllerApi.getProductMetadata({
+    link: string    // Product URL or link
+});
+
+// Returns: Record<string, any> - Product metadata object
+```
+
 ---
 
 ### WebSocket API
@@ -246,6 +261,11 @@ socket.on('close', (event: CloseEvent) => void);
 - `final_message` - Complete response with optional product cards
 - `error` - Error message from the agent
 
+**New in v0.6.0:**
+- **Message fields:** `welcome_message`, `executed_workflows` - Track workflow execution and welcome messages
+- **Card fields:** `category`, `query`, `sub_entities`, `self_review` - Enhanced product card information with self-review scoring
+- **Product Metadata API:** New endpoint to retrieve metadata from product URLs
+
 #### Socket Methods
 
 ```typescript
@@ -280,7 +300,8 @@ const client = new ApolloClient({
 async function searchProducts(userId: string, query: string) {
     // Step 1: Create a task
     const taskResponse = await client.controllerApi.createTask({
-        user_id: userId
+        user_id: userId,
+        task_origin_type: 'web-widget'
     });
     
     const taskId = taskResponse.id;
@@ -367,6 +388,40 @@ async function getTaskHistory(userId: string) {
 getTaskHistory('user123');
 ```
 
+### Get Product Metadata
+
+```typescript
+import { ApolloClient } from '@aui.io/aui-client';
+
+const client = new ApolloClient({
+    networkApiKey: 'API_KEY_YOUR_KEY_HERE'
+});
+
+async function fetchProductMetadata(productLink: string) {
+    try {
+        // Fetch metadata for a product
+        const metadata = await client.controllerApi.getProductMetadata({
+            link: productLink
+        });
+        
+        console.log('Product Metadata:', metadata);
+        
+        // Metadata might include: name, price, description, images, etc.
+        if (metadata) {
+            console.log('Available fields:', Object.keys(metadata));
+        }
+        
+        return metadata;
+    } catch (error) {
+        console.error('Error fetching product metadata:', error);
+        throw error;
+    }
+}
+
+// Example usage
+fetchProductMetadata('https://www.example.com/product/12345');
+```
+
 ## 🔧 Advanced Configuration
 
 ### Custom Timeout and Retries
@@ -380,7 +435,10 @@ const client = new ApolloClient({
 
 // Per-request overrides
 const taskResponse = await client.controllerApi.createTask(
-    { user_id: 'user123' },
+    { 
+        user_id: 'user123',
+        task_origin_type: 'web-widget'
+    },
     {
         timeoutInSeconds: 30,  // Override for this request only
         maxRetries: 2
@@ -414,7 +472,8 @@ const client = new ApolloClient({
 
 try {
     const taskResponse = await client.controllerApi.createTask({
-        user_id: 'user123'
+        user_id: 'user123',
+        task_origin_type: 'web-widget'
     });
 } catch (error) {
     if (error instanceof UnprocessableEntityError) {
@@ -534,6 +593,23 @@ const client = new ApolloClient({
 npm install --save-dev typescript@latest
 ```
 
+## 📚 Examples
+
+The `examples/` directory contains ready-to-run code examples:
+
+- **Product Metadata API** - [`examples/test-product-metadata.js`](./examples/test-product-metadata.js)
+  - Fetch product information from URLs
+  - Handle errors and edge cases
+  - Extract and use metadata
+
+Run examples:
+```bash
+export NETWORK_API_KEY="API_KEY_YOUR_KEY_HERE"
+node examples/test-product-metadata.js
+```
+
+See the [examples README](./examples/README.md) for more details.
+
 ## 🔗 Resources
 
 - **GitHub Repository:** [aui-io/aui-client-typescript](https://github.com/aui-io/aui-client-typescript)

package/dist/cjs/Client.js

@@ -45,8 +45,8 @@ class ApolloClient {
                 "x-network-api-key": _options === null || _options === void 0 ? void 0 : _options.networkApiKey,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@aui.io/aui-client",
-                "X-Fern-SDK-Version": "1.2.16",
-                "User-Agent": "@aui.io/aui-client/1.2.16",
+                "X-Fern-SDK-Version": "1.2.18",
+                "User-Agent": "@aui.io/aui-client/1.2.18",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/cjs/api/resources/controllerApi/client/Client.d.ts

@@ -33,7 +33,8 @@ export declare class ControllerApi {
      *
      * @example
      *     await client.controllerApi.createTask({
-     *         user_id: "user_id"
+     *         user_id: "user_id",
+     *         task_origin_type: "stores"
      *     })
      */
     createTask(request: Apollo.CreateTaskRequest, requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Apollo.CreateTaskResponse>;
@@ -64,4 +65,17 @@ export declare class ControllerApi {
      */
     sendMessage(request: Apollo.SubmitMessageRequest, requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Apollo.Message>;
     private __sendMessage;
+    /**
+     * @param {Apollo.GetProductMetadataRequest} request
+     * @param {ControllerApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Apollo.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.controllerApi.getProductMetadata({
+     *         link: "link"
+     *     })
+     */
+    getProductMetadata(request: Apollo.GetProductMetadataRequest, requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Record<string, unknown>>;
+    private __getProductMetadata;
 }

package/dist/cjs/api/resources/controllerApi/client/Client.js

@@ -147,7 +147,8 @@ class ControllerApi {
      *
      * @example
      *     await client.controllerApi.createTask({
-     *         user_id: "user_id"
+     *         user_id: "user_id",
+     *         task_origin_type: "stores"
      *     })
      */
     createTask(request, requestOptions) {
@@ -342,5 +343,72 @@ class ControllerApi {
             }
         });
     }
+    /**
+     * @param {Apollo.GetProductMetadataRequest} request
+     * @param {ControllerApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Apollo.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.controllerApi.getProductMetadata({
+     *         link: "link"
+     *     })
+     */
+    getProductMetadata(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getProductMetadata(request, requestOptions));
+    }
+    __getProductMetadata(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+            const { link } = request;
+            const _queryParams = {};
+            _queryParams.link = link;
+            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+                "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,
+            }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                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)
+                    .base, "api/v1/external/product-metadata"),
+                method: "GET",
+                headers: _headers,
+                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                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,
+                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,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 422:
+                        throw new Apollo.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.ApolloError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.ApolloError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.ApolloTimeoutError("Timeout exceeded when calling GET /api/v1/external/product-metadata.");
+                case "unknown":
+                    throw new errors.ApolloError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
 }
 exports.ControllerApi = ControllerApi;

package/dist/cjs/api/resources/controllerApi/client/requests/CreateTaskRequest.d.ts

@@ -1,9 +1,12 @@
+import type * as Apollo from "../../../../index.js";
 /**
  * @example
  *     {
- *         user_id: "user_id"
+ *         user_id: "user_id",
+ *         task_origin_type: "stores"
  *     }
  */
 export interface CreateTaskRequest {
     user_id: string;
+    task_origin_type: Apollo.RecordOriginType;
 }

package/dist/cjs/api/resources/controllerApi/client/requests/GetProductMetadataRequest.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @example
+ *     {
+ *         link: "link"
+ *     }
+ */
+export interface GetProductMetadataRequest {
+    link: string;
+}

package/dist/cjs/api/resources/controllerApi/client/requests/GetProductMetadataRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/controllerApi/client/requests/index.d.ts

@@ -1,3 +1,4 @@
 export type { CreateTaskRequest } from "./CreateTaskRequest.js";
+export type { GetProductMetadataRequest } from "./GetProductMetadataRequest.js";
 export type { ListUserTasksRequest } from "./ListUserTasksRequest.js";
 export type { SubmitMessageRequest } from "./SubmitMessageRequest.js";

package/dist/cjs/api/types/Card.d.ts

@@ -2,6 +2,10 @@ import type * as Apollo from "../index.js";
 export interface Card {
     id: string;
     name: string;
+    category: string;
+    query?: Record<string, unknown>;
     parameters: Apollo.CardParameter[];
+    sub_entities?: Apollo.MessageCardSubEntity[];
+    self_review?: Apollo.TaskInteractionOptionSelfReview;
     is_recommended: boolean;
 }

package/dist/cjs/api/types/CardParameter.d.ts

@@ -1,5 +1,6 @@
 import type * as Apollo from "../index.js";
 export interface CardParameter {
+    param: string;
     title: string;
     value?: unknown;
     type: Apollo.ParameterType;

package/dist/cjs/api/types/Context.d.ts

@@ -1,4 +1,5 @@
 export interface Context {
     url?: string;
     lead_details?: Record<string, unknown>;
+    welcome_message?: string;
 }

package/dist/cjs/api/types/Message.d.ts

@@ -6,5 +6,8 @@ export interface Message {
     sender: Apollo.MessageContactParty;
     receiver: Apollo.MessageContactParty;
     cards: Apollo.Card[];
+    welcome_message?: string;
     followup_suggestions: string[];
+    executed_workflows?: string[];
+    url?: string;
 }

package/dist/cjs/api/types/MessageCardParameter.d.ts

@@ -0,0 +1,8 @@
+import type * as Apollo from "../index.js";
+export interface MessageCardParameter {
+    param: string;
+    title: string;
+    name?: string;
+    value?: unknown;
+    type?: Apollo.ParameterType;
+}

package/dist/cjs/api/types/MessageCardParameter.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/MessageCardSubEntity.d.ts

@@ -0,0 +1,5 @@
+import type * as Apollo from "../index.js";
+export interface MessageCardSubEntity {
+    name: string;
+    items: Apollo.MessageCardSubEntityItem[];
+}

package/dist/cjs/api/types/MessageCardSubEntity.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/MessageCardSubEntityItem.d.ts

@@ -0,0 +1,5 @@
+import type * as Apollo from "../index.js";
+export interface MessageCardSubEntityItem {
+    parameters: Apollo.MessageCardParameter[];
+    index?: number;
+}

package/dist/cjs/api/types/MessageCardSubEntityItem.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/OptionsSearchSelfReviewMethod.d.ts

@@ -0,0 +1,10 @@
+export declare const OptionsSearchSelfReviewMethod: {
+    readonly InventoryClassification: "INVENTORY_CLASSIFICATION";
+    readonly Llm: "LLM";
+    readonly LlmPerOption: "LLM_PER_OPTION";
+    readonly CrossEncoderRanker: "CROSS_ENCODER_RANKER";
+    readonly CohereRanker: "COHERE_RANKER";
+    readonly ConstantScore: "CONSTANT_SCORE";
+    readonly ParamMatching: "PARAM_MATCHING";
+};
+export type OptionsSearchSelfReviewMethod = (typeof OptionsSearchSelfReviewMethod)[keyof typeof OptionsSearchSelfReviewMethod];

package/dist/cjs/api/types/OptionsSearchSelfReviewMethod.js

@@ -0,0 +1,13 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OptionsSearchSelfReviewMethod = void 0;
+exports.OptionsSearchSelfReviewMethod = {
+    InventoryClassification: "INVENTORY_CLASSIFICATION",
+    Llm: "LLM",
+    LlmPerOption: "LLM_PER_OPTION",
+    CrossEncoderRanker: "CROSS_ENCODER_RANKER",
+    CohereRanker: "COHERE_RANKER",
+    ConstantScore: "CONSTANT_SCORE",
+    ParamMatching: "PARAM_MATCHING",
+};

package/dist/cjs/api/types/RecordOriginType.d.ts

@@ -0,0 +1,9 @@
+export declare const RecordOriginType: {
+    readonly Stores: "stores";
+    readonly WebWidget: "web-widget";
+    readonly InspectionPlayground: "inspection-playground";
+    readonly FeedbackPlayground: "feedback-playground";
+    readonly LlmManagement: "llm-management";
+    readonly ThirdParty: "third-party";
+};
+export type RecordOriginType = (typeof RecordOriginType)[keyof typeof RecordOriginType];

package/dist/cjs/api/types/RecordOriginType.js

@@ -0,0 +1,12 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RecordOriginType = void 0;
+exports.RecordOriginType = {
+    Stores: "stores",
+    WebWidget: "web-widget",
+    InspectionPlayground: "inspection-playground",
+    FeedbackPlayground: "feedback-playground",
+    LlmManagement: "llm-management",
+    ThirdParty: "third-party",
+};

package/dist/cjs/api/types/TaskInteractionOptionSelfReview.d.ts

@@ -0,0 +1,8 @@
+import type * as Apollo from "../index.js";
+export interface TaskInteractionOptionSelfReview {
+    score: Apollo.TaskInteractionOptionSelfReviewScore;
+    type: Apollo.TaskInteractionOptionSelfReviewType;
+    mismatches?: string[];
+    reasons?: string[];
+    order?: number;
+}

package/dist/cjs/api/types/TaskInteractionOptionSelfReview.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/TaskInteractionOptionSelfReviewScore.d.ts

@@ -0,0 +1,6 @@
+import type * as Apollo from "../index.js";
+export interface TaskInteractionOptionSelfReviewScore {
+    value?: number;
+    label: Apollo.TaskInteractionOptionSelfReviewScoreLabel;
+    method: Apollo.OptionsSearchSelfReviewMethod;
+}

package/dist/cjs/api/types/TaskInteractionOptionSelfReviewScore.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/TaskInteractionOptionSelfReviewScoreLabel.d.ts

@@ -0,0 +1,6 @@
+export declare const TaskInteractionOptionSelfReviewScoreLabel: {
+    readonly High: "HIGH";
+    readonly Medium: "MEDIUM";
+    readonly Low: "LOW";
+};
+export type TaskInteractionOptionSelfReviewScoreLabel = (typeof TaskInteractionOptionSelfReviewScoreLabel)[keyof typeof TaskInteractionOptionSelfReviewScoreLabel];

package/dist/cjs/api/types/TaskInteractionOptionSelfReviewScoreLabel.js

@@ -0,0 +1,9 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TaskInteractionOptionSelfReviewScoreLabel = void 0;
+exports.TaskInteractionOptionSelfReviewScoreLabel = {
+    High: "HIGH",
+    Medium: "MEDIUM",
+    Low: "LOW",
+};

package/dist/cjs/api/types/TaskInteractionOptionSelfReviewType.d.ts

@@ -0,0 +1 @@
+export type TaskInteractionOptionSelfReviewType = "WORKFLOW";

package/dist/cjs/api/types/TaskInteractionOptionSelfReviewType.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/index.d.ts

@@ -8,11 +8,20 @@ export * from "./FinalMessagePayload.js";
 export * from "./HttpValidationError.js";
 export * from "./ListTasksResponse.js";
 export * from "./Message.js";
+export * from "./MessageCardParameter.js";
+export * from "./MessageCardSubEntity.js";
+export * from "./MessageCardSubEntityItem.js";
 export * from "./MessageContactParty.js";
+export * from "./OptionsSearchSelfReviewMethod.js";
 export * from "./ParameterType.js";
 export * from "./ProductCard.js";
 export * from "./ProductParameter.js";
+export * from "./RecordOriginType.js";
 export * from "./StreamingUpdatePayload.js";
+export * from "./TaskInteractionOptionSelfReview.js";
+export * from "./TaskInteractionOptionSelfReviewScore.js";
+export * from "./TaskInteractionOptionSelfReviewScoreLabel.js";
+export * from "./TaskInteractionOptionSelfReviewType.js";
 export * from "./UserMessagePayload.js";
 export * from "./ValidationError.js";
 export * from "./WsActor.js";

package/dist/cjs/api/types/index.js

@@ -24,11 +24,20 @@ __exportStar(require("./FinalMessagePayload.js"), exports);
 __exportStar(require("./HttpValidationError.js"), exports);
 __exportStar(require("./ListTasksResponse.js"), exports);
 __exportStar(require("./Message.js"), exports);
+__exportStar(require("./MessageCardParameter.js"), exports);
+__exportStar(require("./MessageCardSubEntity.js"), exports);
+__exportStar(require("./MessageCardSubEntityItem.js"), exports);
 __exportStar(require("./MessageContactParty.js"), exports);
+__exportStar(require("./OptionsSearchSelfReviewMethod.js"), exports);
 __exportStar(require("./ParameterType.js"), exports);
 __exportStar(require("./ProductCard.js"), exports);
 __exportStar(require("./ProductParameter.js"), exports);
+__exportStar(require("./RecordOriginType.js"), exports);
 __exportStar(require("./StreamingUpdatePayload.js"), exports);
+__exportStar(require("./TaskInteractionOptionSelfReview.js"), exports);
+__exportStar(require("./TaskInteractionOptionSelfReviewScore.js"), exports);
+__exportStar(require("./TaskInteractionOptionSelfReviewScoreLabel.js"), exports);
+__exportStar(require("./TaskInteractionOptionSelfReviewType.js"), exports);
 __exportStar(require("./UserMessagePayload.js"), exports);
 __exportStar(require("./ValidationError.js"), exports);
 __exportStar(require("./WsActor.js"), exports);

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.2.16";
+export declare const SDK_VERSION = "1.2.18";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "1.2.16";
+exports.SDK_VERSION = "1.2.18";

package/dist/esm/Client.mjs

@@ -9,8 +9,8 @@ export class ApolloClient {
                 "x-network-api-key": _options === null || _options === void 0 ? void 0 : _options.networkApiKey,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@aui.io/aui-client",
-                "X-Fern-SDK-Version": "1.2.16",
-                "User-Agent": "@aui.io/aui-client/1.2.16",
+                "X-Fern-SDK-Version": "1.2.18",
+                "User-Agent": "@aui.io/aui-client/1.2.18",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/esm/api/resources/controllerApi/client/Client.d.mts

@@ -33,7 +33,8 @@ export declare class ControllerApi {
      *
      * @example
      *     await client.controllerApi.createTask({
-     *         user_id: "user_id"
+     *         user_id: "user_id",
+     *         task_origin_type: "stores"
      *     })
      */
     createTask(request: Apollo.CreateTaskRequest, requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Apollo.CreateTaskResponse>;
@@ -64,4 +65,17 @@ export declare class ControllerApi {
      */
     sendMessage(request: Apollo.SubmitMessageRequest, requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Apollo.Message>;
     private __sendMessage;
+    /**
+     * @param {Apollo.GetProductMetadataRequest} request
+     * @param {ControllerApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Apollo.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.controllerApi.getProductMetadata({
+     *         link: "link"
+     *     })
+     */
+    getProductMetadata(request: Apollo.GetProductMetadataRequest, requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Record<string, unknown>>;
+    private __getProductMetadata;
 }

package/dist/esm/api/resources/controllerApi/client/Client.mjs

@@ -111,7 +111,8 @@ export class ControllerApi {
      *
      * @example
      *     await client.controllerApi.createTask({
-     *         user_id: "user_id"
+     *         user_id: "user_id",
+     *         task_origin_type: "stores"
      *     })
      */
     createTask(request, requestOptions) {
@@ -306,4 +307,71 @@ export class ControllerApi {
             }
         });
     }
+    /**
+     * @param {Apollo.GetProductMetadataRequest} request
+     * @param {ControllerApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Apollo.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.controllerApi.getProductMetadata({
+     *         link: "link"
+     *     })
+     */
+    getProductMetadata(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getProductMetadata(request, requestOptions));
+    }
+    __getProductMetadata(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+            const { link } = request;
+            const _queryParams = {};
+            _queryParams.link = link;
+            const _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({
+                "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,
+            }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                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)
+                    .base, "api/v1/external/product-metadata"),
+                method: "GET",
+                headers: _headers,
+                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                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,
+                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,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 422:
+                        throw new Apollo.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.ApolloError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.ApolloError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.ApolloTimeoutError("Timeout exceeded when calling GET /api/v1/external/product-metadata.");
+                case "unknown":
+                    throw new errors.ApolloError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
 }

package/dist/esm/api/resources/controllerApi/client/requests/CreateTaskRequest.d.mts

@@ -1,9 +1,12 @@
+import type * as Apollo from "../../../../index.mjs";
 /**
  * @example
  *     {
- *         user_id: "user_id"
+ *         user_id: "user_id",
+ *         task_origin_type: "stores"
  *     }
  */
 export interface CreateTaskRequest {
     user_id: string;
+    task_origin_type: Apollo.RecordOriginType;
 }

package/dist/esm/api/resources/controllerApi/client/requests/GetProductMetadataRequest.d.mts

@@ -0,0 +1,9 @@
+/**
+ * @example
+ *     {
+ *         link: "link"
+ *     }
+ */
+export interface GetProductMetadataRequest {
+    link: string;
+}

package/dist/esm/api/resources/controllerApi/client/requests/GetProductMetadataRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/controllerApi/client/requests/index.d.mts

@@ -1,3 +1,4 @@
 export type { CreateTaskRequest } from "./CreateTaskRequest.mjs";
+export type { GetProductMetadataRequest } from "./GetProductMetadataRequest.mjs";
 export type { ListUserTasksRequest } from "./ListUserTasksRequest.mjs";
 export type { SubmitMessageRequest } from "./SubmitMessageRequest.mjs";

package/dist/esm/api/types/Card.d.mts

@@ -2,6 +2,10 @@ import type * as Apollo from "../index.mjs";
 export interface Card {
     id: string;
     name: string;
+    category: string;
+    query?: Record<string, unknown>;
     parameters: Apollo.CardParameter[];
+    sub_entities?: Apollo.MessageCardSubEntity[];
+    self_review?: Apollo.TaskInteractionOptionSelfReview;
     is_recommended: boolean;
 }

package/dist/esm/api/types/CardParameter.d.mts

@@ -1,5 +1,6 @@
 import type * as Apollo from "../index.mjs";
 export interface CardParameter {
+    param: string;
     title: string;
     value?: unknown;
     type: Apollo.ParameterType;

package/dist/esm/api/types/Context.d.mts

@@ -1,4 +1,5 @@
 export interface Context {
     url?: string;
     lead_details?: Record<string, unknown>;
+    welcome_message?: string;
 }

package/dist/esm/api/types/Message.d.mts

@@ -6,5 +6,8 @@ export interface Message {
     sender: Apollo.MessageContactParty;
     receiver: Apollo.MessageContactParty;
     cards: Apollo.Card[];
+    welcome_message?: string;
     followup_suggestions: string[];
+    executed_workflows?: string[];
+    url?: string;
 }

package/dist/esm/api/types/MessageCardParameter.d.mts

@@ -0,0 +1,8 @@
+import type * as Apollo from "../index.mjs";
+export interface MessageCardParameter {
+    param: string;
+    title: string;
+    name?: string;
+    value?: unknown;
+    type?: Apollo.ParameterType;
+}

package/dist/esm/api/types/MessageCardParameter.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/MessageCardSubEntity.d.mts

@@ -0,0 +1,5 @@
+import type * as Apollo from "../index.mjs";
+export interface MessageCardSubEntity {
+    name: string;
+    items: Apollo.MessageCardSubEntityItem[];
+}

package/dist/esm/api/types/MessageCardSubEntity.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/MessageCardSubEntityItem.d.mts

@@ -0,0 +1,5 @@
+import type * as Apollo from "../index.mjs";
+export interface MessageCardSubEntityItem {
+    parameters: Apollo.MessageCardParameter[];
+    index?: number;
+}

package/dist/esm/api/types/MessageCardSubEntityItem.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/OptionsSearchSelfReviewMethod.d.mts

@@ -0,0 +1,10 @@
+export declare const OptionsSearchSelfReviewMethod: {
+    readonly InventoryClassification: "INVENTORY_CLASSIFICATION";
+    readonly Llm: "LLM";
+    readonly LlmPerOption: "LLM_PER_OPTION";
+    readonly CrossEncoderRanker: "CROSS_ENCODER_RANKER";
+    readonly CohereRanker: "COHERE_RANKER";
+    readonly ConstantScore: "CONSTANT_SCORE";
+    readonly ParamMatching: "PARAM_MATCHING";
+};
+export type OptionsSearchSelfReviewMethod = (typeof OptionsSearchSelfReviewMethod)[keyof typeof OptionsSearchSelfReviewMethod];

package/dist/esm/api/types/OptionsSearchSelfReviewMethod.mjs

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+export const OptionsSearchSelfReviewMethod = {
+    InventoryClassification: "INVENTORY_CLASSIFICATION",
+    Llm: "LLM",
+    LlmPerOption: "LLM_PER_OPTION",
+    CrossEncoderRanker: "CROSS_ENCODER_RANKER",
+    CohereRanker: "COHERE_RANKER",
+    ConstantScore: "CONSTANT_SCORE",
+    ParamMatching: "PARAM_MATCHING",
+};

package/dist/esm/api/types/RecordOriginType.d.mts

@@ -0,0 +1,9 @@
+export declare const RecordOriginType: {
+    readonly Stores: "stores";
+    readonly WebWidget: "web-widget";
+    readonly InspectionPlayground: "inspection-playground";
+    readonly FeedbackPlayground: "feedback-playground";
+    readonly LlmManagement: "llm-management";
+    readonly ThirdParty: "third-party";
+};
+export type RecordOriginType = (typeof RecordOriginType)[keyof typeof RecordOriginType];

package/dist/esm/api/types/RecordOriginType.mjs

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+export const RecordOriginType = {
+    Stores: "stores",
+    WebWidget: "web-widget",
+    InspectionPlayground: "inspection-playground",
+    FeedbackPlayground: "feedback-playground",
+    LlmManagement: "llm-management",
+    ThirdParty: "third-party",
+};

package/dist/esm/api/types/TaskInteractionOptionSelfReview.d.mts

@@ -0,0 +1,8 @@
+import type * as Apollo from "../index.mjs";
+export interface TaskInteractionOptionSelfReview {
+    score: Apollo.TaskInteractionOptionSelfReviewScore;
+    type: Apollo.TaskInteractionOptionSelfReviewType;
+    mismatches?: string[];
+    reasons?: string[];
+    order?: number;
+}

package/dist/esm/api/types/TaskInteractionOptionSelfReview.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/TaskInteractionOptionSelfReviewScore.d.mts

@@ -0,0 +1,6 @@
+import type * as Apollo from "../index.mjs";
+export interface TaskInteractionOptionSelfReviewScore {
+    value?: number;
+    label: Apollo.TaskInteractionOptionSelfReviewScoreLabel;
+    method: Apollo.OptionsSearchSelfReviewMethod;
+}

package/dist/esm/api/types/TaskInteractionOptionSelfReviewScore.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/TaskInteractionOptionSelfReviewScoreLabel.d.mts

@@ -0,0 +1,6 @@
+export declare const TaskInteractionOptionSelfReviewScoreLabel: {
+    readonly High: "HIGH";
+    readonly Medium: "MEDIUM";
+    readonly Low: "LOW";
+};
+export type TaskInteractionOptionSelfReviewScoreLabel = (typeof TaskInteractionOptionSelfReviewScoreLabel)[keyof typeof TaskInteractionOptionSelfReviewScoreLabel];

package/dist/esm/api/types/TaskInteractionOptionSelfReviewScoreLabel.mjs

@@ -0,0 +1,6 @@
+// This file was auto-generated by Fern from our API Definition.
+export const TaskInteractionOptionSelfReviewScoreLabel = {
+    High: "HIGH",
+    Medium: "MEDIUM",
+    Low: "LOW",
+};

package/dist/esm/api/types/TaskInteractionOptionSelfReviewType.d.mts

@@ -0,0 +1 @@
+export type TaskInteractionOptionSelfReviewType = "WORKFLOW";

package/dist/esm/api/types/TaskInteractionOptionSelfReviewType.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/index.d.mts

@@ -8,11 +8,20 @@ export * from "./FinalMessagePayload.mjs";
 export * from "./HttpValidationError.mjs";
 export * from "./ListTasksResponse.mjs";
 export * from "./Message.mjs";
+export * from "./MessageCardParameter.mjs";
+export * from "./MessageCardSubEntity.mjs";
+export * from "./MessageCardSubEntityItem.mjs";
 export * from "./MessageContactParty.mjs";
+export * from "./OptionsSearchSelfReviewMethod.mjs";
 export * from "./ParameterType.mjs";
 export * from "./ProductCard.mjs";
 export * from "./ProductParameter.mjs";
+export * from "./RecordOriginType.mjs";
 export * from "./StreamingUpdatePayload.mjs";
+export * from "./TaskInteractionOptionSelfReview.mjs";
+export * from "./TaskInteractionOptionSelfReviewScore.mjs";
+export * from "./TaskInteractionOptionSelfReviewScoreLabel.mjs";
+export * from "./TaskInteractionOptionSelfReviewType.mjs";
 export * from "./UserMessagePayload.mjs";
 export * from "./ValidationError.mjs";
 export * from "./WsActor.mjs";

package/dist/esm/api/types/index.mjs

@@ -8,11 +8,20 @@ export * from "./FinalMessagePayload.mjs";
 export * from "./HttpValidationError.mjs";
 export * from "./ListTasksResponse.mjs";
 export * from "./Message.mjs";
+export * from "./MessageCardParameter.mjs";
+export * from "./MessageCardSubEntity.mjs";
+export * from "./MessageCardSubEntityItem.mjs";
 export * from "./MessageContactParty.mjs";
+export * from "./OptionsSearchSelfReviewMethod.mjs";
 export * from "./ParameterType.mjs";
 export * from "./ProductCard.mjs";
 export * from "./ProductParameter.mjs";
+export * from "./RecordOriginType.mjs";
 export * from "./StreamingUpdatePayload.mjs";
+export * from "./TaskInteractionOptionSelfReview.mjs";
+export * from "./TaskInteractionOptionSelfReviewScore.mjs";
+export * from "./TaskInteractionOptionSelfReviewScoreLabel.mjs";
+export * from "./TaskInteractionOptionSelfReviewType.mjs";
 export * from "./UserMessagePayload.mjs";
 export * from "./ValidationError.mjs";
 export * from "./WsActor.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.2.16";
+export declare const SDK_VERSION = "1.2.18";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "1.2.16";
+export const SDK_VERSION = "1.2.18";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@aui.io/aui-client",
-    "version": "1.2.16",
+    "version": "1.2.18",
     "private": false,
     "repository": "github:aui-io/aui-client-typescript",
     "type": "commonjs",

package/reference.md

@@ -67,7 +67,8 @@ await client.controllerApi.listUserTasks({
 
 ```typescript
 await client.controllerApi.createTask({
-    user_id: "user_id"
+    user_id: "user_id",
+    task_origin_type: "stores"
 });
 
 ```
@@ -202,6 +203,57 @@ await client.controllerApi.sendMessage({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.controllerApi.<a href="/src/api/resources/controllerApi/client/Client.ts">getProductMetadata</a>({ ...params }) -> Record<string, unknown></code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.controllerApi.getProductMetadata({
+    link: "link"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Apollo.GetProductMetadataRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ControllerApi.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>