Merge pull request #15 from PersephonyAPI/issue/14

Remove callConnectUrl and statusCallbackUrl from api.calls#create

Author: Deseao

README.md

@@ -15,24 +15,18 @@ The Persephony Javascript SDK will allow you to easily use the Persephony API in
 `yarn add @persephony/sdk`
 
 ## Testing your Installation
-Test the SDK is working by sending yourself a phone call.
+Test the SDK is working by sending yourself a text message.
 
 ```javascript
 var persephonySDK = require('@persephony/sdk')
 var persy = persephonySDK('ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', 'your_auth_token')
 var to = 'your_phone_number'
 var from = 'a_persephony_phone_number_in_your_account'
 
-persy.api.calls.create(to, from, {callConnectUrl:'https://www.persephony.com/testApp/voice'})
+persy.api.messages.create(from, to, 'Welcome to Persephony!')
 ```
 
-When you run this code you should get a phone call. On answering the call, you should hear a short message ("Thanks for using Persephony!"). This indicates that you've successfully setup your SDK.
-
-`https://www.persephony.com/testApp/voice` contains a small Persephony application. When a request is made to its `/voice` endpoint, it will respond with the following PerCL script, which produces the message you heard.
-
-```json
-[{"Say": {"text": "Thanks for using Persephony!"}}]
-```
+When you run this code you should get a text message. This indicates that you've successfully setup your SDK.
 
 ## Documentation
 The [Persephony documentation ](https://www.persephony.com/docs) has guides on [getting started](https://www.persephony.com/docs/getting-started) with Persephony, as well as the [API reference](https://www.persephony.com/docs/api), [PerCL reference](https://www.persephony.com/docs/percl), and several useful [tutorials.](https://www.persephony.com/docs/tutorials)

docs/source/api/calls.rst

@@ -42,14 +42,15 @@ getNextPage(nextPageUri)
     :returns: {Promise<oobject>} Returns a promise that resolves to the next page of calls
     :throws: Will throw an error on a filed response.
 
-create(to, from, options)
+create(to, from, applicationId, options)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
     Create a new call through the Persephony API.
 
     :to: {string} The number to call out to (DNIS). This can be any valid phone number formatted in E.164 format in Persephony's service area.
     :from: {string} The number to call from (ANI). This must be a number purchased from Persephony or a verified phone number owned by the user.
-    :options: {object} Additional properties to set the behavior of the call to be placed. Must include either :code:`callConnectUrl` or :code:`applicationId`.
+    :applicationId: {string} The id of the application Persephony should use to handle the phone call.
+    :[options]: {object} Additional properties to set the behavior of the call to be placed.
 
     :returns: {Promise<object>} returns a promise that resolves to the newly placed call.
     :throws: Will throw an error on a failed response.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@persephony/sdk",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "The SDK for the Persephony API",
   "homepage":"https://www.persephony.com",
   "bugs":{

src/api/calls/calls.js

@@ -86,12 +86,13 @@ function calls (accountId, authToken) {
    *
    * @param {string} to - The number to call out to (DNIS). This can be any valid phone number formatted in #.164 format in Persephony's service area.
    * @param {string} from - The number to call from (ANI). This must be a number purchased from Persephony or a verified phone number owned by the user.
-   * @param {object} options - Additional properties to set the behavior of the call to be placed. Must include either {@code callConnectUrl} or {@code applicationId}.
+   * @param {string} applicationId - The Id of the application Persephony should use to handle this phone call.
+   * @param {object} [options] - Additional properties to set the behavior of the call to be placed.
    * @returns {Promise<object>} call - Resolves to the newly placed call
    * @throws will throw an error on a failed response
    */
-  function create (to, from, options) {
-    return commonPoster(rootUrl, assign({to: to, from: from}, options), 'Could not create call')
+  function create (to, from, applicationId, options) {
+    return commonPoster(rootUrl, assign({to: to, from:from, applicationId:applicationId}, options), 'Could not create call')
   }
 
   return {

src/api/calls/calls.test.js

@@ -156,12 +156,11 @@ describe('calls', function () {
       var to = '+14534534345'
       var from = '+143453464345'
       var applicationId = 'AP2341353452345234523452345234623452346'
-      var callConnectUrl = 'http://url.com'
-      var options = {applicationId: applicationId, callConnectUrl: callConnectUrl, statusCallbackUrl: 'http://url.com', sendDigits: '1234#', ifMachine: 'redirect', ifMachineUrl: 'http://redirect.com', timeout: 45}
-      var expectedBody = {to: to, from: from, applicationId: applicationId, callConnectUrl: callConnectUrl, statusCallbackUrl: options.statusCallbackUrl, sendDigits: options.sendDigits, ifMachine: options.ifMachine, ifMachineUrl: options.ifMachineUrl, timeout: options.timeout}
+      var options = {sendDigits: '1234#', ifMachine: 'redirect', ifMachineUrl: 'http://redirect.com', timeout: 45}
+      var expectedBody = {to: to, from: from, applicationId: applicationId, sendDigits: options.sendDigits, ifMachine: options.ifMachine, ifMachineUrl: options.ifMachineUrl, timeout: options.timeout}
 
       expect.assertions(1)
-      return calls(accountId, authToken).create(to, from, options).then(function () {
+      return calls(accountId, authToken).create(to, from, applicationId, options).then(function () {
         expect(postMock).toHaveBeenCalledWith(accountId, authToken, '/Accounts/' + accountId + '/Calls', expectedBody)
       })
     })