feat: add nextWorkflow method to Verify2 (#1032)

Author: alnacle

packages/verify2/__tests__/__dataSets__/nextWorkflow.ts

@@ -0,0 +1,59 @@
+
+import {
+  SDKTestCase,
+  keyAuth,
+  validateBearerAuth,
+} from '../../../../testHelpers';
+import {
+  Verify2,
+} from '../../lib/';
+
+export default [
+  {
+    label: 'next workflow request',
+    baseUrl: 'https://api.nexmo.com',
+    reqHeaders: {
+      authorization: validateBearerAuth,
+    },
+    client: new Verify2(keyAuth),
+    generator: false,
+    error: false,
+    requests: [
+      ['/v2/verify/091e717f-8715-41a0-a3f0-cc04912deaa1/next_workflow', 'POST'],
+    ],
+    responses: [
+      [200],
+    ],
+    method: 'post',
+    clientMethod: 'nextWorkflow',
+    parameters: ['091e717f-8715-41a0-a3f0-cc04912deaa1'],
+    expected: true,
+  },
+  {
+    label: 'error when request Id not found',
+    baseUrl: 'https://api.nexmo.com',
+    reqHeaders: {
+      authorization: validateBearerAuth,
+    },
+    client: new Verify2(keyAuth),
+    generator: false,
+    error: false,
+    requests: [
+      ['/v2/verify/091e717f-8715-41a0-a3f0-cc04912deaa1/next_workflow', 'POST'],
+    ],
+    responses: [
+      [
+        404,
+        {
+          title: 'Not Found',
+          type: 'https://developer.vonage.com/api-errors#not-found',
+          detail: 'Request <id> was not found or it has been verified already.',
+          instance: 'bf0ca0bf927b3b52e3cb03217e1a1ddf',
+        },
+      ],
+    ],
+    clientMethod: 'nextWorkflow',
+    parameters: ['091e717f-8715-41a0-a3f0-cc04912deaa1'],
+    expected: false,
+  },
+] as SDKTestCase<Verify2>[];

packages/verify2/lib/verify2.ts

@@ -61,6 +61,24 @@ export class Verify2 extends Client {
     return resp.data.status;
   }
 
+  /**
+   * Move the request to the next workflow step, if available.
+   * @param {string} requestId - The ID of the verification request.
+   * @return {boolean} `true` if the request was successful.
+   */
+  async nextWorkflow(requestId: string): Promise<boolean> {
+    try {
+      await this.sendPostRequest(
+        `${this.config.apiHost}/v2/verify/${requestId}/next_workflow`,
+      );
+      return true;
+
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    } catch (_) {
+      return false;
+    }
+  }
+
   /**
    * Cancels a verification request.
    * @param {string} requestId - The ID of the verification request to cancel.