Merge pull request watson-developer-cloud#419 from adrien2p/fix/415-STTEventsParameter

[STT] events parameter

[semver patch]

Author: nfriedly

speech-to-text/v1.js

@@ -97,7 +97,7 @@ SpeechToTextV1.URL = 'https://stream.watsonplatform.net/speech-to-text/api';
  *
  * @param {object} params - The parameters
  * @param {string} params.callback_url - A URL to which callback notifications are to be sent
- * @param {string} params.user_secret - A user-specified string that the service uses to generate the HMAC-SHA1 signature that it sends via the X-Callback-Signature header
+ * @param {string} [params.user_secret] - A user-specified string that the service uses to generate the HMAC-SHA1 signature that it sends via the X-Callback-Signature header
  * @param {Function} callback
  * @returns {ReadableStream|undefined}
  */
@@ -131,7 +131,7 @@ SpeechToTextV1.prototype.registerCallback = function(params, callback) {
  * @param {Stream}  params.audio - Audio to be recognized
  * @param {string} params.content_type - The Content-type e.g. audio/l16; rate=48000
  * @param {string} params.callback_url - A URL to which callback notifications are to be sent
- * @param {string} [params.event] - recognitions.started|recognitions.completed|recognitions.failed|recognitions.completed_with_results
+ * @param {string} [params.events] - recognitions.started|recognitions.completed|recognitions.failed|recognitions.completed_with_results
  * @param {string} [params.user_token] - The token allows the user to maintain an internal mapping between jobs and notification events
  * @param {number} [params.results_ttl] - time to alive of the job result
  * @param {*} [params.*] - all params that .recognize() accepts may also be passed to createRecognitionJob()
@@ -157,7 +157,7 @@ SpeechToTextV1.prototype.createRecognitionJob = function(params, callback) {
       headers: {
         'Content-Type': params.content_type
       },
-      qs: pick(params, ['callback_url', 'event', 'user_token', 'results_ttl'].concat(PARAMS_ALLOWED)),
+      qs: pick(params, ['callback_url', 'events', 'user_token', 'results_ttl'].concat(PARAMS_ALLOWED)),
       json: true
     },
     defaultOptions: this._options

test/integration/test.speech_to_text.js

@@ -421,7 +421,7 @@ describe('speech_to_text_integration', function() {
         // if this fails, logs are available at https://watson-test-resources.mybluemix.net/speech-to-text-async/secure
         callback_url: 'https://watson-test-resources.mybluemix.net/speech-to-text-async/secure/callback',
         user_token: 'Node.js SDK Integration Test at ' + new Date(),
-        event: 'recognitions.completed',
+        events: 'recognitions.completed',
         results_ttl: 1
       };
       speech_to_text.createRecognitionJob(params, function(err, res) {

test/unit/test.speech_to_text.v1.js

@@ -368,7 +368,7 @@ describe('speech_to_text', function() {
     });
 
     it('should create new recognitions job', function() {
-      const path = '/v1/recognitions?callback_url=http%3A%2F%2Fwatson-test-resources.mybluemix.net%2Fresults&event=recognitions.completed&user_token=myArbitraryIdentifier1&results_ttl=60';
+      const path = '/v1/recognitions?callback_url=http%3A%2F%2Fwatson-test-resources.mybluemix.net%2Fresults&events=recognitions.completed&user_token=myArbitraryIdentifier1&results_ttl=60';
       const response = {
         id: '4bd734c0-e575-21f3-de03-f932aa0468a0',
         status: 'waiting',
@@ -388,7 +388,7 @@ describe('speech_to_text', function() {
         content_type: 'audio/l16;rate=41100',
         callback_url: 'http://watson-test-resources.mybluemix.net/results',
         user_token: 'myArbitraryIdentifier1',
-        event: 'recognitions.completed',
+        events: 'recognitions.completed',
         results_ttl: 60
       };
       const req = speech_to_text.createRecognitionJob(params, checkRes);