Merge pull request #269 from Nexmo/v2.5.1

V2.5.1 - apps v2 & verify typings

.gitignore

@@ -8,5 +8,7 @@ npm-debug.log
 coverage
 .nyc_output
 .idea
-coverage.lcov
+.DS_Store
+.env
 .nexmo-app
+coverage.lcov

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 2.5.1
+- ADDED: typings for Verify API
+- ADDED: Applications API V2 support
+
 ## 2.4.2
 - Added message signing for for sending SMS
 - Added `Nexmo.generateSignature` to verify signed messages

README.md

@@ -311,42 +311,90 @@ For an overview of applications see https://developer.nexmo.com/concepts/guides/
 ### Create an App
 
 ```js
-nexmo.applications.create(name, type, answerUrl, eventUrl, options, callback);
+nexmo.applications.create(params, callback);
 ```
 
-For more information see https://developer.nexmo.com/api/application#create-an-application
+For more information see https://developer.nexmo.com/api/application.v2#createApplication
+
+`params` can be
+
+``` json
+{
+"name": "My Application",
+  "capabilities": {
+    "voice": {
+      "webhooks": {
+        "answer_url": {
+          "address": "https://example.com/webhooks/answer",
+          "http_method": "POST"
+        },
+        "event_url": {
+          "address": "https://example.com/webhooks/event",
+          "http_method": "POST"
+        }
+      }
+    },
+    "messages": {
+      "webhooks": {
+        "inbound_url": {
+          "address": "https://example.com/webhooks/inbound",
+          "http_method": "POST"
+        },
+        "status_url": {
+          "address": "https://example.com/webhooks/status",
+          "http_method": "POST"
+        }
+      }
+    },
+    "rtc": {
+      "webhooks": {
+        "event_url": {
+          "address": "https://example.com/webhooks/event",
+          "http_method": "POST"
+        }
+      }
+    },
+    "vbc": {}
+  }
+}
+```
 
 ### Get a single App
 
 ```js
-nexmo.applications.get(appId, callback);
+nexmo.applications.get(appId, callback, v2flag);
 ```
 
-For more information see https://developer.nexmo.com/api/application#retrieve-an-application
+For more information see https://developer.nexmo.com/api/application.v2#getApplication
+
+ - `v2flag` - if `true`, you'll receive the V2 API response, else you'll receive a V1 style response from the V2 API
 
 ### Get Apps by a filter
 
 ```js
-nexmo.applications.get(options, callback);
+nexmo.applications.get(options, callback, v2flag);
 ```
 
-For more information see https://developer.nexmo.com/api/application#retrieve-your-applications
+For more information see https://developer.nexmo.com/api/application.v2#listApplication
+- `options` - filter options, use `{}` to get all your applications
+- `v2flag` - if `true`, you'll receive the V2 API response, else you'll receive a V1 style response from the V2 API
+
 
 ### Update an App
 
 ```js
-nexmo.applications.update(appId, name, type, answerUrl, eventUrl, options, callback);
+nexmo.applications.update(appId, params, callback);
 ```
 
-For more information see https://developer.nexmo.com/api/application#update-an-application
+For more information see https://developer.nexmo.com/api/application.v2#updateApplication
 
 ### Delete an App
 
 ```js
 nexmo.application.delete(appId, callback);
 ```
 
-For more information see https://developer.nexmo.com/api/application#destroy-an-application
+For more information see https://developer.nexmo.com/api/application.v2#deleteApplication
 
 ## Management
 

examples/ex-create-v1-application.js

@@ -0,0 +1,23 @@
+module.exports = function(callback, config) {
+
+  var Nexmo = require('../lib/Nexmo');
+
+  var nexmo = new Nexmo({
+    apiKey: config.API_KEY,
+    apiSecret: config.API_SECRET
+  }, {
+    debug: config.DEBUG
+  });
+
+  const name = 'My nexmo-node Messages App';
+  const type = 'messages';
+  const answerUrl = 'https://example.com'; // webhook that points to NCCO
+  const eventUrl = 'https://example.com';
+
+  let options = {
+    inbound_url: 'https://example.com',
+    status_url: 'https://example.com'
+  };
+
+  nexmo.applications.create(name, type, answerUrl, eventUrl, options, callback);
+};

examples/ex-create-v2-application.js

@@ -0,0 +1,49 @@
+module.exports = function(callback, config) {
+
+  var Nexmo = require('../lib/Nexmo');
+
+  var nexmo = new Nexmo({
+    apiKey: config.API_KEY,
+    apiSecret: config.API_SECRET
+  }, {
+    debug: config.DEBUG
+  });
+
+  nexmo.applications.create({
+    name: 'My nexmo-node Example V2 App',
+    capabilities: {
+      voice: {
+        webhooks: {
+          answer_url: {
+            address: "https://example.com",
+            http_method: "GET"
+          },
+          event_url: {
+            address: "https://example.com",
+            http_method: "POST"
+          }
+        }
+      },
+      messages: {
+        webhooks: {
+          inbound_url: {
+            address: "https://example.com",
+            http_method: "POST"
+          },
+          status_url: {
+            address: "https://example.com",
+            http_method: "POST"
+          }
+        }
+      },
+      rtc: {
+        webhooks: {
+          event_url: {
+            address: "https://example.com",
+            http_method: "POST"
+          }
+        }
+      }
+    }
+  }, callback);
+};

examples/ex-delete-application.js

@@ -0,0 +1,13 @@
+module.exports = function(callback, config) {
+
+  var Nexmo = require('../lib/Nexmo');
+
+  var nexmo = new Nexmo({
+      apiKey: config.API_KEY,
+      apiSecret: config.API_SECRET
+    },
+    {debug: config.DEBUG}
+  );
+
+  nexmo.applications.delete(config.APP_ID, callback);
+};

examples/ex-get-v1-application.js

@@ -0,0 +1,13 @@
+module.exports = function(callback, config) {
+
+  var Nexmo = require('../lib/Nexmo');
+
+  var nexmo = new Nexmo({
+      apiKey: config.API_KEY,
+      apiSecret: config.API_SECRET
+    },
+    {debug: config.DEBUG}
+  );
+
+  nexmo.applications.get(config.APP_ID, callback);
+};

examples/ex-get-v1-applications.js

@@ -0,0 +1,13 @@
+module.exports = function(callback, config) {
+
+  var Nexmo = require('../lib/Nexmo');
+
+  var nexmo = new Nexmo({
+      apiKey: config.API_KEY,
+      apiSecret: config.API_SECRET
+    },
+    {debug: config.DEBUG}
+  );
+
+  nexmo.applications.get({page_size: 5}, callback);
+};

examples/ex-get-v2-application.js

@@ -0,0 +1,13 @@
+module.exports = function(callback, config) {
+
+  var Nexmo = require('../lib/Nexmo');
+
+  var nexmo = new Nexmo({
+      apiKey: config.API_KEY,
+      apiSecret: config.API_SECRET
+    },
+    {debug: config.DEBUG}
+  );
+
+  nexmo.applications.get(config.APP_ID, callback, true);
+};

examples/ex-get-v2-applications.js

@@ -0,0 +1,13 @@
+module.exports = function(callback, config) {
+
+  var Nexmo = require('../lib/Nexmo');
+
+  var nexmo = new Nexmo({
+      apiKey: config.API_KEY,
+      apiSecret: config.API_SECRET
+    },
+    {debug: config.DEBUG}
+  );
+
+  nexmo.applications.get({page_size: 5}, callback, true);
+};

examples/ex-update-v1-application.js

@@ -0,0 +1,23 @@
+module.exports = function(callback, config) {
+
+  var Nexmo = require('../lib/Nexmo');
+
+  var nexmo = new Nexmo({
+    apiKey: config.API_KEY,
+    apiSecret: config.API_SECRET
+  }, {
+    debug: config.DEBUG
+  });
+
+  const name = 'My updated nexmo-node Messages App';
+  const type = 'messages';
+  const answerUrl = 'https://example.com'; // webhook that points to NCCO
+  const eventUrl = 'https://example.com';
+
+  let options = {
+    inbound_url: 'https://example.com',
+    status_url: 'https://example.com'
+  };
+
+  nexmo.applications.update(config.APP_ID, name, type, answerUrl, eventUrl, options, callback);
+};

examples/ex-update-v2-application.js

@@ -0,0 +1,49 @@
+module.exports = function(callback, config) {
+
+  var Nexmo = require('../lib/Nexmo');
+
+  var nexmo = new Nexmo({
+    apiKey: config.API_KEY,
+    apiSecret: config.API_SECRET
+  }, {
+    debug: config.DEBUG
+  });
+
+  nexmo.applications.update(config.APP_ID, {
+    name: 'My updated nexmo-node Example V2 App',
+    capabilities: {
+      voice: {
+        webhooks: {
+          answer_url: {
+            address: "https://example.com",
+            http_method: "GET"
+          },
+          event_url: {
+            address: "https://example.com",
+            http_method: "POST"
+          }
+        }
+      },
+      messages: {
+        webhooks: {
+          inbound_url: {
+            address: "https://example.com",
+            http_method: "POST"
+          },
+          status_url: {
+            address: "https://example.com",
+            http_method: "POST"
+          }
+        }
+      },
+      rtc: {
+        webhooks: {
+          event_url: {
+            address: "https://example.com",
+            http_method: "POST"
+          }
+        }
+      }
+    }
+  }, callback);
+};

examples/run-examples.js

@@ -67,15 +67,24 @@ exampleFiles = [
   // 'ex-make-call.js',
   // 'ex-number-insight-basic.js',
   // 'ex-send-sms.js',
-  'ex-send-signed-sms.js',
+  // 'ex-send-signed-sms.js',
   // 'ex-verify-signed-sms.js',
   // 'ex-verify-signed-sms-without-instance.js',
   // 'ex-stream-to-call.js',
   // 'ex-talk-to-call.js',
   // 'ex-create-secret.js',
   // 'ex-get-secret.js',
   // 'ex-list-secrets.js',
-  // 'ex-revoke-secret.js'
+  // 'ex-revoke-secret.js',
+  // 'ex-create-v1-application.js',
+  // 'ex-create-v2-application.js',
+  // 'ex-update-v1-application.js',
+  // 'ex-update-v2-application.js',
+  // 'ex-get-v1-application.js',
+  // 'ex-get-v1-applications.js',
+  // 'ex-get-v2-application.js',
+  // 'ex-get-v2-applications.js',
+  // 'ex-delete-application.js',
 ];
 
 console.log('Found', exampleFiles.length, 'examples to run:\n', exampleFiles);