VBLOCKS-3365 Update preflight docs (#286)

* Update preflight docs

* Update docs

Author: charliesantos

PREFLIGHT.md

@@ -1,12 +1,12 @@
 Preflight Test
 ==============
 
-The SDK supports a preflight test API which can help determine Voice calling readiness. The API creates a test call and will provide information to help troubleshoot call related issues. This new API is a static member of the [Device](https://www.twilio.com/docs/voice/client/javascript/device#twilio-device) class and can be used by calling `Device.testPreflight(token, options)`. For example:
+The SDK supports a preflight test API which can help determine Voice calling readiness. The API creates a test call and will provide information to help troubleshoot call related issues. This new API is a static member of the [Device](https://www.twilio.com/docs/voice/sdks/javascript/twiliodevice) class and can be used by calling `Device.runPreflight(token, options)`. For example:
 
 ```ts
-import { Device, PreflightTest } from 'twilio-client';
+import { Device, PreflightTest } from '@twilio/voice-sdk';
 
-const preflightTest = Device.testPreflight(token, options);
+const preflightTest = Device.runPreflight(token, options);
 
 preflightTest.on(PreflightTest.Events.Completed, (report) => {
   console.log(report);
@@ -20,7 +20,7 @@ preflightTest.on(PreflightTest.Events.Failed, (error) => {
 ## Parameters
 
 ### Token
-`Device.testPreflight(token, options)` requires a [Twilio Access Token](https://www.twilio.com/docs/iam/access-tokens) to initiate the test call. This access token will be passed directly to the [Device's constructor](https://www.twilio.com/docs/voice/client/javascript/device#setup) and will be used to connect to a TwiML app that you associated with your [Twilio Access Token](https://www.twilio.com/docs/iam/access-tokens). In order to get better results, the TwiML app should be able to record audio from a microphone and play it back to the browser. Please see [Preflight Test TwiML App](#twiml-app---record-and-play) for details.
+`Device.runPreflight(token, options)` requires a [Twilio Access Token](https://www.twilio.com/docs/iam/access-tokens) to initiate the test call. This access token will be passed directly to the [Device's constructor](https://www.twilio.com/docs/voice/sdks/javascript/twiliodevice#instantiate-a-device) and will be used to connect to a TwiML app that you associated with your [Twilio Access Token](https://www.twilio.com/docs/iam/access-tokens). In order to get better results, the TwiML app should be able to record audio from a microphone and play it back to the browser. Please see [Preflight Test TwiML App](#twiml-app---record-and-play) for details.
 
 ### Options
 The `PreflightTest.Options` parameter is a JavaScript object containing configuration settings. Available settings are listed below:
@@ -29,7 +29,7 @@ The `PreflightTest.Options` parameter is a JavaScript object containing configur
 |:---------|:--------|:------------|
 | `codecPreferences` | `['pcmu', 'opus']` | An ordered list of preferred codecs. |
 | `debug` | `false` | Can be `true` or `false`. Set this property to true to enable debug logging in your browser console. |
-| `edge` | `roaming` | Specifies which Twilio `edge` to use when initiating the test call. Please see documentation on [edges](https://www.twilio.com/docs/voice/client/edges). |
+| `edge` | `roaming` | Specifies which Twilio `edge` to use when initiating the test call. Please see documentation on [edges](https://www.twilio.com/docs/voice/sdks/javascript/edges). |
 | `fakeMicInput` | `false` | If set to `true`, the test call will ignore microphone input and will use a default audio file. If set to `false`, the test call will capture the audio from the microphone. |
 | `iceServers` | `null` | An array of custom ICE servers to use to connect media. If you provide both STUN and TURN server configurations, the test will detect whether a TURN server is required to establish a connection. See [Using Twilio NTS for Generating STUN/TURN Credentials](#using-twilio-nts-for-generating-stunturn-credentials) |
 | `signalingTimeoutMs` | `10000` | Ammount of time to wait for setting up signaling connection. |
@@ -39,7 +39,7 @@ The following example demonstrates how to use [Twilio's Network Traversal Servic
 
 ```ts
 import Client from 'twilio';
-import { Device } from 'twilio-client';
+import { Device } from '@twilio/voice-sdk';
 
 // Generate the STUN and TURN server credentials with a ttl of 120 seconds
 const client = Client(twilioAccountSid, authToken);
@@ -58,7 +58,7 @@ iceServers = iceServers.map(config => {
 });
 
 // Use the TURN credentials using the iceServers parameter
-const preflightTest = Device.testPreflight(token, { iceServers });
+const preflightTest = Device.runPreflight(token, { iceServers });
 
 // Read from the report object to determine whether TURN is required to connect to media
 preflightTest.on('completed', (report) => {
@@ -69,7 +69,7 @@ preflightTest.on('completed', (report) => {
 Events
 ------
 
-The `PreflightTest` object that is returned by `Device.testPreflight(token, options)` is an [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter), and as such its events can be subscribed to via `preflightTest.on(eventName, handler)`. The following is a list of all supported events that might get emitted throughout the duration of the test.
+The `PreflightTest` object that is returned by `Device.runPreflight(token, options)` is an [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter), and as such its events can be subscribed to via `preflightTest.on(eventName, handler)`. The following is a list of all supported events that might get emitted throughout the duration of the test.
 
 #### .on('completed', handler(report))
 Raised when `PreflightTest.status` has transitioned to `PreflightTest.Status.Completed`. During this time, the `report` is available and ready to be inspected. This will not trigger if a fatal error is encountered during the test. Example report:
@@ -215,12 +215,12 @@ Raised when `PreflightTest.status` has transitioned to `PreflightTest.Status.Com
   /**
    * Array of samples collected during the test.
    * See sample object format here
-   * https://www.twilio.com/docs/voice/client/javascript/connection#sample
+   * https://www.twilio.com/docs/voice/sdks/javascript/twiliocall#sample-event
    */
   "samples": [...],
 
   /**
-   * The edge passed to `Device.testPreflight`.
+   * The edge passed to `Device.runPreflight`.
    */
   "selectedEdge": "roaming",
 
@@ -240,10 +240,10 @@ Raised when `PreflightTest.status` has transitioned to `PreflightTest.Status.Com
 Raised when `PreflightTest.status` has transitioned to `PreflightTest.Status.Connected`. This means, the connection to Twilio has been established.
 
 #### .on('failed', handler(error))
-Raised when `PreflightTest.status` has transitioned to `PreflightTest.Status.Failed`. This happens when establishing a connection to Twilio has failed or when a test call has encountered a fatal error. This is also raised if `PreflightTest.stop` is called while the test is in progress. The error emitted from this event is coming from [Device.on('error)](https://www.twilio.com/docs/voice/client/javascript/device#error) and uses the same error format.
+Raised when `PreflightTest.status` has transitioned to `PreflightTest.Status.Failed`. This happens when establishing a connection to Twilio has failed or when a test call has encountered a fatal error. This is also raised if `PreflightTest.stop` is called while the test is in progress. The error emitted from this event is coming from [Device.on('error)](https://www.twilio.com/docs/voice/sdks/javascript/twiliodevice#error-event) and uses the same error format.
 
 #### .on('sample', handler(sample))
-This event is published every second and is raised when the [Connection](https://www.twilio.com/docs/voice/client/javascript/connection) gets a webrtc sample object. The `sample` object is coming from [Connection.on('sample')](https://www.twilio.com/docs/voice/client/javascript/connection#sample) and uses the same `sample` format.
+This event is published every second and is raised when the [Call](https://www.twilio.com/docs/voice/sdks/javascript/twiliocall) gets a webrtc sample object. The `sample` object is coming from [Call.on('sample')](https://www.twilio.com/docs/voice/sdks/javascript/twiliocall#sample-event) and uses the same `sample` format.
 
 #### .on('warning', handler(warning))
 Raised whenever the test encounters a warning. Example warning data:
@@ -252,7 +252,7 @@ Raised whenever the test encounters a warning. Example warning data:
 {
   /**
    * Name of the warning.
-   * See https://www.twilio.com/docs/voice/insights/call-quality-events-twilio-client-sdk
+   * See https://www.twilio.com/docs/voice/voice-insights/api/call/details-sdk-call-quality-events
    */
   name: 'insights-connection-error',
 
@@ -262,8 +262,8 @@ Raised whenever the test encounters a warning. Example warning data:
   description: 'Received an error when attempting to connect to Insights gateway',
 
   /**
-   * Optional RTCWarning data coming from Connection.on('warning')
-   * See https://www.twilio.com/docs/voice/client/javascript/connection#onwarning-handlerwarningname
+   * Optional RTCWarning data coming from Call.on('warning')
+   * See https://www.twilio.com/docs/voice/sdks/javascript/twiliocall#warning-event
    */
   rtcWarning: {...}
 }
@@ -275,9 +275,9 @@ You can access the following properties on the `PreflightTest` object:
 
 * `callSid` - The callsid generated for the test call. This is set when the client has finished connecting to Twilio.
 * `endTime` - A timestamp in milliseconds of when the test ended. This is set when the test has completed and raised the `completed` event.
-* `latestSample` - The latest WebRTC sample collected. This is set whenever the connection emits a `sample`. Please see [Connection.on('sample')](https://www.twilio.com/docs/voice/client/javascript/connection#sample) API for more details.
+* `latestSample` - The latest WebRTC sample collected. This is set whenever the connection emits a `sample`. Please see [Call.on('sample')](https://www.twilio.com/docs/voice/sdks/javascript/twiliocall#sample-event) API for more details.
 * `report` - The report for this test. This is set when the test has completed and raised the `completed` event.
-* `startTime` - A timestamp in milliseconds of when the test started. This is set right after calling `Device.testPreflight(token, options)`.
+* `startTime` - A timestamp in milliseconds of when the test started. This is set right after calling `Device.runPreflight(token, options)`.
 * `status` - The status of the test. Below are the possible values for this property.
 
   | Value | Description |
@@ -297,7 +297,7 @@ Calling this method from the `PreflightTest` object will stop the existing test
 TwiML App - Record and Play
 ===========================
 
-If `PreflightTest.Options.fakeMicInput` is set to `false`, `Device.testPreflight(token, options)` API requires a [token](https://www.twilio.com/docs/iam/access-tokens) with a TwiML app that can record an audio from a microphone and the ability to play the recorded audio back to the browser. In order to achieve this, we need two TwiML endpoints: one to capture and record the audio, and another one to play the recorded audio.
+If `PreflightTest.Options.fakeMicInput` is set to `false`, `Device.runPreflight(token, options)` API requires a [token](https://www.twilio.com/docs/iam/access-tokens) with a TwiML app that can record an audio from a microphone and the ability to play the recorded audio back to the browser. In order to achieve this, we need two TwiML endpoints: one to capture and record the audio, and another one to play the recorded audio.
 
 TwiML Bins
 ----------
@@ -341,13 +341,13 @@ Creating the TwiML App
 
 Now that we have created our TwiML Bins, let's create our TwiML app by going to the [TwiML Apps](https://www.twilio.com/console/voice/twiml/apps) page. Click the plus button on that screen and enter a friendly name that you prefer. Under Voice request url, enter the **TwiML Bin's Record** url that you created in the previous section, and then click the **Create** button.
 
-On that same page, open the TwiML app that you just created by clicking on it and make note of the `SID`. You can now use this TwiML app to generate your [token](https://www.twilio.com/docs/iam/access-tokens) when calling `Device.testPreflight(token, options)` API.
+On that same page, open the TwiML app that you just created by clicking on it and make note of the `SID`. You can now use this TwiML app to generate your [token](https://www.twilio.com/docs/iam/access-tokens) when calling `Device.runPreflight(token, options)` API.
 
 
 TwiML App - Echo
 ================
 
-If `PreflightTest.Options.fakeMicInput` is set to `true`, `Device.testPreflight(token, options)` API requires a [token](https://www.twilio.com/docs/iam/access-tokens) with a single TwiML app that can capture and play an audio. Following the [previous steps](#twiml-bins), create a TwiML Bin using the following template, and name it `Echo`.
+If `PreflightTest.Options.fakeMicInput` is set to `true`, `Device.runPreflight(token, options)` API requires a [token](https://www.twilio.com/docs/iam/access-tokens) with a single TwiML app that can capture and play an audio. Following the [previous steps](#twiml-bins), create a TwiML Bin using the following template, and name it `Echo`.
 
 ```xml
 <?xml version="1.0" encoding="UTF-8"?>

lib/twilio/preflight/preflight.ts

@@ -806,7 +806,7 @@ export namespace PreflightTest {
      *
      * ```ts
      * import Client from 'twilio';
-     * import { Device } from 'twilio-client';
+     * import { Device } from '@twilio/voice-sdk';
      *
      * // Generate the STUN and TURN server credentials with a ttl of 120 seconds
      * const client = Client(twilioAccountSid, authToken);