Merge pull request #9 from blinkmobile/forms-search

Replaced organisationId search parameter with isAuthenticated and name…

Author: mymattcarroll

docs/forms.md

@@ -98,9 +98,10 @@ forms.getSubmissionData(formId, submissionId)
 ### Example
 
 ```javascript
-const organisationId = '0101010101010'
-const isPublished = true
-forms.getSubmissionData(organisationId, isPublished)
+const options = {
+  isPublished: true
+}
+forms.search(options)
   .then((result) => {
     const forms = result.forms
   })
@@ -113,8 +114,8 @@ forms.getSubmissionData(organisationId, isPublished)
 
 | Parameter | Required | Type | Description
 |---|---|---|---|
-| `organisationId` | Yes | `string` | The exact id of the organisation you wish to return a list of forms from. This value is available from the OneBlink Console in the URL bar. |
-| `isPublished` | No | `boolean` | Return published forms or unpublished forms. If not supplied, all forms will be returned. |
+| `options` | No | `Object` | Search options. |
+| `options.isPublished` | No | `boolean` | Return published forms or unpublished forms. If not supplied, all forms will be returned. |
 
 ### Result (Resolved Promise)
 

lib/forms.js

@@ -71,15 +71,15 @@ module.exports = class Forms extends OneBlinkAPI {
       .then((credentials) => submissionData.getSubmissionData(credentials))
   }
 
-  search (options /* : FormsSearchOptions */) /* : Promise<FormsSearchResult> */ {
+  search (options /* : ?FormsSearchOptions */) /* : Promise<FormsSearchResult> */ {
     options = options || {}
 
-    if (!options.organisationId || typeof options.organisationId !== 'string') {
-      return Promise.reject(new TypeError('Must supply "organisationId" as a string'))
-    }
+    let searchParams = {}
 
-    let searchParams = {
-      organisationId: options.organisationId
+    if (typeof options.isAuthenticated === 'boolean') {
+      searchParams = Object.assign({}, searchParams, {
+        isAuthenticated: options.isAuthenticated
+      })
     }
 
     if (typeof options.isPublished === 'boolean') {
@@ -88,6 +88,12 @@ module.exports = class Forms extends OneBlinkAPI {
       })
     }
 
+    if (typeof options.name === 'string') {
+      searchParams = Object.assign({}, searchParams, {
+        name: options.name
+      })
+    }
+
     return super.searchRequest(`/forms`, searchParams)
   }
 }

types.js

@@ -83,8 +83,9 @@ export type FormsSearchResult = {
 } & BaseSearchResult
 
 export type FormsSearchOptions = {
-  organisationId?: mixed,
-  isPublished?: mixed
+  isAuthenticated?: mixed,
+  isPublished?: mixed,
+  name?: mixed
 }
 
 */