windmill-client 1.442.0 → 1.443.0

package/dist/client.d.ts

@@ -179,6 +179,39 @@ interface SlackApprovalOptions {
     message?: string;
     approver?: string;
     defaultArgsJson?: Record<string, any>;
-    dynamicEnumJson?: Record<string, any>;
+    dynamicEnumsJson?: Record<string, any>;
 }
-export declare function requestInteractiveSlackApproval({ slackResourcePath, channelId, message, approver, defaultArgsJson, dynamicEnumJson, }: SlackApprovalOptions): Promise<void>;
+/**
+ * Sends an interactive approval request via Slack, allowing optional customization of the message, approver, and form fields.
+ *
+ * **[Enterprise Edition Only]** To include form fields in the Slack approval request, go to **Advanced -> Suspend -> Form**
+ * and define a form. Learn more at [Windmill Documentation](https://www.windmill.dev/docs/flows/flow_approval#form).
+ *
+ * @param {Object} options - The configuration options for the Slack approval request.
+ * @param {string} options.slackResourcePath - The path to the Slack resource in Windmill.
+ * @param {string} options.channelId - The Slack channel ID where the approval request will be sent.
+ * @param {string} [options.message] - Optional custom message to include in the Slack approval request.
+ * @param {string} [options.approver] - Optional user ID or name of the approver for the request.
+ * @param {DefaultArgs} [options.defaultArgsJson] - Optional object defining or overriding the default arguments to a form field.
+ * @param {Enums} [options.dynamicEnumsJson] - Optional object overriding the enum default values of an enum form field.
+ *
+ * @returns {Promise<void>} Resolves when the Slack approval request is successfully sent.
+ *
+ * @throws {Error} If the function is not called within a flow or flow preview.
+ * @throws {Error} If the `JobService.getSlackApprovalPayload` call fails.
+ *
+ * **Usage Example:**
+ * ```typescript
+ * await requestInteractiveSlackApproval({
+ *   slackResourcePath: "/u/alex/my_slack_resource",
+ *   channelId: "admins-slack-channel",
+ *   message: "Please approve this request",
+ *   approver: "approver123",
+ *   defaultArgsJson: { key1: "value1", key2: 42 },
+ *   dynamicEnumsJson: { foo: ["choice1", "choice2"], bar: ["optionA", "optionB"] },
+ * });
+ * ```
+ *
+ * **Note:** This function requires execution within a Windmill flow or flow preview.
+ */
+export declare function requestInteractiveSlackApproval({ slackResourcePath, channelId, message, approver, defaultArgsJson, dynamicEnumsJson, }: SlackApprovalOptions): Promise<void>;

package/dist/client.js

@@ -795,8 +795,41 @@ function usernameToEmail(username) {
         return yield index_1.UserService.usernameToEmail({ username, workspace });
     });
 }
+/**
+ * Sends an interactive approval request via Slack, allowing optional customization of the message, approver, and form fields.
+ *
+ * **[Enterprise Edition Only]** To include form fields in the Slack approval request, go to **Advanced -> Suspend -> Form**
+ * and define a form. Learn more at [Windmill Documentation](https://www.windmill.dev/docs/flows/flow_approval#form).
+ *
+ * @param {Object} options - The configuration options for the Slack approval request.
+ * @param {string} options.slackResourcePath - The path to the Slack resource in Windmill.
+ * @param {string} options.channelId - The Slack channel ID where the approval request will be sent.
+ * @param {string} [options.message] - Optional custom message to include in the Slack approval request.
+ * @param {string} [options.approver] - Optional user ID or name of the approver for the request.
+ * @param {DefaultArgs} [options.defaultArgsJson] - Optional object defining or overriding the default arguments to a form field.
+ * @param {Enums} [options.dynamicEnumsJson] - Optional object overriding the enum default values of an enum form field.
+ *
+ * @returns {Promise<void>} Resolves when the Slack approval request is successfully sent.
+ *
+ * @throws {Error} If the function is not called within a flow or flow preview.
+ * @throws {Error} If the `JobService.getSlackApprovalPayload` call fails.
+ *
+ * **Usage Example:**
+ * ```typescript
+ * await requestInteractiveSlackApproval({
+ *   slackResourcePath: "/u/alex/my_slack_resource",
+ *   channelId: "admins-slack-channel",
+ *   message: "Please approve this request",
+ *   approver: "approver123",
+ *   defaultArgsJson: { key1: "value1", key2: 42 },
+ *   dynamicEnumsJson: { foo: ["choice1", "choice2"], bar: ["optionA", "optionB"] },
+ * });
+ * ```
+ *
+ * **Note:** This function requires execution within a Windmill flow or flow preview.
+ */
 function requestInteractiveSlackApproval(_a) {
-    return __awaiter(this, arguments, void 0, function* ({ slackResourcePath, channelId, message, approver, defaultArgsJson, dynamicEnumJson, }) {
+    return __awaiter(this, arguments, void 0, function* ({ slackResourcePath, channelId, message, approver, defaultArgsJson, dynamicEnumsJson, }) {
         var _b;
         const workspace = getWorkspace();
         const flowJobId = getEnv("WM_FLOW_JOB_ID");
@@ -822,8 +855,8 @@ function requestInteractiveSlackApproval(_a) {
         if (defaultArgsJson) {
             params.defaultArgsJson = JSON.stringify(defaultArgsJson);
         }
-        if (dynamicEnumJson) {
-            params.dynamicEnumJson = JSON.stringify(dynamicEnumJson);
+        if (dynamicEnumsJson) {
+            params.dynamicEnumsJson = JSON.stringify(dynamicEnumsJson);
         }
         yield index_1.JobService.getSlackApprovalPayload(Object.assign(Object.assign({ workspace }, params), { id: (_b = getEnv("WM_JOB_ID")) !== null && _b !== void 0 ? _b : "NO_JOB_ID" }));
     });

package/dist/core/OpenAPI.js

@@ -39,7 +39,7 @@ exports.OpenAPI = {
     PASSWORD: undefined,
     TOKEN: getEnv("WM_TOKEN"),
     USERNAME: undefined,
-    VERSION: '1.442.0',
+    VERSION: '1.443.0',
     WITH_CREDENTIALS: true,
     interceptors: {
         request: new Interceptors(),

package/dist/services.gen.d.ts

@@ -2649,7 +2649,7 @@ export declare class JobService {
      * @param data.approver
      * @param data.message
      * @param data.defaultArgsJson
-     * @param data.dynamicEnumJson
+     * @param data.dynamicEnumsJson
      * @returns unknown Interactive slack approval message sent successfully
      * @throws ApiError
      */

package/dist/services.gen.js

@@ -5300,7 +5300,7 @@ class JobService {
      * @param data.approver
      * @param data.message
      * @param data.defaultArgsJson
-     * @param data.dynamicEnumJson
+     * @param data.dynamicEnumsJson
      * @returns unknown Interactive slack approval message sent successfully
      * @throws ApiError
      */
@@ -5319,7 +5319,7 @@ class JobService {
                 channel_id: data.channelId,
                 flow_step_id: data.flowStepId,
                 default_args_json: data.defaultArgsJson,
-                dynamic_enum_json: data.dynamicEnumJson
+                dynamic_enums_json: data.dynamicEnumsJson
             }
         });
     }

package/dist/types.gen.d.ts

@@ -4230,7 +4230,7 @@ export type GetSlackApprovalPayloadData = {
     approver?: string;
     channelId: string;
     defaultArgsJson?: string;
-    dynamicEnumJson?: string;
+    dynamicEnumsJson?: string;
     flowStepId: string;
     id: string;
     message?: string;
@@ -10711,7 +10711,7 @@ export type $OpenApiTs = {
                 approver?: string;
                 channelId: string;
                 defaultArgsJson?: string;
-                dynamicEnumJson?: string;
+                dynamicEnumsJson?: string;
                 flowStepId: string;
                 id: string;
                 message?: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "windmill-client",
   "description": "Windmill SDK client for browsers and Node.js",
-  "version": "1.442.0",
+  "version": "1.443.0",
   "author": "Ruben Fiszel",
   "license": "Apache 2.0",
   "devDependencies": {