feat(web-api): add workflows.featured.{add|list|remove|set} methods (#2303)

Co-authored-by: Elaine Vegeris <[email protected]>

Author: zimeg

packages/web-api/src/WebClient.spec.ts

@@ -326,6 +326,24 @@ describe('WebClient', () => {
           assert.fail('Should have logged a warning and info when files.upload is used');
         }
       });
+
+      it('warns when user is accessing a deprecated method', async () => {
+        const client = new WebClient(token, { logLevel: LogLevel.INFO, logger });
+        await client.apiCall('workflows.stepCompleted', {});
+
+        let warnedAboutDeprecatedMethod = false;
+        for (const call of (logger.warn as sinon.SinonStub).getCalls()) {
+          if (
+            call.args[0] ===
+            'workflows.stepCompleted is deprecated. Please check on https://docs.slack.dev/reference/methods for an alternative.'
+          ) {
+            warnedAboutDeprecatedMethod = true;
+          }
+        }
+        if (!warnedAboutDeprecatedMethod) {
+          assert.fail('Should have logged a warning when a deprecated method is used');
+        }
+      });
     });
 
     describe('with OAuth scopes in the response headers', () => {

packages/web-api/src/WebClient.ts

@@ -964,7 +964,7 @@ function parseRetryHeaders(response: AxiosResponse): number | undefined {
  * @param logger instance of web clients logger
  */
 function warnDeprecations(method: string, logger: Logger): void {
-  const deprecatedMethods = ['workflows.'];
+  const deprecatedMethods = ['workflows.stepCompleted', 'workflows.stepFailed', 'workflows.updateStep'];
 
   const isDeprecated = deprecatedMethods.some((depMethod) => {
     const re = new RegExp(`^${depMethod}`);

packages/web-api/src/methods.ts

@@ -250,6 +250,10 @@ import type {
   ViewsPublishArguments,
   ViewsPushArguments,
   ViewsUpdateArguments,
+  WorkflowsFeaturedAddArguments,
+  WorkflowsFeaturedListArguments,
+  WorkflowsFeaturedRemoveArguments,
+  WorkflowsFeaturedSetArguments,
   WorkflowsStepCompletedArguments,
   WorkflowsStepFailedArguments,
   WorkflowsUpdateStepArguments,
@@ -503,6 +507,10 @@ import type {
   ViewsPublishResponse,
   ViewsPushResponse,
   ViewsUpdateResponse,
+  WorkflowsFeaturedAddResponse,
+  WorkflowsFeaturedListResponse,
+  WorkflowsFeaturedRemoveResponse,
+  WorkflowsFeaturedSetResponse,
   WorkflowsStepCompletedResponse,
   WorkflowsStepFailedResponse,
   WorkflowsUpdateStepResponse,
@@ -2380,6 +2388,31 @@ export abstract class Methods extends EventEmitter<WebClientEvent> {
   };
 
   public readonly workflows = {
+    featured: {
+      /**
+       * @description Add featured workflows to a channel.
+       * @see {@link https://docs.slack.dev/reference/methods/workflows.featured.add `workflows.featured.add` API reference}.
+       */
+      add: bindApiCall<WorkflowsFeaturedAddArguments, WorkflowsFeaturedAddResponse>(this, 'workflows.featured.add'),
+      /**
+       * @description List the featured workflows for specified channels.
+       * @see {@link https://docs.slack.dev/reference/methods/workflows.featured.list `workflows.featured.list` API reference}.
+       */
+      list: bindApiCall<WorkflowsFeaturedListArguments, WorkflowsFeaturedListResponse>(this, 'workflows.featured.list'),
+      /**
+       * @description Remove featured workflows from a channel.
+       * @see {@link https://docs.slack.dev/reference/methods/workflows.featured.remove `workflows.featured.remove` API reference}.
+       */
+      remove: bindApiCall<WorkflowsFeaturedRemoveArguments, WorkflowsFeaturedRemoveResponse>(
+        this,
+        'workflows.featured.remove',
+      ),
+      /**
+       * @description Set featured workflows for a channel.
+       * @see {@link https://docs.slack.dev/reference/methods/workflows.featured.set `workflows.featured.set` API reference}.
+       */
+      set: bindApiCall<WorkflowsFeaturedSetArguments, WorkflowsFeaturedSetResponse>(this, 'workflows.featured.set'),
+    },
     /**
      * @description Indicate that an app's step in a workflow completed execution.
      * @deprecated Steps from Apps is deprecated.

packages/web-api/src/types/request/index.ts

@@ -317,6 +317,10 @@ export type {
   ViewsUpdateArguments,
 } from './views';
 export type {
+  WorkflowsFeaturedAddArguments,
+  WorkflowsFeaturedListArguments,
+  WorkflowsFeaturedRemoveArguments,
+  WorkflowsFeaturedSetArguments,
   WorkflowsStepCompletedArguments,
   WorkflowsStepFailedArguments,
   WorkflowsUpdateStepArguments,

packages/web-api/src/types/request/workflows.ts

@@ -1,5 +1,53 @@
 import type { TokenOverridable } from './common';
 
+// https://docs.slack.dev/reference/methods/workflows.featured.add
+export interface WorkflowsFeaturedAddArguments extends TokenOverridable {
+  /**
+   * @description Channel to add featured workflow in.
+   */
+  channel_id: string;
+  /**
+   * @description Comma-separated array of trigger IDs to add; max 15
+   * @example ["Ft012345", "Ft012346"]
+   */
+  trigger_ids: string[];
+}
+
+// https://docs.slack.dev/reference/methods/workflows.featured.list
+export interface WorkflowsFeaturedListArguments extends TokenOverridable {
+  /**
+   * @description Comma-separated array of channel IDs to list featured workflows for.
+   * @example ["C012345678", "C987654321"]
+   */
+  channel_ids: string[];
+}
+
+// https://docs.slack.dev/reference/methods/workflows.featured.remove
+export interface WorkflowsFeaturedRemoveArguments extends TokenOverridable {
+  /**
+   * @description Channel to remove featured workflow from.
+   */
+  channel_id: string;
+  /**
+   * @description Comma-separated array of trigger IDs to remove; max 15
+   * @example ["Ft012345", "Ft012346"]
+   */
+  trigger_ids: string[];
+}
+
+// https://docs.slack.dev/reference/methods/workflows.featured.set
+export interface WorkflowsFeaturedSetArguments extends TokenOverridable {
+  /**
+   * @description Channel to set featured workflow in.
+   */
+  channel_id: string;
+  /**
+   * @description Comma-separated array of trigger IDs that will replace any existing featured workflows in the channel; max 15
+   * @example ["Ft012345", "Ft012346"]
+   */
+  trigger_ids: string[];
+}
+
 // TODO: breaking change: to be removed after Sep 12 2024
 // https://docs.slack.dev/changelog/2023-08-workflow-steps-from-apps-step-back
 

packages/web-api/src/types/response/WorkflowsFeaturedAddResponse.ts

@@ -0,0 +1,3 @@
+import type { WebAPICallResult } from '../../WebClient';
+
+export type WorkflowsFeaturedAddResponse = WebAPICallResult & {};

packages/web-api/src/types/response/WorkflowsFeaturedListResponse.ts

@@ -0,0 +1,11 @@
+import type { WebAPICallResult } from '../../WebClient';
+
+export type WorkflowsFeaturedListResponse = WebAPICallResult & {
+  featured_workflows: {
+    channel_id: string;
+    triggers: {
+      id: string;
+      title: string;
+    }[];
+  }[];
+};

packages/web-api/src/types/response/WorkflowsFeaturedRemoveResponse.ts

@@ -0,0 +1,3 @@
+import type { WebAPICallResult } from '../../WebClient';
+
+export type WorkflowsFeaturedRemoveResponse = WebAPICallResult & {};

packages/web-api/src/types/response/WorkflowsFeaturedSetResponse.ts

@@ -0,0 +1,3 @@
+import type { WebAPICallResult } from '../../WebClient';
+
+export type WorkflowsFeaturedSetResponse = WebAPICallResult & {};

packages/web-api/src/types/response/index.ts

@@ -308,6 +308,10 @@ export { ViewsOpenResponse } from './ViewsOpenResponse';
 export { ViewsPublishResponse } from './ViewsPublishResponse';
 export { ViewsPushResponse } from './ViewsPushResponse';
 export { ViewsUpdateResponse } from './ViewsUpdateResponse';
+export { WorkflowsFeaturedAddResponse } from './WorkflowsFeaturedAddResponse';
+export { WorkflowsFeaturedListResponse } from './WorkflowsFeaturedListResponse';
+export { WorkflowsFeaturedRemoveResponse } from './WorkflowsFeaturedRemoveResponse';
+export { WorkflowsFeaturedSetResponse } from './WorkflowsFeaturedSetResponse';
 export { WorkflowsStepCompletedResponse } from './WorkflowsStepCompletedResponse';
 export { WorkflowsStepFailedResponse } from './WorkflowsStepFailedResponse';
 export { WorkflowsUpdateStepResponse } from './WorkflowsUpdateStepResponse';