SWI-5430 Add Prism Mock Tests (#31)

* SWI-5429 Update Test Suite and Workflows

* update template

* remove matrix from smoke tests

* add unit tests for calls, conferences, recordings

* update method names

* use nes asserts from extended library

* media and messages

* update asserts with !

* update api error tests

* more mock tests

* add jest-extended

* update tnl tests

* messages tests

* remove unnecessary globalThis

* more globalThis removal

* update to 200

* update bw spec

* add prism to workflows

* move prism to one step

* update matrices

* run prism in another shell

* why is node 16 back

* run tests fr this time

* update package template

* update readme to remove node 16

* regenerate

* specify bash to hopefully work on windows

* does npm work?

* update readme

Author: ckoegel

.github/workflows/deploy.yml

@@ -46,13 +46,15 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 22
           registry-url: "https://registry.npmjs.org"
 
       - name: Install Packages and Test
         run: |
           yarn
-          yarn test-unit
+          npm install -g @stoplight/prism-cli
+          prism mock ./bandwidth.yml & yarn test-unit
+        shell: bash
 
       - name: Publish npm Package
         run: |

.github/workflows/test-nightly.yml

@@ -37,7 +37,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: 22
 
       - name: Install Packages and Test
         run: |

.github/workflows/test-pr.yml

@@ -32,7 +32,7 @@ jobs:
     strategy:
       matrix:
         os: [windows-2022, windows-2019, ubuntu-20.04, ubuntu-22.04]
-        node-version: [16, 18, 20, 22]
+        node-version: [18, 20, 22]
       fail-fast: false
     steps:
       - name: Checkout
@@ -46,6 +46,8 @@ jobs:
       - name: Install Packages and Test
         run: |
           yarn
-          yarn test-unit
+          npm install -g @stoplight/prism-cli
+          prism mock ./bandwidth.yml & yarn test-unit
         env:
           OPERATING_SYSTEM: ${{ matrix.os }}
+        shell: bash

README.md

@@ -1,20 +1,37 @@
 ## bandwidth-sdk
 
-[![Tests](https://github.com/Bandwidth/node-sdk/actions/workflows/test-nightly.yml/badge.svg)](https://github.com/Bandwidth/node-sdk/actions/workflows/test-nightly.yml)
+[![Deploy](https://github.com/Bandwidth/node-sdk/actions/workflows/deploy.yml/badge.svg)](https://github.com/Bandwidth/node-sdk/actions/workflows/deploy.yml)
 
 ### Test Matrix
 | **OS** | **Node** |
 |:---:|:---:|
-| Windows 2019 | 16, 18, 20, 22 |
-| Windows 2022 | 16, 18, 20, 22 |
-| Ubuntu 20.04 | 16, 18, 20, 22 |
-| Ubuntu 22.04 | 16, 18, 20, 22 |
+| Windows 2019 | 18, 20, 22 |
+| Windows 2022 | 18, 20, 22 |
+| Ubuntu 20.04 | 18, 20, 22 |
+| Ubuntu 22.04 | 18, 20, 22 |
 
 #### Available on NPM
 ```
 npm install bandwidth-sdk
 ```
 
+
+#### To Run Unit Tests Locally
+
+1. Install Prism
+```bash
+npm install -g @stoplight/prism-cli
+```
+2. Start Prism Mock Server with the OpenAPI Spec
+```bash
+prism mock bandwidth.yml
+```
+3. Run Tests
+```bash
+npm run test-unit
+```
+
+
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
 Environment

api/transcriptions-api.ts

@@ -34,7 +34,7 @@ import type { VoiceApiError } from '../models';
 export const TranscriptionsApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
         /**
-         * Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).  Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
+         * Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).  Note: After the deletion is requested and a `200` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
          * @summary Delete a specific transcription
          * @param {string} accountId Your Bandwidth Account ID.
          * @param {string} callId Programmable Voice API Call ID.
@@ -178,7 +178,7 @@ export const TranscriptionsApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = TranscriptionsApiAxiosParamCreator(configuration)
     return {
         /**
-         * Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).  Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
+         * Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).  Note: After the deletion is requested and a `200` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
          * @summary Delete a specific transcription
          * @param {string} accountId Your Bandwidth Account ID.
          * @param {string} callId Programmable Voice API Call ID.
@@ -232,7 +232,7 @@ export const TranscriptionsApiFactory = function (configuration?: Configuration,
     const localVarFp = TranscriptionsApiFp(configuration)
     return {
         /**
-         * Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).  Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
+         * Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).  Note: After the deletion is requested and a `200` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
          * @summary Delete a specific transcription
          * @param {string} accountId Your Bandwidth Account ID.
          * @param {string} callId Programmable Voice API Call ID.
@@ -277,7 +277,7 @@ export const TranscriptionsApiFactory = function (configuration?: Configuration,
  */
 export class TranscriptionsApi extends BaseAPI {
     /**
-     * Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).  Note: After the deletion is requested and a `204` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
+     * Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).  Note: After the deletion is requested and a `200` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
      * @summary Delete a specific transcription
      * @param {string} accountId Your Bandwidth Account ID.
      * @param {string} callId Programmable Voice API Call ID.

bandwidth.yml

@@ -1173,7 +1173,7 @@ paths:
         [startTranscription](/docs/voice/bxml/startTranscription).
 
 
-        Note: After the deletion is requested and a `204` is returned, the
+        Note: After the deletion is requested and a `200` is returned, the
         transcription will not be accessible anymore. However, it is not deleted
         immediately. This deletion process, while transparent and irreversible,
         can take an additional 24 to 48 hours.
@@ -1183,7 +1183,7 @@ paths:
         - $ref: '#/components/parameters/callId'
         - $ref: '#/components/parameters/transcriptionId'
       responses:
-        '204':
+        '200':
           $ref: '#/components/responses/deleteCallTranscriptionResponse'
         '400':
           $ref: '#/components/responses/voiceBadRequestError'
@@ -2496,7 +2496,7 @@ components:
           description: >-
             The phone number that made the call, in E.164 format (e.g.
             +15555555555).
-          example: '19195554321'
+          example: '+19195554321'
         direction:
           $ref: '#/components/schemas/callDirectionEnum'
         state:
@@ -3265,7 +3265,7 @@ components:
         accountId:
           type: string
           description: The user account associated with the call.
-          example: '920012'
+          example: '9900000'
         callId:
           type: string
           description: The call id associated with the event.
@@ -4139,7 +4139,7 @@ components:
     accountId:
       type: string
       description: The user account associated with the call.
-      example: '920012'
+      example: '9900000'
     applicationId:
       type: string
       description: The id of the application associated with the call.
@@ -4240,7 +4240,7 @@ components:
       description: >-
         The phone number used as the to field of the B-leg call, in E.164 format
         (e.g. +15555555555).
-      example: +15555555555)
+      example: "+15555555555"
     mediaUrl:
       nullable: true
       type: string
@@ -4451,7 +4451,7 @@ components:
         messageId:
           type: string
           description: Messaging API Message ID.
-          example: 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6
+          example: 1589228074636lm4k2je7j7jklbn2
     verifyCodeRequest:
       type: object
       properties:
@@ -5787,6 +5787,7 @@ components:
         answerMethod: POST
         answerUrl: https://myServer.example/bandwidth/webhooks/answer
         answerFallbackMethod: POST
+        answerFallbackUrl: "https://myServer.example/bandwidth/webhooks/answerFallback"
         disconnectMethod: POST
         disconnectUrl: https://myServer.example/bandwidth/webhooks/disconnect
         username: mySecretUsername

custom_templates/README.mustache

@@ -1,20 +1,37 @@
 ## {{npmName}}
 
-[![Tests](https://github.com/Bandwidth/node-sdk/actions/workflows/test-nightly.yml/badge.svg)](https://github.com/Bandwidth/node-sdk/actions/workflows/test-nightly.yml)
+[![Tests](https://github.com/Bandwidth/node-sdk/actions/workflows/deploy.yml/badge.svg)](https://github.com/Bandwidth/node-sdk/actions/workflows/deploy.yml)
 
 ### Test Matrix
 | **OS** | **Node** |
 |:---:|:---:|
-| Windows 2019 | 16, 18, 20, 22 |
-| Windows 2022 | 16, 18, 20, 22 |
-| Ubuntu 20.04 | 16, 18, 20, 22 |
-| Ubuntu 22.04 | 16, 18, 20, 22 |
+| Windows 2019 | 18, 20, 22 |
+| Windows 2022 | 18, 20, 22 |
+| Ubuntu 20.04 | 18, 20, 22 |
+| Ubuntu 22.04 | 18, 20, 22 |
 
 #### Available on NPM
 ```
 npm install {{npmName}}
 ```
 
+
+#### To Run Unit Tests Locally
+
+1. Install Prism
+```bash
+npm install -g @stoplight/prism-cli
+```
+2. Start Prism Mock Server with the OpenAPI Spec
+```bash
+prism mock bandwidth.yml
+```
+3. Run Tests
+```bash
+npm run test-unit
+```
+
+
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
 Environment

custom_templates/package.mustache

@@ -33,9 +33,10 @@
     "xmlbuilder2": "^3.1.1"
   },
   "devDependencies": {
-    "@types/node": "^12.11.5",
     "@types/jest": "^29.5.12",
+    "@types/node": "^12.11.5",
     "jest": "^29.7.0",
+    "jest-extended": "^4.0.2",
     "ts-jest": "^29.1.1",
     "typescript": "^5.0"
   }{{#npmRepository}},{{/npmRepository}}

custom_templates/tsconfig.mustache

@@ -23,5 +23,6 @@
     "dist",
     "tests",
     "node_modules"
-  ]
+  ],
+  "include": ["global.d.ts"]
 }

global.d.ts

@@ -0,0 +1 @@
+import 'jest-extended';