@aui.io/aui-client 1.2.31 → 1.2.33

package/README.md

@@ -235,6 +235,28 @@ const taskResponse = await client.controllerApi.createTask({
 
 **Note:** `task_origin_type` is required in v1.2.17+. Common values: `'web-widget'`, `'mobile-app'`, `'api'`, `'internal-tool'`
 
+#### `getTask(taskId)` - Get Task By ID
+Retrieve a specific task by its ID.
+
+```typescript
+const task = await client.controllerApi.getTask(taskId: string);
+
+// Returns: { id: string, user_id: string, title: string, welcome_message?: string }
+```
+
+**Example:**
+
+```typescript
+const task = await client.controllerApi.getTask('your-task-id');
+
+console.log('Task ID:', task.id);
+console.log('User ID:', task.user_id);
+console.log('Title:', task.title);
+if (task.welcome_message) {
+    console.log('Welcome:', task.welcome_message);
+}
+```
+
 #### `getTaskMessages(taskId)` - Get Task Messages
 Retrieve all messages for a specific task.
 

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.31",
-                "User-Agent": "@aui.io/aui-client/1.2.31",
+                "X-Fern-SDK-Version": "1.2.33",
+                "User-Agent": "@aui.io/aui-client/1.2.33",
                 "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

@@ -126,4 +126,22 @@ export declare class ControllerApi {
      */
     getWorkflowsMetadata(requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Apollo.WorkflowsMetadataResponse>;
     private __getWorkflowsMetadata;
+    /**
+     * Start a text conversation (WhatsApp or SMS).
+     *
+     * Creates a task and then proxies to third-party-auth(BE) service to send the initial message.
+     *
+     * @param {Apollo.TextConversationInitiateRequest} request
+     * @param {ControllerApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Apollo.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.controllerApi.startTextConversation({
+     *         phoneNumber: "phoneNumber",
+     *         channel: "channel"
+     *     })
+     */
+    startTextConversation(request: Apollo.TextConversationInitiateRequest, requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Apollo.TextConversationInitiateResponse>;
+    private __startTextConversation;
 }

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

@@ -659,5 +659,79 @@ class ControllerApi {
             }
         });
     }
+    /**
+     * Start a text conversation (WhatsApp or SMS).
+     *
+     * Creates a task and then proxies to third-party-auth(BE) service to send the initial message.
+     *
+     * @param {Apollo.TextConversationInitiateRequest} request
+     * @param {ControllerApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Apollo.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.controllerApi.startTextConversation({
+     *         phoneNumber: "phoneNumber",
+     *         channel: "channel"
+     *     })
+     */
+    startTextConversation(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__startTextConversation(request, requestOptions));
+    }
+    __startTextConversation(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+            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.Gcp).base, "api/v1/external/text/conversation"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                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 POST /api/v1/external/text/conversation.");
+                case "unknown":
+                    throw new errors.ApolloError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
 }
 exports.ControllerApi = ControllerApi;

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

@@ -0,0 +1,15 @@
+/**
+ * @example
+ *     {
+ *         phoneNumber: "phoneNumber",
+ *         channel: "channel"
+ *     }
+ */
+export interface TextConversationInitiateRequest {
+    /** Phone number in E.164 format (e.g., +1234567890) */
+    phoneNumber: string;
+    /** Channel type: 'whatsapp' or 'sms' */
+    channel: string;
+    /** Optional initial message to send */
+    message?: string;
+}

package/dist/cjs/api/resources/controllerApi/client/requests/TextConversationInitiateRequest.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

@@ -2,3 +2,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";
+export type { TextConversationInitiateRequest } from "./TextConversationInitiateRequest.js";

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

@@ -0,0 +1,6 @@
+export interface TextConversationInitiateResponse {
+    status: boolean;
+    data: Record<string, string>;
+    message: string;
+    statusCode: number;
+}

package/dist/cjs/api/types/TextConversationInitiateResponse.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

@@ -40,6 +40,7 @@ export * from "./TaskParameterType.js";
 export * from "./TaskParameterValue.js";
 export * from "./TaskTopicEntity.js";
 export * from "./TaskTopicEntityItem.js";
+export * from "./TextConversationInitiateResponse.js";
 export * from "./UserMessagePayload.js";
 export * from "./ValidationError.js";
 export * from "./WorkflowMetadata.js";

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

@@ -56,6 +56,7 @@ __exportStar(require("./TaskParameterType.js"), exports);
 __exportStar(require("./TaskParameterValue.js"), exports);
 __exportStar(require("./TaskTopicEntity.js"), exports);
 __exportStar(require("./TaskTopicEntityItem.js"), exports);
+__exportStar(require("./TextConversationInitiateResponse.js"), exports);
 __exportStar(require("./UserMessagePayload.js"), exports);
 __exportStar(require("./ValidationError.js"), exports);
 __exportStar(require("./WorkflowMetadata.js"), exports);

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.2.31";
+export declare const SDK_VERSION = "1.2.33";

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.31";
+exports.SDK_VERSION = "1.2.33";

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.31",
-                "User-Agent": "@aui.io/aui-client/1.2.31",
+                "X-Fern-SDK-Version": "1.2.33",
+                "User-Agent": "@aui.io/aui-client/1.2.33",
                 "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

@@ -126,4 +126,22 @@ export declare class ControllerApi {
      */
     getWorkflowsMetadata(requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Apollo.WorkflowsMetadataResponse>;
     private __getWorkflowsMetadata;
+    /**
+     * Start a text conversation (WhatsApp or SMS).
+     *
+     * Creates a task and then proxies to third-party-auth(BE) service to send the initial message.
+     *
+     * @param {Apollo.TextConversationInitiateRequest} request
+     * @param {ControllerApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Apollo.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.controllerApi.startTextConversation({
+     *         phoneNumber: "phoneNumber",
+     *         channel: "channel"
+     *     })
+     */
+    startTextConversation(request: Apollo.TextConversationInitiateRequest, requestOptions?: ControllerApi.RequestOptions): core.HttpResponsePromise<Apollo.TextConversationInitiateResponse>;
+    private __startTextConversation;
 }

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

@@ -623,4 +623,78 @@ export class ControllerApi {
             }
         });
     }
+    /**
+     * Start a text conversation (WhatsApp or SMS).
+     *
+     * Creates a task and then proxies to third-party-auth(BE) service to send the initial message.
+     *
+     * @param {Apollo.TextConversationInitiateRequest} request
+     * @param {ControllerApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Apollo.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.controllerApi.startTextConversation({
+     *         phoneNumber: "phoneNumber",
+     *         channel: "channel"
+     *     })
+     */
+    startTextConversation(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__startTextConversation(request, requestOptions));
+    }
+    __startTextConversation(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+            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.Gcp).base, "api/v1/external/text/conversation"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                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 POST /api/v1/external/text/conversation.");
+                case "unknown":
+                    throw new errors.ApolloError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
 }

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

@@ -0,0 +1,15 @@
+/**
+ * @example
+ *     {
+ *         phoneNumber: "phoneNumber",
+ *         channel: "channel"
+ *     }
+ */
+export interface TextConversationInitiateRequest {
+    /** Phone number in E.164 format (e.g., +1234567890) */
+    phoneNumber: string;
+    /** Channel type: 'whatsapp' or 'sms' */
+    channel: string;
+    /** Optional initial message to send */
+    message?: string;
+}

package/dist/esm/api/resources/controllerApi/client/requests/TextConversationInitiateRequest.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

@@ -2,3 +2,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";
+export type { TextConversationInitiateRequest } from "./TextConversationInitiateRequest.mjs";

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

@@ -0,0 +1,6 @@
+export interface TextConversationInitiateResponse {
+    status: boolean;
+    data: Record<string, string>;
+    message: string;
+    statusCode: number;
+}

package/dist/esm/api/types/TextConversationInitiateResponse.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

@@ -40,6 +40,7 @@ export * from "./TaskParameterType.mjs";
 export * from "./TaskParameterValue.mjs";
 export * from "./TaskTopicEntity.mjs";
 export * from "./TaskTopicEntityItem.mjs";
+export * from "./TextConversationInitiateResponse.mjs";
 export * from "./UserMessagePayload.mjs";
 export * from "./ValidationError.mjs";
 export * from "./WorkflowMetadata.mjs";

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

@@ -40,6 +40,7 @@ export * from "./TaskParameterType.mjs";
 export * from "./TaskParameterValue.mjs";
 export * from "./TaskTopicEntity.mjs";
 export * from "./TaskTopicEntityItem.mjs";
+export * from "./TextConversationInitiateResponse.mjs";
 export * from "./UserMessagePayload.mjs";
 export * from "./ValidationError.mjs";
 export * from "./WorkflowMetadata.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.2.31";
+export declare const SDK_VERSION = "1.2.33";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "1.2.31";
+export const SDK_VERSION = "1.2.33";

package/package.json

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

package/reference.md

@@ -459,6 +459,74 @@ await client.controllerApi.getWorkflowsMetadata();
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.controllerApi.<a href="/src/api/resources/controllerApi/client/Client.ts">startTextConversation</a>({ ...params }) -> Apollo.TextConversationInitiateResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Start a text conversation (WhatsApp or SMS).
+
+Creates a task and then proxies to third-party-auth(BE) service to send the initial message.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.controllerApi.startTextConversation({
+    phoneNumber: "phoneNumber",
+    channel: "channel"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Apollo.TextConversationInitiateRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ControllerApi.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>