feat: add new service features and refactor for major release

Author: apaparazzi0329

MIGRATION-V5.md

@@ -0,0 +1,146 @@
+# Upgrading to ibm-watson@6.0
+
+_Note: If migrating from a version less than 5.0, also see the [v5 migration guide wiki](https://github.com/watson-developer-cloud/node-sdk/wiki/v5-Migration-Guide)._
+
+- [Breaking Changes](#breaking-changes)
+  - [Support for callbacks dropped](#support-for-callbacks-dropped)
+  - [Support for Node v10 dropped](#support-for-node-v10-dropped)
+  - [Breaking changes by service](#breaking-changes-by-service)
+
+- [New Features by Service](#new-features-by-service)
+
+## Breaking changes
+
+#### Promises
+The detailed response is always returned. The `return_response` parameter is removed.
+```js
+const response = await listWorkspaces();
+console.log(response.result); // prints the body
+console.log(response.headers); // prints the headers
+```
+
+#### Support for Callbacks Dropped
+Support for callbacks has been dropped in favor of promises. All functions will no longer accept a callback parameter. An example of replacing a callback with a promise using `await` is shown below
+```js
+//Callback
+const assistant = new AssistantV2(options);
+assistant.message(params, (err, res) => {
+  if(err){
+    console.log(err) //Print out error
+    return
+  }
+  console.log(res.result) //Print out body
+});
+```
+```js
+//Promise
+const assistant = new AssistantV2(options);
+try{
+  await res = assistant.message(params);
+  console.log(res.result) //Print out body
+} catch(err){
+  console.log(err) //Print out error
+}
+
+```
+
+### Support for Node v10 Dropped
+The SDK no longer supports Node version 10, as reflected in the `engines` property in the package.json file. Version 6 reached end of life in April 2019 and Version 8 reaches end of life on 31 December 2019.
+
+### Breaking changes by service
+#### Assistant v1
+- Parameter `context` type changed from `JsonObject` to `DialogNodeContext` in `createDialogNode()`
+- Parameter `newContext` type changed from `JsonObject` to `DialogNodeContext` in `updateDialogNode()`
+- Interface `Context` property `system` type changed from `SystemResponse` to `JsonObject`
+- Interface `DialogNode` property `context` type changed from `JsonObject` to `DialogNodeContext`
+- Interface `DialogSuggestion` property `output` type changed from `DialogSuggestionOutput` to `JsonObject`
+- Interface `SystemResponse` removed
+- Interface `DialogSuggestionOuput` removed
+- Interface `DialogNodeOutputGeneric` expanded into multiple interfaces
+- Interface `RuntimeResponseGeneric` expanded into multiple interfaces
+
+#### Assistant v2
+- Interface `MessageContext` property `skills` type changed from `MessageContextSkills` to `JsonObject`
+- Interface `MessageContextStateless` property `skills` type changed from `MessageContextSkills` to `JsonObject`
+- Interface `MessageInputOptions` property `_export` renamed to `export`
+- Interface `MessageContextSkills` removed
+- Interface `RuntimeResponseGeneric` expanded into multiple interfaces
+
+#### Compare Comply
+- Parameter `before` and `after` removed in `listFeedback()`
+- Interface `OriginalLabelsOut` property `modification` removed
+- Interface `UpdatedLabelsOut` property `modification` removed
+- Interface `BatchStatus` property `_function` renamed to `function`
+
+#### Discovery v1
+- Interface `NluEnrichmentCategories` removed
+- Interface `NluEnrichmentFeatures` property `categories` type changed from `NluEnrichmentCategories` to `JsonObject`
+
+#### Discovery v2
+- Interface `DefaultQueryParams` property `_return` renamed `return`
+
+#### Natural Language Understanding
+- Interface `AnalysisResults` property `metadata` type changed from `AnalysisResultsMetadata` to `FeaturesResultsMetadata`
+- Interface `Features` property `metadata` type changed from `MetadataOptions` to `JsonObject`
+- Interface `AnalysisResultsMetadata` removed
+- Interface `MetadataOptions` removed
+
+#### Personality Insights
+- Interface `Content` property `content_items` renamed `contentItems`
+
+#### Text to Speech
+- Interface `CreateVoiceModelParams` renamed to `CreateCustomModelParams`
+- Interface `ListVoiceModelParams` renamed to `ListCustomModelParams`
+- Interface `GetVoiceModelParams` renamed to `GetCustomModelParams`
+- Interface `UpdateVoiceModelParams` renamed to `UpdateCustomModelParams`
+- Interface `DeleteVoiceModelParams` renamed to `DeleteCustomModelParams`
+- Interface `CreateVoiceModelConstants` renamed to `CreateCustomModelConstants`
+- Interface `ListVoiceModelConstants` renamed to `ListCustomModelConstants`
+- Interface `VoiceModel` renamed to `CustomModel`
+- Use of `VoiceModel[]` replaced with interface `CustomModels`
+
+#### Visual Recognition v3
+- Interface `Class` property `_class` renamed `class`
+- Interface `ClassResult` property `_class` renamed `class`
+
+#### Visual Recognition v4
+- Interface `Collection` property `training_status` type changed from `TrainingStatus` to `CollectionTrainingStatus`
+- Interface `ObjectDetail` property `location` type changed from `Location` to `ObjectDetailLocation`
+
+
+### New Features by Service
+
+#### Assistant v1
+- `includeCount` parameter added to several methods: Whether to include information about the number of records that satisfy the request, regardless of the page limit.
+- `bulkClassify()` method added: Identify intents and entities in multiple user utterances.
+- Interface `DialogNodeContext` added
+- Interface `DialogNodeOutput` property `integrations` added: Output intended for specific integrations. For more information, see the [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-responses-json)
+
+#### Assistant v2
+- `bulkClassify()` method added: Identify intents and entities in multiple user utterances.
+
+#### Compare Comply
+- Interface `Category` property `modification` added: The type of modification of the feedback entry in the updated labels response.
+- Interface `TypeLabel` property `modification` added: The type of modification of the feedback entry in the updated labels response.
+
+#### Discovery v2
+- `analyzeDocument()` method added: Process a document using the specified collection's settings and return it for realtime use. **Note: This method is only supported on IBM Cloud Pak for Data instances of Discovery.**
+- Interface `QueryResponsePassage` added
+- Interface `QueryResponse` property `passages` added: Passages returned by Discovery.
+
+#### Language Translator
+- `translateDocument()` now supports these subtitle/caption formats: `text/sbv`, `text/srt`, and `text/vtt`
+
+#### Natural Language Understanding
+- Interface `FeaturesResultsMetadata` added: Webpage metadata, such as the author and the title of the page.
+
+##### Speech to Text
+- `recognize()` and `createJob()` now support Canadian French broadband and narrowband models
+- `createLanguageModel()` and `createAcousticModel()` now supports Australian English broadband and narrowband models
+- `addGrammar()` parameter `grammarFile` now supports `ReadableStream` and `Buffer`
+
+#### Visual Recognition v4
+- `createCollection()` parameter `trainingStatus` added: Training status information for the collection.
+- `updateCollection()` parameter `trainingStatus` added: Training status information for the collection.
+- Interface `CollectionTrainingStatus` added: Training status information for the collection.
+- Interface `ObjectDetailLocation` added: Defines the location of the bounding box around the object.