From d12ed875c8bcfe9f9986bcf21db08d469371b7d5 Mon Sep 17 00:00:00 2001
From: enterfive <dev@enterfive.com>
Date: Fri, 30 Nov 2018 13:51:44 +0100
Subject: [PATCH 01/96] Set theme jekyll-theme-cayman

---
 _config.yml | 1 +
 1 file changed, 1 insertion(+)
 create mode 100644 _config.yml

diff --git a/_config.yml b/_config.yml
new file mode 100644
index 0000000..c419263
--- /dev/null
+++ b/_config.yml
@@ -0,0 +1 @@
+theme: jekyll-theme-cayman
\ No newline at end of file

From 59cf4635d2e1de5a9bc3c402d9dda17518e8473f Mon Sep 17 00:00:00 2001
From: securetorobert <securetorobert@protonmail.com>
Date: Fri, 30 Nov 2018 14:39:15 +0100
Subject: [PATCH 02/96] getting started

---
 Clients.md     | 261 ++++++++++++++++++++++++++++++++++++++++++++++++
 Dashboard.md   | 261 ++++++++++++++++++++++++++++++++++++++++++++++++
 Email.md       | 261 ++++++++++++++++++++++++++++++++++++++++++++++++
 Profanity.md   | 261 ++++++++++++++++++++++++++++++++++++++++++++++++
 Readme.md      |  73 +++++++++-----
 Readme.md.orig | 266 +++++++++++++++++++++++++++++++++++++++++++++++++
 clients.html   |  52 ++++++++++
 dashboard.html |  52 ++++++++++
 email.html     |  52 ++++++++++
 index.html     |  16 +--
 profanity.html |  52 ++++++++++
 11 files changed, 1576 insertions(+), 31 deletions(-)
 create mode 100644 Clients.md
 create mode 100644 Dashboard.md
 create mode 100644 Email.md
 create mode 100644 Profanity.md
 create mode 100644 Readme.md.orig
 create mode 100644 clients.html
 create mode 100644 dashboard.html
 create mode 100644 email.html
 create mode 100644 profanity.html

diff --git a/Clients.md b/Clients.md
new file mode 100644
index 0000000..2dd73b4
--- /dev/null
+++ b/Clients.md
@@ -0,0 +1,261 @@
+Versus API Endpoints
+=======
+
+This documentation lists the API endpoints required for engineers on the Versus team to interface with Versus Backend. The API endpoints are generally grouped into the following.
+
+ * Clients
+ * Dashboard
+ * Email Templates
+ * Profanity Filter
+
+*Current version: [v0.1.0][dist]*
+
+
+Getting started
+---------------
+
+Create a file based on the template, which has a bare DOM, link to the
+scripts, and a link to a theme. It will look something like this (not exact).
+For GitHub projects, simply place this file in your [GitHub pages] branch and
+you're all good to go.
+
+*In short: just download this file and upload it somewhere.*
+
+The main JS and CSS files are also available in [npm] and [bower].
+
+[Default theme template >][template]
+
+[Blank template >][blank]
+
+[bower]: http://bower.io/search/?q=flatdoc
+[npm]: https://www.npmjs.org/package/flatdoc
+
+### Via GitHub
+
+To fetch a Github Repository's readme file, use the `Flatdoc.github` fetcher.
+This will fetch the Readme file of the repository's default branch.
+
+``` javascript
+Flatdoc.run({
+  fetcher: Flatdoc.github('USER/REPO')
+});
+```
+
+You may also fetch another file other than the Readme file, just specify it as
+the 2nd parameter.
+
+``` javascript
+Flatdoc.run({
+  fetcher: Flatdoc.github('USER/REPO', 'Changelog.md')
+});
+```
+
+After you've done this, you probably want to deploy it via [GitHub Pages].
+
+[GitHub Pages guide >][GitHub Pages]
+
+### Via a file
+
+You may also fetch a file. In this example, this fetches the file `Readme.md` in
+the same folder as the HTML file.
+
+``` javascript
+Flatdoc.run({
+  fetcher: Flatdoc.file('Readme.md')
+});
+```
+
+You may actually supply any URL here. It will be fetched via AJAX. This is
+useful for local testing.
+
+``` javascript
+Flatdoc.run({
+  fetcher: Flatdoc.file('http://yoursite.com/Readme.md')
+});
+```
+
+How it works
+------------
+
+Flatdoc is a hosted `.js` file (along with a theme and its assets) that you can
+add into any page hosted anywhere.
+
+#### All client-side
+
+There are no build scripts or 3rd-party services involved. Everything is done in
+the browser. Worried about performance? Oh, It's pretty fast.
+
+Flatdoc utilizes the [GitHub API] to fetch your project's Readme files. You may
+also configure it to fetch any arbitrary URL via AJAX.
+
+#### Lightning-fast parsing
+
+Next, it uses [marked], an extremely fast Markdown parser that has support for
+GitHub flavored Markdown.
+
+Flatdoc then simply renders *menu* and *content* DOM elements to your HTML
+document. Flatdoc also comes with a default theme to style your page for you, or
+you may opt to create your own styles.
+
+Markdown extras
+---------------
+
+Flatdoc offers a few harmless, unobtrusive extras that come in handy in building
+documentation sites.
+
+#### Code highlighting
+
+You can use Markdown code fences to make syntax-highlighted text. Simply
+surround your text with three backticks. This works in GitHub as well.
+See [GitHub Syntax Highlighting][fences] for more info.
+
+    ``` html
+    <strong>Hola, mundo</strong>
+    ```
+
+#### Blockquotes
+
+Blockquotes show up as side figures. This is useful for providing side
+information or non-code examples.
+
+> Blockquotes are blocks that begin with `>`.
+
+#### Smart quotes
+
+Single quotes, double quotes, and double-hyphens are automatically replaced to
+their typographically-accurate equivalent. This, of course, does not apply to
+`<code>` and `<pre>` blocks to leave code alone.
+
+> "From a certain point onward there is no longer any turning back. That is the
+> point that must be reached."  
+> --Franz Kafka
+
+#### Buttons
+
+If your link text has a `>` at the end (for instance: `Continue >`), they show
+up as buttons.
+
+> [View in GitHub >][project]
+
+Customizing
+===========
+
+Basic
+-----
+
+### Theme options
+
+For the default theme (*theme-white*), You can set theme options by adding
+classes to the `<body>` element. The available options are:
+
+#### big-h3
+Makes 3rd-level headings bigger.
+
+``` html
+<body class='big-h3'>
+```
+
+#### no-literate
+Disables "literate" mode, where code appears on the right and content text
+appear on the left.
+
+``` html
+<body class='no-literate'>
+```
+
+#### large-brief
+Makes the opening paragraph large.
+
+``` html
+<body class='large-brief'>
+```
+
+### Adding more markup
+
+You have full control over the HTML file, just add markup wherever you see fit.
+As long as you leave `role='flatdoc-content'` and `role='flatdoc-menu'` empty as
+they are, you'll be fine.
+
+Here are some ideas to get you started.
+
+ * Add a CSS file to make your own CSS adjustments.
+ * Add a 'Tweet' button on top.
+ * Add Google Analytics.
+ * Use CSS to style the IDs in menus (`#acknowledgements + p`).
+
+### JavaScript hooks
+
+Flatdoc emits the events `flatdoc:loading` and `flatdoc:ready` to help you make
+custom behavior when the document loads.
+
+``` js
+$(document).on('flatdoc:ready', function() {
+  // I don't like this section to appear
+  $("#acknowledgements").remove();
+});
+```
+
+Full customization
+------------------
+
+You don't have to be restricted to the given theme. Flatdoc is just really one
+`.js` file that expects 2 HTML elements (for *menu* and *content*). Start with
+the blank template and customize as you see fit.
+
+[Get blank template >][template]
+
+Misc
+====
+
+Inspirations
+------------
+
+The following projects have inspired Flatdoc.
+
+ * [Backbone.js] - Jeremy's projects have always adopted this "one page
+ documentation" approach which I really love.
+
+ * [Docco] - Jeremy's Docco introduced me to the world of literate programming,
+ and side-by-side documentation in general.
+
+ * [Stripe] - Flatdoc took inspiration on the look of their API documentation.
+
+ * [DocumentUp] - This service has the same idea but does a hosted readme 
+ parsing approach.
+
+Attributions
+------------
+
+[Photo](http://www.flickr.com/photos/doug88888/2953428679/) taken from Flickr,
+licensed under Creative Commons.
+
+Acknowledgements
+----------------
+
+© 2013, 2014, Rico Sta. Cruz. Released under the [MIT 
+License](http://www.opensource.org/licenses/mit-license.php).
+
+**Flatdoc** is authored and maintained by [Rico Sta. Cruz][rsc] with help from its 
+[contributors][c].
+
+ * [My website](http://ricostacruz.com) (ricostacruz.com)
+ * [Github](http://github.com/rstacruz) (@rstacruz)
+ * [Twitter](http://twitter.com/rstacruz) (@rstacruz)
+
+[rsc]: http://ricostacruz.com
+[c]:   http://github.com/rstacruz/flatdoc/contributors
+
+[GitHub API]: http://github.com/api
+[marked]: https://github.com/chjj/marked
+[Backbone.js]: http://backbonejs.org
+[dox]: https://github.com/visionmedia/dox
+[Stripe]: https://stripe.com/docs/api
+[Docco]: http://jashkenas.github.com/docco
+[GitHub pages]: https://pages.github.com
+[fences]:https://help.github.com/articles/github-flavored-markdown#syntax-highlighting
+[DocumentUp]: http://documentup.com
+
+[project]: https://github.com/rstacruz/flatdoc
+[template]: https://github.com/rstacruz/flatdoc/raw/gh-pages/templates/template.html
+[blank]: https://github.com/rstacruz/flatdoc/raw/gh-pages/templates/blank.html
+[dist]: https://github.com/rstacruz/flatdoc/tree/gh-pages/v/0.9.0
diff --git a/Dashboard.md b/Dashboard.md
new file mode 100644
index 0000000..2dd73b4
--- /dev/null
+++ b/Dashboard.md
@@ -0,0 +1,261 @@
+Versus API Endpoints
+=======
+
+This documentation lists the API endpoints required for engineers on the Versus team to interface with Versus Backend. The API endpoints are generally grouped into the following.
+
+ * Clients
+ * Dashboard
+ * Email Templates
+ * Profanity Filter
+
+*Current version: [v0.1.0][dist]*
+
+
+Getting started
+---------------
+
+Create a file based on the template, which has a bare DOM, link to the
+scripts, and a link to a theme. It will look something like this (not exact).
+For GitHub projects, simply place this file in your [GitHub pages] branch and
+you're all good to go.
+
+*In short: just download this file and upload it somewhere.*
+
+The main JS and CSS files are also available in [npm] and [bower].
+
+[Default theme template >][template]
+
+[Blank template >][blank]
+
+[bower]: http://bower.io/search/?q=flatdoc
+[npm]: https://www.npmjs.org/package/flatdoc
+
+### Via GitHub
+
+To fetch a Github Repository's readme file, use the `Flatdoc.github` fetcher.
+This will fetch the Readme file of the repository's default branch.
+
+``` javascript
+Flatdoc.run({
+  fetcher: Flatdoc.github('USER/REPO')
+});
+```
+
+You may also fetch another file other than the Readme file, just specify it as
+the 2nd parameter.
+
+``` javascript
+Flatdoc.run({
+  fetcher: Flatdoc.github('USER/REPO', 'Changelog.md')
+});
+```
+
+After you've done this, you probably want to deploy it via [GitHub Pages].
+
+[GitHub Pages guide >][GitHub Pages]
+
+### Via a file
+
+You may also fetch a file. In this example, this fetches the file `Readme.md` in
+the same folder as the HTML file.
+
+``` javascript
+Flatdoc.run({
+  fetcher: Flatdoc.file('Readme.md')
+});
+```
+
+You may actually supply any URL here. It will be fetched via AJAX. This is
+useful for local testing.
+
+``` javascript
+Flatdoc.run({
+  fetcher: Flatdoc.file('http://yoursite.com/Readme.md')
+});
+```
+
+How it works
+------------
+
+Flatdoc is a hosted `.js` file (along with a theme and its assets) that you can
+add into any page hosted anywhere.
+
+#### All client-side
+
+There are no build scripts or 3rd-party services involved. Everything is done in
+the browser. Worried about performance? Oh, It's pretty fast.
+
+Flatdoc utilizes the [GitHub API] to fetch your project's Readme files. You may
+also configure it to fetch any arbitrary URL via AJAX.
+
+#### Lightning-fast parsing
+
+Next, it uses [marked], an extremely fast Markdown parser that has support for
+GitHub flavored Markdown.
+
+Flatdoc then simply renders *menu* and *content* DOM elements to your HTML
+document. Flatdoc also comes with a default theme to style your page for you, or
+you may opt to create your own styles.
+
+Markdown extras
+---------------
+
+Flatdoc offers a few harmless, unobtrusive extras that come in handy in building
+documentation sites.
+
+#### Code highlighting
+
+You can use Markdown code fences to make syntax-highlighted text. Simply
+surround your text with three backticks. This works in GitHub as well.
+See [GitHub Syntax Highlighting][fences] for more info.
+
+    ``` html
+    <strong>Hola, mundo</strong>
+    ```
+
+#### Blockquotes
+
+Blockquotes show up as side figures. This is useful for providing side
+information or non-code examples.
+
+> Blockquotes are blocks that begin with `>`.
+
+#### Smart quotes
+
+Single quotes, double quotes, and double-hyphens are automatically replaced to
+their typographically-accurate equivalent. This, of course, does not apply to
+`<code>` and `<pre>` blocks to leave code alone.
+
+> "From a certain point onward there is no longer any turning back. That is the
+> point that must be reached."  
+> --Franz Kafka
+
+#### Buttons
+
+If your link text has a `>` at the end (for instance: `Continue >`), they show
+up as buttons.
+
+> [View in GitHub >][project]
+
+Customizing
+===========
+
+Basic
+-----
+
+### Theme options
+
+For the default theme (*theme-white*), You can set theme options by adding
+classes to the `<body>` element. The available options are:
+
+#### big-h3
+Makes 3rd-level headings bigger.
+
+``` html
+<body class='big-h3'>
+```
+
+#### no-literate
+Disables "literate" mode, where code appears on the right and content text
+appear on the left.
+
+``` html
+<body class='no-literate'>
+```
+
+#### large-brief
+Makes the opening paragraph large.
+
+``` html
+<body class='large-brief'>
+```
+
+### Adding more markup
+
+You have full control over the HTML file, just add markup wherever you see fit.
+As long as you leave `role='flatdoc-content'` and `role='flatdoc-menu'` empty as
+they are, you'll be fine.
+
+Here are some ideas to get you started.
+
+ * Add a CSS file to make your own CSS adjustments.
+ * Add a 'Tweet' button on top.
+ * Add Google Analytics.
+ * Use CSS to style the IDs in menus (`#acknowledgements + p`).
+
+### JavaScript hooks
+
+Flatdoc emits the events `flatdoc:loading` and `flatdoc:ready` to help you make
+custom behavior when the document loads.
+
+``` js
+$(document).on('flatdoc:ready', function() {
+  // I don't like this section to appear
+  $("#acknowledgements").remove();
+});
+```
+
+Full customization
+------------------
+
+You don't have to be restricted to the given theme. Flatdoc is just really one
+`.js` file that expects 2 HTML elements (for *menu* and *content*). Start with
+the blank template and customize as you see fit.
+
+[Get blank template >][template]
+
+Misc
+====
+
+Inspirations
+------------
+
+The following projects have inspired Flatdoc.
+
+ * [Backbone.js] - Jeremy's projects have always adopted this "one page
+ documentation" approach which I really love.
+
+ * [Docco] - Jeremy's Docco introduced me to the world of literate programming,
+ and side-by-side documentation in general.
+
+ * [Stripe] - Flatdoc took inspiration on the look of their API documentation.
+
+ * [DocumentUp] - This service has the same idea but does a hosted readme 
+ parsing approach.
+
+Attributions
+------------
+
+[Photo](http://www.flickr.com/photos/doug88888/2953428679/) taken from Flickr,
+licensed under Creative Commons.
+
+Acknowledgements
+----------------
+
+© 2013, 2014, Rico Sta. Cruz. Released under the [MIT 
+License](http://www.opensource.org/licenses/mit-license.php).
+
+**Flatdoc** is authored and maintained by [Rico Sta. Cruz][rsc] with help from its 
+[contributors][c].
+
+ * [My website](http://ricostacruz.com) (ricostacruz.com)
+ * [Github](http://github.com/rstacruz) (@rstacruz)
+ * [Twitter](http://twitter.com/rstacruz) (@rstacruz)
+
+[rsc]: http://ricostacruz.com
+[c]:   http://github.com/rstacruz/flatdoc/contributors
+
+[GitHub API]: http://github.com/api
+[marked]: https://github.com/chjj/marked
+[Backbone.js]: http://backbonejs.org
+[dox]: https://github.com/visionmedia/dox
+[Stripe]: https://stripe.com/docs/api
+[Docco]: http://jashkenas.github.com/docco
+[GitHub pages]: https://pages.github.com
+[fences]:https://help.github.com/articles/github-flavored-markdown#syntax-highlighting
+[DocumentUp]: http://documentup.com
+
+[project]: https://github.com/rstacruz/flatdoc
+[template]: https://github.com/rstacruz/flatdoc/raw/gh-pages/templates/template.html
+[blank]: https://github.com/rstacruz/flatdoc/raw/gh-pages/templates/blank.html
+[dist]: https://github.com/rstacruz/flatdoc/tree/gh-pages/v/0.9.0
diff --git a/Email.md b/Email.md
new file mode 100644
index 0000000..2dd73b4
--- /dev/null
+++ b/Email.md
@@ -0,0 +1,261 @@
+Versus API Endpoints
+=======
+
+This documentation lists the API endpoints required for engineers on the Versus team to interface with Versus Backend. The API endpoints are generally grouped into the following.
+
+ * Clients
+ * Dashboard
+ * Email Templates
+ * Profanity Filter
+
+*Current version: [v0.1.0][dist]*
+
+
+Getting started
+---------------
+
+Create a file based on the template, which has a bare DOM, link to the
+scripts, and a link to a theme. It will look something like this (not exact).
+For GitHub projects, simply place this file in your [GitHub pages] branch and
+you're all good to go.
+
+*In short: just download this file and upload it somewhere.*
+
+The main JS and CSS files are also available in [npm] and [bower].
+
+[Default theme template >][template]
+
+[Blank template >][blank]
+
+[bower]: http://bower.io/search/?q=flatdoc
+[npm]: https://www.npmjs.org/package/flatdoc
+
+### Via GitHub
+
+To fetch a Github Repository's readme file, use the `Flatdoc.github` fetcher.
+This will fetch the Readme file of the repository's default branch.
+
+``` javascript
+Flatdoc.run({
+  fetcher: Flatdoc.github('USER/REPO')
+});
+```
+
+You may also fetch another file other than the Readme file, just specify it as
+the 2nd parameter.
+
+``` javascript
+Flatdoc.run({
+  fetcher: Flatdoc.github('USER/REPO', 'Changelog.md')
+});
+```
+
+After you've done this, you probably want to deploy it via [GitHub Pages].
+
+[GitHub Pages guide >][GitHub Pages]
+
+### Via a file
+
+You may also fetch a file. In this example, this fetches the file `Readme.md` in
+the same folder as the HTML file.
+
+``` javascript
+Flatdoc.run({
+  fetcher: Flatdoc.file('Readme.md')
+});
+```
+
+You may actually supply any URL here. It will be fetched via AJAX. This is
+useful for local testing.
+
+``` javascript
+Flatdoc.run({
+  fetcher: Flatdoc.file('http://yoursite.com/Readme.md')
+});
+```
+
+How it works
+------------
+
+Flatdoc is a hosted `.js` file (along with a theme and its assets) that you can
+add into any page hosted anywhere.
+
+#### All client-side
+
+There are no build scripts or 3rd-party services involved. Everything is done in
+the browser. Worried about performance? Oh, It's pretty fast.
+
+Flatdoc utilizes the [GitHub API] to fetch your project's Readme files. You may
+also configure it to fetch any arbitrary URL via AJAX.
+
+#### Lightning-fast parsing
+
+Next, it uses [marked], an extremely fast Markdown parser that has support for
+GitHub flavored Markdown.
+
+Flatdoc then simply renders *menu* and *content* DOM elements to your HTML
+document. Flatdoc also comes with a default theme to style your page for you, or
+you may opt to create your own styles.
+
+Markdown extras
+---------------
+
+Flatdoc offers a few harmless, unobtrusive extras that come in handy in building
+documentation sites.
+
+#### Code highlighting
+
+You can use Markdown code fences to make syntax-highlighted text. Simply
+surround your text with three backticks. This works in GitHub as well.
+See [GitHub Syntax Highlighting][fences] for more info.
+
+    ``` html
+    <strong>Hola, mundo</strong>
+    ```
+
+#### Blockquotes
+
+Blockquotes show up as side figures. This is useful for providing side
+information or non-code examples.
+
+> Blockquotes are blocks that begin with `>`.
+
+#### Smart quotes
+
+Single quotes, double quotes, and double-hyphens are automatically replaced to
+their typographically-accurate equivalent. This, of course, does not apply to
+`<code>` and `<pre>` blocks to leave code alone.
+
+> "From a certain point onward there is no longer any turning back. That is the
+> point that must be reached."  
+> --Franz Kafka
+
+#### Buttons
+
+If your link text has a `>` at the end (for instance: `Continue >`), they show
+up as buttons.
+
+> [View in GitHub >][project]
+
+Customizing
+===========
+
+Basic
+-----
+
+### Theme options
+
+For the default theme (*theme-white*), You can set theme options by adding
+classes to the `<body>` element. The available options are:
+
+#### big-h3
+Makes 3rd-level headings bigger.
+
+``` html
+<body class='big-h3'>
+```
+
+#### no-literate
+Disables "literate" mode, where code appears on the right and content text
+appear on the left.
+
+``` html
+<body class='no-literate'>
+```
+
+#### large-brief
+Makes the opening paragraph large.
+
+``` html
+<body class='large-brief'>
+```
+
+### Adding more markup
+
+You have full control over the HTML file, just add markup wherever you see fit.
+As long as you leave `role='flatdoc-content'` and `role='flatdoc-menu'` empty as
+they are, you'll be fine.
+
+Here are some ideas to get you started.
+
+ * Add a CSS file to make your own CSS adjustments.
+ * Add a 'Tweet' button on top.
+ * Add Google Analytics.
+ * Use CSS to style the IDs in menus (`#acknowledgements + p`).
+
+### JavaScript hooks
+
+Flatdoc emits the events `flatdoc:loading` and `flatdoc:ready` to help you make
+custom behavior when the document loads.
+
+``` js
+$(document).on('flatdoc:ready', function() {
+  // I don't like this section to appear
+  $("#acknowledgements").remove();
+});
+```
+
+Full customization
+------------------
+
+You don't have to be restricted to the given theme. Flatdoc is just really one
+`.js` file that expects 2 HTML elements (for *menu* and *content*). Start with
+the blank template and customize as you see fit.
+
+[Get blank template >][template]
+
+Misc
+====
+
+Inspirations
+------------
+
+The following projects have inspired Flatdoc.
+
+ * [Backbone.js] - Jeremy's projects have always adopted this "one page
+ documentation" approach which I really love.
+
+ * [Docco] - Jeremy's Docco introduced me to the world of literate programming,
+ and side-by-side documentation in general.
+
+ * [Stripe] - Flatdoc took inspiration on the look of their API documentation.
+
+ * [DocumentUp] - This service has the same idea but does a hosted readme 
+ parsing approach.
+
+Attributions
+------------
+
+[Photo](http://www.flickr.com/photos/doug88888/2953428679/) taken from Flickr,
+licensed under Creative Commons.
+
+Acknowledgements
+----------------
+
+© 2013, 2014, Rico Sta. Cruz. Released under the [MIT 
+License](http://www.opensource.org/licenses/mit-license.php).
+
+**Flatdoc** is authored and maintained by [Rico Sta. Cruz][rsc] with help from its 
+[contributors][c].
+
+ * [My website](http://ricostacruz.com) (ricostacruz.com)
+ * [Github](http://github.com/rstacruz) (@rstacruz)
+ * [Twitter](http://twitter.com/rstacruz) (@rstacruz)
+
+[rsc]: http://ricostacruz.com
+[c]:   http://github.com/rstacruz/flatdoc/contributors
+
+[GitHub API]: http://github.com/api
+[marked]: https://github.com/chjj/marked
+[Backbone.js]: http://backbonejs.org
+[dox]: https://github.com/visionmedia/dox
+[Stripe]: https://stripe.com/docs/api
+[Docco]: http://jashkenas.github.com/docco
+[GitHub pages]: https://pages.github.com
+[fences]:https://help.github.com/articles/github-flavored-markdown#syntax-highlighting
+[DocumentUp]: http://documentup.com
+
+[project]: https://github.com/rstacruz/flatdoc
+[template]: https://github.com/rstacruz/flatdoc/raw/gh-pages/templates/template.html
+[blank]: https://github.com/rstacruz/flatdoc/raw/gh-pages/templates/blank.html
+[dist]: https://github.com/rstacruz/flatdoc/tree/gh-pages/v/0.9.0
diff --git a/Profanity.md b/Profanity.md
new file mode 100644
index 0000000..2dd73b4
--- /dev/null
+++ b/Profanity.md
@@ -0,0 +1,261 @@
+Versus API Endpoints
+=======
+
+This documentation lists the API endpoints required for engineers on the Versus team to interface with Versus Backend. The API endpoints are generally grouped into the following.
+
+ * Clients
+ * Dashboard
+ * Email Templates
+ * Profanity Filter
+
+*Current version: [v0.1.0][dist]*
+
+
+Getting started
+---------------
+
+Create a file based on the template, which has a bare DOM, link to the
+scripts, and a link to a theme. It will look something like this (not exact).
+For GitHub projects, simply place this file in your [GitHub pages] branch and
+you're all good to go.
+
+*In short: just download this file and upload it somewhere.*
+
+The main JS and CSS files are also available in [npm] and [bower].
+
+[Default theme template >][template]
+
+[Blank template >][blank]
+
+[bower]: http://bower.io/search/?q=flatdoc
+[npm]: https://www.npmjs.org/package/flatdoc
+
+### Via GitHub
+
+To fetch a Github Repository's readme file, use the `Flatdoc.github` fetcher.
+This will fetch the Readme file of the repository's default branch.
+
+``` javascript
+Flatdoc.run({
+  fetcher: Flatdoc.github('USER/REPO')
+});
+```
+
+You may also fetch another file other than the Readme file, just specify it as
+the 2nd parameter.
+
+``` javascript
+Flatdoc.run({
+  fetcher: Flatdoc.github('USER/REPO', 'Changelog.md')
+});
+```
+
+After you've done this, you probably want to deploy it via [GitHub Pages].
+
+[GitHub Pages guide >][GitHub Pages]
+
+### Via a file
+
+You may also fetch a file. In this example, this fetches the file `Readme.md` in
+the same folder as the HTML file.
+
+``` javascript
+Flatdoc.run({
+  fetcher: Flatdoc.file('Readme.md')
+});
+```
+
+You may actually supply any URL here. It will be fetched via AJAX. This is
+useful for local testing.
+
+``` javascript
+Flatdoc.run({
+  fetcher: Flatdoc.file('http://yoursite.com/Readme.md')
+});
+```
+
+How it works
+------------
+
+Flatdoc is a hosted `.js` file (along with a theme and its assets) that you can
+add into any page hosted anywhere.
+
+#### All client-side
+
+There are no build scripts or 3rd-party services involved. Everything is done in
+the browser. Worried about performance? Oh, It's pretty fast.
+
+Flatdoc utilizes the [GitHub API] to fetch your project's Readme files. You may
+also configure it to fetch any arbitrary URL via AJAX.
+
+#### Lightning-fast parsing
+
+Next, it uses [marked], an extremely fast Markdown parser that has support for
+GitHub flavored Markdown.
+
+Flatdoc then simply renders *menu* and *content* DOM elements to your HTML
+document. Flatdoc also comes with a default theme to style your page for you, or
+you may opt to create your own styles.
+
+Markdown extras
+---------------
+
+Flatdoc offers a few harmless, unobtrusive extras that come in handy in building
+documentation sites.
+
+#### Code highlighting
+
+You can use Markdown code fences to make syntax-highlighted text. Simply
+surround your text with three backticks. This works in GitHub as well.
+See [GitHub Syntax Highlighting][fences] for more info.
+
+    ``` html
+    <strong>Hola, mundo</strong>
+    ```
+
+#### Blockquotes
+
+Blockquotes show up as side figures. This is useful for providing side
+information or non-code examples.
+
+> Blockquotes are blocks that begin with `>`.
+
+#### Smart quotes
+
+Single quotes, double quotes, and double-hyphens are automatically replaced to
+their typographically-accurate equivalent. This, of course, does not apply to
+`<code>` and `<pre>` blocks to leave code alone.
+
+> "From a certain point onward there is no longer any turning back. That is the
+> point that must be reached."  
+> --Franz Kafka
+
+#### Buttons
+
+If your link text has a `>` at the end (for instance: `Continue >`), they show
+up as buttons.
+
+> [View in GitHub >][project]
+
+Customizing
+===========
+
+Basic
+-----
+
+### Theme options
+
+For the default theme (*theme-white*), You can set theme options by adding
+classes to the `<body>` element. The available options are:
+
+#### big-h3
+Makes 3rd-level headings bigger.
+
+``` html
+<body class='big-h3'>
+```
+
+#### no-literate
+Disables "literate" mode, where code appears on the right and content text
+appear on the left.
+
+``` html
+<body class='no-literate'>
+```
+
+#### large-brief
+Makes the opening paragraph large.
+
+``` html
+<body class='large-brief'>
+```
+
+### Adding more markup
+
+You have full control over the HTML file, just add markup wherever you see fit.
+As long as you leave `role='flatdoc-content'` and `role='flatdoc-menu'` empty as
+they are, you'll be fine.
+
+Here are some ideas to get you started.
+
+ * Add a CSS file to make your own CSS adjustments.
+ * Add a 'Tweet' button on top.
+ * Add Google Analytics.
+ * Use CSS to style the IDs in menus (`#acknowledgements + p`).
+
+### JavaScript hooks
+
+Flatdoc emits the events `flatdoc:loading` and `flatdoc:ready` to help you make
+custom behavior when the document loads.
+
+``` js
+$(document).on('flatdoc:ready', function() {
+  // I don't like this section to appear
+  $("#acknowledgements").remove();
+});
+```
+
+Full customization
+------------------
+
+You don't have to be restricted to the given theme. Flatdoc is just really one
+`.js` file that expects 2 HTML elements (for *menu* and *content*). Start with
+the blank template and customize as you see fit.
+
+[Get blank template >][template]
+
+Misc
+====
+
+Inspirations
+------------
+
+The following projects have inspired Flatdoc.
+
+ * [Backbone.js] - Jeremy's projects have always adopted this "one page
+ documentation" approach which I really love.
+
+ * [Docco] - Jeremy's Docco introduced me to the world of literate programming,
+ and side-by-side documentation in general.
+
+ * [Stripe] - Flatdoc took inspiration on the look of their API documentation.
+
+ * [DocumentUp] - This service has the same idea but does a hosted readme 
+ parsing approach.
+
+Attributions
+------------
+
+[Photo](http://www.flickr.com/photos/doug88888/2953428679/) taken from Flickr,
+licensed under Creative Commons.
+
+Acknowledgements
+----------------
+
+© 2013, 2014, Rico Sta. Cruz. Released under the [MIT 
+License](http://www.opensource.org/licenses/mit-license.php).
+
+**Flatdoc** is authored and maintained by [Rico Sta. Cruz][rsc] with help from its 
+[contributors][c].
+
+ * [My website](http://ricostacruz.com) (ricostacruz.com)
+ * [Github](http://github.com/rstacruz) (@rstacruz)
+ * [Twitter](http://twitter.com/rstacruz) (@rstacruz)
+
+[rsc]: http://ricostacruz.com
+[c]:   http://github.com/rstacruz/flatdoc/contributors
+
+[GitHub API]: http://github.com/api
+[marked]: https://github.com/chjj/marked
+[Backbone.js]: http://backbonejs.org
+[dox]: https://github.com/visionmedia/dox
+[Stripe]: https://stripe.com/docs/api
+[Docco]: http://jashkenas.github.com/docco
+[GitHub pages]: https://pages.github.com
+[fences]:https://help.github.com/articles/github-flavored-markdown#syntax-highlighting
+[DocumentUp]: http://documentup.com
+
+[project]: https://github.com/rstacruz/flatdoc
+[template]: https://github.com/rstacruz/flatdoc/raw/gh-pages/templates/template.html
+[blank]: https://github.com/rstacruz/flatdoc/raw/gh-pages/templates/blank.html
+[dist]: https://github.com/rstacruz/flatdoc/tree/gh-pages/v/0.9.0
diff --git a/Readme.md b/Readme.md
index 0967599..79ad31b 100644
--- a/Readme.md
+++ b/Readme.md
@@ -1,39 +1,64 @@
-Flatdoc
+# Versus API Endpoints
 =======
 
-Flatdoc is a small JavaScript file that fetches Markdown files and renders them
-as full pages. Essentially, it's the easiest
-way to make open source documentation from *Readme* files.
+This documentation lists the API endpoints required for engineers on the Versus team to interface with Versus Backend. The API endpoints are generally grouped into the following.
 
- * No server-side components
- * No build process needed
- * Deployable via GitHub Pages
- * Can fetch GitHub Readme files
- * Gorgeous default theme (and it's responsive)
- * Just create an HTML file and deploy!
+ * Clients
+ * Dashboard
+ * Email Templates
+ * Profanity Filter
 
-*Current version: [v0.9.0][dist]*
+*Current version: [v0.1.0][dist]*
 
-[![Build Status](https://travis-ci.org/rstacruz/flatdoc.svg?branch=gh-pages)](https://travis-ci.org/rstacruz/flatdoc)
 
-Getting started
----------------
+# Clients
+----------------
+
+This has functions for managing clients
+1. Create Client: create a new Versus Sentiment Client
+2. Get Client: get details about a Versus Sentiment Client
+3. Update Client: onboard a Versus Sentiment Client
+4. Create Member: register someone who was added to the list of team members
 
-Create a file based on the template, which has a bare DOM, link to the
-scripts, and a link to a theme. It will look something like this (not exact).
-For GitHub projects, simply place this file in your [GitHub pages] branch and
-you're all good to go.
+# Dasboard
+----------------
+
+This has functions for retrieving mentions
+1. Today Summary: Today's mentions on social media, news, and other sources
+2. Week Summary: This week's mentions on social media, news, and other sources
+3. Month Summary: This month's mentions on social media, news, and other sources
+4. All Time Summary: Total aggregate on our systems of mentions on social media, news, and other sources
+5. Today Details: Mentions from social media, news, and other sources grouped by source for today
+6. Week Details: Mentions from social media, news, and other sources grouped by source for the past week
+7. Today Details: Mentions from social media, news, and other sources grouped by source for the past month
+8. All Time Details: Mentions from social media, news, and other sources grouped by source for all content on our systems
+
+# Email Templates
+----------------
 
-*In short: just download this file and upload it somewhere.*
+This has functions for sending out emails
+1. Custom Alerts: Notify an admin that custom alerts have been set for their account
+2. Dashboard Ready: Notify an admin that the Versus Sentiment dashboard has data for viewing
+3. Designated Primary Email: Notify an admin that they have been designated as a primary contact
+4. Designated Team Member: Notify someone that they have been added as a team member to Versus Sentiment
+5. Respond to Article: Notify a recipient to respond to a social media post
+6. Welcome to Versus: Notify the recipient that their Versus Sentiment account has been created
+7. Your Report: Dispatch a periodic report
 
-The main JS and CSS files are also available in [npm] and [bower].
+# Profanity Filter
+----------------
+
+This function will take a string and return a HTML formattted string with tags that decorate profane words.
+
+
+# Getting started
+---------------
 
-[Default theme template >][template]
+All endpoints are REST. The default method is POST unless otherwise specified. There is a base URL to which you will need to append the endpoint.
 
-[Blank template >][blank]
+> Method: POST
+> Base_URL: 
 
-[bower]: http://bower.io/search/?q=flatdoc
-[npm]: https://www.npmjs.org/package/flatdoc
 
 ### Via GitHub
 
diff --git a/Readme.md.orig b/Readme.md.orig
new file mode 100644
index 0000000..0967599
--- /dev/null
+++ b/Readme.md.orig
@@ -0,0 +1,266 @@
+Flatdoc
+=======
+
+Flatdoc is a small JavaScript file that fetches Markdown files and renders them
+as full pages. Essentially, it's the easiest
+way to make open source documentation from *Readme* files.
+
+ * No server-side components
+ * No build process needed
+ * Deployable via GitHub Pages
+ * Can fetch GitHub Readme files
+ * Gorgeous default theme (and it's responsive)
+ * Just create an HTML file and deploy!
+
+*Current version: [v0.9.0][dist]*
+
+[![Build Status](https://travis-ci.org/rstacruz/flatdoc.svg?branch=gh-pages)](https://travis-ci.org/rstacruz/flatdoc)
+
+Getting started
+---------------
+
+Create a file based on the template, which has a bare DOM, link to the
+scripts, and a link to a theme. It will look something like this (not exact).
+For GitHub projects, simply place this file in your [GitHub pages] branch and
+you're all good to go.
+
+*In short: just download this file and upload it somewhere.*
+
+The main JS and CSS files are also available in [npm] and [bower].
+
+[Default theme template >][template]
+
+[Blank template >][blank]
+
+[bower]: http://bower.io/search/?q=flatdoc
+[npm]: https://www.npmjs.org/package/flatdoc
+
+### Via GitHub
+
+To fetch a Github Repository's readme file, use the `Flatdoc.github` fetcher.
+This will fetch the Readme file of the repository's default branch.
+
+``` javascript
+Flatdoc.run({
+  fetcher: Flatdoc.github('USER/REPO')
+});
+```
+
+You may also fetch another file other than the Readme file, just specify it as
+the 2nd parameter.
+
+``` javascript
+Flatdoc.run({
+  fetcher: Flatdoc.github('USER/REPO', 'Changelog.md')
+});
+```
+
+After you've done this, you probably want to deploy it via [GitHub Pages].
+
+[GitHub Pages guide >][GitHub Pages]
+
+### Via a file
+
+You may also fetch a file. In this example, this fetches the file `Readme.md` in
+the same folder as the HTML file.
+
+``` javascript
+Flatdoc.run({
+  fetcher: Flatdoc.file('Readme.md')
+});
+```
+
+You may actually supply any URL here. It will be fetched via AJAX. This is
+useful for local testing.
+
+``` javascript
+Flatdoc.run({
+  fetcher: Flatdoc.file('http://yoursite.com/Readme.md')
+});
+```
+
+How it works
+------------
+
+Flatdoc is a hosted `.js` file (along with a theme and its assets) that you can
+add into any page hosted anywhere.
+
+#### All client-side
+
+There are no build scripts or 3rd-party services involved. Everything is done in
+the browser. Worried about performance? Oh, It's pretty fast.
+
+Flatdoc utilizes the [GitHub API] to fetch your project's Readme files. You may
+also configure it to fetch any arbitrary URL via AJAX.
+
+#### Lightning-fast parsing
+
+Next, it uses [marked], an extremely fast Markdown parser that has support for
+GitHub flavored Markdown.
+
+Flatdoc then simply renders *menu* and *content* DOM elements to your HTML
+document. Flatdoc also comes with a default theme to style your page for you, or
+you may opt to create your own styles.
+
+Markdown extras
+---------------
+
+Flatdoc offers a few harmless, unobtrusive extras that come in handy in building
+documentation sites.
+
+#### Code highlighting
+
+You can use Markdown code fences to make syntax-highlighted text. Simply
+surround your text with three backticks. This works in GitHub as well.
+See [GitHub Syntax Highlighting][fences] for more info.
+
+    ``` html
+    <strong>Hola, mundo</strong>
+    ```
+
+#### Blockquotes
+
+Blockquotes show up as side figures. This is useful for providing side
+information or non-code examples.
+
+> Blockquotes are blocks that begin with `>`.
+
+#### Smart quotes
+
+Single quotes, double quotes, and double-hyphens are automatically replaced to
+their typographically-accurate equivalent. This, of course, does not apply to
+`<code>` and `<pre>` blocks to leave code alone.
+
+> "From a certain point onward there is no longer any turning back. That is the
+> point that must be reached."  
+> --Franz Kafka
+
+#### Buttons
+
+If your link text has a `>` at the end (for instance: `Continue >`), they show
+up as buttons.
+
+> [View in GitHub >][project]
+
+Customizing
+===========
+
+Basic
+-----
+
+### Theme options
+
+For the default theme (*theme-white*), You can set theme options by adding
+classes to the `<body>` element. The available options are:
+
+#### big-h3
+Makes 3rd-level headings bigger.
+
+``` html
+<body class='big-h3'>
+```
+
+#### no-literate
+Disables "literate" mode, where code appears on the right and content text
+appear on the left.
+
+``` html
+<body class='no-literate'>
+```
+
+#### large-brief
+Makes the opening paragraph large.
+
+``` html
+<body class='large-brief'>
+```
+
+### Adding more markup
+
+You have full control over the HTML file, just add markup wherever you see fit.
+As long as you leave `role='flatdoc-content'` and `role='flatdoc-menu'` empty as
+they are, you'll be fine.
+
+Here are some ideas to get you started.
+
+ * Add a CSS file to make your own CSS adjustments.
+ * Add a 'Tweet' button on top.
+ * Add Google Analytics.
+ * Use CSS to style the IDs in menus (`#acknowledgements + p`).
+
+### JavaScript hooks
+
+Flatdoc emits the events `flatdoc:loading` and `flatdoc:ready` to help you make
+custom behavior when the document loads.
+
+``` js
+$(document).on('flatdoc:ready', function() {
+  // I don't like this section to appear
+  $("#acknowledgements").remove();
+});
+```
+
+Full customization
+------------------
+
+You don't have to be restricted to the given theme. Flatdoc is just really one
+`.js` file that expects 2 HTML elements (for *menu* and *content*). Start with
+the blank template and customize as you see fit.
+
+[Get blank template >][template]
+
+Misc
+====
+
+Inspirations
+------------
+
+The following projects have inspired Flatdoc.
+
+ * [Backbone.js] - Jeremy's projects have always adopted this "one page
+ documentation" approach which I really love.
+
+ * [Docco] - Jeremy's Docco introduced me to the world of literate programming,
+ and side-by-side documentation in general.
+
+ * [Stripe] - Flatdoc took inspiration on the look of their API documentation.
+
+ * [DocumentUp] - This service has the same idea but does a hosted readme 
+ parsing approach.
+
+Attributions
+------------
+
+[Photo](http://www.flickr.com/photos/doug88888/2953428679/) taken from Flickr,
+licensed under Creative Commons.
+
+Acknowledgements
+----------------
+
+© 2013, 2014, Rico Sta. Cruz. Released under the [MIT 
+License](http://www.opensource.org/licenses/mit-license.php).
+
+**Flatdoc** is authored and maintained by [Rico Sta. Cruz][rsc] with help from its 
+[contributors][c].
+
+ * [My website](http://ricostacruz.com) (ricostacruz.com)
+ * [Github](http://github.com/rstacruz) (@rstacruz)
+ * [Twitter](http://twitter.com/rstacruz) (@rstacruz)
+
+[rsc]: http://ricostacruz.com
+[c]:   http://github.com/rstacruz/flatdoc/contributors
+
+[GitHub API]: http://github.com/api
+[marked]: https://github.com/chjj/marked
+[Backbone.js]: http://backbonejs.org
+[dox]: https://github.com/visionmedia/dox
+[Stripe]: https://stripe.com/docs/api
+[Docco]: http://jashkenas.github.com/docco
+[GitHub pages]: https://pages.github.com
+[fences]:https://help.github.com/articles/github-flavored-markdown#syntax-highlighting
+[DocumentUp]: http://documentup.com
+
+[project]: https://github.com/rstacruz/flatdoc
+[template]: https://github.com/rstacruz/flatdoc/raw/gh-pages/templates/template.html
+[blank]: https://github.com/rstacruz/flatdoc/raw/gh-pages/templates/blank.html
+[dist]: https://github.com/rstacruz/flatdoc/tree/gh-pages/v/0.9.0
diff --git a/clients.html b/clients.html
new file mode 100644
index 0000000..a9b8523
--- /dev/null
+++ b/clients.html
@@ -0,0 +1,52 @@
+<!doctype html>
+<html>
+<head>
+  <meta charset='utf-8'>
+  <meta http-equiv="X-UA-Compatible" content="chrome=1" />
+  <meta name="viewport" content="width=device-width">
+
+  <title>Flatdoc</title>
+
+  <!-- Flatdoc -->
+  <script src='support/vendor/jquery.js'></script>
+  <script src='legacy.js'></script>
+  <script src='flatdoc.js'></script>
+
+  <!-- Flatdoc theme -->
+  <link  href='theme-white/style.css' rel='stylesheet'>
+  <script src='theme-white/script.js'></script>
+  <link  href='support/theme.css' rel='stylesheet'>
+
+  <!-- Initializer -->
+  <script>
+    Flatdoc.run({
+      fetcher: Flatdoc.file('Reference.md')
+    });
+  </script>
+</head>
+<body role='flatdoc'>
+
+  <div class='header'>
+    <div class='left'>
+      <h1><a href='.'>Flatdoc</a></h1>
+      <ul>
+        <li><a href='https://github.com/rstacruz/flatdoc'>View on Github</a></li>
+        <li><a href='https://github.com/rstacruz/flatdoc/issues'>Issues</a></li>
+        <li><a href='reference.html'>API reference</a></li>
+      </ul>
+    </div>
+    <div class='right'>
+      <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;type=follow&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="170" height="20"></iframe>
+      <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;repo=flatdoc&amp;type=watch&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe>
+    </div>
+  </div>
+
+  <div class='content-root'>
+    <div class='menubar'>
+      <div class='menu section' role='flatdoc-menu'></div>
+    </div>
+    <div role='flatdoc-content' class='content'></div>
+  </div>
+
+</body>
+</html>
diff --git a/dashboard.html b/dashboard.html
new file mode 100644
index 0000000..a9b8523
--- /dev/null
+++ b/dashboard.html
@@ -0,0 +1,52 @@
+<!doctype html>
+<html>
+<head>
+  <meta charset='utf-8'>
+  <meta http-equiv="X-UA-Compatible" content="chrome=1" />
+  <meta name="viewport" content="width=device-width">
+
+  <title>Flatdoc</title>
+
+  <!-- Flatdoc -->
+  <script src='support/vendor/jquery.js'></script>
+  <script src='legacy.js'></script>
+  <script src='flatdoc.js'></script>
+
+  <!-- Flatdoc theme -->
+  <link  href='theme-white/style.css' rel='stylesheet'>
+  <script src='theme-white/script.js'></script>
+  <link  href='support/theme.css' rel='stylesheet'>
+
+  <!-- Initializer -->
+  <script>
+    Flatdoc.run({
+      fetcher: Flatdoc.file('Reference.md')
+    });
+  </script>
+</head>
+<body role='flatdoc'>
+
+  <div class='header'>
+    <div class='left'>
+      <h1><a href='.'>Flatdoc</a></h1>
+      <ul>
+        <li><a href='https://github.com/rstacruz/flatdoc'>View on Github</a></li>
+        <li><a href='https://github.com/rstacruz/flatdoc/issues'>Issues</a></li>
+        <li><a href='reference.html'>API reference</a></li>
+      </ul>
+    </div>
+    <div class='right'>
+      <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;type=follow&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="170" height="20"></iframe>
+      <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;repo=flatdoc&amp;type=watch&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe>
+    </div>
+  </div>
+
+  <div class='content-root'>
+    <div class='menubar'>
+      <div class='menu section' role='flatdoc-menu'></div>
+    </div>
+    <div role='flatdoc-content' class='content'></div>
+  </div>
+
+</body>
+</html>
diff --git a/email.html b/email.html
new file mode 100644
index 0000000..a9b8523
--- /dev/null
+++ b/email.html
@@ -0,0 +1,52 @@
+<!doctype html>
+<html>
+<head>
+  <meta charset='utf-8'>
+  <meta http-equiv="X-UA-Compatible" content="chrome=1" />
+  <meta name="viewport" content="width=device-width">
+
+  <title>Flatdoc</title>
+
+  <!-- Flatdoc -->
+  <script src='support/vendor/jquery.js'></script>
+  <script src='legacy.js'></script>
+  <script src='flatdoc.js'></script>
+
+  <!-- Flatdoc theme -->
+  <link  href='theme-white/style.css' rel='stylesheet'>
+  <script src='theme-white/script.js'></script>
+  <link  href='support/theme.css' rel='stylesheet'>
+
+  <!-- Initializer -->
+  <script>
+    Flatdoc.run({
+      fetcher: Flatdoc.file('Reference.md')
+    });
+  </script>
+</head>
+<body role='flatdoc'>
+
+  <div class='header'>
+    <div class='left'>
+      <h1><a href='.'>Flatdoc</a></h1>
+      <ul>
+        <li><a href='https://github.com/rstacruz/flatdoc'>View on Github</a></li>
+        <li><a href='https://github.com/rstacruz/flatdoc/issues'>Issues</a></li>
+        <li><a href='reference.html'>API reference</a></li>
+      </ul>
+    </div>
+    <div class='right'>
+      <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;type=follow&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="170" height="20"></iframe>
+      <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;repo=flatdoc&amp;type=watch&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe>
+    </div>
+  </div>
+
+  <div class='content-root'>
+    <div class='menubar'>
+      <div class='menu section' role='flatdoc-menu'></div>
+    </div>
+    <div role='flatdoc-content' class='content'></div>
+  </div>
+
+</body>
+</html>
diff --git a/index.html b/index.html
index 45a95e6..3a047c4 100644
--- a/index.html
+++ b/index.html
@@ -5,7 +5,7 @@
   <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
   <meta name="viewport" content="width=device-width">
 
-  <title>Flatdoc</title>
+  <title>Versus Flatdoc</title>
 
   <!-- Flatdoc -->
   <script src='support/vendor/jquery.js'></script>
@@ -29,8 +29,8 @@
   <meta content="Flatdoc" property="og:site_name">
   <meta content="Flatdoc" property="og:title">
   <meta content="website" property="og:type">
-  <meta content="Flatdoc is the fastest way to create a site for your open source project." name="description">
-  <meta content="Flatdoc is the fastest way to create a site for your open source project." property="og:description">
+  <meta content="Versus Flatdoc API Documentation." name="description">
+  <meta content="Versus Flatdoc API Documentation." property="og:description">
   <meta content="http://ricostacruz.com/flatdoc/support/preview.jpg" property="og:image">
 
   <!-- Analytics -->
@@ -41,8 +41,8 @@
   <div class='title-area title-card' style='background-image: url(support/blur.jpg)'>
     <div class='in'>
       <div class='headline'>
-        <h1>Documentation is easy.</h1>
-        <p>Flatdoc is the fastest way to create a site for your open source project.</p>
+        <h1>Versus API Documentation.</h1>
+        <p>.</p>
         <h5><span>Flatdoc</span></h5>
       </div>
     </div>
@@ -52,8 +52,10 @@ <h5><span>Flatdoc</span></h5>
     <div class='left'>
       <h1><a href='.'>Flatdoc</a></h1>
       <ul>
-        <li><a href='https://github.com/rstacruz/flatdoc'>View on GitHub</a></li>
-        <li><a href='https://github.com/rstacruz/flatdoc/issues'>Issues</a></li>
+        <li><a href='clients.html'>Clients</a></li>
+        <li><a href='dashboard.html'>Dashboard</a></li>
+        <li><a href='email.html'>Email Templates</a></li>
+        <li><a href='profanity.html'>Profanity Filter</a></li>
         <li><a href='reference.html'>API reference</a></li>
       </ul>
     </div>
diff --git a/profanity.html b/profanity.html
new file mode 100644
index 0000000..a9b8523
--- /dev/null
+++ b/profanity.html
@@ -0,0 +1,52 @@
+<!doctype html>
+<html>
+<head>
+  <meta charset='utf-8'>
+  <meta http-equiv="X-UA-Compatible" content="chrome=1" />
+  <meta name="viewport" content="width=device-width">
+
+  <title>Flatdoc</title>
+
+  <!-- Flatdoc -->
+  <script src='support/vendor/jquery.js'></script>
+  <script src='legacy.js'></script>
+  <script src='flatdoc.js'></script>
+
+  <!-- Flatdoc theme -->
+  <link  href='theme-white/style.css' rel='stylesheet'>
+  <script src='theme-white/script.js'></script>
+  <link  href='support/theme.css' rel='stylesheet'>
+
+  <!-- Initializer -->
+  <script>
+    Flatdoc.run({
+      fetcher: Flatdoc.file('Reference.md')
+    });
+  </script>
+</head>
+<body role='flatdoc'>
+
+  <div class='header'>
+    <div class='left'>
+      <h1><a href='.'>Flatdoc</a></h1>
+      <ul>
+        <li><a href='https://github.com/rstacruz/flatdoc'>View on Github</a></li>
+        <li><a href='https://github.com/rstacruz/flatdoc/issues'>Issues</a></li>
+        <li><a href='reference.html'>API reference</a></li>
+      </ul>
+    </div>
+    <div class='right'>
+      <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;type=follow&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="170" height="20"></iframe>
+      <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;repo=flatdoc&amp;type=watch&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe>
+    </div>
+  </div>
+
+  <div class='content-root'>
+    <div class='menubar'>
+      <div class='menu section' role='flatdoc-menu'></div>
+    </div>
+    <div role='flatdoc-content' class='content'></div>
+  </div>
+
+</body>
+</html>

From d2b2179e3a23c7906b297ef10022534d33c3e95f Mon Sep 17 00:00:00 2001
From: securetorobert <securetorobert@protonmail.com>
Date: Fri, 30 Nov 2018 14:47:26 +0100
Subject: [PATCH 03/96] changed the runner

---
 index.html | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/index.html b/index.html
index 3a047c4..6609de1 100644
--- a/index.html
+++ b/index.html
@@ -21,7 +21,7 @@
   <!-- Initializer -->
   <script>
     Flatdoc.run({
-      fetcher: Flatdoc.file('Readme.md')
+      fetcher: Flatdoc.github('enterfive/flatdoc')
     });
   </script>
 
@@ -33,8 +33,7 @@
   <meta content="Versus Flatdoc API Documentation." property="og:description">
   <meta content="http://ricostacruz.com/flatdoc/support/preview.jpg" property="og:image">
 
-  <!-- Analytics -->
-  <script>if (location.hostname.match(/ricostacruz\.com/)){var _gaq=_gaq||[];_gaq.push(["_setAccount","UA-20473929-1"]);_gaq.push(["_trackPageview"]);!function(){var ga=document.createElement("script");ga.type="text/javascript";ga.async=true;ga.src=("https:"==document.location.protocol?"https://ssl":"http://www")+".google-analytics.com/ga.js";var s=document.getElementsByTagName("script")[0];s.parentNode.insertBefore(ga,s)}();}</script>
+  
 </head>
 <body role='flatdoc' class='big-h3 large-brief'>
 

From 33af3629ff4d412c99635174f32387f49f82d106 Mon Sep 17 00:00:00 2001
From: securetorobert <securetorobert@protonmail.com>
Date: Fri, 30 Nov 2018 15:20:01 +0100
Subject: [PATCH 04/96] fixed profanity page

---
 Profanity.md   | 45 ++++++++++-----------------------------------
 Readme.md      |  9 ++-------
 index.html     |  2 +-
 profanity.html | 32 +++++++++++++++++---------------
 4 files changed, 30 insertions(+), 58 deletions(-)

diff --git a/Profanity.md b/Profanity.md
index 2dd73b4..df5a32f 100644
--- a/Profanity.md
+++ b/Profanity.md
@@ -1,44 +1,19 @@
-Versus API Endpoints
-=======
+# Profanity Filter
 
-This documentation lists the API endpoints required for engineers on the Versus team to interface with Versus Backend. The API endpoints are generally grouped into the following.
+This function will take a string and return a HTML formattted string with tags that decorate profane words.
 
- * Clients
- * Dashboard
- * Email Templates
- * Profanity Filter
 
-*Current version: [v0.1.0][dist]*
+> Endpoint: versus_profanity_filter
 
-
-Getting started
----------------
-
-Create a file based on the template, which has a bare DOM, link to the
-scripts, and a link to a theme. It will look something like this (not exact).
-For GitHub projects, simply place this file in your [GitHub pages] branch and
-you're all good to go.
-
-*In short: just download this file and upload it somewhere.*
-
-The main JS and CSS files are also available in [npm] and [bower].
-
-[Default theme template >][template]
-
-[Blank template >][blank]
-
-[bower]: http://bower.io/search/?q=flatdoc
-[npm]: https://www.npmjs.org/package/flatdoc
-
-### Via GitHub
-
-To fetch a Github Repository's readme file, use the `Flatdoc.github` fetcher.
-This will fetch the Readme file of the repository's default branch.
+> Payload
 
 ``` javascript
-Flatdoc.run({
-  fetcher: Flatdoc.github('USER/REPO')
-});
+{"text": "What the hell"}
+```
+
+> Result
+``` html
+what the <STRONG CLASS="blacklist">hell</STRONG>
 ```
 
 You may also fetch another file other than the Readme file, just specify it as
diff --git a/Readme.md b/Readme.md
index 79ad31b..ee37dd9 100644
--- a/Readme.md
+++ b/Readme.md
@@ -1,5 +1,4 @@
 # Versus API Endpoints
-=======
 
 This documentation lists the API endpoints required for engineers on the Versus team to interface with Versus Backend. The API endpoints are generally grouped into the following.
 
@@ -12,7 +11,6 @@ This documentation lists the API endpoints required for engineers on the Versus
 
 
 # Clients
-----------------
 
 This has functions for managing clients
 1. Create Client: create a new Versus Sentiment Client
@@ -21,7 +19,6 @@ This has functions for managing clients
 4. Create Member: register someone who was added to the list of team members
 
 # Dasboard
-----------------
 
 This has functions for retrieving mentions
 1. Today Summary: Today's mentions on social media, news, and other sources
@@ -34,7 +31,6 @@ This has functions for retrieving mentions
 8. All Time Details: Mentions from social media, news, and other sources grouped by source for all content on our systems
 
 # Email Templates
-----------------
 
 This has functions for sending out emails
 1. Custom Alerts: Notify an admin that custom alerts have been set for their account
@@ -46,18 +42,17 @@ This has functions for sending out emails
 7. Your Report: Dispatch a periodic report
 
 # Profanity Filter
-----------------
 
 This function will take a string and return a HTML formattted string with tags that decorate profane words.
 
 
 # Getting started
----------------
 
 All endpoints are REST. The default method is POST unless otherwise specified. There is a base URL to which you will need to append the endpoint.
 
 > Method: POST
-> Base_URL: 
+
+> Base_URL: https://us-central1-versus-dev-212614.cloudfunctions.net/
 
 
 ### Via GitHub
diff --git a/index.html b/index.html
index 6609de1..bac2272 100644
--- a/index.html
+++ b/index.html
@@ -21,7 +21,7 @@
   <!-- Initializer -->
   <script>
     Flatdoc.run({
-      fetcher: Flatdoc.github('enterfive/flatdoc')
+      fetcher: Flatdoc.file('Readme.md')
     });
   </script>
 
diff --git a/profanity.html b/profanity.html
index a9b8523..2b45827 100644
--- a/profanity.html
+++ b/profanity.html
@@ -20,26 +20,28 @@
   <!-- Initializer -->
   <script>
     Flatdoc.run({
-      fetcher: Flatdoc.file('Reference.md')
+      fetcher: Flatdoc.file('Profanity.md')
     });
   </script>
 </head>
 <body role='flatdoc'>
 
-  <div class='header'>
-    <div class='left'>
-      <h1><a href='.'>Flatdoc</a></h1>
-      <ul>
-        <li><a href='https://github.com/rstacruz/flatdoc'>View on Github</a></li>
-        <li><a href='https://github.com/rstacruz/flatdoc/issues'>Issues</a></li>
-        <li><a href='reference.html'>API reference</a></li>
-      </ul>
-    </div>
-    <div class='right'>
-      <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;type=follow&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="170" height="20"></iframe>
-      <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;repo=flatdoc&amp;type=watch&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe>
-    </div>
-  </div>
+    <div class='header'>
+        <div class='left'>
+          <h1><a href='.'>Flatdoc</a></h1>
+          <ul>
+            <li><a href='clients.html'>Clients</a></li>
+            <li><a href='dashboard.html'>Dashboard</a></li>
+            <li><a href='email.html'>Email Templates</a></li>
+            <li><a href='profanity.html'>Profanity Filter</a></li>
+            <li><a href='reference.html'>API reference</a></li>
+          </ul>
+        </div>
+        <div class='right'>
+          <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;type=follow&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="170" height="20"></iframe>
+          <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;repo=flatdoc&amp;type=watch&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe>
+        </div>
+      </div>
 
   <div class='content-root'>
     <div class='menubar'>

From 31f0625b17c4d6650cc13eff6e5c67c59464d7b6 Mon Sep 17 00:00:00 2001
From: securetorobert <securetorobert@protonmail.com>
Date: Fri, 30 Nov 2018 15:31:23 +0100
Subject: [PATCH 05/96] updated numbering in index

---
 Profanity.md | 218 -----------------------------------------
 Readme.md    | 269 ++++-----------------------------------------------
 2 files changed, 19 insertions(+), 468 deletions(-)

diff --git a/Profanity.md b/Profanity.md
index df5a32f..6df005b 100644
--- a/Profanity.md
+++ b/Profanity.md
@@ -16,221 +16,3 @@ This function will take a string and return a HTML formattted string with tags t
 what the <STRONG CLASS="blacklist">hell</STRONG>
 ```
 
-You may also fetch another file other than the Readme file, just specify it as
-the 2nd parameter.
-
-``` javascript
-Flatdoc.run({
-  fetcher: Flatdoc.github('USER/REPO', 'Changelog.md')
-});
-```
-
-After you've done this, you probably want to deploy it via [GitHub Pages].
-
-[GitHub Pages guide >][GitHub Pages]
-
-### Via a file
-
-You may also fetch a file. In this example, this fetches the file `Readme.md` in
-the same folder as the HTML file.
-
-``` javascript
-Flatdoc.run({
-  fetcher: Flatdoc.file('Readme.md')
-});
-```
-
-You may actually supply any URL here. It will be fetched via AJAX. This is
-useful for local testing.
-
-``` javascript
-Flatdoc.run({
-  fetcher: Flatdoc.file('http://yoursite.com/Readme.md')
-});
-```
-
-How it works
-------------
-
-Flatdoc is a hosted `.js` file (along with a theme and its assets) that you can
-add into any page hosted anywhere.
-
-#### All client-side
-
-There are no build scripts or 3rd-party services involved. Everything is done in
-the browser. Worried about performance? Oh, It's pretty fast.
-
-Flatdoc utilizes the [GitHub API] to fetch your project's Readme files. You may
-also configure it to fetch any arbitrary URL via AJAX.
-
-#### Lightning-fast parsing
-
-Next, it uses [marked], an extremely fast Markdown parser that has support for
-GitHub flavored Markdown.
-
-Flatdoc then simply renders *menu* and *content* DOM elements to your HTML
-document. Flatdoc also comes with a default theme to style your page for you, or
-you may opt to create your own styles.
-
-Markdown extras
----------------
-
-Flatdoc offers a few harmless, unobtrusive extras that come in handy in building
-documentation sites.
-
-#### Code highlighting
-
-You can use Markdown code fences to make syntax-highlighted text. Simply
-surround your text with three backticks. This works in GitHub as well.
-See [GitHub Syntax Highlighting][fences] for more info.
-
-    ``` html
-    <strong>Hola, mundo</strong>
-    ```
-
-#### Blockquotes
-
-Blockquotes show up as side figures. This is useful for providing side
-information or non-code examples.
-
-> Blockquotes are blocks that begin with `>`.
-
-#### Smart quotes
-
-Single quotes, double quotes, and double-hyphens are automatically replaced to
-their typographically-accurate equivalent. This, of course, does not apply to
-`<code>` and `<pre>` blocks to leave code alone.
-
-> "From a certain point onward there is no longer any turning back. That is the
-> point that must be reached."  
-> --Franz Kafka
-
-#### Buttons
-
-If your link text has a `>` at the end (for instance: `Continue >`), they show
-up as buttons.
-
-> [View in GitHub >][project]
-
-Customizing
-===========
-
-Basic
------
-
-### Theme options
-
-For the default theme (*theme-white*), You can set theme options by adding
-classes to the `<body>` element. The available options are:
-
-#### big-h3
-Makes 3rd-level headings bigger.
-
-``` html
-<body class='big-h3'>
-```
-
-#### no-literate
-Disables "literate" mode, where code appears on the right and content text
-appear on the left.
-
-``` html
-<body class='no-literate'>
-```
-
-#### large-brief
-Makes the opening paragraph large.
-
-``` html
-<body class='large-brief'>
-```
-
-### Adding more markup
-
-You have full control over the HTML file, just add markup wherever you see fit.
-As long as you leave `role='flatdoc-content'` and `role='flatdoc-menu'` empty as
-they are, you'll be fine.
-
-Here are some ideas to get you started.
-
- * Add a CSS file to make your own CSS adjustments.
- * Add a 'Tweet' button on top.
- * Add Google Analytics.
- * Use CSS to style the IDs in menus (`#acknowledgements + p`).
-
-### JavaScript hooks
-
-Flatdoc emits the events `flatdoc:loading` and `flatdoc:ready` to help you make
-custom behavior when the document loads.
-
-``` js
-$(document).on('flatdoc:ready', function() {
-  // I don't like this section to appear
-  $("#acknowledgements").remove();
-});
-```
-
-Full customization
-------------------
-
-You don't have to be restricted to the given theme. Flatdoc is just really one
-`.js` file that expects 2 HTML elements (for *menu* and *content*). Start with
-the blank template and customize as you see fit.
-
-[Get blank template >][template]
-
-Misc
-====
-
-Inspirations
-------------
-
-The following projects have inspired Flatdoc.
-
- * [Backbone.js] - Jeremy's projects have always adopted this "one page
- documentation" approach which I really love.
-
- * [Docco] - Jeremy's Docco introduced me to the world of literate programming,
- and side-by-side documentation in general.
-
- * [Stripe] - Flatdoc took inspiration on the look of their API documentation.
-
- * [DocumentUp] - This service has the same idea but does a hosted readme 
- parsing approach.
-
-Attributions
-------------
-
-[Photo](http://www.flickr.com/photos/doug88888/2953428679/) taken from Flickr,
-licensed under Creative Commons.
-
-Acknowledgements
-----------------
-
-© 2013, 2014, Rico Sta. Cruz. Released under the [MIT 
-License](http://www.opensource.org/licenses/mit-license.php).
-
-**Flatdoc** is authored and maintained by [Rico Sta. Cruz][rsc] with help from its 
-[contributors][c].
-
- * [My website](http://ricostacruz.com) (ricostacruz.com)
- * [Github](http://github.com/rstacruz) (@rstacruz)
- * [Twitter](http://twitter.com/rstacruz) (@rstacruz)
-
-[rsc]: http://ricostacruz.com
-[c]:   http://github.com/rstacruz/flatdoc/contributors
-
-[GitHub API]: http://github.com/api
-[marked]: https://github.com/chjj/marked
-[Backbone.js]: http://backbonejs.org
-[dox]: https://github.com/visionmedia/dox
-[Stripe]: https://stripe.com/docs/api
-[Docco]: http://jashkenas.github.com/docco
-[GitHub pages]: https://pages.github.com
-[fences]:https://help.github.com/articles/github-flavored-markdown#syntax-highlighting
-[DocumentUp]: http://documentup.com
-
-[project]: https://github.com/rstacruz/flatdoc
-[template]: https://github.com/rstacruz/flatdoc/raw/gh-pages/templates/template.html
-[blank]: https://github.com/rstacruz/flatdoc/raw/gh-pages/templates/blank.html
-[dist]: https://github.com/rstacruz/flatdoc/tree/gh-pages/v/0.9.0
diff --git a/Readme.md b/Readme.md
index ee37dd9..d330bd9 100644
--- a/Readme.md
+++ b/Readme.md
@@ -13,33 +13,33 @@ This documentation lists the API endpoints required for engineers on the Versus
 # Clients
 
 This has functions for managing clients
-1. Create Client: create a new Versus Sentiment Client
-2. Get Client: get details about a Versus Sentiment Client
-3. Update Client: onboard a Versus Sentiment Client
-4. Create Member: register someone who was added to the list of team members
+ * Create Client: create a new Versus Sentiment Client
+ * Get Client: get details about a Versus Sentiment Client
+ * Update Client: onboard a Versus Sentiment Client
+ * Create Member: register someone who was added to the list of team members
 
 # Dasboard
 
 This has functions for retrieving mentions
-1. Today Summary: Today's mentions on social media, news, and other sources
-2. Week Summary: This week's mentions on social media, news, and other sources
-3. Month Summary: This month's mentions on social media, news, and other sources
-4. All Time Summary: Total aggregate on our systems of mentions on social media, news, and other sources
-5. Today Details: Mentions from social media, news, and other sources grouped by source for today
-6. Week Details: Mentions from social media, news, and other sources grouped by source for the past week
-7. Today Details: Mentions from social media, news, and other sources grouped by source for the past month
-8. All Time Details: Mentions from social media, news, and other sources grouped by source for all content on our systems
+ * Today Summary: Today's mentions on social media, news, and other sources
+ * Week Summary: This week's mentions on social media, news, and other sources
+ * Month Summary: This month's mentions on social media, news, and other sources
+ * All Time Summary: Total aggregate on our systems of mentions on social media, news, and other sources
+ * Today Details: Mentions from social media, news, and other sources grouped by source for today
+ * Week Details: Mentions from social media, news, and other sources grouped by source for the past week
+ * Today Details: Mentions from social media, news, and other sources grouped by source for the past month
+ * All Time Details: Mentions from social media, news, and other sources grouped by source for all content on our systems
 
 # Email Templates
 
 This has functions for sending out emails
-1. Custom Alerts: Notify an admin that custom alerts have been set for their account
-2. Dashboard Ready: Notify an admin that the Versus Sentiment dashboard has data for viewing
-3. Designated Primary Email: Notify an admin that they have been designated as a primary contact
-4. Designated Team Member: Notify someone that they have been added as a team member to Versus Sentiment
-5. Respond to Article: Notify a recipient to respond to a social media post
-6. Welcome to Versus: Notify the recipient that their Versus Sentiment account has been created
-7. Your Report: Dispatch a periodic report
+ * Custom Alerts: Notify an admin that custom alerts have been set for their account
+ * Dashboard Ready: Notify an admin that the Versus Sentiment dashboard has data for viewing
+ * Designated Primary Email: Notify an admin that they have been designated as a primary contact
+ * Designated Team Member: Notify someone that they have been added as a team member to Versus Sentiment
+ * Respond to Article: Notify a recipient to respond to a social media post
+ * Welcome to Versus: Notify the recipient that their Versus Sentiment account has been created
+ * Your Report: Dispatch a periodic report
 
 # Profanity Filter
 
@@ -53,234 +53,3 @@ All endpoints are REST. The default method is POST unless otherwise specified. T
 > Method: POST
 
 > Base_URL: https://us-central1-versus-dev-212614.cloudfunctions.net/
-
-
-### Via GitHub
-
-To fetch a Github Repository's readme file, use the `Flatdoc.github` fetcher.
-This will fetch the Readme file of the repository's default branch.
-
-``` javascript
-Flatdoc.run({
-  fetcher: Flatdoc.github('USER/REPO')
-});
-```
-
-You may also fetch another file other than the Readme file, just specify it as
-the 2nd parameter.
-
-``` javascript
-Flatdoc.run({
-  fetcher: Flatdoc.github('USER/REPO', 'Changelog.md')
-});
-```
-
-After you've done this, you probably want to deploy it via [GitHub Pages].
-
-[GitHub Pages guide >][GitHub Pages]
-
-### Via a file
-
-You may also fetch a file. In this example, this fetches the file `Readme.md` in
-the same folder as the HTML file.
-
-``` javascript
-Flatdoc.run({
-  fetcher: Flatdoc.file('Readme.md')
-});
-```
-
-You may actually supply any URL here. It will be fetched via AJAX. This is
-useful for local testing.
-
-``` javascript
-Flatdoc.run({
-  fetcher: Flatdoc.file('http://yoursite.com/Readme.md')
-});
-```
-
-How it works
-------------
-
-Flatdoc is a hosted `.js` file (along with a theme and its assets) that you can
-add into any page hosted anywhere.
-
-#### All client-side
-
-There are no build scripts or 3rd-party services involved. Everything is done in
-the browser. Worried about performance? Oh, It's pretty fast.
-
-Flatdoc utilizes the [GitHub API] to fetch your project's Readme files. You may
-also configure it to fetch any arbitrary URL via AJAX.
-
-#### Lightning-fast parsing
-
-Next, it uses [marked], an extremely fast Markdown parser that has support for
-GitHub flavored Markdown.
-
-Flatdoc then simply renders *menu* and *content* DOM elements to your HTML
-document. Flatdoc also comes with a default theme to style your page for you, or
-you may opt to create your own styles.
-
-Markdown extras
----------------
-
-Flatdoc offers a few harmless, unobtrusive extras that come in handy in building
-documentation sites.
-
-#### Code highlighting
-
-You can use Markdown code fences to make syntax-highlighted text. Simply
-surround your text with three backticks. This works in GitHub as well.
-See [GitHub Syntax Highlighting][fences] for more info.
-
-    ``` html
-    <strong>Hola, mundo</strong>
-    ```
-
-#### Blockquotes
-
-Blockquotes show up as side figures. This is useful for providing side
-information or non-code examples.
-
-> Blockquotes are blocks that begin with `>`.
-
-#### Smart quotes
-
-Single quotes, double quotes, and double-hyphens are automatically replaced to
-their typographically-accurate equivalent. This, of course, does not apply to
-`<code>` and `<pre>` blocks to leave code alone.
-
-> "From a certain point onward there is no longer any turning back. That is the
-> point that must be reached."  
-> --Franz Kafka
-
-#### Buttons
-
-If your link text has a `>` at the end (for instance: `Continue >`), they show
-up as buttons.
-
-> [View in GitHub >][project]
-
-Customizing
-===========
-
-Basic
------
-
-### Theme options
-
-For the default theme (*theme-white*), You can set theme options by adding
-classes to the `<body>` element. The available options are:
-
-#### big-h3
-Makes 3rd-level headings bigger.
-
-``` html
-<body class='big-h3'>
-```
-
-#### no-literate
-Disables "literate" mode, where code appears on the right and content text
-appear on the left.
-
-``` html
-<body class='no-literate'>
-```
-
-#### large-brief
-Makes the opening paragraph large.
-
-``` html
-<body class='large-brief'>
-```
-
-### Adding more markup
-
-You have full control over the HTML file, just add markup wherever you see fit.
-As long as you leave `role='flatdoc-content'` and `role='flatdoc-menu'` empty as
-they are, you'll be fine.
-
-Here are some ideas to get you started.
-
- * Add a CSS file to make your own CSS adjustments.
- * Add a 'Tweet' button on top.
- * Add Google Analytics.
- * Use CSS to style the IDs in menus (`#acknowledgements + p`).
-
-### JavaScript hooks
-
-Flatdoc emits the events `flatdoc:loading` and `flatdoc:ready` to help you make
-custom behavior when the document loads.
-
-``` js
-$(document).on('flatdoc:ready', function() {
-  // I don't like this section to appear
-  $("#acknowledgements").remove();
-});
-```
-
-Full customization
-------------------
-
-You don't have to be restricted to the given theme. Flatdoc is just really one
-`.js` file that expects 2 HTML elements (for *menu* and *content*). Start with
-the blank template and customize as you see fit.
-
-[Get blank template >][template]
-
-Misc
-====
-
-Inspirations
-------------
-
-The following projects have inspired Flatdoc.
-
- * [Backbone.js] - Jeremy's projects have always adopted this "one page
- documentation" approach which I really love.
-
- * [Docco] - Jeremy's Docco introduced me to the world of literate programming,
- and side-by-side documentation in general.
-
- * [Stripe] - Flatdoc took inspiration on the look of their API documentation.
-
- * [DocumentUp] - This service has the same idea but does a hosted readme 
- parsing approach.
-
-Attributions
-------------
-
-[Photo](http://www.flickr.com/photos/doug88888/2953428679/) taken from Flickr,
-licensed under Creative Commons.
-
-Acknowledgements
-----------------
-
-© 2013, 2014, Rico Sta. Cruz. Released under the [MIT 
-License](http://www.opensource.org/licenses/mit-license.php).
-
-**Flatdoc** is authored and maintained by [Rico Sta. Cruz][rsc] with help from its 
-[contributors][c].
-
- * [My website](http://ricostacruz.com) (ricostacruz.com)
- * [Github](http://github.com/rstacruz) (@rstacruz)
- * [Twitter](http://twitter.com/rstacruz) (@rstacruz)
-
-[rsc]: http://ricostacruz.com
-[c]:   http://github.com/rstacruz/flatdoc/contributors
-
-[GitHub API]: http://github.com/api
-[marked]: https://github.com/chjj/marked
-[Backbone.js]: http://backbonejs.org
-[dox]: https://github.com/visionmedia/dox
-[Stripe]: https://stripe.com/docs/api
-[Docco]: http://jashkenas.github.com/docco
-[GitHub pages]: https://pages.github.com
-[fences]:https://help.github.com/articles/github-flavored-markdown#syntax-highlighting
-[DocumentUp]: http://documentup.com
-
-[project]: https://github.com/rstacruz/flatdoc
-[template]: https://github.com/rstacruz/flatdoc/raw/gh-pages/templates/template.html
-[blank]: https://github.com/rstacruz/flatdoc/raw/gh-pages/templates/blank.html
-[dist]: https://github.com/rstacruz/flatdoc/tree/gh-pages/v/0.9.0

From 056352c1ff5eb2f650c8f25901a80a8d4cd0efac Mon Sep 17 00:00:00 2001
From: securetorobert <securetorobert@protonmail.com>
Date: Fri, 30 Nov 2018 15:54:01 +0100
Subject: [PATCH 06/96] added a fields table

---
 Profanity.md | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/Profanity.md b/Profanity.md
index 6df005b..34ef13a 100644
--- a/Profanity.md
+++ b/Profanity.md
@@ -1,6 +1,11 @@
 # Profanity Filter
 
-This function will take a string and return a HTML formattted string with tags that decorate profane words.
+This function will take a string and return a HTML formatted string with tags that decorate profane words.
+
+| Field     | Type       | Description                                  |
+|-----------|------------|----------------------------------------------|
+|  text     | string     | the string to be formatted                   |
+|           |            |                                              |
 
 
 > Endpoint: versus_profanity_filter

From 07b364bd67de732bc1cab971d239eeddb4755c58 Mon Sep 17 00:00:00 2001
From: securetorobert <securetorobert@protonmail.com>
Date: Fri, 30 Nov 2018 16:28:35 +0100
Subject: [PATCH 07/96] started working on email

---
 Email.md     | 278 +++++++++------------------------------------------
 Profanity.md |  11 +-
 Readme.md    |   1 +
 email.html   |  32 +++---
 4 files changed, 71 insertions(+), 251 deletions(-)

diff --git a/Email.md b/Email.md
index 2dd73b4..147e3c9 100644
--- a/Email.md
+++ b/Email.md
@@ -1,261 +1,75 @@
-Versus API Endpoints
-=======
+# Email
 
-This documentation lists the API endpoints required for engineers on the Versus team to interface with Versus Backend. The API endpoints are generally grouped into the following.
+This has endpoints for sending out emails.
 
- * Clients
- * Dashboard
- * Email Templates
- * Profanity Filter
+## Custom Alerts: 
+Notify an admin that custom alerts have been set for their account. The payload has the following fields.
 
-*Current version: [v0.1.0][dist]*
+| Field            | Type   | Description                                               |
+|------------------|--------|-----------------------------------------------------------|
+| recipient        | string | the email to send the mail to                             |
+| firstName        | string | the name of the email recipient                           |
+| organizationName | string | the name of the organization that the recipient works for |
+| alertFrequency   | string | one or more periods, separated by a comma                 |
 
+> Endpoint: email_custom_alerts_set
 
-Getting started
----------------
-
-Create a file based on the template, which has a bare DOM, link to the
-scripts, and a link to a theme. It will look something like this (not exact).
-For GitHub projects, simply place this file in your [GitHub pages] branch and
-you're all good to go.
-
-*In short: just download this file and upload it somewhere.*
-
-The main JS and CSS files are also available in [npm] and [bower].
-
-[Default theme template >][template]
-
-[Blank template >][blank]
-
-[bower]: http://bower.io/search/?q=flatdoc
-[npm]: https://www.npmjs.org/package/flatdoc
-
-### Via GitHub
-
-To fetch a Github Repository's readme file, use the `Flatdoc.github` fetcher.
-This will fetch the Readme file of the repository's default branch.
+> Payload
 
 ``` javascript
-Flatdoc.run({
-  fetcher: Flatdoc.github('USER/REPO')
-});
+{
+  "recipient": "deji.a.ibrahim@gmail.com",
+  "firstName": "Deji",
+  "organizationName": "Deji Enterprises",
+  "alertFrequency": "Daily"
+}
 ```
 
-You may also fetch another file other than the Readme file, just specify it as
-the 2nd parameter.
+> Response
 
 ``` javascript
-Flatdoc.run({
-  fetcher: Flatdoc.github('USER/REPO', 'Changelog.md')
-});
+{"recipient": "deji.a.ibrahim@gmail.com"}
 ```
 
-After you've done this, you probably want to deploy it via [GitHub Pages].
+## Dashboard Ready: 
+Notify an admin that the Versus Sentiment dashboard has data for viewing. The payload has the following fields.
 
-[GitHub Pages guide >][GitHub Pages]
+| Field     | Type   | Description                         |
+|-----------|--------|-------------------------------------|
+| recipient | string | the email to send the mail to       |
+| firstName | string | the name of the email recipient     |
 
-### Via a file
+> Endpoint: email_dashboard_ready
 
-You may also fetch a file. In this example, this fetches the file `Readme.md` in
-the same folder as the HTML file.
+> Payload: 
 
 ``` javascript
-Flatdoc.run({
-  fetcher: Flatdoc.file('Readme.md')
-});
+{
+  "recipient": "johnthas@yahoo.com",
+  "firstName": "Robert"
+}
 ```
 
-You may actually supply any URL here. It will be fetched via AJAX. This is
-useful for local testing.
+> Response
 
 ``` javascript
-Flatdoc.run({
-  fetcher: Flatdoc.file('http://yoursite.com/Readme.md')
-});
-```
-
-How it works
-------------
-
-Flatdoc is a hosted `.js` file (along with a theme and its assets) that you can
-add into any page hosted anywhere.
-
-#### All client-side
-
-There are no build scripts or 3rd-party services involved. Everything is done in
-the browser. Worried about performance? Oh, It's pretty fast.
-
-Flatdoc utilizes the [GitHub API] to fetch your project's Readme files. You may
-also configure it to fetch any arbitrary URL via AJAX.
-
-#### Lightning-fast parsing
-
-Next, it uses [marked], an extremely fast Markdown parser that has support for
-GitHub flavored Markdown.
-
-Flatdoc then simply renders *menu* and *content* DOM elements to your HTML
-document. Flatdoc also comes with a default theme to style your page for you, or
-you may opt to create your own styles.
-
-Markdown extras
----------------
-
-Flatdoc offers a few harmless, unobtrusive extras that come in handy in building
-documentation sites.
-
-#### Code highlighting
-
-You can use Markdown code fences to make syntax-highlighted text. Simply
-surround your text with three backticks. This works in GitHub as well.
-See [GitHub Syntax Highlighting][fences] for more info.
-
-    ``` html
-    <strong>Hola, mundo</strong>
-    ```
-
-#### Blockquotes
-
-Blockquotes show up as side figures. This is useful for providing side
-information or non-code examples.
-
-> Blockquotes are blocks that begin with `>`.
-
-#### Smart quotes
-
-Single quotes, double quotes, and double-hyphens are automatically replaced to
-their typographically-accurate equivalent. This, of course, does not apply to
-`<code>` and `<pre>` blocks to leave code alone.
-
-> "From a certain point onward there is no longer any turning back. That is the
-> point that must be reached."  
-> --Franz Kafka
-
-#### Buttons
-
-If your link text has a `>` at the end (for instance: `Continue >`), they show
-up as buttons.
-
-> [View in GitHub >][project]
-
-Customizing
-===========
-
-Basic
------
-
-### Theme options
-
-For the default theme (*theme-white*), You can set theme options by adding
-classes to the `<body>` element. The available options are:
-
-#### big-h3
-Makes 3rd-level headings bigger.
-
-``` html
-<body class='big-h3'>
-```
-
-#### no-literate
-Disables "literate" mode, where code appears on the right and content text
-appear on the left.
-
-``` html
-<body class='no-literate'>
-```
-
-#### large-brief
-Makes the opening paragraph large.
-
-``` html
-<body class='large-brief'>
-```
-
-### Adding more markup
-
-You have full control over the HTML file, just add markup wherever you see fit.
-As long as you leave `role='flatdoc-content'` and `role='flatdoc-menu'` empty as
-they are, you'll be fine.
-
-Here are some ideas to get you started.
-
- * Add a CSS file to make your own CSS adjustments.
- * Add a 'Tweet' button on top.
- * Add Google Analytics.
- * Use CSS to style the IDs in menus (`#acknowledgements + p`).
-
-### JavaScript hooks
-
-Flatdoc emits the events `flatdoc:loading` and `flatdoc:ready` to help you make
-custom behavior when the document loads.
-
-``` js
-$(document).on('flatdoc:ready', function() {
-  // I don't like this section to appear
-  $("#acknowledgements").remove();
-});
+{"recipient": "johnthas@yahoo.com"}
 ```
 
-Full customization
-------------------
-
-You don't have to be restricted to the given theme. Flatdoc is just really one
-`.js` file that expects 2 HTML elements (for *menu* and *content*). Start with
-the blank template and customize as you see fit.
-
-[Get blank template >][template]
-
-Misc
-====
-
-Inspirations
-------------
-
-The following projects have inspired Flatdoc.
-
- * [Backbone.js] - Jeremy's projects have always adopted this "one page
- documentation" approach which I really love.
-
- * [Docco] - Jeremy's Docco introduced me to the world of literate programming,
- and side-by-side documentation in general.
-
- * [Stripe] - Flatdoc took inspiration on the look of their API documentation.
-
- * [DocumentUp] - This service has the same idea but does a hosted readme 
- parsing approach.
-
-Attributions
-------------
-
-[Photo](http://www.flickr.com/photos/doug88888/2953428679/) taken from Flickr,
-licensed under Creative Commons.
-
-Acknowledgements
-----------------
-
-© 2013, 2014, Rico Sta. Cruz. Released under the [MIT 
-License](http://www.opensource.org/licenses/mit-license.php).
+## Designated Primary Email: 
+Notify an admin that they have been designated as a primary contact
 
-**Flatdoc** is authored and maintained by [Rico Sta. Cruz][rsc] with help from its 
-[contributors][c].
+## Designated Team Member: 
+Notify someone that they have been added as a team member to Versus Sentiment
 
- * [My website](http://ricostacruz.com) (ricostacruz.com)
- * [Github](http://github.com/rstacruz) (@rstacruz)
- * [Twitter](http://twitter.com/rstacruz) (@rstacruz)
+## Request a Demo: 
+Let a potential user request a demo
 
-[rsc]: http://ricostacruz.com
-[c]:   http://github.com/rstacruz/flatdoc/contributors
+## Respond to Article: 
+Notify a recipient to respond to a social media post
 
-[GitHub API]: http://github.com/api
-[marked]: https://github.com/chjj/marked
-[Backbone.js]: http://backbonejs.org
-[dox]: https://github.com/visionmedia/dox
-[Stripe]: https://stripe.com/docs/api
-[Docco]: http://jashkenas.github.com/docco
-[GitHub pages]: https://pages.github.com
-[fences]:https://help.github.com/articles/github-flavored-markdown#syntax-highlighting
-[DocumentUp]: http://documentup.com
+## Welcome to Versus: 
+Notify the recipient that their Versus Sentiment account has been created
 
-[project]: https://github.com/rstacruz/flatdoc
-[template]: https://github.com/rstacruz/flatdoc/raw/gh-pages/templates/template.html
-[blank]: https://github.com/rstacruz/flatdoc/raw/gh-pages/templates/blank.html
-[dist]: https://github.com/rstacruz/flatdoc/tree/gh-pages/v/0.9.0
+## Your Report: 
+Dispatch a periodic report
\ No newline at end of file
diff --git a/Profanity.md b/Profanity.md
index 34ef13a..f088c03 100644
--- a/Profanity.md
+++ b/Profanity.md
@@ -2,10 +2,13 @@
 
 This function will take a string and return a HTML formatted string with tags that decorate profane words.
 
-| Field     | Type       | Description                                  |
-|-----------|------------|----------------------------------------------|
-|  text     | string     | the string to be formatted                   |
-|           |            |                                              |
+## Parameters
+
+| Field | Type   | Description                         |
+|-------|--------|-------------------------------------|
+| text  | string | the field to be formatted into HTML |
+|       |        |                                     |
+|       |        |                                     |
 
 
 > Endpoint: versus_profanity_filter
diff --git a/Readme.md b/Readme.md
index d330bd9..6e2147a 100644
--- a/Readme.md
+++ b/Readme.md
@@ -37,6 +37,7 @@ This has functions for sending out emails
  * Dashboard Ready: Notify an admin that the Versus Sentiment dashboard has data for viewing
  * Designated Primary Email: Notify an admin that they have been designated as a primary contact
  * Designated Team Member: Notify someone that they have been added as a team member to Versus Sentiment
+ * Request a Demo: Let a potential user request a demo
  * Respond to Article: Notify a recipient to respond to a social media post
  * Welcome to Versus: Notify the recipient that their Versus Sentiment account has been created
  * Your Report: Dispatch a periodic report
diff --git a/email.html b/email.html
index a9b8523..11ab6c1 100644
--- a/email.html
+++ b/email.html
@@ -20,26 +20,28 @@
   <!-- Initializer -->
   <script>
     Flatdoc.run({
-      fetcher: Flatdoc.file('Reference.md')
+      fetcher: Flatdoc.file('Email.md')
     });
   </script>
 </head>
 <body role='flatdoc'>
 
-  <div class='header'>
-    <div class='left'>
-      <h1><a href='.'>Flatdoc</a></h1>
-      <ul>
-        <li><a href='https://github.com/rstacruz/flatdoc'>View on Github</a></li>
-        <li><a href='https://github.com/rstacruz/flatdoc/issues'>Issues</a></li>
-        <li><a href='reference.html'>API reference</a></li>
-      </ul>
-    </div>
-    <div class='right'>
-      <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;type=follow&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="170" height="20"></iframe>
-      <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;repo=flatdoc&amp;type=watch&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe>
-    </div>
-  </div>
+    <div class='header'>
+        <div class='left'>
+          <h1><a href='.'>Flatdoc</a></h1>
+          <ul>
+            <li><a href='clients.html'>Clients</a></li>
+            <li><a href='dashboard.html'>Dashboard</a></li>
+            <li><a href='email.html'>Email Templates</a></li>
+            <li><a href='profanity.html'>Profanity Filter</a></li>
+            <li><a href='reference.html'>API reference</a></li>
+          </ul>
+        </div>
+        <div class='right'>
+          <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;type=follow&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="170" height="20"></iframe>
+          <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;repo=flatdoc&amp;type=watch&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe>
+        </div>
+      </div>
 
   <div class='content-root'>
     <div class='menubar'>

From d63f550fb61c8eab05206b878d701d3b1671621c Mon Sep 17 00:00:00 2001
From: securetorobert <securetorobert@protonmail.com>
Date: Fri, 30 Nov 2018 20:22:06 +0100
Subject: [PATCH 08/96] completed email

---
 Email.md     | 161 +++++++++++++++++++++++++++++++++++++++++++++++++--
 Profanity.md |   4 +-
 2 files changed, 156 insertions(+), 9 deletions(-)

diff --git a/Email.md b/Email.md
index 147e3c9..f0e616a 100644
--- a/Email.md
+++ b/Email.md
@@ -57,19 +57,168 @@ Notify an admin that the Versus Sentiment dashboard has data for viewing. The pa
 ```
 
 ## Designated Primary Email: 
-Notify an admin that they have been designated as a primary contact
+Notify an admin that they have been designated as a primary contact. The payload has the following fields.
+
+| Field            | Type   | Description                     |
+|------------------|--------|---------------------------------|
+| recipient        | string | the email recipient             |
+| firstName        | string | the name of the email recipient |
+| organizationName | string | the name of the organization    |
+
+> Endpoint: email_designated_primary
+
+> Payload
+
+``` javascript
+{
+  "recipient": "johnthas@yahoo.com",
+  "firstName": "Robert",
+  "organizationName": "Enterfive"
+}
+```
+
+> Response
+
+``` javascript
+{"recipient": "johnthas@yahoo.com"}
+```
 
 ## Designated Team Member: 
-Notify someone that they have been added as a team member to Versus Sentiment
+Notify someone that they have been added as a team member to Versus Sentiment. The payload has the following fields.
+
+| Field            | Type   | Description                      |
+|------------------|--------|----------------------------------|
+| recipient        | string | the email recipient              |
+| firstName        | string | the name of the email recipient  |
+| organizationName | string | the name of the organization     |
+| inviteLink       | string | the URL that links to onboarding |
+
+> Endpoint: email_designated_team_member
+
+> Payload
+
+``` javascript
+{
+  "recipient": "kemdi@enterfive.com",
+  "firstName": "kemdi",
+  "organizationName": "Enterfive",
+  "inviteLink": "https://app.versus.ng/"
+}
+```
+
+> Response
+
+``` javascript
+{"recipient": "kemdi@enterfive.com"}
+```
 
 ## Request a Demo: 
-Let a potential user request a demo
+Let a potential user request a demo. The payload has the following fields.
+
+| Field        | Type   | Description                             |
+|--------------|--------|-----------------------------------------|
+| firstName    | string | the first name of the potential user    |
+| lastName     | string | the last name of the potential user     |
+| email        | string | the email address of the potential user |
+| organization | string | the name of the organization            |
+| sector       | string | the business sector of the requestor    |
+
+> Endpoint: email_request
+
+> Payload
+
+``` javascript
+{
+  "firstName": "Robert",
+  "lastName": "John",
+  "email": "robert@enterfive.com",
+  "organization": "Enterfive",
+  "sector": "Information Technology"
+}
+```
+
+> Response
+
+``` javascript
+{"recipient": "kemdi@enterfive.com"}
+```
 
 ## Respond to Article: 
-Notify a recipient to respond to a social media post
+Notify a recipient to respond to a social media post. The payload has the following fields.
+
+| Field            | Type   | Description                                  |
+|------------------|--------|----------------------------------------------|
+| firstName        | string | the first name of the recipient              |
+| recipient        | string | the email address of the recipient           |
+| link             | string | the URL to the article/post                  |
+| notes            | string | a call to action or message to the recipient |
+| requestFirstName | string | the name of the person sending the request   |
+
+> Endpoint: email_respond_to_article
+
+> Payload
+
+``` javascript
+{
+  "firstName": "Robert",
+  "recipient": "robert.thas.john@gmail.com",
+  "link": "https://twitter.com",
+  "notes": "I think you should respond to this tweet",
+  "requestFirstName": "Kemdi"
+}
+```
+
+> Response
+
+``` javascript
+{"recipient": "kemdi@enterfive.com"}
+```
 
 ## Welcome to Versus: 
-Notify the recipient that their Versus Sentiment account has been created
+Notify the recipient that their Versus Sentiment account has been created. The payload has the following fields.
+
+> Endpoint: email_welcome_to_versus
+
+> Payload
+
+``` javascript
+{
+  "recipient": "josh@enterfive.com",
+  "inviteLink": "https://app.versus.ng"
+}
+```
+
+> Response
+
+``` javascript
+{"recipient": "kemdi@enterfive.com"}
+```
 
 ## Your Report: 
-Dispatch a periodic report
\ No newline at end of file
+Dispatch a periodic report. The payload has the following fields.
+
+| Field          | Type   | Description                                           |
+|----------------|--------|-------------------------------------------------------|
+| recipient      | string | the email address of the recipient                    |
+| firstName      | string | the name of the recipient                             |
+| alertFrequency | string | the report being received (daily, weekly, or monthly) |
+| reportLink     | string | the URL from which to download reports                |
+
+> Endpoint: email_your_report
+
+> Payload
+
+``` javascript
+{
+  "recipient": "johnthas@yahoo.com",
+  "alertFrequency": "weekly",
+  "firstName": "Robert",
+  "reportLink": "https://app.versus.ng"
+}
+```
+
+> Response
+
+``` javascript
+{"recipient": "kemdi@enterfive.com"}
+```
\ No newline at end of file
diff --git a/Profanity.md b/Profanity.md
index f088c03..927868f 100644
--- a/Profanity.md
+++ b/Profanity.md
@@ -1,8 +1,6 @@
 # Profanity Filter
 
-This function will take a string and return a HTML formatted string with tags that decorate profane words.
-
-## Parameters
+This function will take a string and return a HTML formatted string with tags that decorate profane words. The payload has the following parameters.
 
 | Field | Type   | Description                         |
 |-------|--------|-------------------------------------|

From bdf9dc2e4ee7f355d73986b43183bbda560229bc Mon Sep 17 00:00:00 2001
From: securetorobert <securetorobert@protonmail.com>
Date: Mon, 3 Dec 2018 14:37:33 +0100
Subject: [PATCH 09/96] filled in Clients and Dashboard

---
 Clients.md     |  449 ++++++++++++-------
 Dashboard.md   | 1140 +++++++++++++++++++++++++++++++++++++++++-------
 Email.md       |    5 +
 clients.html   |    8 +-
 dashboard.html |    8 +-
 5 files changed, 1267 insertions(+), 343 deletions(-)

diff --git a/Clients.md b/Clients.md
index 2dd73b4..7f1afb5 100644
--- a/Clients.md
+++ b/Clients.md
@@ -1,261 +1,374 @@
-Versus API Endpoints
-=======
+# Clients
 
-This documentation lists the API endpoints required for engineers on the Versus team to interface with Versus Backend. The API endpoints are generally grouped into the following.
+This has endpoints for managing clients
 
- * Clients
- * Dashboard
- * Email Templates
- * Profanity Filter
 
-*Current version: [v0.1.0][dist]*
+## Add Comparison
 
+This adds a new brand to the comparisons that a client carry out. The fields in the payload are listed below.
 
-Getting started
----------------
+> Endpoint: versus_add_comparison
 
-Create a file based on the template, which has a bare DOM, link to the
-scripts, and a link to a theme. It will look something like this (not exact).
-For GitHub projects, simply place this file in your [GitHub pages] branch and
-you're all good to go.
+> Payload
 
-*In short: just download this file and upload it somewhere.*
+``` javascript
+{
+  "docRef": "sz4rWLgN7yt0PU3frmjX",
+  "brand": {
+    "brandName": "1st Brand",
+    "otherBrandName": "1st other brand"
+  }
+}
+```
+
+> Response
 
-The main JS and CSS files are also available in [npm] and [bower].
+``` javascript
 
-[Default theme template >][template]
+```
 
-[Blank template >][blank]
+## Add Member
 
-[bower]: http://bower.io/search/?q=flatdoc
-[npm]: https://www.npmjs.org/package/flatdoc
+This adds a new user to a client account.
 
-### Via GitHub
+> Endpoint: versus_add_member
 
-To fetch a Github Repository's readme file, use the `Flatdoc.github` fetcher.
-This will fetch the Readme file of the repository's default branch.
+> Payload
 
 ``` javascript
-Flatdoc.run({
-  fetcher: Flatdoc.github('USER/REPO')
-});
+{
+	"docRef": "sz4rWLgN7yt0PU3frmjX",
+	"member":{"email": "robert@otheremail.com", "canEdit": true}
+}
 ```
 
-You may also fetch another file other than the Readme file, just specify it as
-the 2nd parameter.
+> Response
 
 ``` javascript
-Flatdoc.run({
-  fetcher: Flatdoc.github('USER/REPO', 'Changelog.md')
-});
+
 ```
 
-After you've done this, you probably want to deploy it via [GitHub Pages].
+## Create Client
 
-[GitHub Pages guide >][GitHub Pages]
+Create a new client on the Versus platform. The response to this event causes a Welcome to Versus email to be triggered.
 
-### Via a file
+> Endpoint: versus_create_client
 
-You may also fetch a file. In this example, this fetches the file `Readme.md` in
-the same folder as the HTML file.
+> Payload
 
 ``` javascript
-Flatdoc.run({
-  fetcher: Flatdoc.file('Readme.md')
-});
+{
+  "name": "Deji Ibrahim",
+  "email": "deji.a.ibrahim@gmail.com",
+  "uniqueIdentifier": "deji"
+}
 ```
 
-You may actually supply any URL here. It will be fetched via AJAX. This is
-useful for local testing.
+> Response
 
 ``` javascript
-Flatdoc.run({
-  fetcher: Flatdoc.file('http://yoursite.com/Readme.md')
-});
+{
+  "docRef": "dZU51YTPmB2qqA030JA4"
+}
 ```
 
-How it works
-------------
+## Create Member
 
-Flatdoc is a hosted `.js` file (along with a theme and its assets) that you can
-add into any page hosted anywhere.
+This creates a user account when they accept the invite from a client.
 
-#### All client-side
+> Endpoint: versus_create_member
 
-There are no build scripts or 3rd-party services involved. Everything is done in
-the browser. Worried about performance? Oh, It's pretty fast.
+> Payload
 
-Flatdoc utilizes the [GitHub API] to fetch your project's Readme files. You may
-also configure it to fetch any arbitrary URL via AJAX.
+``` javascript
+{
+  "email": "deji@enterfive.com",
+  "docRef": "cueIYrE3PyXXJmu4tPea",
+  "firstName": "Dejiasd",
+  "lastName": "ibrahimm",
+  "password": "deji1234"
+}
+```
 
-#### Lightning-fast parsing
+> Response
 
-Next, it uses [marked], an extremely fast Markdown parser that has support for
-GitHub flavored Markdown.
+``` javascript
 
-Flatdoc then simply renders *menu* and *content* DOM elements to your HTML
-document. Flatdoc also comes with a default theme to style your page for you, or
-you may opt to create your own styles.
+```
 
-Markdown extras
----------------
+## Delete Comparison
 
-Flatdoc offers a few harmless, unobtrusive extras that come in handy in building
-documentation sites.
+Delete a brand comparison from a client account.
 
-#### Code highlighting
+> Endpoint: versus_delete_comparison
 
-You can use Markdown code fences to make syntax-highlighted text. Simply
-surround your text with three backticks. This works in GitHub as well.
-See [GitHub Syntax Highlighting][fences] for more info.
+> Payload
 
-    ``` html
-    <strong>Hola, mundo</strong>
-    ```
+``` javascript
+{
+	"clientRef": “sz4rWLgN7yt0PU3frmjX",
+	"brand": "1st Brand"
+}
+```
 
-#### Blockquotes
+> Response
 
-Blockquotes show up as side figures. This is useful for providing side
-information or non-code examples.
+``` javascript
 
-> Blockquotes are blocks that begin with `>`.
+```
 
-#### Smart quotes
+## Delete Member
 
-Single quotes, double quotes, and double-hyphens are automatically replaced to
-their typographically-accurate equivalent. This, of course, does not apply to
-`<code>` and `<pre>` blocks to leave code alone.
+Remove a user from a client account.
 
-> "From a certain point onward there is no longer any turning back. That is the
-> point that must be reached."  
-> --Franz Kafka
+> Endpoint: versus_delete_member
 
-#### Buttons
+> Payload
 
-If your link text has a `>` at the end (for instance: `Continue >`), they show
-up as buttons.
+``` javascript
+{
+	"clientRef": “sz4rWLgN7yt0PU3frmjX",
+	"email": "abc@email.com"
+}
+```
 
-> [View in GitHub >][project]
+> Response
 
-Customizing
-===========
+``` javascript
 
-Basic
------
+```
 
-### Theme options
+## Edit Client
 
-For the default theme (*theme-white*), You can set theme options by adding
-classes to the `<body>` element. The available options are:
+This edits the details on a client's account.
+
+> Endpoint: versus_edit_client
+
+> Payload
+
+``` javascript
+{
+	"docRef": "sz4rWLgN7yt0PU3frmjX",
+	"alertOptions": {
+        "criticalMentions": true, 
+        "sentimentReports": "daily"
+    },
+    "brandName": "My brand",
+  	"facebook":"fb.me/brand",
+    "filterProfanity": true,
+    "firstName": "Deji",
+    "lastName": "Ibrahim",
+    "officeAddress": "Victoria Island",
+    "organizationName": "Enterfive",
+    "otherBrandNames": "My other brand",
+    "responseEmails": "abc@e5.com, def@e5.com",
+    "topics": "Pricing, experience",
+    "twitterHandle": "twitter"
+}
+```
 
-#### big-h3
-Makes 3rd-level headings bigger.
+> Response
 
-``` html
-<body class='big-h3'>
+``` javascript
+{
+  "docRef": "dZU51YTPmB2qqA030JA4"
+}
 ```
 
-#### no-literate
-Disables "literate" mode, where code appears on the right and content text
-appear on the left.
+## Get Client
+
+Returns the details associated with a client account
+
+> Endpoint: versus_get_client
 
-``` html
-<body class='no-literate'>
+> Payload
+
+``` javascript
+{
+  "docRef": "sz4rWLgN7yt0PU3frmjX"
+}
 ```
 
-#### large-brief
-Makes the opening paragraph large.
+> Response
+
+``` javascript
 
-``` html
-<body class='large-brief'>
 ```
 
-### Adding more markup
+## Get Comparisons
 
-You have full control over the HTML file, just add markup wherever you see fit.
-As long as you leave `role='flatdoc-content'` and `role='flatdoc-menu'` empty as
-they are, you'll be fine.
+Returns the comparison brand details that the client keeps an eye on.
 
-Here are some ideas to get you started.
+> Endpoint: versus_get_comparisons
 
- * Add a CSS file to make your own CSS adjustments.
- * Add a 'Tweet' button on top.
- * Add Google Analytics.
- * Use CSS to style the IDs in menus (`#acknowledgements + p`).
+> Payload
 
-### JavaScript hooks
+``` javascript
+{
+  "docRef": "68CgvyEYhGlLcAlDFdol"
+}
+```
 
-Flatdoc emits the events `flatdoc:loading` and `flatdoc:ready` to help you make
-custom behavior when the document loads.
+> Response
 
-``` js
-$(document).on('flatdoc:ready', function() {
-  // I don't like this section to appear
-  $("#acknowledgements").remove();
-});
+``` javascript
+{
+  "comparisons": [
+    {
+      "otherBrandName": null,
+      "clientRef": "68CgvyEYhGlLcAlDFdol",
+      "brandName": "Jumia"
+    },
+    {
+      "otherBrandName": "",
+      "clientRef": "68CgvyEYhGlLcAlDFdol",
+      "brandName": "Konga"
+    }
+  ]
+}
 ```
 
-Full customization
-------------------
+## Get DocRef
 
-You don't have to be restricted to the given theme. Flatdoc is just really one
-`.js` file that expects 2 HTML elements (for *menu* and *content*). Start with
-the blank template and customize as you see fit.
+Returns the client reference associated with a logged in user.
 
-[Get blank template >][template]
+> Endpoint: versus_get_docref
 
-Misc
-====
+> Payload
 
-Inspirations
-------------
+``` javascript
+{
+  "email": "deji.a.ibrahim@gmail.com"
+}
+```
 
-The following projects have inspired Flatdoc.
+> Response
 
- * [Backbone.js] - Jeremy's projects have always adopted this "one page
- documentation" approach which I really love.
+``` javascript
+{
+  "members": [
+    {
+      "email": "deji.a.ibrahim@gmail.com",
+      "canEdit": false,
+      "clientRef": "nqaXKB0SzWN6xh7RVyzl"
+    },
+    {
+      "email": "deji.a.ibrahim@gmail.com",
+      "is_admin": true,
+      "clientRef": "nqaXKB0SzWN6xh7RVyzl"
+    },
+    {
+      "email": "deji.a.ibrahim@gmail.com",
+      "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+      "canEdit": false
+    }
+  ]
+}
+```
 
- * [Docco] - Jeremy's Docco introduced me to the world of literate programming,
- and side-by-side documentation in general.
+## Get Members
 
- * [Stripe] - Flatdoc took inspiration on the look of their API documentation.
+Returns the list of users associated with a client account.
 
- * [DocumentUp] - This service has the same idea but does a hosted readme 
- parsing approach.
+> Endpoint: versus_get_members
 
-Attributions
-------------
+> Payload
 
-[Photo](http://www.flickr.com/photos/doug88888/2953428679/) taken from Flickr,
-licensed under Creative Commons.
+``` javascript
+{
+  "docRef": "68CgvyEYhGlLcAlDFdol"
+}
+```
 
-Acknowledgements
-----------------
+> Response
 
-© 2013, 2014, Rico Sta. Cruz. Released under the [MIT 
-License](http://www.opensource.org/licenses/mit-license.php).
+``` javascript
+{
+  "members": [
+    {
+      "clientRef": "68CgvyEYhGlLcAlDFdol",
+      "email": "kemdi@enterfive.com",
+      "is_admin": true
+    },
+    {
+      "clientRef": "68CgvyEYhGlLcAlDFdol",
+      "canEdit": true,
+      "accepted": true,
+      "email": "kemdi@voteorquench.org"
+    },
+    {
+      "email": "kemdi.ebi@gmail.com",
+      "clientRef": "68CgvyEYhGlLcAlDFdol",
+      "canEdit": true
+    }
+  ]
+}
+```
 
-**Flatdoc** is authored and maintained by [Rico Sta. Cruz][rsc] with help from its 
-[contributors][c].
+## Update Client
 
- * [My website](http://ricostacruz.com) (ricostacruz.com)
- * [Github](http://github.com/rstacruz) (@rstacruz)
- * [Twitter](http://twitter.com/rstacruz) (@rstacruz)
+Complete the onboarding process for a client.
 
-[rsc]: http://ricostacruz.com
-[c]:   http://github.com/rstacruz/flatdoc/contributors
+> Endpoint: versus_update_client
 
-[GitHub API]: http://github.com/api
-[marked]: https://github.com/chjj/marked
-[Backbone.js]: http://backbonejs.org
-[dox]: https://github.com/visionmedia/dox
-[Stripe]: https://stripe.com/docs/api
-[Docco]: http://jashkenas.github.com/docco
-[GitHub pages]: https://pages.github.com
-[fences]:https://help.github.com/articles/github-flavored-markdown#syntax-highlighting
-[DocumentUp]: http://documentup.com
+> Payload
 
-[project]: https://github.com/rstacruz/flatdoc
-[template]: https://github.com/rstacruz/flatdoc/raw/gh-pages/templates/template.html
-[blank]: https://github.com/rstacruz/flatdoc/raw/gh-pages/templates/blank.html
-[dist]: https://github.com/rstacruz/flatdoc/tree/gh-pages/v/0.9.0
+``` javascript
+{
+  "docRef": "sz4rWLgN7yt0PU3frmjX",
+  "alertOptions": {
+    "criticalMentions": true,
+    "sentimentReports": "daily"
+  },
+  "brandName": "My brand",
+  "comparisonBrands": [
+    {
+      "brandName": "1st Brand",
+      "otherBrandName": "1st other brand"
+    },
+    {
+      "brandName": "2nd Brand",
+      "otherBrandName": "2nd other brand"
+    },
+    {
+      "brandName": "3rd brand",
+      "otherBrandName": "3rd other brand"
+    }
+  ],
+  "email": "deji.a.ibrahim@gmail.com",
+  "facebook": "facebook",
+  "filterProfanity": true,
+  "firstName": "Deji",
+  "lastName": "Ibrahim",
+  "officeAddress": "Victoria Island",
+  "organizationName": "Enterfive",
+  "otherBrandNames": "My other brand",
+  "password": "1234abc",
+  "responseEmails": "abc@e5.com, def@e5.com",
+  "sentimentReports": "weekly",
+  "teamMembers": [
+    {
+      "email": "robert@enterfive.com",
+      "canEdit": true
+    },
+    {
+      "email": "kemdi@enterfive.com",
+      "canEdit": true
+    },
+    {
+      "email": "anyone@enterfive.com",
+      "canEdit": false
+    }
+  ],
+  "topics": "Pricing, experience",
+  "twitterHandle": "twitter"
+}
+```
+
+> Response
+
+``` javascript
+{
+  "docRef": "dZU51YTPmB2qqA030JA4"
+}
+```
\ No newline at end of file
diff --git a/Dashboard.md b/Dashboard.md
index 2dd73b4..e7c4836 100644
--- a/Dashboard.md
+++ b/Dashboard.md
@@ -1,261 +1,1063 @@
-Versus API Endpoints
-=======
+# Dashboard
 
-This documentation lists the API endpoints required for engineers on the Versus team to interface with Versus Backend. The API endpoints are generally grouped into the following.
+Endpoints responsible for the charts and components that render on the  Versus dashboard.
 
- * Clients
- * Dashboard
- * Email Templates
- * Profanity Filter
+## All Time Detail
 
-*Current version: [v0.1.0][dist]*
+> Endpoint: versus_dashboard_all_time_detail
 
+> Payload
 
-Getting started
----------------
-
-Create a file based on the template, which has a bare DOM, link to the
-scripts, and a link to a theme. It will look something like this (not exact).
-For GitHub projects, simply place this file in your [GitHub pages] branch and
-you're all good to go.
+``` javascript
+{
+  "docRef": "68CgvyEYhGlLcAlDFdol"
+}
+```
 
-*In short: just download this file and upload it somewhere.*
+> Response
 
-The main JS and CSS files are also available in [npm] and [bower].
+``` javascript
+{
+  "socialMedia": [
+    {
+      "type": "bar",
+      "x": [
+        19,
+        12,
+        35
+      ],
+      "y": [
+        "Twitter",
+        "Facebook",
+        "Telegram"
+      ],
+      "orientation": "h"
+    }
+  ],
+  "news": [
+    {
+      "type": "bar",
+      "x": [
+        3,
+        5,
+        1,
+        2
+      ],
+      "y": [
+        "CNN",
+        "Business Times",
+        "Time Magazine",
+        "Fortune"
+      ],
+      "orientation": "h"
+    }
+  ],
+  "other": [
+    {
+      "type": "bar",
+      "x": [
+        200,
+        50,
+        35
+      ],
+      "y": [
+        "Nairaland",
+        "Y Naija",
+        "Guardian Newspapers"
+      ],
+      "orientation": "h"
+    }
+  ]
+}
+```
 
-[Default theme template >][template]
+## All Time Summary
 
-[Blank template >][blank]
+> Endpoint: versus_dashboard_all_time_summary
 
-[bower]: http://bower.io/search/?q=flatdoc
-[npm]: https://www.npmjs.org/package/flatdoc
+> Payload
 
-### Via GitHub
+``` javascript
+{
+  "docRef": "68CgvyEYhGlLcAlDFdol"
+}
+```
 
-To fetch a Github Repository's readme file, use the `Flatdoc.github` fetcher.
-This will fetch the Readme file of the repository's default branch.
+> Response
 
 ``` javascript
-Flatdoc.run({
-  fetcher: Flatdoc.github('USER/REPO')
-});
+{
+  "data": [
+    {
+      "type": "bar",
+      "x": [
+        5,
+        2,
+        1
+      ],
+      "y": [
+        "Social Media",
+        "News",
+        "Other"
+      ],
+      "orientation": "h"
+    }
+  ],
+  "total": 8
+}
 ```
 
-You may also fetch another file other than the Readme file, just specify it as
-the 2nd parameter.
+## Channel Sentiments
+
+> Endpoint: versus_dashboard_channel_sentiments
+
+> Payload
 
 ``` javascript
-Flatdoc.run({
-  fetcher: Flatdoc.github('USER/REPO', 'Changelog.md')
-});
+{
+  "docRef": "68CgvyEYhGlLcAlDFdol"
+}
 ```
 
-After you've done this, you probably want to deploy it via [GitHub Pages].
+> Response
+
+``` javascript
+[
+  {
+    "x": [
+      14,
+      23,
+      11
+    ],
+    "y": [
+      "Social Media",
+      "News",
+      "Other"
+    ],
+    "name": "Positive",
+    "type": "bar",
+    "orientation": "h"
+  },
+  {
+    "x": [
+      0,
+      0,
+      0
+    ],
+    "y": [
+      "Social Media",
+      "News",
+      "Other"
+    ],
+    "name": "neutral",
+    "type": "bar",
+    "orientation": "h"
+  },
+  {
+    "x": [
+      18,
+      29,
+      25
+    ],
+    "y": [
+      "Social Media",
+      "News",
+      "Other"
+    ],
+    "name": "Negative",
+    "type": "bar",
+    "orientation": "h"
+  }
+]
+```
 
-[GitHub Pages guide >][GitHub Pages]
+## Month Detail
 
-### Via a file
+> Endpoint: versus_dashboard_month_detail
 
-You may also fetch a file. In this example, this fetches the file `Readme.md` in
-the same folder as the HTML file.
+> Payload
 
 ``` javascript
-Flatdoc.run({
-  fetcher: Flatdoc.file('Readme.md')
-});
+{
+  "docRef": "68CgvyEYhGlLcAlDFdol"
+}
 ```
 
-You may actually supply any URL here. It will be fetched via AJAX. This is
-useful for local testing.
+> Response
 
 ``` javascript
-Flatdoc.run({
-  fetcher: Flatdoc.file('http://yoursite.com/Readme.md')
-});
+{
+  "socialMedia": [
+    {
+      "type": "bar",
+      "x": [
+        19,
+        12,
+        35
+      ],
+      "y": [
+        "Twitter",
+        "Facebook",
+        "Telegram"
+      ],
+      "orientation": "h"
+    }
+  ],
+  "news": [
+    {
+      "type": "bar",
+      "x": [
+        3,
+        5,
+        1,
+        2
+      ],
+      "y": [
+        "CNN",
+        "Business Times",
+        "Time Magazine",
+        "Fortune"
+      ],
+      "orientation": "h"
+    }
+  ],
+  "other": [
+    {
+      "type": "bar",
+      "x": [
+        200,
+        50,
+        35
+      ],
+      "y": [
+        "Nairaland",
+        "Y Naija",
+        "Guardian Newspapers"
+      ],
+      "orientation": "h"
+    }
+  ]
+}
 ```
 
-How it works
-------------
+## Month Sentiments
 
-Flatdoc is a hosted `.js` file (along with a theme and its assets) that you can
-add into any page hosted anywhere.
+> Endpoint: versus_dashboard_month_sentiments
 
-#### All client-side
+> Payload
 
-There are no build scripts or 3rd-party services involved. Everything is done in
-the browser. Worried about performance? Oh, It's pretty fast.
+``` javascript
+{
+  "docRef": "68CgvyEYhGlLcAlDFdol"
+}
+```
 
-Flatdoc utilizes the [GitHub API] to fetch your project's Readme files. You may
-also configure it to fetch any arbitrary URL via AJAX.
+> Response
 
-#### Lightning-fast parsing
+``` javascript
+[
+  {
+    "x": [
+      "Sep 30",
+      "Oct 01",
+      "Oct 02",
+      "Oct 03",
+      "Oct 04",
+      "Oct 05",
+      "Oct 06",
+      "Oct 07",
+      "Oct 08",
+      "Oct 09",
+      "Oct 10",
+      "Oct 11",
+      "Oct 12",
+      "Oct 13",
+      "Oct 14",
+      "Oct 15",
+      "Oct 16",
+      "Oct 17",
+      "Oct 18",
+      "Oct 19",
+      "Oct 20",
+      "Oct 21",
+      "Oct 22",
+      "Oct 23",
+      "Oct 24",
+      "Oct 25",
+      "Oct 26",
+      "Oct 27",
+      "Oct 28",
+      "Oct 29"
+    ],
+    "y": [
+      1111,
+      688,
+      4000,
+      1105,
+      599,
+      3200,
+      2195,
+      1900,
+      2650,
+      3718,
+      613,
+      552,
+      323,
+      1466,
+      1577,
+      1777,
+      955,
+      2131,
+      1262,
+      3280,
+      1229,
+      2324,
+      1625,
+      1886,
+      2785,
+      3191,
+      2334,
+      1255,
+      3666,
+      918
+    ],
+    "mode": "lines",
+    "line": {
+      "shape": "spline"
+    },
+    "name": "Social Media"
+  },
+  {
+    "x": [
+      "Sep 30",
+      "Oct 01",
+      "Oct 02",
+      "Oct 03",
+      "Oct 04",
+      "Oct 05",
+      "Oct 06",
+      "Oct 07",
+      "Oct 08",
+      "Oct 09",
+      "Oct 10",
+      "Oct 11",
+      "Oct 12",
+      "Oct 13",
+      "Oct 14",
+      "Oct 15",
+      "Oct 16",
+      "Oct 17",
+      "Oct 18",
+      "Oct 19",
+      "Oct 20",
+      "Oct 21",
+      "Oct 22",
+      "Oct 23",
+      "Oct 24",
+      "Oct 25",
+      "Oct 26",
+      "Oct 27",
+      "Oct 28",
+      "Oct 29"
+    ],
+    "y": [
+      11,
+      6,
+      15,
+      20,
+      22,
+      24,
+      25,
+      6,
+      5,
+      11,
+      9,
+      20,
+      18,
+      13,
+      2,
+      3,
+      4,
+      5,
+      7,
+      9,
+      11,
+      22,
+      24,
+      25,
+      6,
+      5,
+      11,
+      9,
+      20,
+      18
+    ],
+    "mode": "lines",
+    "line": {
+      "shape": "spline"
+    },
+    "name": "News"
+  },
+  {
+    "x": [
+      "Sep 30",
+      "Oct 01",
+      "Oct 02",
+      "Oct 03",
+      "Oct 04",
+      "Oct 05",
+      "Oct 06",
+      "Oct 07",
+      "Oct 08",
+      "Oct 09",
+      "Oct 10",
+      "Oct 11",
+      "Oct 12",
+      "Oct 13",
+      "Oct 14",
+      "Oct 15",
+      "Oct 16",
+      "Oct 17",
+      "Oct 18",
+      "Oct 19",
+      "Oct 20",
+      "Oct 21",
+      "Oct 22",
+      "Oct 23",
+      "Oct 24",
+      "Oct 25",
+      "Oct 26",
+      "Oct 27",
+      "Oct 28",
+      "Oct 29"
+    ],
+    "y": [
+      111,
+      68,
+      566,
+      110,
+      99,
+      200,
+      195,
+      900,
+      250,
+      718,
+      613,
+      552,
+      323,
+      466,
+      577,
+      777,
+      955,
+      131,
+      262,
+      280,
+      229,
+      2324,
+      625,
+      886,
+      785,
+      191,
+      2334,
+      255,
+      666,
+      918
+    ],
+    "mode": "lines",
+    "line": {
+      "shape": "spline"
+    },
+    "name": "Others"
+  }
+]
+```
 
-Next, it uses [marked], an extremely fast Markdown parser that has support for
-GitHub flavored Markdown.
+## Month Summary
 
-Flatdoc then simply renders *menu* and *content* DOM elements to your HTML
-document. Flatdoc also comes with a default theme to style your page for you, or
-you may opt to create your own styles.
+> Endpoint: versus_dashboard_month_summary
 
-Markdown extras
----------------
+> Payload
 
-Flatdoc offers a few harmless, unobtrusive extras that come in handy in building
-documentation sites.
+``` javascript
+{
+  "docRef": "68CgvyEYhGlLcAlDFdol"
+}
+```
 
-#### Code highlighting
+> Response
 
-You can use Markdown code fences to make syntax-highlighted text. Simply
-surround your text with three backticks. This works in GitHub as well.
-See [GitHub Syntax Highlighting][fences] for more info.
+``` javascript
+{
+  "data": [
+    {
+      "type": "bar",
+      "x": [
+        5,
+        2,
+        1
+      ],
+      "y": [
+        "Social Media",
+        "News",
+        "Other"
+      ],
+      "orientation": "h"
+    }
+  ],
+  "total": 8
+}
+```
 
-    ``` html
-    <strong>Hola, mundo</strong>
-    ```
+## News Mentions
 
-#### Blockquotes
+> Endpoint: versus_dashboard_news_mentions
 
-Blockquotes show up as side figures. This is useful for providing side
-information or non-code examples.
+> Payload
 
-> Blockquotes are blocks that begin with `>`.
+``` javascript
+{
+  "docRef": "68CgvyEYhGlLcAlDFdol"
+}
+```
 
-#### Smart quotes
+> Response
 
-Single quotes, double quotes, and double-hyphens are automatically replaced to
-their typographically-accurate equivalent. This, of course, does not apply to
-`<code>` and `<pre>` blocks to leave code alone.
+``` javascript
+{
+  "mentions": 14,
+  "data": [
+    {
+      "sentiment": -1,
+      "outlet": "Guardian",
+      "views": 890,
+      "title": "Lorem dolor ipsum",
+      "content": "Mauris lobortis eleifend tempor. Etiam et imperdiet sem. Aliquam eu mattis purus. Vivamus et molestie nunc, ultricies viverra justo. Praesent lacinia in quam sit amet blandit. Vestibulum placerat, enim at cursus dignissim, nisl risus ultricies dolor, condimentum finibus justo dolor at purus. Aenean in fringilla dolor, vitae hendrerit lectus. Etiam gravida dolor eu auctor faucibus. Nulla eu orci laoreet sapien vulputate semper non a nunc. Nam condimentum lorem mattis tellus efficitur vulputate. Aliquam erat volutpat. Vivamus ac elit eu nibh gravida egestas. Curabitur sed ligula arcu. Aliquam hendrerit enim id elementum faucibus. Duis placerat at sapien eget tincidunt.",
+      "url": "http://www.guardian.com"
+    },
+    {
+      "sentiment": 1,
+      "outlet": "Time Magazine",
+      "views": 221,
+      "title": "Sit amet dolor",
+      "content": "Nullam faucibus luctus ultricies. Cras ac faucibus arcu. Donec varius facilisis nisi. Quisque posuere libero nec consectetur ornare. Cras ullamcorper euismod tellus, posuere pharetra est blandit eu. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Aenean justo lacus, maximus nec egestas vel, semper sit amet neque. Aenean efficitur tincidunt arcu, vel tincidunt nibh sodales id. Suspendisse potenti. Phasellus sagittis consectetur placerat. Vestibulum nec tempor est.",
+      "url": "http://www.time.com"
+    },
+    {
+      "sentiment": 1,
+      "platform": "Newsweek",
+      "views": 832,
+      "title": "ut orci vel finibus",
+      "content": "Nullam venenatis ut orci vel finibus. Phasellus efficitur dui risus, at ultricies augue semper et. Donec sed rutrum massa, a dignissim urna. Nulla viverra, sapien et blandit laoreet, urna diam aliquam velit, vel interdum nisl libero a odio. Donec ut interdum risus. Vestibulum tempus elit eget urna pretium tincidunt. Integer at convallis ipsum.",
+      "url": "http://www.newsweek.com"
+    },
+    {
+      "sentiment": -1,
+      "platform": "Time Magazine",
+      "views": 930,
+      "title": "In efficitur erat",
+      "content": "In efficitur erat egestas magna finibus, nec lacinia velit sollicitudin. Phasellus id mattis dolor, in hendrerit elit. Phasellus at tortor placerat, maximus elit sit amet, sodales velit. Mauris ligula leo, posuere eu risus ut, hendrerit consequat sapien. Mauris convallis tortor ut est porta sagittis. Mauris sed mi purus. Nulla in fermentum massa, nec vestibulum eros.",
+      "url": "http://www.time.com"
+    },
+    {
+      "sentiment": 1,
+      "platform": "Time Magazine",
+      "views": 384,
+      "title": "Duis molestie dignissim mauris",
+      "content": "Nam a est mi. Duis molestie dignissim mauris, in scelerisque quam eleifend at. Fusce consequat, quam et tincidunt tincidunt, tellus leo consectetur diam, gravida vestibulum orci nisl vel nulla. Etiam ac elit dignissim ex accumsan bibendum et eu lorem. Ut in vulputate sem, vel finibus nulla. Suspendisse semper sit amet sem id tempus. Praesent vulputate mattis nisi, ut interdum nulla suscipit eu. Suspendisse potenti.",
+      "url": "http://www.time.com"
+    }
+  ]
+}
+```
 
-> "From a certain point onward there is no longer any turning back. That is the
-> point that must be reached."  
-> --Franz Kafka
+## Other Mentions
 
-#### Buttons
+> Endpoint: versus_dashboard_other_mentions
 
-If your link text has a `>` at the end (for instance: `Continue >`), they show
-up as buttons.
+> Payload
 
-> [View in GitHub >][project]
+``` javascript
+{
+  "docRef": "68CgvyEYhGlLcAlDFdol"
+}
+```
 
-Customizing
-===========
+> Response
 
-Basic
------
+``` javascript
+{
+  "mentions": 14,
+  "data": [
+    {
+      "sentiment": -1,
+      "outlet": "Punch",
+      "views": 890,
+      "title": "Lorem dolor ipsum",
+      "content": "Mauris lobortis eleifend tempor. Etiam et imperdiet sem. Aliquam eu mattis purus. Vivamus et molestie nunc, ultricies viverra justo. Praesent lacinia in quam sit amet blandit. Vestibulum placerat, enim at cursus dignissim, nisl risus ultricies dolor, condimentum finibus justo dolor at purus. Aenean in fringilla dolor, vitae hendrerit lectus. Etiam gravida dolor eu auctor faucibus. Nulla eu orci laoreet sapien vulputate semper non a nunc. Nam condimentum lorem mattis tellus efficitur vulputate. Aliquam erat volutpat. Vivamus ac elit eu nibh gravida egestas. Curabitur sed ligula arcu. Aliquam hendrerit enim id elementum faucibus. Duis placerat at sapien eget tincidunt.",
+      "url": "http://www.punch.com"
+    },
+    {
+      "sentiment": 1,
+      "outlet": "Yello Magazine",
+      "views": 221,
+      "title": "Sit amet dolor",
+      "content": "Nullam faucibus luctus ultricies. Cras ac faucibus arcu. Donec varius facilisis nisi. Quisque posuere libero nec consectetur ornare. Cras ullamcorper euismod tellus, posuere pharetra est blandit eu. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Aenean justo lacus, maximus nec egestas vel, semper sit amet neque. Aenean efficitur tincidunt arcu, vel tincidunt nibh sodales id. Suspendisse potenti. Phasellus sagittis consectetur placerat. Vestibulum nec tempor est.",
+      "url": "http://www.yello.com"
+    },
+    {
+      "sentiment": 1,
+      "platform": "Naija",
+      "views": 832,
+      "title": "ut orci vel finibus",
+      "content": "Nullam venenatis ut orci vel finibus. Phasellus efficitur dui risus, at ultricies augue semper et. Donec sed rutrum massa, a dignissim urna. Nulla viverra, sapien et blandit laoreet, urna diam aliquam velit, vel interdum nisl libero a odio. Donec ut interdum risus. Vestibulum tempus elit eget urna pretium tincidunt. Integer at convallis ipsum.",
+      "url": "http://www.naija.com"
+    },
+    {
+      "sentiment": -1,
+      "platform": "Other Magazine",
+      "views": 930,
+      "title": "In efficitur erat",
+      "content": "In efficitur erat egestas magna finibus, nec lacinia velit sollicitudin. Phasellus id mattis dolor, in hendrerit elit. Phasellus at tortor placerat, maximus elit sit amet, sodales velit. Mauris ligula leo, posuere eu risus ut, hendrerit consequat sapien. Mauris convallis tortor ut est porta sagittis. Mauris sed mi purus. Nulla in fermentum massa, nec vestibulum eros.",
+      "url": "http://www.other.com"
+    },
+    {
+      "sentiment": 1,
+      "platform": "Other Magazine",
+      "views": 384,
+      "title": "Duis molestie dignissim mauris",
+      "content": "Nam a est mi. Duis molestie dignissim mauris, in scelerisque quam eleifend at. Fusce consequat, quam et tincidunt tincidunt, tellus leo consectetur diam, gravida vestibulum orci nisl vel nulla. Etiam ac elit dignissim ex accumsan bibendum et eu lorem. Ut in vulputate sem, vel finibus nulla. Suspendisse semper sit amet sem id tempus. Praesent vulputate mattis nisi, ut interdum nulla suscipit eu. Suspendisse potenti.",
+      "url": "http://www.other.com"
+    }
+  ]
+}
+```
 
-### Theme options
+## Social Mentions
 
-For the default theme (*theme-white*), You can set theme options by adding
-classes to the `<body>` element. The available options are:
+> Endpoint: versus_dashboard_social_mentions
 
-#### big-h3
-Makes 3rd-level headings bigger.
+> Payload
 
-``` html
-<body class='big-h3'>
+``` javascript
+{
+  "docRef": "68CgvyEYhGlLcAlDFdol"
+}
 ```
 
-#### no-literate
-Disables "literate" mode, where code appears on the right and content text
-appear on the left.
+> Response
 
-``` html
-<body class='no-literate'>
+``` javascript
+{
+  "mentions": 25,
+  "data": [
+    {
+      "sentiment": -1,
+      "content": "Mauris lobortis eleifend tempor. Etiam et imperdiet sem. Aliquam eu mattis purus. Vivamus et molestie nunc, ultricies viverra justo. Praesent lacinia in quam sit amet blandit. Vestibulum placerat, enim at cursus dignissim, nisl risus ultricies dolor, condimentum finibus justo dolor at purus. Aenean in fringilla dolor, vitae hendrerit lectus. Etiam gravida dolor eu auctor faucibus. Nulla eu orci laoreet sapien vulputate semper non a nunc. Nam condimentum lorem mattis tellus efficitur vulputate. Aliquam erat volutpat. Vivamus ac elit eu nibh gravida egestas. Curabitur sed ligula arcu. Aliquam hendrerit enim id elementum faucibus. Duis placerat at sapien eget tincidunt.",
+      "url": "http://www.fb.me/asdf",
+      "platform": "facebook",
+      "handle": "asdf",
+      "followers": 890
+    },
+    {
+      "sentiment": 1,
+      "content": "Nullam faucibus luctus ultricies. Cras ac faucibus arcu. Donec varius facilisis nisi. Quisque posuere libero nec consectetur ornare. Cras ullamcorper euismod tellus, posuere pharetra est blandit eu. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Aenean justo lacus, maximus nec egestas vel, semper sit amet neque. Aenean efficitur tincidunt arcu, vel tincidunt nibh sodales id. Suspendisse potenti. Phasellus sagittis consectetur placerat. Vestibulum nec tempor est.",
+      "url": "http://www.twitter.com",
+      "platform": "twitter",
+      "handle": "@ien",
+      "followers": 221
+    },
+    {
+      "sentiment": 1,
+      "platform": "twitter",
+      "content": "Nullam venenatis ut orci vel finibus. Phasellus efficitur dui risus, at ultricies augue semper et. Donec sed rutrum massa, a dignissim urna. Nulla viverra, sapien et blandit laoreet, urna diam aliquam velit, vel interdum nisl libero a odio. Donec ut interdum risus. Vestibulum tempus elit eget urna pretium tincidunt. Integer at convallis ipsum.",
+      "url": "http://www.twitter.com",
+      "handle": "@doe",
+      "followers": 832
+    },
+    {
+      "sentiment": -1,
+      "platform": "twitter",
+      "content": "In efficitur erat egestas magna finibus, nec lacinia velit sollicitudin. Phasellus id mattis dolor, in hendrerit elit. Phasellus at tortor placerat, maximus elit sit amet, sodales velit. Mauris ligula leo, posuere eu risus ut, hendrerit consequat sapien. Mauris convallis tortor ut est porta sagittis. Mauris sed mi purus. Nulla in fermentum massa, nec vestibulum eros.",
+      "url": "http://www.twitter.com",
+      "handle": "@eod_",
+      "followers": 930
+    },
+    {
+      "sentiment": 1,
+      "platform": "facebook",
+      "content": "Nam a est mi. Duis molestie dignissim mauris, in scelerisque quam eleifend at. Fusce consequat, quam et tincidunt tincidunt, tellus leo consectetur diam, gravida vestibulum orci nisl vel nulla. Etiam ac elit dignissim ex accumsan bibendum et eu lorem. Ut in vulputate sem, vel finibus nulla. Suspendisse semper sit amet sem id tempus. Praesent vulputate mattis nisi, ut interdum nulla suscipit eu. Suspendisse potenti.",
+      "url": "http://www.fb.me/_ee__",
+      "handle": "_ee__",
+      "followers": 384
+    }
+  ]
+}
 ```
 
-#### large-brief
-Makes the opening paragraph large.
+## Today Detail
 
-``` html
-<body class='large-brief'>
+> Endpoint: versus_dashboard_today_detail
+
+> Payload
+
+``` javascript
+{
+  "docRef": "68CgvyEYhGlLcAlDFdol"
+}
 ```
 
-### Adding more markup
+> Response
+
+``` javascript
+{
+  "socialMedia": [
+    {
+      "type": "bar",
+      "x": [
+        19,
+        12,
+        35
+      ],
+      "y": [
+        "Twitter",
+        "Facebook",
+        "Telegram"
+      ],
+      "orientation": "h"
+    }
+  ],
+  "news": [
+    {
+      "type": "bar",
+      "x": [
+        3,
+        5,
+        1,
+        2
+      ],
+      "y": [
+        "CNN",
+        "Business Times",
+        "Time Magazine",
+        "Fortune"
+      ],
+      "orientation": "h"
+    }
+  ],
+  "other": [
+    {
+      "type": "bar",
+      "x": [
+        200,
+        50,
+        35
+      ],
+      "y": [
+        "Nairaland",
+        "Y Naija",
+        "Guardian Newspapers"
+      ],
+      "orientation": "h"
+    }
+  ]
+}
+```
 
-You have full control over the HTML file, just add markup wherever you see fit.
-As long as you leave `role='flatdoc-content'` and `role='flatdoc-menu'` empty as
-they are, you'll be fine.
+## Today Summary
 
-Here are some ideas to get you started.
+> Endpoint: versus_dashboard_today_summary
 
- * Add a CSS file to make your own CSS adjustments.
- * Add a 'Tweet' button on top.
- * Add Google Analytics.
- * Use CSS to style the IDs in menus (`#acknowledgements + p`).
+> Payload
 
-### JavaScript hooks
+``` javascript
+{
+  "docRef": "68CgvyEYhGlLcAlDFdol"
+}
+```
 
-Flatdoc emits the events `flatdoc:loading` and `flatdoc:ready` to help you make
-custom behavior when the document loads.
+> Response
 
-``` js
-$(document).on('flatdoc:ready', function() {
-  // I don't like this section to appear
-  $("#acknowledgements").remove();
-});
+``` javascript
+{
+  "data": [
+    {
+      "type": "bar",
+      "x": [
+        5,
+        2,
+        1
+      ],
+      "y": [
+        "Social Media",
+        "News",
+        "Other"
+      ],
+      "orientation": "h"
+    }
+  ],
+  "total": 8
+}
 ```
 
-Full customization
-------------------
+## Topic Sentiments
 
-You don't have to be restricted to the given theme. Flatdoc is just really one
-`.js` file that expects 2 HTML elements (for *menu* and *content*). Start with
-the blank template and customize as you see fit.
+> Endpoint: versus_dashboard_topic_sentiments
 
-[Get blank template >][template]
+> Payload
 
-Misc
-====
+``` javascript
+{
+  "docRef": "68CgvyEYhGlLcAlDFdol"
+}
+```
 
-Inspirations
-------------
+> Response
 
-The following projects have inspired Flatdoc.
+``` javascript
+[
+  {
+    "x": [
+      14,
+      23,
+      11
+    ],
+    "y": [
+      "Social Media",
+      "News",
+      "Other"
+    ],
+    "name": "Positive",
+    "type": "bar",
+    "orientation": "h"
+  },
+  {
+    "x": [
+      0,
+      0,
+      0
+    ],
+    "y": [
+      "Social Media",
+      "News",
+      "Other"
+    ],
+    "name": "neutral",
+    "type": "bar",
+    "orientation": "h"
+  },
+  {
+    "x": [
+      18,
+      29,
+      25
+    ],
+    "y": [
+      "Social Media",
+      "News",
+      "Other"
+    ],
+    "name": "Negative",
+    "type": "bar",
+    "orientation": "h"
+  }
+]
+```
 
- * [Backbone.js] - Jeremy's projects have always adopted this "one page
- documentation" approach which I really love.
+## Week Detail
 
- * [Docco] - Jeremy's Docco introduced me to the world of literate programming,
- and side-by-side documentation in general.
+> Endpoint: versus_dashboard_week_detail
 
- * [Stripe] - Flatdoc took inspiration on the look of their API documentation.
+> Payload
 
- * [DocumentUp] - This service has the same idea but does a hosted readme 
- parsing approach.
+``` javascript
+{
+  "docRef": "68CgvyEYhGlLcAlDFdol"
+}
+```
 
-Attributions
-------------
+> Response
 
-[Photo](http://www.flickr.com/photos/doug88888/2953428679/) taken from Flickr,
-licensed under Creative Commons.
+``` javascript
+{
+  "socialMedia": [
+    {
+      "type": "bar",
+      "x": [
+        19,
+        12,
+        35
+      ],
+      "y": [
+        "Twitter",
+        "Facebook",
+        "Telegram"
+      ],
+      "orientation": "h"
+    }
+  ],
+  "news": [
+    {
+      "type": "bar",
+      "x": [
+        3,
+        5,
+        1,
+        2
+      ],
+      "y": [
+        "CNN",
+        "Business Times",
+        "Time Magazine",
+        "Fortune"
+      ],
+      "orientation": "h"
+    }
+  ],
+  "other": [
+    {
+      "type": "bar",
+      "x": [
+        200,
+        50,
+        35
+      ],
+      "y": [
+        "Nairaland",
+        "Y Naija",
+        "Guardian Newspapers"
+      ],
+      "orientation": "h"
+    }
+  ]
+}
+```
+
+## Week Sentiments
+
+> Endpoint: versus_dashboard_week_sentiments
+
+> Payload
+
+``` javascript
+{
+  "docRef": "68CgvyEYhGlLcAlDFdol"
+}
+```
 
-Acknowledgements
-----------------
+> Response
 
-© 2013, 2014, Rico Sta. Cruz. Released under the [MIT 
-License](http://www.opensource.org/licenses/mit-license.php).
+``` javascript
+[
+  {
+    "x": [
+      "Monday",
+      "Tuesday",
+      "Wednesday",
+      "Thursday",
+      "Friday",
+      "Saturday",
+      "Sunday"
+    ],
+    "y": [
+      11,
+      6,
+      15,
+      20,
+      22,
+      24,
+      25
+    ],
+    "mode": "lines",
+    "line": {
+      "shape": "spline"
+    },
+    "name": "Social Media"
+  },
+  {
+    "x": [
+      "Monday",
+      "Tuesday",
+      "Wednesday",
+      "Thursday",
+      "Friday",
+      "Saturday",
+      "Sunday"
+    ],
+    "y": [
+      16,
+      5,
+      11,
+      9,
+      20,
+      18,
+      13
+    ],
+    "mode": "lines",
+    "line": {
+      "shape": "spline"
+    },
+    "name": "News"
+  },
+  {
+    "x": [
+      "Monday",
+      "Tuesday",
+      "Wednesday",
+      "Thursday",
+      "Friday",
+      "Saturday",
+      "Sunday"
+    ],
+    "y": [
+      2,
+      3,
+      4,
+      5,
+      7,
+      9,
+      11
+    ],
+    "mode": "lines",
+    "line": {
+      "shape": "spline"
+    },
+    "name": "Others"
+  }
+]
+```
 
-**Flatdoc** is authored and maintained by [Rico Sta. Cruz][rsc] with help from its 
-[contributors][c].
+## Week Summary
 
- * [My website](http://ricostacruz.com) (ricostacruz.com)
- * [Github](http://github.com/rstacruz) (@rstacruz)
- * [Twitter](http://twitter.com/rstacruz) (@rstacruz)
+> Endpoint: versus_dashboard_week_summary
 
-[rsc]: http://ricostacruz.com
-[c]:   http://github.com/rstacruz/flatdoc/contributors
+> Payload
 
-[GitHub API]: http://github.com/api
-[marked]: https://github.com/chjj/marked
-[Backbone.js]: http://backbonejs.org
-[dox]: https://github.com/visionmedia/dox
-[Stripe]: https://stripe.com/docs/api
-[Docco]: http://jashkenas.github.com/docco
-[GitHub pages]: https://pages.github.com
-[fences]:https://help.github.com/articles/github-flavored-markdown#syntax-highlighting
-[DocumentUp]: http://documentup.com
+``` javascript
+{
+  "docRef": "68CgvyEYhGlLcAlDFdol"
+}
+```
+
+> Response
 
-[project]: https://github.com/rstacruz/flatdoc
-[template]: https://github.com/rstacruz/flatdoc/raw/gh-pages/templates/template.html
-[blank]: https://github.com/rstacruz/flatdoc/raw/gh-pages/templates/blank.html
-[dist]: https://github.com/rstacruz/flatdoc/tree/gh-pages/v/0.9.0
+``` javascript
+{
+  "data": [
+    {
+      "type": "bar",
+      "x": [
+        5,
+        2,
+        1
+      ],
+      "y": [
+        "Social Media",
+        "News",
+        "Other"
+      ],
+      "orientation": "h"
+    }
+  ],
+  "total": 8
+}
+```
\ No newline at end of file
diff --git a/Email.md b/Email.md
index f0e616a..88853e7 100644
--- a/Email.md
+++ b/Email.md
@@ -177,6 +177,11 @@ Notify a recipient to respond to a social media post. The payload has the follow
 ## Welcome to Versus: 
 Notify the recipient that their Versus Sentiment account has been created. The payload has the following fields.
 
+| Field      | Type   | Description                            |
+|------------|--------|----------------------------------------|
+| recipient  | string | the email address of the recipient     |
+| inviteLink | string | the URL from which to begin onboarding |
+
 > Endpoint: email_welcome_to_versus
 
 > Payload
diff --git a/clients.html b/clients.html
index a9b8523..9d59277 100644
--- a/clients.html
+++ b/clients.html
@@ -20,7 +20,7 @@
   <!-- Initializer -->
   <script>
     Flatdoc.run({
-      fetcher: Flatdoc.file('Reference.md')
+      fetcher: Flatdoc.file('Clients.md')
     });
   </script>
 </head>
@@ -30,8 +30,10 @@
     <div class='left'>
       <h1><a href='.'>Flatdoc</a></h1>
       <ul>
-        <li><a href='https://github.com/rstacruz/flatdoc'>View on Github</a></li>
-        <li><a href='https://github.com/rstacruz/flatdoc/issues'>Issues</a></li>
+        <li><a href='clients.html'>Clients</a></li>
+        <li><a href='dashboard.html'>Dashboard</a></li>
+        <li><a href='email.html'>Email Templates</a></li>
+        <li><a href='profanity.html'>Profanity Filter</a></li>
         <li><a href='reference.html'>API reference</a></li>
       </ul>
     </div>
diff --git a/dashboard.html b/dashboard.html
index a9b8523..00adb2f 100644
--- a/dashboard.html
+++ b/dashboard.html
@@ -20,7 +20,7 @@
   <!-- Initializer -->
   <script>
     Flatdoc.run({
-      fetcher: Flatdoc.file('Reference.md')
+      fetcher: Flatdoc.file('Dashboard.md')
     });
   </script>
 </head>
@@ -30,8 +30,10 @@
     <div class='left'>
       <h1><a href='.'>Flatdoc</a></h1>
       <ul>
-        <li><a href='https://github.com/rstacruz/flatdoc'>View on Github</a></li>
-        <li><a href='https://github.com/rstacruz/flatdoc/issues'>Issues</a></li>
+        <li><a href='clients.html'>Clients</a></li>
+        <li><a href='dashboard.html'>Dashboard</a></li>
+        <li><a href='email.html'>Email Templates</a></li>
+        <li><a href='profanity.html'>Profanity Filter</a></li>
         <li><a href='reference.html'>API reference</a></li>
       </ul>
     </div>

From 136df1c89720134c246471ccd933e61564ffdca9 Mon Sep 17 00:00:00 2001
From: securetorobert <securetorobert@protonmail.com>
Date: Fri, 14 Dec 2018 22:39:16 +0100
Subject: [PATCH 10/96] modified index

---
 Readme.md | 41 ++++++++++++++++++++++++++++++++---------
 1 file changed, 32 insertions(+), 9 deletions(-)

diff --git a/Readme.md b/Readme.md
index 6e2147a..751f478 100644
--- a/Readme.md
+++ b/Readme.md
@@ -2,21 +2,44 @@
 
 This documentation lists the API endpoints required for engineers on the Versus team to interface with Versus Backend. The API endpoints are generally grouped into the following.
 
- * Clients
- * Dashboard
- * Email Templates
- * Profanity Filter
+1. Clients
+
+2. Dashboard
+
+3. Email Templates
+
+4. Profanity Filter
 
 *Current version: [v0.1.0][dist]*
 
 
 # Clients
 
-This has functions for managing clients
- * Create Client: create a new Versus Sentiment Client
- * Get Client: get details about a Versus Sentiment Client
- * Update Client: onboard a Versus Sentiment Client
- * Create Member: register someone who was added to the list of team members
+This has functions for managing clients.
+
+1. Add Comparison
+
+2. Add Member
+
+3. Create Client
+
+4. Create Member
+
+5. Delete Comparison
+
+6. Delete Member
+
+7. Edit Client
+
+8. Get Client
+
+9. Get Comparisons
+
+10. Get DocRef
+
+11. Get Members
+
+12. Update Client
 
 # Dasboard
 

From b88eea4dee867e0ed39732d624f949839597c1dd Mon Sep 17 00:00:00 2001
From: securetorobert <securetorobert@protonmail.com>
Date: Mon, 31 Dec 2018 22:59:51 +0100
Subject: [PATCH 11/96] making updates to Readme

---
 Readme.md | 20 +++++++++++++-------
 1 file changed, 13 insertions(+), 7 deletions(-)

diff --git a/Readme.md b/Readme.md
index 751f478..b347ea3 100644
--- a/Readme.md
+++ b/Readme.md
@@ -2,13 +2,15 @@
 
 This documentation lists the API endpoints required for engineers on the Versus team to interface with Versus Backend. The API endpoints are generally grouped into the following.
 
-1. Clients
+* Clients
 
-2. Dashboard
+* Dashboard
 
-3. Email Templates
+* Email Templates
 
-4. Profanity Filter
+* Profanity Filter
+
+* Scouts
 
 *Current version: [v0.1.0][dist]*
 
@@ -17,9 +19,13 @@ This documentation lists the API endpoints required for engineers on the Versus
 
 This has functions for managing clients.
 
-1. Add Comparison
+* Add Campaign
+
+* Add Comparison
+
+* Add Member
 
-2. Add Member
+* Add Question
 
 3. Create Client
 
@@ -41,7 +47,7 @@ This has functions for managing clients.
 
 12. Update Client
 
-# Dasboard
+# Dashboard
 
 This has functions for retrieving mentions
  * Today Summary: Today's mentions on social media, news, and other sources

From 5978c38fd9dfc53594d4e9987fdad728bb040e70 Mon Sep 17 00:00:00 2001
From: securetorobert <securetorobert@protonmail.com>
Date: Mon, 31 Dec 2018 23:13:23 +0100
Subject: [PATCH 12/96] updated Readme

---
 Readme.md | 45 +++++++++++++++++++++++++++++++++++----------
 1 file changed, 35 insertions(+), 10 deletions(-)

diff --git a/Readme.md b/Readme.md
index b347ea3..343fe4d 100644
--- a/Readme.md
+++ b/Readme.md
@@ -27,25 +27,33 @@ This has functions for managing clients.
 
 * Add Question
 
-3. Create Client
+* Create Client
 
-4. Create Member
+* Create Member
 
-5. Delete Comparison
+* Delete Comparison
 
-6. Delete Member
+* Delete Member
 
-7. Edit Client
+* Edit Client
 
-8. Get Client
+* Generate Report
 
-9. Get Comparisons
+* Get Campaigns
 
-10. Get DocRef
+* Get Client
 
-11. Get Members
+* Get Comparisons
 
-12. Update Client
+* Get DocRef
+
+* Get Members
+
+* Get Questions
+
+* Get Responses
+
+* Update Client
 
 # Dashboard
 
@@ -75,6 +83,23 @@ This has functions for sending out emails
 
 This function will take a string and return a HTML formattted string with tags that decorate profane words.
 
+# Scouts
+
+This has functions required for scouts to interact with campaigns:
+
+* Add Response
+
+* Create Scout
+
+* Get Campaigns
+
+* Get DocRef
+
+* Get Questions
+
+* Get Responses
+
+* Get Scout
 
 # Getting started
 

From 5887ab1f34a664f31ee60cbcfec660f7ad7825b5 Mon Sep 17 00:00:00 2001
From: securetorobert <securetorobert@protonmail.com>
Date: Mon, 31 Dec 2018 23:57:11 +0100
Subject: [PATCH 13/96] added endpoints for scouts

---
 Scout.md       | 184 +++++++++++++++++++++++++++++++++++++++++++++++++
 clients.html   |   1 +
 dashboard.html |   1 +
 email.html     |   1 +
 index.html     |   1 +
 profanity.html |   1 +
 scout.html     |  55 +++++++++++++++
 7 files changed, 244 insertions(+)
 create mode 100644 Scout.md
 create mode 100644 scout.html

diff --git a/Scout.md b/Scout.md
new file mode 100644
index 0000000..c59a277
--- /dev/null
+++ b/Scout.md
@@ -0,0 +1,184 @@
+# Scout
+
+Endpoints for Versus Scouts
+
+## Add Response
+
+Add a response to a question.
+
+
+> Endpoint: scout_add_response
+
+> Payload
+
+``` javascript
+{
+  "cRef": "",
+  "qRef": "",
+  "sRef": "",
+  "response": ""
+}
+```
+
+> Result
+``` javascript
+{
+  "response": {
+    "value": ""
+  }
+}
+```
+
+## Create Scout
+
+Add a scout
+
+
+> Endpoint: scout_create_scout
+
+> Payload
+
+``` javascript
+{
+  "firstName": "Kemdi",
+  "lastName": "Ebi",
+  "phoneNumber": "08136260795",
+  "bankName": "EcoBank",
+  "accountNumber": "07097533321",
+  "bvn": "202020202020"
+}
+```
+
+> Result
+``` javascript
+{
+  "docRef": "APeORvgxRox2YwzESeZK"
+}
+```
+
+## Get Campaigns
+
+Get all campaigns on the system
+
+
+> Endpoint: scout_get_campaigns
+
+> Payload
+
+``` javascript
+{}
+```
+
+> Result
+``` javascript
+{
+  "campaigns": [
+    {
+      "startDate": "2019-01-01",
+      "description": "Campaign for McScoutie",
+      "campaignName": "First Campaign",
+      "startAge": 18,
+      "country": "Nigeria",
+      "endAge": 65,
+      "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+      "clientName": "The Enterprise",
+      "endDate": "2019-03-30",
+      "docRef": "WXGj5wfVS6DKpyecChYm"
+    }
+  ]
+}
+```
+
+## Get DocRef
+
+Get a Scout reference given a phoneNumber.
+
+
+> Endpoint: scout_get_docref
+
+> Payload
+
+``` javascript
+{
+  "phoneNumber": "08023004000"
+}
+```
+
+> Result
+``` javascript
+{
+  "scouts": [
+    "4XhTtoWg0Yg7q4PSVXOU"
+  ]
+}
+```
+
+## Get Questions
+
+Get the questions associated with a campaign.
+
+
+> Endpoint: scout_get_questions
+
+> Payload
+
+``` javascript
+{
+  "docRef": "WXGj5wfVS6DKpyecChYm"
+}
+```
+
+> Result
+``` javascript
+{
+  "questions": [
+    {
+      "question": "Are you a scout?",
+      "options": "Yes, No",
+      "docRef": "kVjTjvEEwk18sLH5RmZX"
+    }
+  ]
+}
+```
+
+## Get Scout
+
+Get a scout given the docRef
+
+
+> Endpoint: scout_get_scout
+
+> Payload
+
+``` javascript
+{
+  "docRef": "APeORvgxRox2YwzESeZK"
+}
+```
+
+> Result
+``` javascript
+{
+  "gender": "",
+  "bvn": "202020202020",
+  "religion": "",
+  "occupation": "",
+  "firstName": "Kemdi",
+  "country": "",
+  "bankName": "EcoBank",
+  "emailAddress": "",
+  "lastName": "Ebi",
+  "accountNumber": "07097533321",
+  "age": "",
+  "education": "",
+  "twoFA": false,
+  "maritalStatus": "",
+  "state": "",
+  "verified": false,
+  "versusCredits": {
+    "amount": 0,
+    "canCashOut": false
+  },
+  "phoneNumber": "08136260795"
+}
+```
\ No newline at end of file
diff --git a/clients.html b/clients.html
index 9d59277..64e97a6 100644
--- a/clients.html
+++ b/clients.html
@@ -35,6 +35,7 @@ <h1><a href='.'>Flatdoc</a></h1>
         <li><a href='email.html'>Email Templates</a></li>
         <li><a href='profanity.html'>Profanity Filter</a></li>
         <li><a href='reference.html'>API reference</a></li>
+        <li><a href='scout.html'>Scouts</a></li>
       </ul>
     </div>
     <div class='right'>
diff --git a/dashboard.html b/dashboard.html
index 00adb2f..684a2b5 100644
--- a/dashboard.html
+++ b/dashboard.html
@@ -35,6 +35,7 @@ <h1><a href='.'>Flatdoc</a></h1>
         <li><a href='email.html'>Email Templates</a></li>
         <li><a href='profanity.html'>Profanity Filter</a></li>
         <li><a href='reference.html'>API reference</a></li>
+        <li><a href='scout.html'>Scouts</a></li>
       </ul>
     </div>
     <div class='right'>
diff --git a/email.html b/email.html
index 11ab6c1..8e8bae4 100644
--- a/email.html
+++ b/email.html
@@ -35,6 +35,7 @@ <h1><a href='.'>Flatdoc</a></h1>
             <li><a href='email.html'>Email Templates</a></li>
             <li><a href='profanity.html'>Profanity Filter</a></li>
             <li><a href='reference.html'>API reference</a></li>
+            <li><a href='scout.html'>Scouts</a></li>
           </ul>
         </div>
         <div class='right'>
diff --git a/index.html b/index.html
index bac2272..a5b3c90 100644
--- a/index.html
+++ b/index.html
@@ -56,6 +56,7 @@ <h1><a href='.'>Flatdoc</a></h1>
         <li><a href='email.html'>Email Templates</a></li>
         <li><a href='profanity.html'>Profanity Filter</a></li>
         <li><a href='reference.html'>API reference</a></li>
+        <li><a href='scout.html'>Scouts</a></li>
       </ul>
     </div>
     <div class='right'>
diff --git a/profanity.html b/profanity.html
index 2b45827..e941838 100644
--- a/profanity.html
+++ b/profanity.html
@@ -35,6 +35,7 @@ <h1><a href='.'>Flatdoc</a></h1>
             <li><a href='email.html'>Email Templates</a></li>
             <li><a href='profanity.html'>Profanity Filter</a></li>
             <li><a href='reference.html'>API reference</a></li>
+            <li><a href='scout.html'>Scouts</a></li>
           </ul>
         </div>
         <div class='right'>
diff --git a/scout.html b/scout.html
new file mode 100644
index 0000000..a31c86a
--- /dev/null
+++ b/scout.html
@@ -0,0 +1,55 @@
+<!doctype html>
+<html>
+<head>
+  <meta charset='utf-8'>
+  <meta http-equiv="X-UA-Compatible" content="chrome=1" />
+  <meta name="viewport" content="width=device-width">
+
+  <title>Flatdoc</title>
+
+  <!-- Flatdoc -->
+  <script src='support/vendor/jquery.js'></script>
+  <script src='legacy.js'></script>
+  <script src='flatdoc.js'></script>
+
+  <!-- Flatdoc theme -->
+  <link  href='theme-white/style.css' rel='stylesheet'>
+  <script src='theme-white/script.js'></script>
+  <link  href='support/theme.css' rel='stylesheet'>
+
+  <!-- Initializer -->
+  <script>
+    Flatdoc.run({
+      fetcher: Flatdoc.file('Scout.md')
+    });
+  </script>
+</head>
+<body role='flatdoc'>
+
+    <div class='header'>
+        <div class='left'>
+          <h1><a href='.'>Flatdoc</a></h1>
+          <ul>
+            <li><a href='clients.html'>Clients</a></li>
+            <li><a href='dashboard.html'>Dashboard</a></li>
+            <li><a href='email.html'>Email Templates</a></li>
+            <li><a href='profanity.html'>Profanity Filter</a></li>
+            <li><a href='reference.html'>API reference</a></li>
+            <li><a href='scout.html'>Scouts</a></li>
+          </ul>
+        </div>
+        <div class='right'>
+          <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;type=follow&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="170" height="20"></iframe>
+          <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;repo=flatdoc&amp;type=watch&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe>
+        </div>
+      </div>
+
+  <div class='content-root'>
+    <div class='menubar'>
+      <div class='menu section' role='flatdoc-menu'></div>
+    </div>
+    <div role='flatdoc-content' class='content'></div>
+  </div>
+
+</body>
+</html>

From 4aa11b6c74724508103499fdde629a37a32e05e8 Mon Sep 17 00:00:00 2001
From: securetorobert <securetorobert@protonmail.com>
Date: Mon, 7 Jan 2019 13:52:17 +0100
Subject: [PATCH 14/96] updated Readme so bullet points can look better

---
 Readme.md | 48 ++++++++++++++++++++++++++++++++----------------
 1 file changed, 32 insertions(+), 16 deletions(-)

diff --git a/Readme.md b/Readme.md
index 343fe4d..14bec9e 100644
--- a/Readme.md
+++ b/Readme.md
@@ -58,26 +58,42 @@ This has functions for managing clients.
 # Dashboard
 
 This has functions for retrieving mentions
- * Today Summary: Today's mentions on social media, news, and other sources
- * Week Summary: This week's mentions on social media, news, and other sources
- * Month Summary: This month's mentions on social media, news, and other sources
- * All Time Summary: Total aggregate on our systems of mentions on social media, news, and other sources
- * Today Details: Mentions from social media, news, and other sources grouped by source for today
- * Week Details: Mentions from social media, news, and other sources grouped by source for the past week
- * Today Details: Mentions from social media, news, and other sources grouped by source for the past month
- * All Time Details: Mentions from social media, news, and other sources grouped by source for all content on our systems
+
+* Today Summary: Today's mentions on social media, news, and other sources
+
+* Week Summary: This week's mentions on social media, news, and other sources
+
+* Month Summary: This month's mentions on social media, news, and other sources
+
+* All Time Summary: Total aggregate on our systems of mentions on social media, news, and other sources
+
+* Today Details: Mentions from social media, news, and other sources grouped by source for today
+
+* Week Details: Mentions from social media, news, and other sources grouped by source for the past week
+
+* Today Details: Mentions from social media, news, and other sources grouped by source for the past month
+
+* All Time Details: Mentions from social media, news, and other sources grouped by source for all content on our systems
 
 # Email Templates
 
 This has functions for sending out emails
- * Custom Alerts: Notify an admin that custom alerts have been set for their account
- * Dashboard Ready: Notify an admin that the Versus Sentiment dashboard has data for viewing
- * Designated Primary Email: Notify an admin that they have been designated as a primary contact
- * Designated Team Member: Notify someone that they have been added as a team member to Versus Sentiment
- * Request a Demo: Let a potential user request a demo
- * Respond to Article: Notify a recipient to respond to a social media post
- * Welcome to Versus: Notify the recipient that their Versus Sentiment account has been created
- * Your Report: Dispatch a periodic report
+
+* Custom Alerts: Notify an admin that custom alerts have been set for their account
+
+* Dashboard Ready: Notify an admin that the Versus Sentiment dashboard has data for viewing
+
+* Designated Primary Email: Notify an admin that they have been designated as a primary contact
+
+* Designated Team Member: Notify someone that they have been added as a team member to Versus Sentiment
+
+* Request a Demo: Let a potential user request a demo
+
+* Respond to Article: Notify a recipient to respond to a social media post
+
+* Welcome to Versus: Notify the recipient that their Versus Sentiment account has been created
+
+* Your Report: Dispatch a periodic report
 
 # Profanity Filter
 

From e433cd6287f8e3074d2da34c45a65f01b8c99558 Mon Sep 17 00:00:00 2001
From: securetorobert <securetorobert@protonmail.com>
Date: Tue, 8 Jan 2019 23:58:36 +0100
Subject: [PATCH 15/96] added endpoints for managing client campaigns

---
 Clients.md | 170 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 170 insertions(+)

diff --git a/Clients.md b/Clients.md
index 7f1afb5..c5cba8c 100644
--- a/Clients.md
+++ b/Clients.md
@@ -2,6 +2,46 @@
 
 This has endpoints for managing clients
 
+## Add Campaign
+
+This creates a new campaign under the client account.
+
+> Endpoint: versus_add_campaign
+
+> Payload
+
+``` javascript
+{
+  "docRef": "nqaXKB0SzWN6xh7RVyzl",
+  "clientName": "clientName",
+  "campaignName": "campaignName",
+  "description": "description",
+  "startDate": "2019-01-01",
+  "endDate": "2019-06-30",
+  "country": "NG",
+  "startAge": 18,
+  "endAge": 60
+}
+```
+
+> Response
+
+``` javascript
+{
+  "campaign": {
+    "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+    "clientName": "clientName",
+    "campaignName": "campaignName",
+    "description": "description",
+    "startDate": "2019-01-01",
+    "endDate": "2019-06-30",
+    "country": "NG",
+    "startAge": 18,
+    "endAge": 60
+  }
+}
+```
+
 
 ## Add Comparison
 
@@ -48,6 +88,33 @@ This adds a new user to a client account.
 
 ```
 
+## Add Question
+
+This adds a question to a campaign.
+
+> Endpoint: versus_add_question
+
+> Payload
+
+``` javascript
+{
+  "docRef": "nqaXKB0SzWN6xh7RVyzl",
+  "question": "Please pick an option",
+  "options": "One, Two, Three"
+}
+```
+
+> Response
+
+``` javascript
+{
+  "question": {
+    "question": "Please pick an option",
+    "options": "One, Two, Three"
+  }
+}
+```
+
 ## Create Client
 
 Create a new client on the Versus platform. The response to this event causes a Welcome to Versus email to be triggered.
@@ -175,6 +242,53 @@ This edits the details on a client's account.
 }
 ```
 
+## Get Campaigns
+
+Returns a list of campaigns belonging to a client
+
+> Endpoint: versus_get_campaigns
+
+> Payload
+
+``` javascript
+{
+  "docRef": "nqaXKB0SzWN6xh7RVyzl"
+}
+```
+
+> Response
+
+``` javascript
+{
+  "campaigns": [
+    {
+      "startDate": "2019-01-01",
+      "description": "description",
+      "campaignName": "campaignName",
+      "startAge": 18,
+      "country": "NG",
+      "endAge": 60,
+      "clientName": "clientName",
+      "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+      "endDate": "2019-06-30",
+      "docRef": "NuYgN5IyhPpeEDq9bxoz"
+    },
+    {
+      "endAge": 65,
+      "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+      "clientName": "The Enterprise",
+      "endDate": "2019-03-30",
+      "startDate": "2019-01-01",
+      "description": "Campaign for McScoutie",
+      "campaignName": "First Campaign",
+      "startAge": 18,
+      "country": "Nigeria",
+      "docRef": "WXGj5wfVS6DKpyecChYm"
+    }
+  ]
+}
+```
+
 ## Get Client
 
 Returns the details associated with a client account
@@ -305,6 +419,62 @@ Returns the list of users associated with a client account.
 }
 ```
 
+## Get Questions
+
+Get a list of questions under a campaign
+
+> Endpoint: versus_get_questions
+
+> Payload
+
+``` javascript
+{
+  "docRef": "WXGj5wfVS6DKpyecChYm"
+}
+```
+
+> Response
+
+``` javascript
+{
+  "questions": [
+    {
+      "options": "Yes, No",
+      "question": "Are you a scout?",
+      "docRef": "kVjTjvEEwk18sLH5RmZX"
+    }
+  ]
+}
+```
+
+## Get Responses
+
+Get all the responses that have been provided to a question.
+
+> Endpoint:  versus_get_responses
+
+> Payload
+
+``` javascript
+{
+  "cRef": "WXGj5wfVS6DKpyecChYm",
+  "qRef": "kVjTjvEEwk18sLH5RmZX"
+}
+```
+
+> Response
+
+``` javascript
+{
+  "responses": [
+    {
+      "value": "Yes",
+      "docRef": "4XhTtoWg0Yg7q4PSVXOU"
+    }
+  ]
+}
+```
+
 ## Update Client
 
 Complete the onboarding process for a client.

From 5d7aa9438bd1784e35ddc4dfd5fbb31180ee5653 Mon Sep 17 00:00:00 2001
From: securetorobert <securetorobert@protonmail.com>
Date: Wed, 9 Jan 2019 16:19:49 +0100
Subject: [PATCH 16/96] added a missing attribute in update_client payload

---
 Clients.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Clients.md b/Clients.md
index c5cba8c..02a7578 100644
--- a/Clients.md
+++ b/Clients.md
@@ -531,7 +531,8 @@ Complete the onboarding process for a client.
     }
   ],
   "topics": "Pricing, experience",
-  "twitterHandle": "twitter"
+  "twitterHandle": "twitter",
+  "instagramHandle":"@2019Oby"
 }
 ```
 

From 8270f928a2ce173135782434eff6d969e6ae454e Mon Sep 17 00:00:00 2001
From: securetorobert <securetorobert@protonmail.com>
Date: Fri, 18 Jan 2019 17:56:38 +0100
Subject: [PATCH 17/96] added Get Clients

---
 Clients.md   | 42 ++++++++++++++++++++++++++++++++++++++++++
 Dashboard.md |  9 ++++++---
 Email.md     |  2 +-
 3 files changed, 49 insertions(+), 4 deletions(-)

diff --git a/Clients.md b/Clients.md
index 02a7578..496b108 100644
--- a/Clients.md
+++ b/Clients.md
@@ -303,6 +303,48 @@ Returns the details associated with a client account
 }
 ```
 
+## Get Clients
+
+Returns an array of objects showing the name and docRef of clients in a specified category
+
+> Endpoint: versus_get_clients
+
+> Payload
+
+``` javascript
+{"category":"Banking"}
+```
+
+> Response
+
+``` javascript
+
+{
+  "clients": [
+    {
+      "docRef": "68CgvyEYhGlLcAlDFdol",
+      "name": "Kemdi Limited"
+    },
+    {
+      "docRef": "mvPKqA09G4Fm09RMxs4a",
+      "name": null
+    },
+    {
+      "docRef": "nqaXKB0SzWN6xh7RVyzl",
+      "name": "The Enterprise"
+    },
+    {
+      "docRef": "uDs47BUH4v1EWXP0lPf7",
+      "name": "Amaka Limited"
+    },
+    {
+      "docRef": "xzfTjhjSw7UHOSbtRKXS",
+      "name": "Chika Limited"
+    }
+  ]
+}
+```
+
 > Response
 
 ``` javascript
diff --git a/Dashboard.md b/Dashboard.md
index e7c4836..ccdd3b5 100644
--- a/Dashboard.md
+++ b/Dashboard.md
@@ -516,7 +516,8 @@ Endpoints responsible for the charts and components that render on the  Versus d
 
 ``` javascript
 {
-  "docRef": "68CgvyEYhGlLcAlDFdol"
+  "docRef": "68CgvyEYhGlLcAlDFdol",
+  "when": "2019-01-10"
 }
 ```
 
@@ -578,7 +579,8 @@ Endpoints responsible for the charts and components that render on the  Versus d
 
 ``` javascript
 {
-  "docRef": "68CgvyEYhGlLcAlDFdol"
+  "docRef": "68CgvyEYhGlLcAlDFdol",
+  "when": "2019-01-10"
 }
 ```
 
@@ -640,7 +642,8 @@ Endpoints responsible for the charts and components that render on the  Versus d
 
 ``` javascript
 {
-  "docRef": "68CgvyEYhGlLcAlDFdol"
+  "docRef": "68CgvyEYhGlLcAlDFdol",
+  "when": "2019-01-10"
 }
 ```
 
diff --git a/Email.md b/Email.md
index 88853e7..9bbc6d5 100644
--- a/Email.md
+++ b/Email.md
@@ -102,7 +102,7 @@ Notify someone that they have been added as a team member to Versus Sentiment. T
   "recipient": "kemdi@enterfive.com",
   "firstName": "kemdi",
   "organizationName": "Enterfive",
-  "inviteLink": "https://app.versus.ng/"
+  "inviteLink": "https://versus-dev-212614.appspot.com/create-profile?ref=undefined&email=kemdi@enterfive.com"
 }
 ```
 

From 21e2a5325861bb6ba4629b299d02e4c067d714be Mon Sep 17 00:00:00 2001
From: securetorobert <securetorobert@protonmail.com>
Date: Sat, 19 Jan 2019 14:55:51 +0100
Subject: [PATCH 18/96] added compare month

---
 Dashboard.md | 55 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)

diff --git a/Dashboard.md b/Dashboard.md
index ccdd3b5..de57f2d 100644
--- a/Dashboard.md
+++ b/Dashboard.md
@@ -171,6 +171,61 @@ Endpoints responsible for the charts and components that render on the  Versus d
 ]
 ```
 
+## Compare Mentions
+
+Compare the number of mentions across channels for up to three clients
+
+> Endpoint: versus_dashboard_compare_month
+
+> Payload
+
+``` javascript
+{
+  "clients": [
+    {
+      "name": "Client 1",
+      "id": "68CgvyEYhGlLcAlDFdol"
+    },
+    {
+      "name": "Client 2",
+      "id": "mvPKqA09G4Fm09RMxs4a"
+    },
+    {
+      "name": "Client 3",
+      "id": "nqaXKB0SzWN6xh7RVyzl"
+    }
+  ]
+}
+```
+
+> Response
+
+``` javascript
+[
+  {
+    "type": "bar",
+    "x": [
+      103,
+      165,
+      337
+    ],
+    "y": [
+      "Client 1",
+      "Client 2",
+      "Client 3"
+    ],
+    "orientation": "h",
+    "marker": {
+      "color": [
+        "#9775fa",
+        "#4dabf7",
+        "#38d9a9"
+      ]
+    }
+  }
+]
+```
+
 ## Month Detail
 
 > Endpoint: versus_dashboard_month_detail

From bea0341c8b905b146ec38b03419c6ec1f7604dc5 Mon Sep 17 00:00:00 2001
From: securetorobert <securetorobert@protonmail.com>
Date: Sat, 19 Jan 2019 15:31:28 +0100
Subject: [PATCH 19/96] added Compare Average, Compare Day

---
 Dashboard.md | 114 ++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 112 insertions(+), 2 deletions(-)

diff --git a/Dashboard.md b/Dashboard.md
index de57f2d..ffa2c54 100644
--- a/Dashboard.md
+++ b/Dashboard.md
@@ -171,9 +171,119 @@ Endpoints responsible for the charts and components that render on the  Versus d
 ]
 ```
 
-## Compare Mentions
+## Compare Average
 
-Compare the number of mentions across channels for up to three clients
+Compare the average (monthly) of mentions across channels for up to three clients
+
+> Endpoint: versus_dashboard_compare_average
+
+> Payload
+
+``` javascript
+{
+  "clients": [
+    {
+      "name": "Client 1",
+      "id": "68CgvyEYhGlLcAlDFdol"
+    },
+    {
+      "name": "Client 2",
+      "id": "mvPKqA09G4Fm09RMxs4a"
+    },
+    {
+      "name": "Client 3",
+      "id": "nqaXKB0SzWN6xh7RVyzl"
+    }
+  ]
+}
+```
+
+> Response
+
+``` javascript
+[
+  {
+    "type": "bar",
+    "x": [
+      103,
+      165,
+      337
+    ],
+    "y": [
+      "Client 1",
+      "Client 2",
+      "Client 3"
+    ],
+    "orientation": "h",
+    "marker": {
+      "color": [
+        "#9775fa",
+        "#4dabf7",
+        "#38d9a9"
+      ]
+    }
+  }
+]
+```
+
+## Compare Day
+
+Compare the number of mentions (past 24 hours) across channels for up to three clients
+
+> Endpoint: versus_dashboard_compare_day
+
+> Payload
+
+``` javascript
+{
+  "clients": [
+    {
+      "name": "Client 1",
+      "id": "68CgvyEYhGlLcAlDFdol"
+    },
+    {
+      "name": "Client 2",
+      "id": "mvPKqA09G4Fm09RMxs4a"
+    },
+    {
+      "name": "Client 3",
+      "id": "nqaXKB0SzWN6xh7RVyzl"
+    }
+  ]
+}
+```
+
+> Response
+
+``` javascript
+[
+  {
+    "type": "bar",
+    "x": [
+      103,
+      165,
+      337
+    ],
+    "y": [
+      "Client 1",
+      "Client 2",
+      "Client 3"
+    ],
+    "orientation": "h",
+    "marker": {
+      "color": [
+        "#9775fa",
+        "#4dabf7",
+        "#38d9a9"
+      ]
+    }
+  }
+]
+```
+
+## Compare Month
+
+Compare the number of mentions in a month across channels for up to three clients
 
 > Endpoint: versus_dashboard_compare_month
 

From ea9cb223314f5cdbdc38fedd783c4a0534f8f992 Mon Sep 17 00:00:00 2001
From: securetorobert <securetorobert@protonmail.com>
Date: Sat, 19 Jan 2019 16:05:28 +0100
Subject: [PATCH 20/96] added Compare Pie

---
 Dashboard.md | 55 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)

diff --git a/Dashboard.md b/Dashboard.md
index ffa2c54..7320c97 100644
--- a/Dashboard.md
+++ b/Dashboard.md
@@ -336,6 +336,61 @@ Compare the number of mentions in a month across channels for up to three client
 ]
 ```
 
+## Compare Pie
+
+Compare the number of mentions in a month across channels for up to three clients as a Pie Chart
+
+> Endpoint: versus_dashboard_compare_pie
+
+> Payload
+
+``` javascript
+{
+  "clients": [
+    {
+      "name": "Client 1",
+      "id": "68CgvyEYhGlLcAlDFdol"
+    },
+    {
+      "name": "Client 2",
+      "id": "mvPKqA09G4Fm09RMxs4a"
+    },
+    {
+      "name": "Client 3",
+      "id": "nqaXKB0SzWN6xh7RVyzl"
+    }
+  ]
+}
+```
+
+> Response
+
+``` javascript
+[
+  {
+    "type": "bar",
+    "x": [
+      103,
+      165,
+      337
+    ],
+    "y": [
+      "Client 1",
+      "Client 2",
+      "Client 3"
+    ],
+    "orientation": "h",
+    "marker": {
+      "color": [
+        "#9775fa",
+        "#4dabf7",
+        "#38d9a9"
+      ]
+    }
+  }
+]
+```
+
 ## Month Detail
 
 > Endpoint: versus_dashboard_month_detail

From 136c0cda4d7f15ff15f5dfb8533364a6c3198864 Mon Sep 17 00:00:00 2001
From: securetorobert <securetorobert@protonmail.com>
Date: Sat, 19 Jan 2019 16:54:13 +0100
Subject: [PATCH 21/96] added Compare Social

---
 Dashboard.md | 90 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 90 insertions(+)

diff --git a/Dashboard.md b/Dashboard.md
index 7320c97..9d90a41 100644
--- a/Dashboard.md
+++ b/Dashboard.md
@@ -391,6 +391,96 @@ Compare the number of mentions in a month across channels for up to three client
 ]
 ```
 
+## Compare Social
+
+Compare the number of mentions in a month across channels for up to three clients as a Pie Chart
+
+> Endpoint: versus_dashboard_compare_social
+
+> Payload
+
+``` javascript
+{
+  "clients": [
+    {
+      "name": "Client 1",
+      "id": "68CgvyEYhGlLcAlDFdol"
+    },
+    {
+      "name": "Client 2",
+      "id": "mvPKqA09G4Fm09RMxs4a"
+    },
+    {
+      "name": "Client 3",
+      "id": "nqaXKB0SzWN6xh7RVyzl"
+    }
+  ]
+}
+```
+
+> Response
+
+``` javascript
+[
+  {
+    "type": "bar",
+    "x": [
+      100,
+      100,
+      100
+    ],
+    "y": [
+      "Client 1",
+      "Client 2",
+      "Client 3"
+    ],
+    "orientation": "h",
+    "marker": {
+      "color": "#40C057"
+    },
+    "name": "Positive"
+  },
+  {
+    "showlegend": true,
+    "name": "Neutral",
+    "marker": {
+      "color": "#FAB005"
+    },
+    "hoverinfo": "y",
+    "y": [
+      "Client 1",
+      "Client 2",
+      "Client 3"
+    ],
+    "x": [
+      0,
+      0,
+      0
+    ],
+    "type": "bar",
+    "orientation": "h"
+  },
+  {
+    "name": "Negative",
+    "marker": {
+      "color": "#FA5252"
+    },
+    "y": [
+      "Client 1",
+      "Client 2",
+      "Client 3"
+    ],
+    "x": [
+      0,
+      0,
+      0
+    ],
+    "type": "bar",
+    "orientation": "h"
+  }
+]
+```
+
 ## Month Detail
 
 > Endpoint: versus_dashboard_month_detail

From 3a204cb40f895daa09267c7256ef0a09d6b2c514 Mon Sep 17 00:00:00 2001
From: securetorobert <securetorobert@protonmail.com>
Date: Sat, 19 Jan 2019 17:12:12 +0100
Subject: [PATCH 22/96] added Compare News and Compare Others

---
 Dashboard.md | 182 ++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 181 insertions(+), 1 deletion(-)

diff --git a/Dashboard.md b/Dashboard.md
index 9d90a41..dc84eb6 100644
--- a/Dashboard.md
+++ b/Dashboard.md
@@ -336,6 +336,186 @@ Compare the number of mentions in a month across channels for up to three client
 ]
 ```
 
+## Compare News
+
+Compare sentiment across news sources for clients
+
+> Endpoint: versus_dashboard_compare_news
+
+> Payload
+
+``` javascript
+{
+  "clients": [
+    {
+      "name": "Client 1",
+      "id": "68CgvyEYhGlLcAlDFdol"
+    },
+    {
+      "name": "Client 2",
+      "id": "mvPKqA09G4Fm09RMxs4a"
+    },
+    {
+      "name": "Client 3",
+      "id": "nqaXKB0SzWN6xh7RVyzl"
+    }
+  ]
+}
+```
+
+> Response
+
+``` javascript
+[
+  {
+    "type": "bar",
+    "x": [
+      100,
+      100,
+      100
+    ],
+    "y": [
+      "Client 1",
+      "Client 2",
+      "Client 3"
+    ],
+    "orientation": "h",
+    "marker": {
+      "color": "#40C057"
+    },
+    "name": "Positive"
+  },
+  {
+    "showlegend": true,
+    "name": "Neutral",
+    "marker": {
+      "color": "#FAB005"
+    },
+    "hoverinfo": "y",
+    "y": [
+      "Client 1",
+      "Client 2",
+      "Client 3"
+    ],
+    "x": [
+      0,
+      0,
+      0
+    ],
+    "type": "bar",
+    "orientation": "h"
+  },
+  {
+    "name": "Negative",
+    "marker": {
+      "color": "#FA5252"
+    },
+    "y": [
+      "Client 1",
+      "Client 2",
+      "Client 3"
+    ],
+    "x": [
+      0,
+      0,
+      0
+    ],
+    "type": "bar",
+    "orientation": "h"
+  }
+]
+```
+
+## Compare Other
+
+Compare sentiment across other news sources for clients
+
+> Endpoint: versus_dashboard_compare_other
+
+> Payload
+
+``` javascript
+{
+  "clients": [
+    {
+      "name": "Client 1",
+      "id": "68CgvyEYhGlLcAlDFdol"
+    },
+    {
+      "name": "Client 2",
+      "id": "mvPKqA09G4Fm09RMxs4a"
+    },
+    {
+      "name": "Client 3",
+      "id": "nqaXKB0SzWN6xh7RVyzl"
+    }
+  ]
+}
+```
+
+> Response
+
+``` javascript
+[
+  {
+    "type": "bar",
+    "x": [
+      100,
+      100,
+      100
+    ],
+    "y": [
+      "Client 1",
+      "Client 2",
+      "Client 3"
+    ],
+    "orientation": "h",
+    "marker": {
+      "color": "#40C057"
+    },
+    "name": "Positive"
+  },
+  {
+    "showlegend": true,
+    "name": "Neutral",
+    "marker": {
+      "color": "#FAB005"
+    },
+    "hoverinfo": "y",
+    "y": [
+      "Client 1",
+      "Client 2",
+      "Client 3"
+    ],
+    "x": [
+      0,
+      0,
+      0
+    ],
+    "type": "bar",
+    "orientation": "h"
+  },
+  {
+    "name": "Negative",
+    "marker": {
+      "color": "#FA5252"
+    },
+    "y": [
+      "Client 1",
+      "Client 2",
+      "Client 3"
+    ],
+    "x": [
+      0,
+      0,
+      0
+    ],
+    "type": "bar",
+    "orientation": "h"
+  }
+]
+```
+
 ## Compare Pie
 
 Compare the number of mentions in a month across channels for up to three clients as a Pie Chart
@@ -393,7 +573,7 @@ Compare the number of mentions in a month across channels for up to three client
 
 ## Compare Social
 
-Compare the number of mentions in a month across channels for up to three clients as a Pie Chart
+Compare sentiment across social channels for clients
 
 > Endpoint: versus_dashboard_compare_social
 

From b190b7931aefd6b0db84cee0d66511b82d228c7f Mon Sep 17 00:00:00 2001
From: securetorobert <securetorobert@protonmail.com>
Date: Sun, 20 Jan 2019 15:18:39 +0100
Subject: [PATCH 23/96] added Compare Week Sentiments and Compare Month
 Sentiments

---
 Dashboard.md | 242 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 242 insertions(+)

diff --git a/Dashboard.md b/Dashboard.md
index dc84eb6..1c674f1 100644
--- a/Dashboard.md
+++ b/Dashboard.md
@@ -661,6 +661,248 @@ Compare sentiment across social channels for clients
 ]
 ```
 
+## Compare Month Sentiment
+
+Compare weekly positive sentiment count over a period of one month for clients
+
+> Endpoint: versus_dashboard_compare_month_sentiments
+
+> Payload
+
+``` javascript
+{
+  "clients": [
+    {
+      "name": "Client 1",
+      "id": "68CgvyEYhGlLcAlDFdol"
+    },
+    {
+      "name": "Client 2",
+      "id": "mvPKqA09G4Fm09RMxs4a"
+    },
+    {
+      "name": "Client 3",
+      "id": "nqaXKB0SzWN6xh7RVyzl"
+    }
+  ]
+}
+```
+
+> Response
+
+``` javascript
+[
+  {
+    "x": [
+      "2019-01-14",
+      "2019-01-15",
+      "2019-01-16",
+      "2019-01-17",
+      "2019-01-18",
+      "2019-01-19",
+      "2019-01-20"
+    ],
+    "y": [
+      0,
+      0,
+      0,
+      100,
+      100,
+      100,
+      0
+    ],
+    "marker": {
+      "color": "rgb(151, 117, 250)"
+    },
+    "line": {
+      "color": "rgb(151, 117, 250)",
+      "shape": "spline"
+    },
+    "mode": "markers+lines",
+    "name": "Client 1"
+  },
+  {
+    "x": [
+      "2019-01-14",
+      "2019-01-15",
+      "2019-01-16",
+      "2019-01-17",
+      "2019-01-18",
+      "2019-01-19",
+      "2019-01-20"
+    ],
+    "y": [
+      0,
+      100,
+      100,
+      100,
+      100,
+      100,
+      0
+    ],
+    "marker": {
+      "color": "rgb(77, 171, 247)"
+    },
+    "line": {
+      "color": "rgb(77, 171, 247)",
+      "shape": "spline"
+    },
+    "mode": "markers+lines",
+    "name": "Client 2"
+  },
+  {
+    "x": [
+      "2019-01-14",
+      "2019-01-15",
+      "2019-01-16",
+      "2019-01-17",
+      "2019-01-18",
+      "2019-01-19",
+      "2019-01-20"
+    ],
+    "y": [
+      0,
+      0,
+      0,
+      0,
+      0,
+      0,
+      0
+    ],
+    "line": {
+      "color": "rgb(56, 217, 169)",
+      "shape": "spline"
+    },
+    "marker": {
+      "color": "rgb(56, 217, 169)"
+    },
+    "mode": "markers+lines",
+    "name": "Client 3"
+  }
+]
+```
+
+## Compare Week Sentiment
+
+Compare weekly positive sentiment count over a period of one week for clients
+
+> Endpoint: versus_dashboard_compare_week_sentiments
+
+> Payload
+
+``` javascript
+{
+  "clients": [
+    {
+      "name": "Client 1",
+      "id": "68CgvyEYhGlLcAlDFdol"
+    },
+    {
+      "name": "Client 2",
+      "id": "mvPKqA09G4Fm09RMxs4a"
+    },
+    {
+      "name": "Client 3",
+      "id": "nqaXKB0SzWN6xh7RVyzl"
+    }
+  ]
+}
+```
+
+> Response
+
+``` javascript
+[
+  {
+    "x": [
+      "2019-01-14",
+      "2019-01-15",
+      "2019-01-16",
+      "2019-01-17",
+      "2019-01-18",
+      "2019-01-19",
+      "2019-01-20"
+    ],
+    "y": [
+      0,
+      0,
+      0,
+      100,
+      100,
+      100,
+      0
+    ],
+    "marker": {
+      "color": "rgb(151, 117, 250)"
+    },
+    "line": {
+      "color": "rgb(151, 117, 250)",
+      "shape": "spline"
+    },
+    "mode": "markers+lines",
+    "name": "Client 1"
+  },
+  {
+    "x": [
+      "2019-01-14",
+      "2019-01-15",
+      "2019-01-16",
+      "2019-01-17",
+      "2019-01-18",
+      "2019-01-19",
+      "2019-01-20"
+    ],
+    "y": [
+      0,
+      100,
+      100,
+      100,
+      100,
+      100,
+      0
+    ],
+    "marker": {
+      "color": "rgb(77, 171, 247)"
+    },
+    "line": {
+      "color": "rgb(77, 171, 247)",
+      "shape": "spline"
+    },
+    "mode": "markers+lines",
+    "name": "Client 2"
+  },
+  {
+    "x": [
+      "2019-01-14",
+      "2019-01-15",
+      "2019-01-16",
+      "2019-01-17",
+      "2019-01-18",
+      "2019-01-19",
+      "2019-01-20"
+    ],
+    "y": [
+      0,
+      0,
+      0,
+      0,
+      0,
+      0,
+      0
+    ],
+    "line": {
+      "color": "rgb(56, 217, 169)",
+      "shape": "spline"
+    },
+    "marker": {
+      "color": "rgb(56, 217, 169)"
+    },
+    "mode": "markers+lines",
+    "name": "Client 3"
+  }
+]
+```
+
 ## Month Detail
 
 > Endpoint: versus_dashboard_month_detail

From ff8bfaa026273a5b9f4cd975e2243f6822e19be4 Mon Sep 17 00:00:00 2001
From: securetorobert <securetorobert@protonmail.com>
Date: Sat, 26 Jan 2019 02:20:38 +0100
Subject: [PATCH 24/96] trying prettyprint

---
 Profanity.md | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/Profanity.md b/Profanity.md
index 927868f..63ddfd6 100644
--- a/Profanity.md
+++ b/Profanity.md
@@ -13,12 +13,14 @@ This function will take a string and return a HTML formatted string with tags th
 
 > Payload
 
-``` javascript
-{"text": "What the hell"}
+```prettyprint linenums:1
+{
+    "text": "What the hell"
+}
 ```
 
 > Result
-``` html
+```html
 what the <STRONG CLASS="blacklist">hell</STRONG>
 ```
 

From be08774543c870fb5d03f3e82cae0e9f837c9602 Mon Sep 17 00:00:00 2001
From: securetorobert <securetorobert@protonmail.com>
Date: Sat, 26 Jan 2019 02:23:19 +0100
Subject: [PATCH 25/96] trying prettyprint

---
 Profanity.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Profanity.md b/Profanity.md
index 63ddfd6..23e82dc 100644
--- a/Profanity.md
+++ b/Profanity.md
@@ -13,14 +13,14 @@ This function will take a string and return a HTML formatted string with tags th
 
 > Payload
 
-```prettyprint linenums:1
+``` prettyprint linenums:1
 {
     "text": "What the hell"
 }
 ```
 
 > Result
-```html
+``` html
 what the <STRONG CLASS="blacklist">hell</STRONG>
 ```
 

From 1b5afbe5db6ad90fd7f7906bfcdb0836ae95dadb Mon Sep 17 00:00:00 2001
From: securetorobert <securetorobert@protonmail.com>
Date: Sat, 26 Jan 2019 02:29:47 +0100
Subject: [PATCH 26/96] removed prettyprint

---
 Profanity.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Profanity.md b/Profanity.md
index 23e82dc..267df82 100644
--- a/Profanity.md
+++ b/Profanity.md
@@ -13,7 +13,7 @@ This function will take a string and return a HTML formatted string with tags th
 
 > Payload
 
-``` prettyprint linenums:1
+``` javascript
 {
     "text": "What the hell"
 }

From ecdddf15fb9f9dc9d1954afcf6b8ce12c603ec63 Mon Sep 17 00:00:00 2001
From: securetorobert <securetorobert@protonmail.com>
Date: Sat, 26 Jan 2019 02:30:35 +0100
Subject: [PATCH 27/96] corrected table

---
 Profanity.md | 2 --
 1 file changed, 2 deletions(-)

diff --git a/Profanity.md b/Profanity.md
index 267df82..c7c3cad 100644
--- a/Profanity.md
+++ b/Profanity.md
@@ -5,8 +5,6 @@ This function will take a string and return a HTML formatted string with tags th
 | Field | Type   | Description                         |
 |-------|--------|-------------------------------------|
 | text  | string | the field to be formatted into HTML |
-|       |        |                                     |
-|       |        |                                     |
 
 
 > Endpoint: versus_profanity_filter

From aee200d2e2e11db80139d69243ab067cd8b5fc33 Mon Sep 17 00:00:00 2001
From: Deji Ibrahim <deji.a.ibrahim@gmail.com>
Date: Sun, 27 Jan 2019 01:46:40 +0100
Subject: [PATCH 28/96] update scout docs

---
 .idea/flatdoc.iml   |  12 +++
 .idea/misc.xml      |   6 ++
 .idea/modules.xml   |   8 ++
 .idea/vcs.xml       |   6 ++
 .idea/workspace.xml | 186 ++++++++++++++++++++++++++++++++++++++++++++
 Scout.md            | 172 +++++++++++++++++++++++++++++-----------
 6 files changed, 345 insertions(+), 45 deletions(-)
 create mode 100644 .idea/flatdoc.iml
 create mode 100644 .idea/misc.xml
 create mode 100644 .idea/modules.xml
 create mode 100644 .idea/vcs.xml
 create mode 100644 .idea/workspace.xml

diff --git a/.idea/flatdoc.iml b/.idea/flatdoc.iml
new file mode 100644
index 0000000..24643cc
--- /dev/null
+++ b/.idea/flatdoc.iml
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
+      <excludeFolder url="file://$MODULE_DIR$/temp" />
+      <excludeFolder url="file://$MODULE_DIR$/tmp" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>
\ No newline at end of file
diff --git a/.idea/misc.xml b/.idea/misc.xml
new file mode 100644
index 0000000..28a804d
--- /dev/null
+++ b/.idea/misc.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="JavaScriptSettings">
+    <option name="languageLevel" value="ES6" />
+  </component>
+</project>
\ No newline at end of file
diff --git a/.idea/modules.xml b/.idea/modules.xml
new file mode 100644
index 0000000..7de3269
--- /dev/null
+++ b/.idea/modules.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/flatdoc.iml" filepath="$PROJECT_DIR$/.idea/flatdoc.iml" />
+    </modules>
+  </component>
+</project>
\ No newline at end of file
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
new file mode 100644
index 0000000..94a25f7
--- /dev/null
+++ b/.idea/vcs.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>
\ No newline at end of file
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
new file mode 100644
index 0000000..ff5cdb9
--- /dev/null
+++ b/.idea/workspace.xml
@@ -0,0 +1,186 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ChangeListManager">
+    <list default="true" id="961d0b92-ea17-47b9-a7f7-a474e5e59d29" name="Default Changelist" comment="">
+      <change beforePath="$PROJECT_DIR$/Scout.md" beforeDir="false" afterPath="$PROJECT_DIR$/Scout.md" afterDir="false" />
+    </list>
+    <ignored path="$PROJECT_DIR$/.tmp/" />
+    <ignored path="$PROJECT_DIR$/temp/" />
+    <ignored path="$PROJECT_DIR$/tmp/" />
+    <option name="EXCLUDED_CONVERTED_TO_IGNORED" value="true" />
+    <option name="SHOW_DIALOG" value="false" />
+    <option name="HIGHLIGHT_CONFLICTS" value="true" />
+    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
+    <option name="LAST_RESOLUTION" value="IGNORE" />
+  </component>
+  <component name="FUSProjectUsageTrigger">
+    <session id="-394556569">
+      <usages-collector id="statistics.lifecycle.project">
+        <counts>
+          <entry key="project.open.time.1" value="1" />
+          <entry key="project.opened" value="1" />
+        </counts>
+      </usages-collector>
+      <usages-collector id="statistics.file.extensions.open">
+        <counts>
+          <entry key="md" value="1" />
+        </counts>
+      </usages-collector>
+      <usages-collector id="statistics.file.types.open">
+        <counts>
+          <entry key="Markdown" value="1" />
+        </counts>
+      </usages-collector>
+      <usages-collector id="statistics.file.extensions.edit">
+        <counts>
+          <entry key="md" value="323" />
+        </counts>
+      </usages-collector>
+      <usages-collector id="statistics.file.types.edit">
+        <counts>
+          <entry key="Markdown" value="323" />
+        </counts>
+      </usages-collector>
+    </session>
+  </component>
+  <component name="FileEditorManager">
+    <leaf>
+      <file pinned="false" current-in-tab="true">
+        <entry file="file://$PROJECT_DIR$/Scout.md">
+          <provider selected="true" editor-type-id="split-provider[text-editor;markdown-preview-editor]">
+            <state split_layout="SPLIT">
+              <first_editor relative-caret-position="390">
+                <caret line="26" column="15" selection-start-line="26" selection-start-column="15" selection-end-line="26" selection-end-column="15" />
+              </first_editor>
+              <second_editor />
+            </state>
+          </provider>
+        </entry>
+      </file>
+    </leaf>
+  </component>
+  <component name="Git.Settings">
+    <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
+  </component>
+  <component name="IdeDocumentHistory">
+    <option name="CHANGED_PATHS">
+      <list>
+        <option value="$PROJECT_DIR$/Scout.md" />
+      </list>
+    </option>
+  </component>
+  <component name="JsBuildToolGruntFileManager" detection-done="true" sorting="DEFINITION_ORDER" />
+  <component name="JsBuildToolPackageJson" detection-done="true" sorting="DEFINITION_ORDER">
+    <package-json value="$PROJECT_DIR$/package.json" />
+  </component>
+  <component name="JsGulpfileManager">
+    <detection-done>true</detection-done>
+    <sorting>DEFINITION_ORDER</sorting>
+  </component>
+  <component name="NodePackageJsonFileManager">
+    <packageJsonPaths>
+      <path value="$PROJECT_DIR$/package.json" />
+    </packageJsonPaths>
+  </component>
+  <component name="ProjectFrameBounds" extendedState="6" fullScreen="true">
+    <option name="width" value="1440" />
+    <option name="height" value="900" />
+  </component>
+  <component name="ProjectView">
+    <navigator proportions="" version="1">
+      <foldersAlwaysOnTop value="true" />
+    </navigator>
+    <panes>
+      <pane id="Scope" />
+      <pane id="ProjectPane">
+        <subPane>
+          <expand>
+            <path>
+              <item name="flatdoc" type="b2602c69:ProjectViewProjectNode" />
+              <item name="flatdoc" type="462c0819:PsiDirectoryNode" />
+            </path>
+          </expand>
+          <select />
+        </subPane>
+      </pane>
+    </panes>
+  </component>
+  <component name="PropertiesComponent">
+    <property name="WebServerToolWindowFactoryState" value="false" />
+    <property name="last_opened_file_path" value="$PROJECT_DIR$" />
+    <property name="nodejs_interpreter_path.stuck_in_default_project" value="undefined stuck path" />
+    <property name="nodejs_npm_path_reset_for_default_project" value="true" />
+    <property name="nodejs_package_manager_path" value="npm" />
+  </component>
+  <component name="RunDashboard">
+    <option name="ruleStates">
+      <list>
+        <RuleState>
+          <option name="name" value="ConfigurationTypeDashboardGroupingRule" />
+        </RuleState>
+        <RuleState>
+          <option name="name" value="StatusDashboardGroupingRule" />
+        </RuleState>
+      </list>
+    </option>
+  </component>
+  <component name="SvnConfiguration">
+    <configuration />
+  </component>
+  <component name="TaskManager">
+    <task active="true" id="Default" summary="Default task">
+      <changelist id="961d0b92-ea17-47b9-a7f7-a474e5e59d29" name="Default Changelist" comment="" />
+      <created>1548547114846</created>
+      <option name="number" value="Default" />
+      <option name="presentableId" value="Default" />
+      <updated>1548547114846</updated>
+      <workItem from="1548547116126" duration="2199000" />
+    </task>
+    <servers />
+  </component>
+  <component name="TimeTrackingManager">
+    <option name="totallyTimeSpent" value="2199000" />
+  </component>
+  <component name="ToolWindowManager">
+    <frame x="0" y="0" width="1440" height="900" extended-state="6" />
+    <editor active="true" />
+    <layout>
+      <window_info id="npm" side_tool="true" />
+      <window_info id="Favorites" side_tool="true" />
+      <window_info active="true" content_ui="combo" id="Project" order="0" visible="true" weight="0.24947146" />
+      <window_info id="Structure" order="1" side_tool="true" weight="0.25" />
+      <window_info anchor="bottom" id="Docker" show_stripe_button="false" />
+      <window_info anchor="bottom" id="Version Control" show_stripe_button="false" />
+      <window_info anchor="bottom" id="Terminal" visible="true" weight="0.2253012" />
+      <window_info anchor="bottom" id="Event Log" side_tool="true" />
+      <window_info anchor="bottom" id="Message" order="0" />
+      <window_info anchor="bottom" id="Find" order="1" />
+      <window_info anchor="bottom" id="Run" order="2" />
+      <window_info anchor="bottom" id="Debug" order="3" weight="0.4" />
+      <window_info anchor="bottom" id="Cvs" order="4" weight="0.25" />
+      <window_info anchor="bottom" id="Inspection" order="5" weight="0.4" />
+      <window_info anchor="bottom" id="TODO" order="6" />
+      <window_info anchor="right" id="Commander" internal_type="SLIDING" order="0" type="SLIDING" weight="0.4" />
+      <window_info anchor="right" id="Ant Build" order="1" weight="0.25" />
+      <window_info anchor="right" content_ui="combo" id="Hierarchy" order="2" weight="0.25" />
+    </layout>
+  </component>
+  <component name="TypeScriptGeneratedFilesManager">
+    <option name="version" value="1" />
+  </component>
+  <component name="VcsContentAnnotationSettings">
+    <option name="myLimit" value="2678400000" />
+  </component>
+  <component name="editorHistoryManager">
+    <entry file="file://$PROJECT_DIR$/Scout.md">
+      <provider selected="true" editor-type-id="split-provider[text-editor;markdown-preview-editor]">
+        <state split_layout="SPLIT">
+          <first_editor relative-caret-position="390">
+            <caret line="26" column="15" selection-start-line="26" selection-start-column="15" selection-end-line="26" selection-end-column="15" />
+          </first_editor>
+          <second_editor />
+        </state>
+      </provider>
+    </entry>
+  </component>
+</project>
\ No newline at end of file
diff --git a/Scout.md b/Scout.md
index c59a277..9f02169 100644
--- a/Scout.md
+++ b/Scout.md
@@ -24,14 +24,18 @@ Add a response to a question.
 ``` javascript
 {
   "response": {
-    "value": ""
+    "campaignRef": "0b3cf5bd-bea9-429b-b374-8f65e5473ed9",
+    "questionRef": "c30e78b6-ff88-49a5-91e9-bb7fb46f1455"
+    "scoutRef": "ea7ca901-9217-4a04-9af4-3c6c21ccc3a2",
+    "response": "response",
+    "clientRef": "clientRef"
   }
 }
 ```
 
 ## Create Scout
 
-Add a scout
+Add a scout - firstName, lastName and phoneNumber are required
 
 
 > Endpoint: scout_create_scout
@@ -40,19 +44,30 @@ Add a scout
 
 ``` javascript
 {
-  "firstName": "Kemdi",
-  "lastName": "Ebi",
-  "phoneNumber": "08136260795",
-  "bankName": "EcoBank",
-  "accountNumber": "07097533321",
-  "bvn": "202020202020"
+    "firstName": "firstName",
+    "lastName": "lastName",
+    "phoneNumber": "phoneNumber",
+    "bankName": "bankName",
+    "bankCode": "bankCode",
+    "accountNumber": "accountNumber",
+    "bvn": "bvn",
+    "emailAddress": "emailAddress",
+    "dob": "dob",
+    "gender": "gender",
+    "education": "education",
+    "maritalStatus": "maritalStatus",
+    "religion": "religion",
+    "occupation": "occupation",
+    "country": "country",
+    "state": "state",
+    "language": "language"
 }
 ```
 
 > Result
 ``` javascript
 {
-  "docRef": "APeORvgxRox2YwzESeZK"
+  "scoutRef": "ea7ca901-9217-4a04-9af4-3c6c21ccc3a2"
 }
 ```
 
@@ -74,16 +89,21 @@ Get all campaigns on the system
 {
   "campaigns": [
     {
-      "startDate": "2019-01-01",
-      "description": "Campaign for McScoutie",
-      "campaignName": "First Campaign",
-      "startAge": 18,
-      "country": "Nigeria",
-      "endAge": 65,
-      "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+      "campaignName": "Biq Query",
+      "campaignRef": "0b3cf5bd-bea9-429b-b374-8f65e5473ed9",
       "clientName": "The Enterprise",
-      "endDate": "2019-03-30",
-      "docRef": "WXGj5wfVS6DKpyecChYm"
+      "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+      "country": "NG",
+      "description": "Big query",
+      "education": null,
+      "endAge": 60,
+      "endDate": "2020-10-10 00:00:00",
+      "gender": null,
+      "maritalStatus": null,
+      "occupation": null,
+      "religion": null,
+      "startAge": 20,
+      "startDate": "2000-10-10 00:00:00"
     }
   ]
 }
@@ -108,7 +128,32 @@ Get a Scout reference given a phoneNumber.
 ``` javascript
 {
   "scouts": [
-    "4XhTtoWg0Yg7q4PSVXOU"
+    {
+        "firstName": "firstName",
+        "lastName": "lastName",
+        "phoneNumber": "phoneNumber",
+        "bankName": "bankName",
+        "bankCode": "bankCode",
+        "accountNumber": "accountNumber",
+        "bvn": "bvn",
+        "emailAddress": "emailAddress",
+        "dob": "dob",
+        "gender": "gender",
+        "education": "education",
+        "maritalStatus": "maritalStatus",
+        "religion": "religion",
+        "occupation": "occupation",
+        "country": "country",
+        "state": "state",
+        "language": "language",
+        "scoutRef": "ea7ca901-9217-4a04-9af4-3c6c21ccc3a2",
+        "versusCredits: {
+            "canCashOut": false,
+            "amount": 0
+        },
+        "verified": false,
+        "twoFA": false
+    }
   ]
 }
 ```
@@ -124,7 +169,39 @@ Get the questions associated with a campaign.
 
 ``` javascript
 {
-  "docRef": "WXGj5wfVS6DKpyecChYm"
+  "docRef": "0b3cf5bd-bea9-429b-b374-8f65e5473ed9"
+}
+```
+
+> Result
+``` javascript
+{
+  "questions": [
+    {
+      "campaignName": "campaignRef",
+      "campaignRef": "0b3cf5bd-bea9-429b-b374-8f65e5473ed9",
+      "clientName": "clientName",
+      "clientRef": "clientRef",
+      "options": "1,2,3",
+      "question": "Big question",
+      "questionRef": "c30e78b6-ff88-49a5-91e9-bb7fb46f1455"
+    }
+  ]
+}
+```
+
+## Get Responses
+
+Get the responses associated with a question.
+
+
+> Endpoint: scout_get_questions
+
+> Payload
+
+``` javascript
+{
+  "docRef": "0b3cf5bd-bea9-429b-b374-8f65e5473ed9"
 }
 ```
 
@@ -133,9 +210,11 @@ Get the questions associated with a campaign.
 {
   "questions": [
     {
-      "question": "Are you a scout?",
-      "options": "Yes, No",
-      "docRef": "kVjTjvEEwk18sLH5RmZX"
+      "campaignRef": "0b3cf5bd-bea9-429b-b374-8f65e5473ed9",
+      "questionRef": "c30e78b6-ff88-49a5-91e9-bb7fb46f1455"
+      "scoutRef": "ea7ca901-9217-4a04-9af4-3c6c21ccc3a2",
+      "response": "response",
+      "clientRef": "clientRef"
     }
   ]
 }
@@ -152,33 +231,36 @@ Get a scout given the docRef
 
 ``` javascript
 {
-  "docRef": "APeORvgxRox2YwzESeZK"
+  "docRef": "ea7ca901-9217-4a04-9af4-3c6c21ccc3a2"
 }
 ```
 
 > Result
 ``` javascript
 {
-  "gender": "",
-  "bvn": "202020202020",
-  "religion": "",
-  "occupation": "",
-  "firstName": "Kemdi",
-  "country": "",
-  "bankName": "EcoBank",
-  "emailAddress": "",
-  "lastName": "Ebi",
-  "accountNumber": "07097533321",
-  "age": "",
-  "education": "",
-  "twoFA": false,
-  "maritalStatus": "",
-  "state": "",
-  "verified": false,
-  "versusCredits": {
-    "amount": 0,
-    "canCashOut": false
-  },
-  "phoneNumber": "08136260795"
+    "firstName": "firstName",
+    "lastName": "lastName",
+    "phoneNumber": "phoneNumber",
+    "bankName": "bankName",
+    "bankCode": "bankCode",
+    "accountNumber": "accountNumber",
+    "bvn": "bvn",
+    "emailAddress": "emailAddress",
+    "dob": "dob",
+    "gender": "gender",
+    "education": "education",
+    "maritalStatus": "maritalStatus",
+    "religion": "religion",
+    "occupation": "occupation",
+    "country": "country",
+    "state": "state",
+    "language": "language",
+    "scoutRef": "ea7ca901-9217-4a04-9af4-3c6c21ccc3a2",
+    "versusCredits: {
+        "canCashOut": false,
+        "amount": 0
+    },
+    "verified": false,
+    "twoFA": false
 }
 ```
\ No newline at end of file

From 2fd245be6bbdc07cb1d7df4f363b16781f47c5f4 Mon Sep 17 00:00:00 2001
From: Deji Ibrahim <deji.a.ibrahim@gmail.com>
Date: Sun, 27 Jan 2019 14:42:52 +0100
Subject: [PATCH 29/96] fix scout docs

---
 .idea/workspace.xml | 23 ++++++++++-------------
 Scout.md            |  3 ++-
 2 files changed, 12 insertions(+), 14 deletions(-)

diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index ff5cdb9..6385067 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -1,9 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project version="4">
   <component name="ChangeListManager">
-    <list default="true" id="961d0b92-ea17-47b9-a7f7-a474e5e59d29" name="Default Changelist" comment="">
-      <change beforePath="$PROJECT_DIR$/Scout.md" beforeDir="false" afterPath="$PROJECT_DIR$/Scout.md" afterDir="false" />
-    </list>
+    <list default="true" id="961d0b92-ea17-47b9-a7f7-a474e5e59d29" name="Default Changelist" comment="" />
     <ignored path="$PROJECT_DIR$/.tmp/" />
     <ignored path="$PROJECT_DIR$/temp/" />
     <ignored path="$PROJECT_DIR$/tmp/" />
@@ -33,12 +31,12 @@
       </usages-collector>
       <usages-collector id="statistics.file.extensions.edit">
         <counts>
-          <entry key="md" value="323" />
+          <entry key="md" value="377" />
         </counts>
       </usages-collector>
       <usages-collector id="statistics.file.types.edit">
         <counts>
-          <entry key="Markdown" value="323" />
+          <entry key="Markdown" value="377" />
         </counts>
       </usages-collector>
     </session>
@@ -49,8 +47,8 @@
         <entry file="file://$PROJECT_DIR$/Scout.md">
           <provider selected="true" editor-type-id="split-provider[text-editor;markdown-preview-editor]">
             <state split_layout="SPLIT">
-              <first_editor relative-caret-position="390">
-                <caret line="26" column="15" selection-start-line="26" selection-start-column="15" selection-end-line="26" selection-end-column="15" />
+              <first_editor relative-caret-position="225">
+                <caret line="15" column="13" lean-forward="true" selection-start-line="15" selection-start-column="13" selection-end-line="15" selection-end-column="13" />
               </first_editor>
               <second_editor />
             </state>
@@ -134,16 +132,15 @@
       <option name="number" value="Default" />
       <option name="presentableId" value="Default" />
       <updated>1548547114846</updated>
-      <workItem from="1548547116126" duration="2199000" />
+      <workItem from="1548547116126" duration="3497000" />
     </task>
     <servers />
   </component>
   <component name="TimeTrackingManager">
-    <option name="totallyTimeSpent" value="2199000" />
+    <option name="totallyTimeSpent" value="3497000" />
   </component>
   <component name="ToolWindowManager">
     <frame x="0" y="0" width="1440" height="900" extended-state="6" />
-    <editor active="true" />
     <layout>
       <window_info id="npm" side_tool="true" />
       <window_info id="Favorites" side_tool="true" />
@@ -151,7 +148,7 @@
       <window_info id="Structure" order="1" side_tool="true" weight="0.25" />
       <window_info anchor="bottom" id="Docker" show_stripe_button="false" />
       <window_info anchor="bottom" id="Version Control" show_stripe_button="false" />
-      <window_info anchor="bottom" id="Terminal" visible="true" weight="0.2253012" />
+      <window_info anchor="bottom" id="Terminal" visible="true" weight="0.44578314" />
       <window_info anchor="bottom" id="Event Log" side_tool="true" />
       <window_info anchor="bottom" id="Message" order="0" />
       <window_info anchor="bottom" id="Find" order="1" />
@@ -175,8 +172,8 @@
     <entry file="file://$PROJECT_DIR$/Scout.md">
       <provider selected="true" editor-type-id="split-provider[text-editor;markdown-preview-editor]">
         <state split_layout="SPLIT">
-          <first_editor relative-caret-position="390">
-            <caret line="26" column="15" selection-start-line="26" selection-start-column="15" selection-end-line="26" selection-end-column="15" />
+          <first_editor relative-caret-position="225">
+            <caret line="15" column="13" lean-forward="true" selection-start-line="15" selection-start-column="13" selection-end-line="15" selection-end-column="13" />
           </first_editor>
           <second_editor />
         </state>
diff --git a/Scout.md b/Scout.md
index 9f02169..0f7a2f5 100644
--- a/Scout.md
+++ b/Scout.md
@@ -16,7 +16,8 @@ Add a response to a question.
   "cRef": "",
   "qRef": "",
   "sRef": "",
-  "response": ""
+  "response": "",
+  "clientRef: ""
 }
 ```
 

From 3581f6d51cb8893284a933bde72adbcea696ec7d Mon Sep 17 00:00:00 2001
From: Uzondu Enudeme <willpoint@gmail.com>
Date: Sat, 9 Mar 2019 15:56:56 +0100
Subject: [PATCH 30/96] scout doc: Update doc for scout wallet creation

---
 Scout.md | 37 +++++++++++++++++++++++++++++++++----
 1 file changed, 33 insertions(+), 4 deletions(-)

diff --git a/Scout.md b/Scout.md
index 0f7a2f5..8bab87d 100644
--- a/Scout.md
+++ b/Scout.md
@@ -17,7 +17,7 @@ Add a response to a question.
   "qRef": "",
   "sRef": "",
   "response": "",
-  "clientRef: ""
+  "clientRef": ""
 }
 ```
 
@@ -148,7 +148,7 @@ Get a Scout reference given a phoneNumber.
         "state": "state",
         "language": "language",
         "scoutRef": "ea7ca901-9217-4a04-9af4-3c6c21ccc3a2",
-        "versusCredits: {
+        "versusCredits": {
             "canCashOut": false,
             "amount": 0
         },
@@ -257,11 +257,40 @@ Get a scout given the docRef
     "state": "state",
     "language": "language",
     "scoutRef": "ea7ca901-9217-4a04-9af4-3c6c21ccc3a2",
-    "versusCredits: {
+    "versusCredits": {
         "canCashOut": false,
         "amount": 0
     },
     "verified": false,
     "twoFA": false
 }
-```
\ No newline at end of file
+```
+
+## Create Scout Wallet
+
+Create a Stellar Wallet associated with a Scout.
+
+| Field               | Type   | Description                                                                        |
+|---------------------|--------|------------------------------------------------------------------------------------|
+| sourceStellarSeed   | string | A Stellar Account funded in XLM to provide the mimimum balance needed for a wallet |
+| scoutRef            | string | A unique string to identify a scout, a wallet is created once for each scoutRef    | 
+
+> Endpoint: scout_create_wallet 
+
+> Payload
+
+```json
+{
+  "sourceStellarSeed": "SCY5QWUU7IGWGVUWYFSPBA2CAYQFYR63QALEIIX3ITYDPLV2AUIY6Q5S",
+  "scoutRef": "ea7ca901-9217-4a04-9af4-3c6c21ccc3a2"
+}
+```
+
+> Result
+
+```json
+{
+  "walletRef": "FQ0upRkKXT3xdwzzKs6X"
+}
+```
+

From a16895b5bd73782dac8c1a042aaab1200d7dbe24 Mon Sep 17 00:00:00 2001
From: Uzondu Enudeme <willpoint@gmail.com>
Date: Sun, 10 Mar 2019 05:27:40 +0100
Subject: [PATCH 31/96] scout doc: Update doc describing scout_fund_wallet
 function

---
 Scout.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/Scout.md b/Scout.md
index 8bab87d..f0f5201 100644
--- a/Scout.md
+++ b/Scout.md
@@ -294,3 +294,32 @@ Create a Stellar Wallet associated with a Scout.
 }
 ```
 
+## Fund a Scout Wallet
+
+Create a Stellar Wallet associated with a Scout.
+
+| Field               | Type   | Description                                                 |
+|---------------------|--------|-------------------------------------------------------------|
+| sourceStellarSeed   | string | A Stellar Issuing Account to provide at transaction fee     |
+| scoutRef            | string | A unique string to used to create a wallet for the scout    | 
+| versusCoinCredit    | string | VersusCoin amount formatted as a string to fund the wallet  | 
+
+> Endpoint: scout_fund_wallet
+
+> Payload
+
+```json
+{
+  "sourceStellarSeed": "SCY5QWUU7IGWGVUWYFSPBA2CAYQFYR63QALEIIX3ITYDPLV2AUIY6Q5S",
+  "scoutRef": "ea7ca901-9217-4a04-9af4-3c6c21ccc3a2",
+  "versusCoinCredit": "1.05"
+}
+```
+
+> Result
+
+```json
+{
+  "status": "ok"
+}
+```

From d0d0d9f05b658ca402dd5e1b5cc5ba47df273dc5 Mon Sep 17 00:00:00 2001
From: Uzondu Enudeme <willpoint@gmail.com>
Date: Thu, 4 Apr 2019 16:33:42 +0100
Subject: [PATCH 32/96] tixy: add doc to sign_up for and sign_in to an account

---
 Tixy.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)
 create mode 100644 Tixy.md

diff --git a/Tixy.md b/Tixy.md
new file mode 100644
index 0000000..7e22304
--- /dev/null
+++ b/Tixy.md
@@ -0,0 +1,54 @@
+# Tixy
+
+Endpoint for Tixy
+
+## Create an account (Sign up)
+
+> Endpoint: tixy_sign_up
+
+> Payload
+
+```json
+{
+    "email": "email",
+    "industry": "industry",
+    "password": "password",
+    "organizer": "organizer",
+    "website": "website"
+}
+```
+
+> Result
+
+```json
+{
+    "accountRef": "ea7ca901-9217-4a04-9af4-3c6c21ccc3a2"
+}
+```
+
+## Sign-in to an account
+
+> Endpoint: tixy_sign_in
+
+> Payload
+
+```json
+{
+    "email": "email",
+    "password": "password"
+}
+```
+> Result
+
+```json
+{
+    "account": {
+        "accountRef": "ea7ca901-9217-4a04-9af4-3c6c21ccc3a2",
+        "email": "email",
+        "industry": "industry",
+        "organizer": "organizer",
+        "website": "website",
+        "plan": ""
+    }
+}
+```

From 0830e305582e659c8e081e77d7dd04072d0ffe08 Mon Sep 17 00:00:00 2001
From: Robert John <securetorobert@protonmail.com>
Date: Mon, 22 Jul 2019 10:10:22 +0100
Subject: [PATCH 33/96] edited payload example for creating a scout

---
 Scout.md | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/Scout.md b/Scout.md
index f0f5201..ccae069 100644
--- a/Scout.md
+++ b/Scout.md
@@ -45,23 +45,23 @@ Add a scout - firstName, lastName and phoneNumber are required
 
 ``` javascript
 {
-    "firstName": "firstName",
-    "lastName": "lastName",
-    "phoneNumber": "phoneNumber",
-    "bankName": "bankName",
-    "bankCode": "bankCode",
-    "accountNumber": "accountNumber",
+    "firstName": "James",
+    "lastName": "Austin",
+    "phoneNumber": "+2347023004000",
+    "bankName": "Prudential",
+    "bankCode": "002",
+    "accountNumber": "10-2-200-5",
     "bvn": "bvn",
-    "emailAddress": "emailAddress",
-    "dob": "dob",
-    "gender": "gender",
+    "emailAddress": "a@test.com",
+    "dob": "2017-12-31",
+    "gender": "Female",
     "education": "education",
     "maritalStatus": "maritalStatus",
     "religion": "religion",
     "occupation": "occupation",
     "country": "country",
     "state": "state",
-    "language": "language"
+    "language": "English"
 }
 ```
 

From 131029c5e9b9dffcbdd96e1751264922d431f637 Mon Sep 17 00:00:00 2001
From: Robert John <securetorobert@protonmail.com>
Date: Wed, 7 Aug 2019 18:28:44 +0100
Subject: [PATCH 34/96] updated versus add question to show correct payload

---
 .idea/workspace.xml | 83 +++++++++++----------------------------------
 Clients.md          | 19 ++++++++---
 2 files changed, 34 insertions(+), 68 deletions(-)

diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index 6385067..ea3fdbb 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -11,44 +11,14 @@
     <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
     <option name="LAST_RESOLUTION" value="IGNORE" />
   </component>
-  <component name="FUSProjectUsageTrigger">
-    <session id="-394556569">
-      <usages-collector id="statistics.lifecycle.project">
-        <counts>
-          <entry key="project.open.time.1" value="1" />
-          <entry key="project.opened" value="1" />
-        </counts>
-      </usages-collector>
-      <usages-collector id="statistics.file.extensions.open">
-        <counts>
-          <entry key="md" value="1" />
-        </counts>
-      </usages-collector>
-      <usages-collector id="statistics.file.types.open">
-        <counts>
-          <entry key="Markdown" value="1" />
-        </counts>
-      </usages-collector>
-      <usages-collector id="statistics.file.extensions.edit">
-        <counts>
-          <entry key="md" value="377" />
-        </counts>
-      </usages-collector>
-      <usages-collector id="statistics.file.types.edit">
-        <counts>
-          <entry key="Markdown" value="377" />
-        </counts>
-      </usages-collector>
-    </session>
-  </component>
   <component name="FileEditorManager">
-    <leaf>
+    <leaf SIDE_TABS_SIZE_LIMIT_KEY="300">
       <file pinned="false" current-in-tab="true">
         <entry file="file://$PROJECT_DIR$/Scout.md">
           <provider selected="true" editor-type-id="split-provider[text-editor;markdown-preview-editor]">
             <state split_layout="SPLIT">
-              <first_editor relative-caret-position="225">
-                <caret line="15" column="13" lean-forward="true" selection-start-line="15" selection-start-column="13" selection-end-line="15" selection-end-column="13" />
+              <first_editor relative-caret-position="-5303">
+                <caret line="15" column="13" selection-start-line="15" selection-start-column="13" selection-end-line="15" selection-end-column="13" />
               </first_editor>
               <second_editor />
             </state>
@@ -67,29 +37,16 @@
       </list>
     </option>
   </component>
-  <component name="JsBuildToolGruntFileManager" detection-done="true" sorting="DEFINITION_ORDER" />
-  <component name="JsBuildToolPackageJson" detection-done="true" sorting="DEFINITION_ORDER">
-    <package-json value="$PROJECT_DIR$/package.json" />
-  </component>
-  <component name="JsGulpfileManager">
-    <detection-done>true</detection-done>
-    <sorting>DEFINITION_ORDER</sorting>
-  </component>
-  <component name="NodePackageJsonFileManager">
-    <packageJsonPaths>
-      <path value="$PROJECT_DIR$/package.json" />
-    </packageJsonPaths>
-  </component>
-  <component name="ProjectFrameBounds" extendedState="6" fullScreen="true">
+  <component name="ProjectFrameBounds">
+    <option name="y" value="23" />
     <option name="width" value="1440" />
-    <option name="height" value="900" />
+    <option name="height" value="830" />
   </component>
   <component name="ProjectView">
     <navigator proportions="" version="1">
       <foldersAlwaysOnTop value="true" />
     </navigator>
     <panes>
-      <pane id="Scope" />
       <pane id="ProjectPane">
         <subPane>
           <expand>
@@ -101,9 +58,11 @@
           <select />
         </subPane>
       </pane>
+      <pane id="Scope" />
     </panes>
   </component>
   <component name="PropertiesComponent">
+    <property name="SHARE_PROJECT_CONFIGURATION_FILES" value="true" />
     <property name="WebServerToolWindowFactoryState" value="false" />
     <property name="last_opened_file_path" value="$PROJECT_DIR$" />
     <property name="nodejs_interpreter_path.stuck_in_default_project" value="undefined stuck path" />
@@ -133,23 +92,20 @@
       <option name="presentableId" value="Default" />
       <updated>1548547114846</updated>
       <workItem from="1548547116126" duration="3497000" />
+      <workItem from="1564140296011" duration="250000" />
     </task>
     <servers />
   </component>
   <component name="TimeTrackingManager">
-    <option name="totallyTimeSpent" value="3497000" />
+    <option name="totallyTimeSpent" value="3747000" />
   </component>
   <component name="ToolWindowManager">
-    <frame x="0" y="0" width="1440" height="900" extended-state="6" />
+    <frame x="0" y="23" width="1440" height="830" extended-state="0" />
     <layout>
-      <window_info id="npm" side_tool="true" />
-      <window_info id="Favorites" side_tool="true" />
-      <window_info active="true" content_ui="combo" id="Project" order="0" visible="true" weight="0.24947146" />
+      <window_info content_ui="combo" id="Project" order="0" visible="true" weight="0.24947146" />
       <window_info id="Structure" order="1" side_tool="true" weight="0.25" />
-      <window_info anchor="bottom" id="Docker" show_stripe_button="false" />
-      <window_info anchor="bottom" id="Version Control" show_stripe_button="false" />
-      <window_info anchor="bottom" id="Terminal" visible="true" weight="0.44578314" />
-      <window_info anchor="bottom" id="Event Log" side_tool="true" />
+      <window_info id="npm" order="2" side_tool="true" />
+      <window_info id="Favorites" order="3" side_tool="true" />
       <window_info anchor="bottom" id="Message" order="0" />
       <window_info anchor="bottom" id="Find" order="1" />
       <window_info anchor="bottom" id="Run" order="2" />
@@ -157,6 +113,10 @@
       <window_info anchor="bottom" id="Cvs" order="4" weight="0.25" />
       <window_info anchor="bottom" id="Inspection" order="5" weight="0.4" />
       <window_info anchor="bottom" id="TODO" order="6" />
+      <window_info anchor="bottom" id="Docker" order="7" show_stripe_button="false" />
+      <window_info anchor="bottom" id="Version Control" order="8" show_stripe_button="false" />
+      <window_info anchor="bottom" id="Event Log" order="9" side_tool="true" />
+      <window_info active="true" anchor="bottom" id="Terminal" order="10" visible="true" weight="0.50138503" />
       <window_info anchor="right" id="Commander" internal_type="SLIDING" order="0" type="SLIDING" weight="0.4" />
       <window_info anchor="right" id="Ant Build" order="1" weight="0.25" />
       <window_info anchor="right" content_ui="combo" id="Hierarchy" order="2" weight="0.25" />
@@ -165,15 +125,12 @@
   <component name="TypeScriptGeneratedFilesManager">
     <option name="version" value="1" />
   </component>
-  <component name="VcsContentAnnotationSettings">
-    <option name="myLimit" value="2678400000" />
-  </component>
   <component name="editorHistoryManager">
     <entry file="file://$PROJECT_DIR$/Scout.md">
       <provider selected="true" editor-type-id="split-provider[text-editor;markdown-preview-editor]">
         <state split_layout="SPLIT">
-          <first_editor relative-caret-position="225">
-            <caret line="15" column="13" lean-forward="true" selection-start-line="15" selection-start-column="13" selection-end-line="15" selection-end-column="13" />
+          <first_editor relative-caret-position="-5303">
+            <caret line="15" column="13" selection-start-line="15" selection-start-column="13" selection-end-line="15" selection-end-column="13" />
           </first_editor>
           <second_editor />
         </state>
diff --git a/Clients.md b/Clients.md
index 496b108..4fe757c 100644
--- a/Clients.md
+++ b/Clients.md
@@ -98,19 +98,28 @@ This adds a question to a campaign.
 
 ``` javascript
 {
-  "docRef": "nqaXKB0SzWN6xh7RVyzl",
-  "question": "Please pick an option",
-  "options": "One, Two, Three"
+  "campaignRef": "86fea0f1-7c00-4ab7-bbc0-6125a4326125",
+  "question": "Test Question 1",
+  "options": "Positive, Neutral, Negative",
+  "campaignName":"Test Campaign 1",
+  "clientRef":"nqaXKB0SzWN6xh7RVyzl",
+  "clientName":"The Enterprise"
 }
 ```
 
 > Response
 
 ``` javascript
+
 {
   "question": {
-    "question": "Please pick an option",
-    "options": "One, Two, Three"
+    "question": "Test Question 1",
+    "options": "Positive, Neutral, Negative",
+    "campaignRef": "86fea0f1-7c00-4ab7-bbc0-6125a4326125",
+    "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+    "campaignName": "Test Campaign 1",
+    "clientName": "The Enterprise",
+    "questionRef": "0899c86d-cbf6-4490-872f-269dcedad05d"
   }
 }
 ```

From e363b5e6b2c38c8e7eed4cb57818194910625468 Mon Sep 17 00:00:00 2001
From: enterfive <dev@enterfive.com>
Date: Wed, 28 Aug 2019 13:41:29 +0100
Subject: [PATCH 35/96] Added link to tixy docs

---
 index.html | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/index.html b/index.html
index a5b3c90..7ce450b 100644
--- a/index.html
+++ b/index.html
@@ -49,7 +49,7 @@ <h5><span>Flatdoc</span></h5>
 
   <div class='header'>
     <div class='left'>
-      <h1><a href='.'>Flatdoc</a></h1>
+      <h1><a href='.'>Enterfive</a></h1>
       <ul>
         <li><a href='clients.html'>Clients</a></li>
         <li><a href='dashboard.html'>Dashboard</a></li>
@@ -58,6 +58,9 @@ <h1><a href='.'>Flatdoc</a></h1>
         <li><a href='reference.html'>API reference</a></li>
         <li><a href='scout.html'>Scouts</a></li>
       </ul>
+      <ul>
+        <li><a href='tixy.html'>Tixy</a></li>
+      </ul>
     </div>
     <div class='right'>
       <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;type=follow&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="170" height="20"></iframe>

From 97458430a170158b6b25d3e30095c681d06c96f6 Mon Sep 17 00:00:00 2001
From: Robert John <securetorobert@protonmail.com>
Date: Wed, 28 Aug 2019 13:42:25 +0100
Subject: [PATCH 36/96] added tixy.html

---
 tixy.html | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)
 create mode 100644 tixy.html

diff --git a/tixy.html b/tixy.html
new file mode 100644
index 0000000..e941838
--- /dev/null
+++ b/tixy.html
@@ -0,0 +1,55 @@
+<!doctype html>
+<html>
+<head>
+  <meta charset='utf-8'>
+  <meta http-equiv="X-UA-Compatible" content="chrome=1" />
+  <meta name="viewport" content="width=device-width">
+
+  <title>Flatdoc</title>
+
+  <!-- Flatdoc -->
+  <script src='support/vendor/jquery.js'></script>
+  <script src='legacy.js'></script>
+  <script src='flatdoc.js'></script>
+
+  <!-- Flatdoc theme -->
+  <link  href='theme-white/style.css' rel='stylesheet'>
+  <script src='theme-white/script.js'></script>
+  <link  href='support/theme.css' rel='stylesheet'>
+
+  <!-- Initializer -->
+  <script>
+    Flatdoc.run({
+      fetcher: Flatdoc.file('Profanity.md')
+    });
+  </script>
+</head>
+<body role='flatdoc'>
+
+    <div class='header'>
+        <div class='left'>
+          <h1><a href='.'>Flatdoc</a></h1>
+          <ul>
+            <li><a href='clients.html'>Clients</a></li>
+            <li><a href='dashboard.html'>Dashboard</a></li>
+            <li><a href='email.html'>Email Templates</a></li>
+            <li><a href='profanity.html'>Profanity Filter</a></li>
+            <li><a href='reference.html'>API reference</a></li>
+            <li><a href='scout.html'>Scouts</a></li>
+          </ul>
+        </div>
+        <div class='right'>
+          <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;type=follow&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="170" height="20"></iframe>
+          <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;repo=flatdoc&amp;type=watch&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe>
+        </div>
+      </div>
+
+  <div class='content-root'>
+    <div class='menubar'>
+      <div class='menu section' role='flatdoc-menu'></div>
+    </div>
+    <div role='flatdoc-content' class='content'></div>
+  </div>
+
+</body>
+</html>

From 33a4ee673d89ef5dae57fbe33289fbeaf700e94d Mon Sep 17 00:00:00 2001
From: enterfive <dev@enterfive.com>
Date: Wed, 28 Aug 2019 13:45:22 +0100
Subject: [PATCH 37/96] Updated file to point at Tixy.md

---
 tixy.html | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/tixy.html b/tixy.html
index e941838..172f3bd 100644
--- a/tixy.html
+++ b/tixy.html
@@ -5,7 +5,7 @@
   <meta http-equiv="X-UA-Compatible" content="chrome=1" />
   <meta name="viewport" content="width=device-width">
 
-  <title>Flatdoc</title>
+  <title>Enterfive Docs - Tixy</title>
 
   <!-- Flatdoc -->
   <script src='support/vendor/jquery.js'></script>
@@ -20,7 +20,7 @@
   <!-- Initializer -->
   <script>
     Flatdoc.run({
-      fetcher: Flatdoc.file('Profanity.md')
+      fetcher: Flatdoc.file('Tixy.md')
     });
   </script>
 </head>
@@ -28,7 +28,7 @@
 
     <div class='header'>
         <div class='left'>
-          <h1><a href='.'>Flatdoc</a></h1>
+          <h1><a href='.'>Enterfive</a></h1>
           <ul>
             <li><a href='clients.html'>Clients</a></li>
             <li><a href='dashboard.html'>Dashboard</a></li>
@@ -37,6 +37,9 @@ <h1><a href='.'>Flatdoc</a></h1>
             <li><a href='reference.html'>API reference</a></li>
             <li><a href='scout.html'>Scouts</a></li>
           </ul>
+          <ul>
+            <li><a href='tixy.html'>Tixy</a></li>
+          </ul>
         </div>
         <div class='right'>
           <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;type=follow&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="170" height="20"></iframe>

From 2f5e282b7e3d05ea605f394178c1cfbf0985b587 Mon Sep 17 00:00:00 2001
From: enterfive <dev@enterfive.com>
Date: Wed, 28 Aug 2019 13:46:39 +0100
Subject: [PATCH 38/96] Updated file to add reference to Tixy docs

---
 scout.html | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/scout.html b/scout.html
index a31c86a..6ff35f9 100644
--- a/scout.html
+++ b/scout.html
@@ -5,7 +5,7 @@
   <meta http-equiv="X-UA-Compatible" content="chrome=1" />
   <meta name="viewport" content="width=device-width">
 
-  <title>Flatdoc</title>
+  <title>Enterfive Docs - Scouts</title>
 
   <!-- Flatdoc -->
   <script src='support/vendor/jquery.js'></script>
@@ -28,7 +28,7 @@
 
     <div class='header'>
         <div class='left'>
-          <h1><a href='.'>Flatdoc</a></h1>
+          <h1><a href='.'>Enterfive</a></h1>
           <ul>
             <li><a href='clients.html'>Clients</a></li>
             <li><a href='dashboard.html'>Dashboard</a></li>
@@ -37,6 +37,9 @@ <h1><a href='.'>Flatdoc</a></h1>
             <li><a href='reference.html'>API reference</a></li>
             <li><a href='scout.html'>Scouts</a></li>
           </ul>
+          <ul>
+            <li><a href='tixy.html'>Tixy</a></li>
+          </ul>
         </div>
         <div class='right'>
           <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;type=follow&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="170" height="20"></iframe>

From dda40f4a60d73b1e46e01668d192259170b6b739 Mon Sep 17 00:00:00 2001
From: enterfive <dev@enterfive.com>
Date: Wed, 28 Aug 2019 13:51:18 +0100
Subject: [PATCH 39/96] Update reference.html

---
 reference.html | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/reference.html b/reference.html
index a9b8523..227fe80 100644
--- a/reference.html
+++ b/reference.html
@@ -5,7 +5,7 @@
   <meta http-equiv="X-UA-Compatible" content="chrome=1" />
   <meta name="viewport" content="width=device-width">
 
-  <title>Flatdoc</title>
+  <title>Enterfive Docs - API Reference</title>
 
   <!-- Flatdoc -->
   <script src='support/vendor/jquery.js'></script>
@@ -28,7 +28,7 @@
 
   <div class='header'>
     <div class='left'>
-      <h1><a href='.'>Flatdoc</a></h1>
+      <h1><a href='.'>Enterfive</a></h1>
       <ul>
         <li><a href='https://github.com/rstacruz/flatdoc'>View on Github</a></li>
         <li><a href='https://github.com/rstacruz/flatdoc/issues'>Issues</a></li>

From d992fa605b82115dbe04bd768bef9842884acfb2 Mon Sep 17 00:00:00 2001
From: enterfive <dev@enterfive.com>
Date: Wed, 28 Aug 2019 13:52:22 +0100
Subject: [PATCH 40/96] Update profanity.html

---
 profanity.html | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/profanity.html b/profanity.html
index e941838..3e225ee 100644
--- a/profanity.html
+++ b/profanity.html
@@ -5,7 +5,7 @@
   <meta http-equiv="X-UA-Compatible" content="chrome=1" />
   <meta name="viewport" content="width=device-width">
 
-  <title>Flatdoc</title>
+  <title>Enterfive Docs - Profanity</title>
 
   <!-- Flatdoc -->
   <script src='support/vendor/jquery.js'></script>
@@ -28,7 +28,7 @@
 
     <div class='header'>
         <div class='left'>
-          <h1><a href='.'>Flatdoc</a></h1>
+          <h1><a href='.'>Enterfive</a></h1>
           <ul>
             <li><a href='clients.html'>Clients</a></li>
             <li><a href='dashboard.html'>Dashboard</a></li>
@@ -37,6 +37,9 @@ <h1><a href='.'>Flatdoc</a></h1>
             <li><a href='reference.html'>API reference</a></li>
             <li><a href='scout.html'>Scouts</a></li>
           </ul>
+          <ul>
+            <li><a href='tixy.html'>Tixy</a></li>
+          </ul>
         </div>
         <div class='right'>
           <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;type=follow&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="170" height="20"></iframe>

From 43475e99b1908ad82b55a3691255f88f3ffe9b91 Mon Sep 17 00:00:00 2001
From: enterfive <dev@enterfive.com>
Date: Wed, 28 Aug 2019 13:53:31 +0100
Subject: [PATCH 41/96] Update index.html

---
 index.html | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/index.html b/index.html
index 7ce450b..2a8023a 100644
--- a/index.html
+++ b/index.html
@@ -5,7 +5,7 @@
   <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
   <meta name="viewport" content="width=device-width">
 
-  <title>Versus Flatdoc</title>
+  <title>Enterfive Docs</title>
 
   <!-- Flatdoc -->
   <script src='support/vendor/jquery.js'></script>
@@ -40,9 +40,9 @@
   <div class='title-area title-card' style='background-image: url(support/blur.jpg)'>
     <div class='in'>
       <div class='headline'>
-        <h1>Versus API Documentation.</h1>
+        <h1>Enterfive API Documentation.</h1>
         <p>.</p>
-        <h5><span>Flatdoc</span></h5>
+        <h5><span>Powered by Flatdoc</span></h5>
       </div>
     </div>
   </div>

From 3a6dcbfffd19fab806a9f15872883cfaae0e5a8f Mon Sep 17 00:00:00 2001
From: enterfive <dev@enterfive.com>
Date: Wed, 28 Aug 2019 13:56:26 +0100
Subject: [PATCH 42/96] Update email.html

---
 email.html | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/email.html b/email.html
index 8e8bae4..1fb443b 100644
--- a/email.html
+++ b/email.html
@@ -5,7 +5,7 @@
   <meta http-equiv="X-UA-Compatible" content="chrome=1" />
   <meta name="viewport" content="width=device-width">
 
-  <title>Flatdoc</title>
+  <title>Enterfive Docs - Email</title>
 
   <!-- Flatdoc -->
   <script src='support/vendor/jquery.js'></script>
@@ -37,6 +37,9 @@ <h1><a href='.'>Flatdoc</a></h1>
             <li><a href='reference.html'>API reference</a></li>
             <li><a href='scout.html'>Scouts</a></li>
           </ul>
+          <ul>
+            <li><a href='tixy.html'>Tixy</a></li>
+          </ul>
         </div>
         <div class='right'>
           <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;type=follow&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="170" height="20"></iframe>

From 254c281965dbbb11f3206fc0d3ead23de0e4c3f4 Mon Sep 17 00:00:00 2001
From: enterfive <dev@enterfive.com>
Date: Wed, 28 Aug 2019 13:57:24 +0100
Subject: [PATCH 43/96] Update dashboard.html

---
 dashboard.html | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/dashboard.html b/dashboard.html
index 684a2b5..0cc2949 100644
--- a/dashboard.html
+++ b/dashboard.html
@@ -5,7 +5,7 @@
   <meta http-equiv="X-UA-Compatible" content="chrome=1" />
   <meta name="viewport" content="width=device-width">
 
-  <title>Flatdoc</title>
+  <title>Enterfive Docs - Dashboard</title>
 
   <!-- Flatdoc -->
   <script src='support/vendor/jquery.js'></script>
@@ -28,7 +28,7 @@
 
   <div class='header'>
     <div class='left'>
-      <h1><a href='.'>Flatdoc</a></h1>
+      <h1><a href='.'>Enterfive</a></h1>
       <ul>
         <li><a href='clients.html'>Clients</a></li>
         <li><a href='dashboard.html'>Dashboard</a></li>
@@ -37,6 +37,9 @@ <h1><a href='.'>Flatdoc</a></h1>
         <li><a href='reference.html'>API reference</a></li>
         <li><a href='scout.html'>Scouts</a></li>
       </ul>
+      <ul>
+        <li><a href='tixy.html'>Tixy</a></li>
+      </ul>
     </div>
     <div class='right'>
       <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;type=follow&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="170" height="20"></iframe>

From 4bff871f2df7229b4eecffe79977e54675ad4675 Mon Sep 17 00:00:00 2001
From: enterfive <dev@enterfive.com>
Date: Wed, 28 Aug 2019 13:57:51 +0100
Subject: [PATCH 44/96] Update email.html

---
 email.html | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/email.html b/email.html
index 1fb443b..c651907 100644
--- a/email.html
+++ b/email.html
@@ -28,7 +28,7 @@
 
     <div class='header'>
         <div class='left'>
-          <h1><a href='.'>Flatdoc</a></h1>
+          <h1><a href='.'>Enterfive</a></h1>
           <ul>
             <li><a href='clients.html'>Clients</a></li>
             <li><a href='dashboard.html'>Dashboard</a></li>

From b607ec094347d4563e57114c6f00e053d145c69f Mon Sep 17 00:00:00 2001
From: enterfive <dev@enterfive.com>
Date: Wed, 28 Aug 2019 13:58:30 +0100
Subject: [PATCH 45/96] Update clients.html

---
 clients.html | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/clients.html b/clients.html
index 64e97a6..7c06a26 100644
--- a/clients.html
+++ b/clients.html
@@ -5,7 +5,7 @@
   <meta http-equiv="X-UA-Compatible" content="chrome=1" />
   <meta name="viewport" content="width=device-width">
 
-  <title>Flatdoc</title>
+  <title>Enterfive Docs - Clients</title>
 
   <!-- Flatdoc -->
   <script src='support/vendor/jquery.js'></script>
@@ -28,7 +28,7 @@
 
   <div class='header'>
     <div class='left'>
-      <h1><a href='.'>Flatdoc</a></h1>
+      <h1><a href='.'>Enterfive</a></h1>
       <ul>
         <li><a href='clients.html'>Clients</a></li>
         <li><a href='dashboard.html'>Dashboard</a></li>
@@ -37,6 +37,9 @@ <h1><a href='.'>Flatdoc</a></h1>
         <li><a href='reference.html'>API reference</a></li>
         <li><a href='scout.html'>Scouts</a></li>
       </ul>
+      <ul>
+        <li><a href='tixy.html'>Tixy</a></li>
+      </ul>
     </div>
     <div class='right'>
       <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;type=follow&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="170" height="20"></iframe>

From ca0ed7fc68887f266801b39e924e9cb428e70f24 Mon Sep 17 00:00:00 2001
From: enterfive <dev@enterfive.com>
Date: Wed, 28 Aug 2019 14:00:31 +0100
Subject: [PATCH 46/96] Update Readme.md

---
 Readme.md | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/Readme.md b/Readme.md
index 14bec9e..ece6519 100644
--- a/Readme.md
+++ b/Readme.md
@@ -117,6 +117,11 @@ This has functions required for scouts to interact with campaigns:
 
 * Get Scout
 
+# Tixy API Endpoints
+
+This documentation lists the API endpoints required for engineers on the Tixy team to interface with Tixy Backend. The API endpoints are generally grouped into the following.
+* To-do: edit the bullet points for Tixy docs
+
 # Getting started
 
 All endpoints are REST. The default method is POST unless otherwise specified. There is a base URL to which you will need to append the endpoint.

From d1dba178e5c57eeca080a4a5a1da27d71f6d1539 Mon Sep 17 00:00:00 2001
From: munnyraht <muniratsulaimon@gmail.com>
Date: Tue, 10 Sep 2019 17:32:02 +0100
Subject: [PATCH 47/96] exposed more endpoint on tixy2.0

---
 Tixy.md | 257 +++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 256 insertions(+), 1 deletion(-)

diff --git a/Tixy.md b/Tixy.md
index 7e22304..88e8f40 100644
--- a/Tixy.md
+++ b/Tixy.md
@@ -4,7 +4,7 @@ Endpoint for Tixy
 
 ## Create an account (Sign up)
 
-> Endpoint: tixy_sign_up
+> Endpoint: tixy_register
 
 > Payload
 
@@ -51,4 +51,259 @@ Endpoint for Tixy
         "plan": ""
     }
 }
+
+```
+## get_event_by_email (Retreive event)
+
+> Endpoint: get_events_by_email.py
+
+> Payload
+
+```json
+{
+    "email": "email",
+}
+```
+
+> Result
+
+```json
+
+{
+    "event1": {"event_id": 1, 
+                "event_name": "event_name", 
+                "event_tag": "event_tag",
+                "start_date": "2019-12-02T12:30:30.001Z", 
+                "end_date": "2019-05-04T12:30:30.001Z", 
+                "username": "username", 
+                "no_tickets_sold": 12,
+                "revenue": 36000, 
+                "status": "status"},
+    "event2": {"event_id": 2, 
+                "event_name": "Slay Festival", 
+                "event_tag": "Slay", 
+                "start_date": "2019-01-24T12:30:30.001Z",
+                "end_date": "2019-05-04T12:30:30.001Z", 
+                "username": "username", 
+                "no_tickets_sold": 62,
+                "revenue": 186000, 
+                "status": "status"},
+
+}
+```
+
+## get_events_by_status (Retreive event)
+
+> Endpoint: get_events_by_status.py
+
+> Payload
+
+```json
+{
+    "username": "username", "status":"status"
+}
+```
+
+> Result
+
+```json
+
+{
+    "event1": {"event_id": 1, 
+                "event_name": "event_name", 
+                "event_tag": "event_tag",
+                "start_date": "2019-12-02T12:30:30.001Z", 
+                "end_date": "2019-05-04T12:30:30.001Z", 
+                "username": "username", 
+                "no_tickets_sold": 12,
+                "revenue": 36000, 
+                "status": "status"},
+    "event2": {"event_id": 2, 
+                "event_name": "Slay Festival", 
+                "event_tag": "Slay", 
+                "start_date": "2019-01-24T12:30:30.001Z",
+                "end_date": "2019-05-04T12:30:30.001Z", 
+                "username": "username", 
+                "no_tickets_sold": 62,
+                "revenue": 186000, 
+                "status": "status"},
+
+}
+```
+
+## get_events_by_tag (Retreive event)
+
+> Endpoint: get_events_by_tag.py
+
+> Payload
+
+```json
+{
+    "username": "username", "tag":"tag"
+}
+```
+
+> Result
+
+```json
+
+{
+    "event1": {"event_id": 1, 
+                "event_name": "event_name", 
+                "event_tag": "event_tag",
+                "start_date": "2019-12-02T12:30:30.001Z", 
+                "end_date": "2019-05-04T12:30:30.001Z", 
+                "username": "username", 
+                "no_tickets_sold": 12,
+                "revenue": 36000, 
+                "status": "status"},
+    "event2": {"event_id": 2, 
+                "event_name": "Slay Festival", 
+                "event_tag": "Slay", 
+                "start_date": "2019-01-24T12:30:30.001Z",
+                "end_date": "2019-05-04T12:30:30.001Z", 
+                "username": "username", 
+                "no_tickets_sold": 62,
+                "revenue": 186000, 
+                "status": "status"},
+
+}
+```
+
+## get_no_of_sold_tickets (Retreive the number of ticket sold over a specified period of time)
+
+> Endpoint: get_no_of_sold_tickets.py
+
+> Payload
+
+```json
+{
+    "username": "username", "period":"period"
+}
+```
+
+> Result
+
+```json
+
+{"number_of_tickets_sold": "number_of_tickets_sold"}
+```
+
+## get_total_revenue (Retreive the amount of revenue made over a specified period of time)
+
+> Endpoint: get_no_of_sold_tickets.py
+
+> Payload
+
+```json
+{
+    "username": "username", "period":"period"
+}
+```
+
+> Result
+
+```json
+
+{"total_revenue":"total_revenue"}
 ```
+
+## get_recent_purchases_by_email (Retreive top 10 tickets purchase records)
+
+> Endpoint: get_recent_purchases_by_email.py
+
+> Payload
+
+```json
+{
+    "email": "email"
+}
+```
+
+> Result
+
+```json
+
+
+{
+    "event1": 
+        {"ticket_buyer_name": "David", 
+        "amount": 24000, 
+        "event_name": "Teker Expo", 
+        "purchase_date": "2019-05-04T12:30:30.001Z"}, 
+    "event2": 
+        {"ticket_buyer_name": "David",
+         "amount": 6000,
+         "event_name": "Teker Expo", 
+         "purchase_date": "2019-05-04T12:30:30.001Z"} 
+
+```
+
+## create_event (create a new event)
+
+> Endpoint: create_event.py
+
+> Payload
+
+```json
+{
+    "username":"username",
+    "event_name":"event_name",
+    "event_tag":"event_tag",
+    "description":"description",
+    "start_date":"start_date",
+    "end_date":"end_date"
+}
+```
+
+> Result
+
+```json
+{   "event_ref":"event_ref",
+    "username":"username",
+   "event_name":"event_name",
+   "event_tag":"event_tag",
+   "description":"description",
+   "start_date":"start_date",
+   "end_date":"end_date"    
+
+   } 
+
+```
+
+## edit_user_info (Retreive top 10 tickets purchase records)
+
+> Endpoint: create_event.py
+
+> Payload
+
+```json
+{
+    "event_name":"event_name",
+    "event_tag":"event_tag",
+    "description":"description",
+    "start_date":"start_date",
+    "email":"email",
+    "end_date":"end_date",
+    "twitter_link":"twitter_link",
+    "facebook_link":"facebook_link"
+}
+```
+
+> Result
+
+```json
+{   "event_ref":"event_ref",
+   "event_name":"event_name",
+   "event_tag":"event_tag",
+   "description":"description",
+   "email":"email",
+   "description":"description",
+   "start_date":"start_date",
+   "end_date":"end_date",
+   "twitter_link":"twitter_link",
+    "facebook_link":"facebook_link"   
+
+   } 
+
+```
\ No newline at end of file

From 64ae355bd41746062d5d3b92cdadcc9c6b2cb67d Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Tue, 8 Oct 2019 12:02:53 +0100
Subject: [PATCH 48/96] Cashout actions

Added documentation for the following scout actions:
* scout_get_banks
* scout_convert_amount
* scout_verify_account_number
* scout_cashout
---
 Scout.md | 157 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 157 insertions(+)

diff --git a/Scout.md b/Scout.md
index ccae069..87d0a72 100644
--- a/Scout.md
+++ b/Scout.md
@@ -323,3 +323,160 @@ Create a Stellar Wallet associated with a Scout.
   "status": "ok"
 }
 ```
+
+## Get Banks
+
+Get a list of banks supported by cashout in Nigeria
+
+
+> Endpoint: scout_get_banks
+
+> Payload
+
+``` javascript
+{
+  "authstring": "authentication string"
+}
+```
+
+> Result
+``` javascript
+{
+  "msg":"Successfully obtained banks list",
+  "banks":[
+    {"name":"Access Bank",
+    "slug":"access-bank",
+    "code":"044",
+    "longcode":"044150149",
+    "gateway":"emandate",
+    "pay_with_bank":false,
+    "active":true,
+    "is_deleted":null,
+    "country":"Nigeria",
+    "currency":"NGN",
+    "type":"nuban",
+    "id":1,
+    "createdAt":"2016-07-14T10:04:29.000Z",
+    "updatedAt":"2019-06-18T10:52:46.000Z"
+    }
+    .
+    .
+    .
+  ]
+}
+```
+
+## Convert Scout Credits
+
+Convert scout credits to amount in local currency
+
+
+> Endpoint: scout_convert_amount
+
+> Payload
+
+``` javascript
+{
+  "authstring": "authentication string",
+  "amount": "scout credits to be converted",
+  "country": "Two letter alpha-2 ISO code of country for which credit amount is to be converted e.g 'NG'"
+}
+```
+
+> Result
+``` javascript
+
+{
+  "message":
+  "Successfully converted scout credit",
+  "convertedAmount":1628,
+  "currency":"NGN"
+}
+```
+
+## Verify Account Number
+
+Verify that scout bank account number is correct and can recieve funds
+
+> Endpoint: scout_verify_account_number
+
+> Payload
+
+``` javascript
+{
+  "authstring": "authentication string",
+  "accountNumber": "bank account number",
+  "bankCode": "bank code - returned from scout_getbanks",
+  "bankName": "name of bank - returned from scout_getbanks",
+  "phoneNumber": "scount phone number"
+}
+```
+
+> Result
+``` javascript
+{
+  "message":"Sucessfully verified account number",
+  "account": {
+    "account_number":"1234567890",
+    "account_name":"JOHN DOE"
+  }
+}
+```
+
+## Verify Account Number
+
+Verify that scout bank account number is correct and can recieve funds
+
+> Endpoint: scout_verify_account_number
+
+> Payload
+
+``` javascript
+{
+  "authstring": "authentication string",
+  "accountNumber": "bank account number",
+  "bankCode": "bank code - returned from scout_getbanks",
+  "bankName": "name of bank - returned from scout_getbanks",
+  "phoneNumber": "scount phone number"
+}
+```
+
+> Result
+``` javascript
+{
+  "message":"Sucessfully verified account number",
+  "account": {
+    "account_number":"1234567890",
+    "account_name":"JOHN DOE"
+  }
+}
+```
+
+## Cashout
+
+Cashout scout credits to local currency
+
+> Endpoint: scout_cashout
+
+> Payload
+
+``` javascript
+{
+  "authstring": "authentication string",
+  "accountNumber": "bank account number",
+  "amount": "credit amount to be cashed out",
+  "country": "NG",
+  "phoneNumber": "+2348045634567"
+}
+```
+
+> Result
+``` javascript
+{
+  "message":"Successfully transferred money to recipient",
+  "credits":"50",
+  "amount":2714,
+  "currency":"NGN",
+  "referenceNumber":"b96f5fc7-722b-4f9e-bf81-a114d45f8dc6"
+}
+```
\ No newline at end of file

From c6351d5fcda1e33aad7bb469a3f97b113e3e601d Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Tue, 8 Oct 2019 14:54:02 +0100
Subject: [PATCH 49/96] Destructure result object

---
 Scout.md | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

diff --git a/Scout.md b/Scout.md
index 87d0a72..99d1944 100644
--- a/Scout.md
+++ b/Scout.md
@@ -416,10 +416,8 @@ Verify that scout bank account number is correct and can recieve funds
 ``` javascript
 {
   "message":"Sucessfully verified account number",
-  "account": {
-    "account_number":"1234567890",
-    "account_name":"JOHN DOE"
-  }
+  "accountNumber":"1234567890",
+  "accountName":"JOHN DOE"
 }
 ```
 

From bd51d039e1ddbc59955c5299874ef3e7ae16f665 Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Tue, 2 Jun 2020 10:19:27 +0100
Subject: [PATCH 50/96] Added 2.0 title

---
 Readme.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/Readme.md b/Readme.md
index ece6519..977f3dc 100644
--- a/Readme.md
+++ b/Readme.md
@@ -122,6 +122,14 @@ This has functions required for scouts to interact with campaigns:
 This documentation lists the API endpoints required for engineers on the Tixy team to interface with Tixy Backend. The API endpoints are generally grouped into the following.
 * To-do: edit the bullet points for Tixy docs
 
+# Versus-2.0 API Endpoints
+
+This documentation lists the API endpoints required for engineers on the Versus team to interface with Versus-2.0 Backend. The API endpoints are generally grouped into the following.
+
+* Scouts
+
+* Dashboard
+
 # Getting started
 
 All endpoints are REST. The default method is POST unless otherwise specified. There is a base URL to which you will need to append the endpoint.

From b3fbe6da60308f26f7959c3ada005c6cc4095336 Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Tue, 2 Jun 2020 10:49:19 +0100
Subject: [PATCH 51/96] Added menu content

For easy access via tabs
---
 Versus-2.0.md   |  0
 index.html      |  6 +++--
 versus-2.0.html | 62 +++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 66 insertions(+), 2 deletions(-)
 create mode 100644 Versus-2.0.md
 create mode 100644 versus-2.0.html

diff --git a/Versus-2.0.md b/Versus-2.0.md
new file mode 100644
index 0000000..e69de29
diff --git a/index.html b/index.html
index 2a8023a..5066152 100644
--- a/index.html
+++ b/index.html
@@ -57,10 +57,12 @@ <h1><a href='.'>Enterfive</a></h1>
         <li><a href='profanity.html'>Profanity Filter</a></li>
         <li><a href='reference.html'>API reference</a></li>
         <li><a href='scout.html'>Scouts</a></li>
-      </ul>
-      <ul>
         <li><a href='tixy.html'>Tixy</a></li>
+        <li><a href='versus-2.0.html'>Versus-2.0</a></li>
       </ul>
+      <!-- <ul>
+        <li><a href='tixy.html'>Tixy</a></li>
+      </ul> -->
     </div>
     <div class='right'>
       <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;type=follow&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="170" height="20"></iframe>
diff --git a/versus-2.0.html b/versus-2.0.html
new file mode 100644
index 0000000..0bde1fc
--- /dev/null
+++ b/versus-2.0.html
@@ -0,0 +1,62 @@
+<!doctype html>
+<html>
+
+  <head>
+    <meta charset='utf-8'>
+    <meta http-equiv="X-UA-Compatible" content="chrome=1" />
+    <meta name="viewport" content="width=device-width">
+
+    <title>Enterfive Docs - Versus-2.0</title>
+
+    <!-- Flatdoc -->
+    <script src='support/vendor/jquery.js'></script>
+    <script src='legacy.js'></script>
+    <script src='flatdoc.js'></script>
+
+    <!-- Flatdoc theme -->
+    <link href='theme-white/style.css' rel='stylesheet'>
+    <script src='theme-white/script.js'></script>
+    <link href='support/theme.css' rel='stylesheet'>
+
+    <!-- Initializer -->
+    <script>
+      Flatdoc.run({
+        fetcher: Flatdoc.file('Versus-2.0.md')
+      });
+    </script>
+  </head>
+
+  <body role='flatdoc'>
+
+    <div class='header'>
+      <div class='left'>
+        <h1><a href='.'>Enterfive</a></h1>
+        <ul>
+          <li><a href='clients.html'>Clients</a></li>
+          <li><a href='dashboard.html'>Dashboard</a></li>
+          <li><a href='email.html'>Email Templates</a></li>
+          <li><a href='profanity.html'>Profanity Filter</a></li>
+          <li><a href='reference.html'>API reference</a></li>
+          <li><a href='scout.html'>Scouts</a></li>
+          <li><a href='tixy.html'>Tixy</a></li>
+          <li><a href='versus-2.0.html'>Versus-2.0</a></li>
+        </ul>
+      </div>
+      <div class='right'>
+        <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;type=follow&amp;count=true"
+          allowtransparency="true" frameborder="0" scrolling="0" width="170" height="20"></iframe>
+        <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;repo=flatdoc&amp;type=watch&amp;count=true"
+          allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe>
+      </div>
+    </div>
+
+    <div class='content-root'>
+      <div class='menubar'>
+        <div class='menu section' role='flatdoc-menu'></div>
+      </div>
+      <div role='flatdoc-content' class='content'></div>
+    </div>
+
+  </body>
+
+</html>
\ No newline at end of file

From 0b27054cc66e8d9237351254ef842933ce6ad893 Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Tue, 2 Jun 2020 12:19:39 +0100
Subject: [PATCH 52/96] Added first scout API

---
 Versus-2.0.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/Versus-2.0.md b/Versus-2.0.md
index e69de29..dbf33ba 100644
--- a/Versus-2.0.md
+++ b/Versus-2.0.md
@@ -0,0 +1,37 @@
+# Scout
+
+This has endpoints for managing scout actions that are unique to Versus 2.0. For other actions refer to v1 docs. 
+
+## End Campaign
+
+This is called after a scout has answered all campaign questions. It calculates the credits earned and adds it to respective scout account.
+
+> Endpoint: scout_end_campaign
+
+> Payload
+
+``` json
+{
+  "phoneNumber": "+2348123456789",
+  "campaignRef": "47b73826-e9b2-412f-b8b4-c055eeec778b",
+  "authstring": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a"
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully submitted survey and credited scout",
+  "credits": 12,
+  "campaignRef": "47b73826-e9b2-412f-b8b4-c055eeec778b"
+  }
+}
+```
+
+> Errors
+
+* 401 - Failed authentication. Authstring invalid or not found in request body
+* 403 - Missing required parameters
+* 404 - Scout does not exist
+* 500 - Backend service error
\ No newline at end of file

From 08589c6cdca39716645ac2f064d343fa864096f0 Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Tue, 2 Jun 2020 12:22:20 +0100
Subject: [PATCH 53/96] fix errors

---
 Versus-2.0.md | 1 -
 1 file changed, 1 deletion(-)

diff --git a/Versus-2.0.md b/Versus-2.0.md
index dbf33ba..dc4f210 100644
--- a/Versus-2.0.md
+++ b/Versus-2.0.md
@@ -30,7 +30,6 @@ This is called after a scout has answered all campaign questions. It calculates
 ```
 
 > Errors
-
 * 401 - Failed authentication. Authstring invalid or not found in request body
 * 403 - Missing required parameters
 * 404 - Scout does not exist

From a0b1bed9f16d2a32834351db9e9ffa000b19b88a Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Tue, 2 Jun 2020 12:24:35 +0100
Subject: [PATCH 54/96] fix errors

---
 Versus-2.0.md | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/Versus-2.0.md b/Versus-2.0.md
index dc4f210..48ebb66 100644
--- a/Versus-2.0.md
+++ b/Versus-2.0.md
@@ -30,7 +30,10 @@ This is called after a scout has answered all campaign questions. It calculates
 ```
 
 > Errors
+
+```
 * 401 - Failed authentication. Authstring invalid or not found in request body
 * 403 - Missing required parameters
 * 404 - Scout does not exist
-* 500 - Backend service error
\ No newline at end of file
+* 500 - Backend service error
+```
\ No newline at end of file

From 7137c6cbe17976f5a0461ce124ffd89d02e29759 Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Tue, 2 Jun 2020 12:26:57 +0100
Subject: [PATCH 55/96] fix errors

---
 Versus-2.0.md | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/Versus-2.0.md b/Versus-2.0.md
index 48ebb66..dbf33ba 100644
--- a/Versus-2.0.md
+++ b/Versus-2.0.md
@@ -31,9 +31,7 @@ This is called after a scout has answered all campaign questions. It calculates
 
 > Errors
 
-```
 * 401 - Failed authentication. Authstring invalid or not found in request body
 * 403 - Missing required parameters
 * 404 - Scout does not exist
-* 500 - Backend service error
-```
\ No newline at end of file
+* 500 - Backend service error
\ No newline at end of file

From c89998a2699b0198aa74d80bcdec33336b176948 Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Wed, 3 Jun 2020 05:58:01 +0100
Subject: [PATCH 56/96] Added v2 scout endpoints

---
 Versus-2.0.md | 269 +++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 267 insertions(+), 2 deletions(-)

diff --git a/Versus-2.0.md b/Versus-2.0.md
index dbf33ba..37a653c 100644
--- a/Versus-2.0.md
+++ b/Versus-2.0.md
@@ -25,7 +25,6 @@ This is called after a scout has answered all campaign questions. It calculates
   "message": "Successfully submitted survey and credited scout",
   "credits": 12,
   "campaignRef": "47b73826-e9b2-412f-b8b4-c055eeec778b"
-  }
 }
 ```
 
@@ -34,4 +33,270 @@ This is called after a scout has answered all campaign questions. It calculates
 * 401 - Failed authentication. Authstring invalid or not found in request body
 * 403 - Missing required parameters
 * 404 - Scout does not exist
-* 500 - Backend service error
\ No newline at end of file
+* 500 - Backend service error
+
+## Get Campaigns
+
+To obtain campaigns that match a scout's demographic.
+
+> Endpoint: scout_get_campaigns
+
+> Payload
+
+``` json
+{
+  "phoneNumber": "+2348123456789"
+}
+```
+
+> Response
+
+``` json
+{
+  "campaigns": [
+    {
+      "description": "Let’s get you started with a simple demographics survey! This will help us send you surveys that are more appropriate for you.",
+      "endDate": 2571212464693,
+      "startDate": 1546300800,
+      "campaignName": "Demographics Survey",
+      "isDemographicSurvey": true,
+      "campaignRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
+      "country": "NG",
+      "clientName": "The Enterprise",
+      "clientRef": "nqaXKB0SzWN6xh7RVyzlzl",
+      "endAge": 65,
+      "startAge": 16
+    }
+  ]
+}
+```
+
+> Errors
+
+* 403 - Missing required parameters
+* 404 - Scout does not exist
+* 500 - Backend service error
+
+## Get Partners
+
+Get current scout partners.
+
+> Endpoint: scout_get_partners
+
+> Payload
+
+``` json
+{
+  "authstring": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a"
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully obtained scout partners",
+  "scoutPartners": [
+    {
+        "scoutPartnerRef": "33c514f8-3484-4646-a0b3-6be4a5957248",
+        "name": "Facebook"
+    },
+    {
+        "name": "Catch them Young Nigeria (Next Digital Talent)",
+        "scoutPartnerRef": "4e18e782-e873-4832-879d-97b288a9e85b"
+    },
+    {
+        "scoutPartnerRef": "86f52918-4987-4c0b-a71d-37ab743bc58d",
+        "name": "West Africa Vocational Education (WAVE)"
+    },
+    {
+        "scoutPartnerRef": "a25b5ac8-3e17-4e35-9ce8-f534e89b4e02",
+        "name": "Instagram"
+    },
+    {
+        "scoutPartnerRef": "af8ed4cf-974c-4b69-9663-3c115594655f",
+        "name": "She Leads Africa"
+    },
+    {
+        "scoutPartnerRef": "d3c48853-eda9-45d6-b127-4d3f66dcb975",
+        "name": "Twitter"
+    },
+    {
+        "name": "GIEVA",
+        "scoutPartnerRef": "f572e8a0-7526-41df-962b-1fb20ad7baa1"
+    }
+  ]
+}
+```
+
+> Errors
+
+* 400 - Missing authstring in request body
+* 401 - Failed authentication. Invalid authstring
+* 500 - Backend service error
+
+## Convert Amount
+
+Convert scout credit amount to equivalent cash.
+
+> Endpoint: scout_convert_amount
+
+> Payload
+
+``` json
+{
+  "amount": 200,
+  "country": "NG",
+  "authstring": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a"
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully converted scout credit",
+  "convertedAmount": 10800,
+  "currency": "NGN"
+  }
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - Failed authentication. Authstring invalid or not found in request body
+* 500 - Backend service error
+
+## Verify Account Number
+
+This endpoint verifies scout bank account number and creates a Paystack recipient ready for transfer of funds.
+
+> Endpoint: scout_verify_account_number
+
+> Payload
+
+``` json
+{
+  "phoneNumber": "+2348123456789",
+  "accountNumber": "0123456789",
+  "bankCode": "026",
+  "bankName": "ZENITH",
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Sucessfully verified account number",
+  "accountName": "XAVIER STAN",
+  "accountNumber": "0123456789"
+  }
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters || other errors
+* 401 - Failed authentication. Authstring invalid or not found in request body
+* 500 - Backend service error
+
+## Cashout
+
+Initiate transfer of funds to scout bank account.
+
+> Endpoint: scout_cashout
+
+> Payload
+
+``` json
+{
+  "phoneNumber": "+2348123456789",
+  "amount": 1000,
+  "accountNumber": "01234567890",
+  "country": "NG",
+  "authstring": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a"
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully transferred money to recipient",
+  "credits": 12,
+  "amount": 1000,
+  "currency": "NGN",
+  "referenceNumber": "t_c7c53f113d5ac7c53f113d5a"
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters || other errors
+* 401 - Failed authentication. Authstring invalid or not found in request body
+* 404 - Scout does not exist
+* 500 - Backend service error
+
+## Get Banks
+
+Obtain a list of banks with their codes.
+
+> Endpoint: scout_get_banks
+
+> Payload
+
+``` json
+{
+  "authstring": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a"
+}
+```
+
+> Response
+
+``` json
+{
+  "msg": "Successfully obtained banks list",
+  "banks": [
+    {
+      "name": "Access Bank",
+      "slug": "access-bank",
+      "code": "044",
+      "longcode": "044150149",
+      "gateway": "emandate",
+      "pay_with_bank": false,
+      "active": true,
+      "is_deleted": null,
+      "country": "Nigeria",
+      "currency": "NGN",
+      "type": "nuban",
+      "id": 1,
+      "createdAt": "2016-07-14T10:04:29.000Z",
+      "updatedAt": "2020-02-18T08:06:44.000Z"
+  },
+  {
+      "name": "Access Bank (Diamond)",
+      "slug": "access-bank-diamond",
+      "code": "063",
+      "longcode": "063150162",
+      "gateway": "emandate",
+      "pay_with_bank": false,
+      "active": true,
+      "is_deleted": null,
+      "country": "Nigeria",
+      "currency": "NGN",
+      "type": "nuban",
+      "id": 3,
+      "createdAt": "2016-07-14T10:04:29.000Z",
+      "updatedAt": "2020-02-18T08:06:48.000Z"
+    },
+  ]
+  }
+}
+```
+
+> Errors
+
+* 401 - Failed authentication. Authstring invalid or not found in request body
+* 500 - Backend service error

From cd2ab63776f3b51ca0ec25bd0db438dd9b0b658e Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Mon, 8 Jun 2020 04:00:35 +0100
Subject: [PATCH 57/96] Document dashboard endpoints

Added all endpoint called by dashboard
---
 Versus-2.0.md | 1189 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 1189 insertions(+)

diff --git a/Versus-2.0.md b/Versus-2.0.md
index 37a653c..769d865 100644
--- a/Versus-2.0.md
+++ b/Versus-2.0.md
@@ -300,3 +300,1192 @@ Obtain a list of banks with their codes.
 
 * 401 - Failed authentication. Authstring invalid or not found in request body
 * 500 - Backend service error
+
+# Dashboard
+
+These are endpoints called by v2.0 dashbboard components. 
+
+## Add Campaign
+
+Add a new campaign
+
+> Endpoint: versus_v2_add_campaign
+
+> Payload
+
+``` json
+{
+  "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+  "uid": "bfbbc055eeec778b",
+  "idToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a.13238bee-3ac9-4c77-b3b1-c7c53f113d5a",
+  "description": "Let’s get you started with a simple demographics survey! This will help us send you surveys that are more appropriate for you.",
+  "endDate": 2571212464693,
+  "startDate": 1546300800,
+  "campaignName": "Demographics Survey",
+  "isDemographicSurvey": true,
+  "campaignRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
+  "country": "NG",
+  "stateOrRegion": "Lagos",
+  "endAge": 65,
+  "startAge": 16,
+  "gender": "female",
+  "numberOfRespondents": 500
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully added new client campaign",
+  "campaignRef": "47b73826-e9b2-412f-b8b4-c055eeec778b"
+}
+```
+
+> Errors
+
+* 401 - User is not authorized to make this request || Error authenticating user
+* 402 - Insufficient versus credit balance
+* 403 - Missing required parameters
+* 404 - Client does not exist
+* 500 - Backend service error
+
+## Add Client
+
+Add a new client on signup
+
+> Endpoint: versus_v2_add_client
+
+> Payload
+
+``` json
+{
+  "email": "abc@def.ghi",
+  "firstName": "Xavier",
+  "lastName": "Stan",
+  "organizationName": "Enterfive",
+  "OrganizationSector": "Software and Internet",
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully added new client",
+  "clientRef": "47b73826-e9b2-412f-b8b4-c055eeec778b"
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - User is not authorized to make this request || Error authenticating user
+* 404 - Client does not exist
+* 409 - Email already exists
+* 500 - Backend service error
+
+## Add Question
+
+Add a new campaign question
+
+> Endpoint: versus_v2_add_question
+
+> Payload
+
+``` json
+{
+  "uid": "bfbbc055eeec778b",
+  "idToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a.13238bee-3ac9-4c77-b3b1-c7c53f113d5a",
+  "question": "Which snack do you like best?",
+  "optionsType": "multiplechoice",
+  "optionsList": [
+    {"text": "Biscuits"},
+    {"text": "Chocolate"},
+    {"text": "Groundnuts"}
+  ],
+  "campaignRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81"
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully added new question",
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - User is not authorized to make this request || Error authenticating user
+* 402 - Insufficient versus credit balance
+* 404 - Campaign does not exist
+* 500 - Backend service error
+
+## Confirm Team Member
+
+Confirm a new team member who is onboarding and creating a profile 
+
+> Endpoint: versus_v2_confirm_team_member
+
+> Payload
+
+``` json
+{
+  "email": "xavi@stan.dev",
+  "token": "bfbbc055eeec778b",
+  "firstName": "Xavier",
+  "lastName": "Stan",
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully confirmed team"
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - Invalid team token
+* 402 - Insufficient versus credit balance
+* 404 - Team not found
+* 500 - Backend service error
+
+## Edit Campaign
+
+Update a campaign
+
+> Endpoint: versus_v2_edit_campaign
+
+> Payload
+
+``` json
+{
+  "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+  "uid": "bfbbc055eeec778b",
+  "idToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a.13238bee-3ac9-4c77-b3b1-c7c53f113d5a",
+  "campaignRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81"
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully updated client campaign",
+  "campaignRef": "47b73826-e9b2-412f-b8b4-c055eeec778b"
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - User is not authorized to make this request || Error authenticating user
+* 404 - Client does not exist
+* 500 - Backend service error
+
+## Edit Client
+
+Update client data
+
+> Endpoint: versus_v2_edit_client
+
+> Payload
+
+``` json
+{
+  "email": "xavier@stan.dev",
+  "uid": "bfbbc055eeec778b",
+  "idToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a.13238bee-3ac9-4c77-b3b1-c7c53f113d5a",
+  "clientData": {
+    "logoURL": "https://clientlogo.png"
+  }
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully updated client data"
+}
+```
+
+> Errors
+
+* 401 - Team member does not have edit capability || Error authenticating user
+* 402 - Insufficient versus credit balance
+* 403 - Missing required parameters
+* 404 - Team not found || Client does not exist
+* 500 - Backend service error
+
+## Get All Campaign Data **
+
+Get all campaign-related data
+
+> Endpoint: versus_v2_get_all_campaign_data
+
+> Payload
+
+``` json
+{
+  "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+  "uid": "bfbbc055eeec778b",
+  "idToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a.13238bee-3ac9-4c77-b3b1-c7c53f113d5a",
+  "campaignRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81"
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully obtained all campaign data",
+  "campaign": {
+    "campaignRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
+  },
+  "questions": [],
+  "reponses": [],
+  "respondents": []
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - User is not authorized to make this request || Error authenticating user
+* 404 - Campaign does not exist
+* 500 - Backend service error
+
+## Get All Surveys**
+
+Get all surveys
+
+> Endpoint: versus_v2_add_campaign
+
+> Payload
+
+``` json
+{
+  "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+  "uid": "bfbbc055eeec778b",
+  "idToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a.13238bee-3ac9-4c77-b3b1-c7c53f113d5a",
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully obtained all campaigns",
+  "campaigns": []
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - User is not authorized to make this request || Error authenticating user
+* 404 - Client does not exist
+* 500 - Backend service error
+
+## Get Campaign **
+
+Get campaign data
+
+> Endpoint: versus_v2_get_campaign
+
+> Payload
+
+``` json
+{
+  "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+  "uid": "bfbbc055eeec778b",
+  "idToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a.13238bee-3ac9-4c77-b3b1-c7c53f113d5a",
+  "campaignRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81"
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully obtained campaign data",
+  "campaign": {},
+  "questionsData": [],
+  "responsesData": []
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - User is not authorized to make this request || Error authenticating user
+* 404 - Campaign does not exist
+* 500 - Backend service error
+
+## Get Campaigns **
+
+Get all campaigns
+
+> Endpoint: versus_v2_get_campaigns
+
+> Payload
+
+``` json
+{
+  "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+  "uid": "bfbbc055eeec778b",
+  "idToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a.13238bee-3ac9-4c77-b3b1-c7c53f113d5a"
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully obtained campaigns data",
+  "campaign": [],
+  "questionsData": [],
+  "responsesData": []
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - User is not authorized to make this request || Error authenticating user
+* 500 - Backend service error
+
+## Get Chart Data
+
+Get processed chart data and labels
+
+> Endpoint: versus_v2_get_chart_data
+
+> Payload
+
+``` json
+{
+  "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+  "uid": "bfbbc055eeec778b",
+  "idToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a.13238bee-3ac9-4c77-b3b1-c7c53f113d5a",
+  "period": "today",
+  "sources": {
+    "news": [],
+    "others": [],
+    "socialmedia": []
+  }
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully obtained chart data",
+  "chartData": {
+    "labels": [],
+    "mentions": [],
+    "positive": [],
+    "negative": [],
+    "neutral": []
+  }
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - User is not authorized to make this request || Error authenticating user
+* 500 - Backend service error
+
+## Get Client
+
+Get client data
+
+> Endpoint: versus_v2_get_client
+
+> Payload
+
+``` json
+{
+  "email": "xavier@stan.dev",
+  "uid": "bfbbc055eeec778b",
+  "idToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a.13238bee-3ac9-4c77-b3b1-c7c53f113d5a"
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully obtained client",
+  "client": {},
+  "team": {}
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - User is not authorized to make this request || Error authenticating user
+* 404 - Client or Team does not exist
+* 500 - Backend service error
+
+## Get Filtered Mentions
+
+Get mentions for specific set of filters
+
+> Endpoint: versus_v2_get_filtered_mentions
+
+> Payload
+
+``` json
+{
+  "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+  "uid": "bfbbc055eeec778b",
+  "idToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a.13238bee-3ac9-4c77-b3b1-c7c53f113d5a",
+  "period": "today"
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully obtained mentions",
+  "classifiedNewsMentions": {
+    "positiveMentions": [],
+    "negativeMentions": []
+  },
+  "classifiedOthersMentions": {
+    "positiveMentions": [],
+    "negativeMentions": []
+  },
+  "classifiedTwitterMentions": {
+    "positiveMentions": [],
+    "negativeMentions": []
+  }
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - User is not authorized to make this request || Error authenticating user
+* 500 - Backend service error
+
+## Get Mentions Summary
+
+Get a summary of mentions distribution for a period
+
+> Endpoint: versus_v2_get_mentions_summary
+
+> Payload
+
+``` json
+{
+  "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+  "uid": "bfbbc055eeec778b",
+  "idToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a.13238bee-3ac9-4c77-b3b1-c7c53f113d5a",
+  "period": "last 30 days",
+  "sentiment": "positive",
+  "sources": {
+    "categories": ["news", "others", "socialmedia"],
+    "news": [],
+    "others": [],
+    "socialmedia": []
+  }
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully obtained mentions summary",
+  "sentiment": "positive",
+  "sources": {},
+  "total": 90,
+  "news": 20,
+  "tweets": 60,
+  "others": 10,
+  "percentagePositive": 100,
+  "percentageNegative": 0,
+  "percentageNeutral": 0
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - User is not authorized to make this request || Error authenticating user
+* 500 - Backend service error
+
+## Get Most Popular Mentions
+
+Obtain most popular mentions
+
+> Endpoint: versus_v2_get_most_popular_mentions
+
+> Payload
+
+``` json
+{
+  "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+  "uid": "bfbbc055eeec778b",
+  "idToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a.13238bee-3ac9-4c77-b3b1-c7c53f113d5a",
+  "period": "last 7 days"
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully obtained most popular mentions",
+  "popularMentions": {
+    "positive": [],
+    "negative": []
+  }
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - User is not authorized to make this request || Error authenticating user
+* 404 - Client does not exist
+* 500 - Backend service error
+
+## Get Newsfeed
+
+Get social media and news mentions details for newsfeed
+
+> Endpoint: versus_v2_get_newsfeed
+
+> Payload
+
+``` json
+{
+  "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+  "uid": "bfbbc055eeec778b",
+  "idToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a.13238bee-3ac9-4c77-b3b1-c7c53f113d5a",
+  "period": "today",
+  "sentiment": "negative",
+  "sources": {
+    "news": [],
+    "others": [],
+    "socialmedia": []
+  }
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully obtained newsfeed",
+  "newsfeed": []
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - User is not authorized to make this request || Error authenticating user
+* 500 - Backend service error
+
+## Get News Mentions Sources
+
+Obtain sources of news mentions
+
+> Endpoint: versus_v2_get_news_mentions_sources
+
+> Payload
+
+``` json
+{
+  "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+  "uid": "bfbbc055eeec778b",
+  "idToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a.13238bee-3ac9-4c77-b3b1-c7c53f113d5a",
+  "period": "today",
+  "sentiment": "positive"
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully obtained news mentions sources",
+  "totalSources": 10,
+  "sources": []
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - User is not authorized to make this request || Error authenticating user
+* 500 - Backend service error
+
+## Get Others Mentions Sources
+
+Obtain sources of other mentions
+
+> Endpoint: versus_v2_get_others_mentions_sources
+
+> Payload
+
+``` json
+{
+  "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+  "uid": "bfbbc055eeec778b",
+  "idToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a.13238bee-3ac9-4c77-b3b1-c7c53f113d5a",
+  "period": "today",
+  "sentiment": "positive"
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully obtained others mentions sources",
+  "totalSources": 10,
+  "sources": []
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - User is not authorized to make this request || Error authenticating user
+* 500 - Backend service error
+
+## Get Socialmedia Mentions Sources
+
+Obtain sources of social media mentions
+
+> Endpoint: versus_v2_get_socialmedia_mentions_sources
+
+> Payload
+
+``` json
+{
+  "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+  "uid": "bfbbc055eeec778b",
+  "idToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a.13238bee-3ac9-4c77-b3b1-c7c53f113d5a",
+  "period": "today",
+  "sentiment": "positive"
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully obtained socialmedia mentions sources",
+  "totalTwitterMentions": 20
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - User is not authorized to make this request || Error authenticating user
+* 500 - Backend service error
+
+## Get Offboard Client
+
+Obtain details of client that has not yet onboarded
+
+> Endpoint: versus_v2_get_offboard_client
+
+> Payload
+
+``` json
+{
+  "onboardingToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a"
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully obtained client",
+  "client": {}
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 404 - Client does not exist
+* 500 - Backend service error
+
+## Get Team Members
+
+Get client team members 
+
+> Endpoint: versus_v2_get_team_members
+
+> Payload
+
+``` json
+{
+  "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+  "uid": "bfbbc055eeec778b",
+  "idToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a.13238bee-3ac9-4c77-b3b1-c7c53f113d5a"
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully obtained team members",
+  "teamMembers": [
+    {
+      "email": "deji@enterfive.com",
+      "canEdit": false,
+      "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+      "accepted": true
+    }
+  ]
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - User is not authorized to make this request || Error authenticating user
+* 404 - Team does not exist
+* 500 - Backend service error
+
+## Get Top Influencers
+
+Obtain a list of top influencers
+
+> Endpoint: versus_v2_get_top_influencers
+
+> Payload
+
+``` json
+{
+  "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+  "uid": "bfbbc055eeec778b",
+  "idToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a.13238bee-3ac9-4c77-b3b1-c7c53f113d5a",
+  "period": "today"
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully obtained top influencers",
+  "topInfluencers": {
+    "positive": [],
+    "negative": []
+  }
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - User is not authorized to make this request || Error authenticating user
+* 500 - Backend service error
+
+## Get Total Questions
+
+Get a count of total questions for a client 
+
+> Endpoint: versus_v2_get_total_questions
+
+> Payload
+
+``` json
+{
+  "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+  "uid": "bfbbc055eeec778b",
+  "idToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a.13238bee-3ac9-4c77-b3b1-c7c53f113d5a"
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully obtained total questions",
+  "totalQuestions": 320
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - User is not authorized to make this request || Error authenticating user
+* 500 - Backend service error
+
+## Get Total Responses
+
+Get a count of total responses for a client 
+
+> Endpoint: versus_v2_get_total_responses
+
+> Payload
+
+``` json
+{
+  "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+  "uid": "bfbbc055eeec778b",
+  "idToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a.13238bee-3ac9-4c77-b3b1-c7c53f113d5a",
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully obtained total responses",
+  "totalQuestions": 320
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - User is not authorized to make this request || Error authenticating user
+* 500 - Backend service error
+
+## Get Total Survey Questions
+
+Get a count of total survey questions for each campaign
+
+> Endpoint: versus_v2_get_total_survey_questions
+
+> Payload
+
+``` json
+{
+  "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+  "uid": "bfbbc055eeec778b",
+  "idToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a.13238bee-3ac9-4c77-b3b1-c7c53f113d5a",
+  "campaignRef": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a"
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully obtained total survey questions",
+  "totalSurveyQuestions": 6
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - User is not authorized to make this request || Error authenticating user
+* 500 - Backend service error
+
+## Get Total Survey Responses
+
+Get a count of total survey responses for each campaign
+
+> Endpoint: versus_v2_get_total_survey_responses
+
+> Payload
+
+``` json
+{
+  "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+  "uid": "bfbbc055eeec778b",
+  "idToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a.13238bee-3ac9-4c77-b3b1-c7c53f113d5a",
+  "campaignRef": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a"
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully obtained total survey responses",
+  "totalSurveyResponses": 6
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - User is not authorized to make this request || Error authenticating user
+* 500 - Backend service error
+
+## Get Total Surveys
+
+Obtain a count of all the surveys for a client
+
+> Endpoint: versus_v2_get_total_surveys
+
+> Payload
+
+``` json
+{
+  "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+  "uid": "bfbbc055eeec778b",
+  "idToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a.13238bee-3ac9-4c77-b3b1-c7c53f113d5a",
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully obtained total surveys data",
+  "totalSurveys": 14
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - User is not authorized to make this request || Error authenticating user
+* 500 - Backend service error
+
+## Launch campaign
+
+CHange the status pf a campaign from draft to live
+
+> Endpoint: versus_v2_launch_campaign
+
+> Payload
+
+``` json
+{
+  "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+  "uid": "bfbbc055eeec778b",
+  "idToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a.13238bee-3ac9-4c77-b3b1-c7c53f113d5a",
+  "campaignRef": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a"
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully launched client campaign",
+  "campaignRef": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a"
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - User is not authorized to make this request || Error authenticating user
+* 500 - Backend service error
+
+## Mark Irrelevant Mentions
+
+Register a mention as irrlevant and notify project team
+
+> Endpoint: versus_v2_mark_irrelevant_mention
+
+> Payload
+
+``` json
+{
+  "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+  "uid": "bfbbc055eeec778b",
+  "idToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a.13238bee-3ac9-4c77-b3b1-c7c53f113d5a",
+  "mention": {},
+  "brandName": 
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully sent email"
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - User is not authorized to make this request || Error authenticating user
+* 500 - Backend service error
+
+## Onboard Client
+
+Onboard client
+
+> Endpoint: versus_v2_onboard_client
+
+> Payload
+
+``` json
+{
+  "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+  "officeAddress": "35 Oju Omega Avenue, Ikoyi, Lagos",
+  "onboardingToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a",
+  "brandName": "Enterfive",
+  "otherBrandNames": "e5",
+  "responseEmails": "pr@e5.com, hr@e5.com",
+  "comparisonBrands": [],
+  "teamMembers": [],
+  "filterProfanity": true
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully onboarded client",
+  "clientRef": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a"
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - Client is not approved for onboarding
+* 500 - Backend service error
+
+## Respond To Mention
+
+Notify client designated responder of a mention they should act on
+
+> Endpoint: versus_v2_respond_to_mention
+
+> Payload
+
+``` json
+{
+  "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+  "uid": "bfbbc055eeec778b",
+  "idToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a.13238bee-3ac9-4c77-b3b1-c7c53f113d5a",
+  "mentionUrl": "https://twitter.com/user/234455/status/098734",
+  "brandName": "Enterfive",
+  "emailAddress": "pr@e5.co"
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully sent email"
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - User is not authorized to make this request || Error authenticating user
+* 500 - Backend service error
+
+## Retag Mention
+
+Register a mention which sentiment is to be retagged and notify project team
+
+> Endpoint: versus_v2_retag_mention
+
+> Payload
+
+``` json
+{
+  "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+  "uid": "bfbbc055eeec778b",
+  "idToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a.13238bee-3ac9-4c77-b3b1-c7c53f113d5a",
+  "mention": {},
+  "brandName": "e5",
+  "retaggedSentiment": "neutral"
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully sent email"
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - User is not authorized to make this request || Error authenticating user
+* 500 - Backend service error
+
+## Get Versus Credits
+
+Obtain client's current value of versus credit
+
+> Endpoint: versus_v2_get_versus_credits
+
+> Payload
+
+``` json
+{
+  "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+  "uid": "bfbbc055eeec778b",
+  "idToken": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a.13238bee-3ac9-4c77-b3b1-c7c53f113d5a"
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully obtained client versus credits",
+  "versusCredits": 5500
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - User is not authorized to make this request || Error authenticating user
+* 500 - Backend service error
+
+## Verify Signup Access
+
+Validate tokenized signup link
+
+> Endpoint: versus_v2_verify_signup_access
+
+> Payload
+
+``` json
+{
+  "tk": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a"
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully verified signup"
+}
+```
+
+> Errors
+
+* 400 - Missing required parameters
+* 401 - Invalid signup token
+* 500 - Backend service error
\ No newline at end of file

From 8e9660e214a469698087a21c8f060980507f0215 Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Mon, 8 Jun 2020 04:06:13 +0100
Subject: [PATCH 58/96] Add deprecation notice

To endpoins that have been or are schedued for deprecation
---
 Versus-2.0.md | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/Versus-2.0.md b/Versus-2.0.md
index 769d865..e5178f2 100644
--- a/Versus-2.0.md
+++ b/Versus-2.0.md
@@ -529,6 +529,8 @@ Update client data
 
 Get all campaign-related data
 
+** To be deprecated soon
+
 > Endpoint: versus_v2_get_all_campaign_data
 
 > Payload
@@ -563,10 +565,12 @@ Get all campaign-related data
 * 404 - Campaign does not exist
 * 500 - Backend service error
 
-## Get All Surveys**
+## Get All Surveys **
 
 Get all surveys
 
+** To be deprecated soon
+
 > Endpoint: versus_v2_add_campaign
 
 > Payload
@@ -599,6 +603,8 @@ Get all surveys
 
 Get campaign data
 
+** To be deprecated soon
+
 > Endpoint: versus_v2_get_campaign
 
 > Payload
@@ -634,6 +640,8 @@ Get campaign data
 
 Get all campaigns
 
+** To be deprecated soon
+
 > Endpoint: versus_v2_get_campaigns
 
 > Payload

From 01a91c6e243748bc87c45ca75e260bc414e8c25a Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Fri, 12 Jun 2020 09:06:08 +0100
Subject: [PATCH 59/96] Added missing error messages

For every error code reported on the scout endpoints
---
 Versus-2.0.md | 21 ++++++++++++---------
 1 file changed, 12 insertions(+), 9 deletions(-)

diff --git a/Versus-2.0.md b/Versus-2.0.md
index e5178f2..8ae7af0 100644
--- a/Versus-2.0.md
+++ b/Versus-2.0.md
@@ -31,9 +31,9 @@ This is called after a scout has answered all campaign questions. It calculates
 > Errors
 
 * 401 - Failed authentication. Authstring invalid or not found in request body
-* 403 - Missing required parameters
+* 403 - Missing required parameters || Scout has already completed this campaign
 * 404 - Scout does not exist
-* 500 - Backend service error
+* 500 - Backend service error || Oops! Something happened from our end
 
 ## Get Campaigns
 
@@ -73,9 +73,9 @@ To obtain campaigns that match a scout's demographic.
 
 > Errors
 
-* 403 - Missing required parameters
+* 403 - Missing required param: phoneNumber 
 * 404 - Scout does not exist
-* 500 - Backend service error
+* 500 - Backend service error || Oops! Something broke from our end 
 
 ## Get Partners
 
@@ -133,7 +133,7 @@ Get current scout partners.
 
 * 400 - Missing authstring in request body
 * 401 - Failed authentication. Invalid authstring
-* 500 - Backend service error
+* 500 - Backend service error || Oops! Something broke from our end
 
 ## Convert Amount
 
@@ -164,7 +164,7 @@ Convert scout credit amount to equivalent cash.
 
 > Errors
 
-* 400 - Missing required parameters
+* 400 - Missing body parameters... || We do not yet support cashout in that country || Error converting scout credit
 * 401 - Failed authentication. Authstring invalid or not found in request body
 * 500 - Backend service error
 
@@ -198,9 +198,10 @@ This endpoint verifies scout bank account number and creates a Paystack recipien
 
 > Errors
 
-* 400 - Missing required parameters || other errors
+* 400 - Missing body parameters ... || Error verifying account number || Error creating recipient
 * 401 - Failed authentication. Authstring invalid or not found in request body
-* 500 - Backend service error
+* 404 - Scout does not exist
+* 500 - Backend service error || Error verifying account || Error obtaining scout
 
 ## Cashout
 
@@ -234,8 +235,9 @@ Initiate transfer of funds to scout bank account.
 
 > Errors
 
-* 400 - Missing required parameters || other errors
+* 400 - Missing required parameters || That country is not yet supported for cashout || Error converting scout credit for transfer || Error initiating transfer to scout || Error checking transfer status || Failed to transfer money to recipient
 * 401 - Failed authentication. Authstring invalid or not found in request body
+* 403 - The given account number is invalid, please verify bank account || Insufficient scout credit balance || Cashout is disabled for this scout. Less than 33 credits || Scout does not have a verified bank account
 * 404 - Scout does not exist
 * 500 - Backend service error
 
@@ -298,6 +300,7 @@ Obtain a list of banks with their codes.
 
 > Errors
 
+* 400 - Error obtaining banks list
 * 401 - Failed authentication. Authstring invalid or not found in request body
 * 500 - Backend service error
 

From fa5f322dad4006d5b175e9a8dbe71b08cc38eeee Mon Sep 17 00:00:00 2001
From: Oche Onoja <oche@Oches-MacBook-Pro.local>
Date: Sun, 14 Jun 2020 20:34:18 +0100
Subject: [PATCH 60/96] Added powertrack documentation

---
 Powertrack.md   | 72 +++++++++++++++++++++++++++++++++++++++++++++++++
 clients.html    |  1 +
 dashboard.html  |  1 +
 email.html      |  1 +
 index.html      |  1 +
 powertrack.html | 59 ++++++++++++++++++++++++++++++++++++++++
 profanity.html  |  1 +
 scout.html      |  1 +
 tixy.html       |  1 +
 versus-2.0.html |  1 +
 10 files changed, 139 insertions(+)
 create mode 100644 Powertrack.md
 create mode 100644 powertrack.html

diff --git a/Powertrack.md b/Powertrack.md
new file mode 100644
index 0000000..e694568
--- /dev/null
+++ b/Powertrack.md
@@ -0,0 +1,72 @@
+# PowerTrack
+
+Endpoints for PowerTrack Rules
+
+
+## Add Rule
+This function will take an array of rules and a string containing client reference, adds the rules to PowerTrack with the client reference as tags and returns the id of the rules created.
+
+| Field      | Type   | Description                                |
+|------------|--------|--------------------------------------------|
+| rules      | array  | An array of strings with rules to be added |
+| client_ref | string | A sstring containing client reference
+
+
+> Endpoint: https://us-central1-versus-dev-212614.cloudfunctions.net/add_powertrack_rule
+
+> Payload
+
+``` javascript
+{
+	"rules": ["keyword", "#hashtag" "key phrase"],
+	"client_ref": "company"
+}
+```
+
+> Result
+``` javascript
+{
+    "created": true,
+    "detail": {
+        "rule": "(keyword OR #hastag OR \"key phrase\")",
+        "client_ref": "company",
+        "id": "1272119853105766401"
+    }
+}
+```
+
+## Remove Rule
+This function will take an array of rule ids to be removed, removes the rules from PowerTrack filter and returns a summary of rules deleted.
+
+| Field      | Type   | Description                                      |
+|------------|--------|--------------------------------------------------|
+| rule_ids   | array  | An array of strings with rules ids to be removed |
+
+
+> Endpoint: https://us-central1-versus-dev-212614.cloudfunctions.net/remove_powertrack_rule
+
+> Payload
+
+``` javascript
+{
+	"rule_ids": ["1272116620828258304"]
+}
+```
+
+> Result
+``` javascript
+{
+    "summary": {
+        "deleted": 0,
+        "not_deleted": 1
+    },
+    "detail": [
+        {
+            "id": "1272116620828258304",
+            "deleted": false,
+            "message": "Rule does not exist"
+        }
+    ]
+}
+```
+
diff --git a/clients.html b/clients.html
index 7c06a26..9f09eab 100644
--- a/clients.html
+++ b/clients.html
@@ -36,6 +36,7 @@ <h1><a href='.'>Enterfive</a></h1>
         <li><a href='profanity.html'>Profanity Filter</a></li>
         <li><a href='reference.html'>API reference</a></li>
         <li><a href='scout.html'>Scouts</a></li>
+        <li><a href='powertrack.html'>Powertrack</a></li>
       </ul>
       <ul>
         <li><a href='tixy.html'>Tixy</a></li>
diff --git a/dashboard.html b/dashboard.html
index 0cc2949..260e125 100644
--- a/dashboard.html
+++ b/dashboard.html
@@ -36,6 +36,7 @@ <h1><a href='.'>Enterfive</a></h1>
         <li><a href='profanity.html'>Profanity Filter</a></li>
         <li><a href='reference.html'>API reference</a></li>
         <li><a href='scout.html'>Scouts</a></li>
+        <li><a href='powertrack.html'>Powertrack</a></li>
       </ul>
       <ul>
         <li><a href='tixy.html'>Tixy</a></li>
diff --git a/email.html b/email.html
index c651907..5bc3dec 100644
--- a/email.html
+++ b/email.html
@@ -36,6 +36,7 @@ <h1><a href='.'>Enterfive</a></h1>
             <li><a href='profanity.html'>Profanity Filter</a></li>
             <li><a href='reference.html'>API reference</a></li>
             <li><a href='scout.html'>Scouts</a></li>
+            <li><a href='powertrack.html'>Powertrack</a></li>
           </ul>
           <ul>
             <li><a href='tixy.html'>Tixy</a></li>
diff --git a/index.html b/index.html
index 5066152..64a30b6 100644
--- a/index.html
+++ b/index.html
@@ -59,6 +59,7 @@ <h1><a href='.'>Enterfive</a></h1>
         <li><a href='scout.html'>Scouts</a></li>
         <li><a href='tixy.html'>Tixy</a></li>
         <li><a href='versus-2.0.html'>Versus-2.0</a></li>
+        <li><a href='powertrack.html'>Powertrack</a></li>
       </ul>
       <!-- <ul>
         <li><a href='tixy.html'>Tixy</a></li>
diff --git a/powertrack.html b/powertrack.html
new file mode 100644
index 0000000..efffa85
--- /dev/null
+++ b/powertrack.html
@@ -0,0 +1,59 @@
+<!doctype html>
+<html>
+<head>
+  <meta charset='utf-8'>
+  <meta http-equiv="X-UA-Compatible" content="chrome=1" />
+  <meta name="viewport" content="width=device-width">
+
+  <title>Enterfive Docs - Powertrack</title>
+
+  <!-- Flatdoc -->
+  <script src='support/vendor/jquery.js'></script>
+  <script src='legacy.js'></script>
+  <script src='flatdoc.js'></script>
+
+  <!-- Flatdoc theme -->
+  <link  href='theme-white/style.css' rel='stylesheet'>
+  <script src='theme-white/script.js'></script>
+  <link  href='support/theme.css' rel='stylesheet'>
+
+  <!-- Initializer -->
+  <script>
+    Flatdoc.run({
+      fetcher: Flatdoc.file('Powertrack.md')
+    });
+  </script>
+</head>
+<body role='flatdoc'>
+
+    <div class='header'>
+        <div class='left'>
+          <h1><a href='.'>Enterfive</a></h1>
+          <ul>
+            <li><a href='clients.html'>Clients</a></li>
+            <li><a href='dashboard.html'>Dashboard</a></li>
+            <li><a href='email.html'>Email Templates</a></li>
+            <li><a href='profanity.html'>Profanity Filter</a></li>
+            <li><a href='reference.html'>API reference</a></li>
+            <li><a href='scout.html'>Scouts</a></li>
+            <li><a href='powertrack.html'>Powertrack</a></li>
+          </ul>
+          <ul>
+            <li><a href='tixy.html'>Tixy</a></li>
+          </ul>
+        </div>
+        <div class='right'>
+          <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;type=follow&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="170" height="20"></iframe>
+          <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;repo=flatdoc&amp;type=watch&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe>
+        </div>
+      </div>
+
+  <div class='content-root'>
+    <div class='menubar'>
+      <div class='menu section' role='flatdoc-menu'></div>
+    </div>
+    <div role='flatdoc-content' class='content'></div>
+  </div>
+
+</body>
+</html>
diff --git a/profanity.html b/profanity.html
index 3e225ee..1bcdd90 100644
--- a/profanity.html
+++ b/profanity.html
@@ -36,6 +36,7 @@ <h1><a href='.'>Enterfive</a></h1>
             <li><a href='profanity.html'>Profanity Filter</a></li>
             <li><a href='reference.html'>API reference</a></li>
             <li><a href='scout.html'>Scouts</a></li>
+            <li><a href='powertrack.html'>Powertrack</a></li>
           </ul>
           <ul>
             <li><a href='tixy.html'>Tixy</a></li>
diff --git a/scout.html b/scout.html
index 6ff35f9..a171958 100644
--- a/scout.html
+++ b/scout.html
@@ -36,6 +36,7 @@ <h1><a href='.'>Enterfive</a></h1>
             <li><a href='profanity.html'>Profanity Filter</a></li>
             <li><a href='reference.html'>API reference</a></li>
             <li><a href='scout.html'>Scouts</a></li>
+            <li><a href='powertrack.html'>Powertrack</a></li>
           </ul>
           <ul>
             <li><a href='tixy.html'>Tixy</a></li>
diff --git a/tixy.html b/tixy.html
index 172f3bd..285b3e8 100644
--- a/tixy.html
+++ b/tixy.html
@@ -36,6 +36,7 @@ <h1><a href='.'>Enterfive</a></h1>
             <li><a href='profanity.html'>Profanity Filter</a></li>
             <li><a href='reference.html'>API reference</a></li>
             <li><a href='scout.html'>Scouts</a></li>
+            <li><a href='powertrack.html'>Powertrack</a></li>
           </ul>
           <ul>
             <li><a href='tixy.html'>Tixy</a></li>
diff --git a/versus-2.0.html b/versus-2.0.html
index 0bde1fc..21901a6 100644
--- a/versus-2.0.html
+++ b/versus-2.0.html
@@ -40,6 +40,7 @@ <h1><a href='.'>Enterfive</a></h1>
           <li><a href='scout.html'>Scouts</a></li>
           <li><a href='tixy.html'>Tixy</a></li>
           <li><a href='versus-2.0.html'>Versus-2.0</a></li>
+          <li><a href='powertrack.html'>Powertrack</a></li>
         </ul>
       </div>
       <div class='right'>

From ad0566c8e0754497ff99ee5181128feb8fbe907f Mon Sep 17 00:00:00 2001
From: Oche Onoja <oche@Oches-MacBook-Pro.local>
Date: Wed, 24 Jun 2020 07:57:29 +0100
Subject: [PATCH 61/96] Added PDF Report

---
 Versus-2.0.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

diff --git a/Versus-2.0.md b/Versus-2.0.md
index 8ae7af0..658db91 100644
--- a/Versus-2.0.md
+++ b/Versus-2.0.md
@@ -1497,6 +1497,45 @@ Validate tokenized signup link
 
 > Errors
 
+* 400 - Missing required parameters
+* 401 - Invalid signup token
+* 500 - Backend service error
+
+## Download Report
+
+Generates and downloads Versus pdf report based on filter parameters
+
+> Endpoint: get_pdf_report
+
+> Payload
+
+``` json
+{
+    "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+    "brandName": "The New",
+    "idToken": "eyJhbGciOiJSUzI1NiIsImtpZCI6ImMzZjI3NjU0MmJmZmU0NWU5OGMyMGQ2MDNlYmUyYmExMTc2ZWRhMzMiLCJ0eXAiOiJKV1QifQ.eyJuYW1lIjoiRGVqaSBJYnJhaGltIiwiaXNzIjoiaHR0cHM6Ly9zZWN1cmV0b2tlbi5nb29nbGUuY29tL2NvbG9ycy0yMWNiYyIsImF1ZCI6ImNvbG9ycy0yMWNiYyIsImF1dGhfdGltZSI6MTU5Mjk3OTk5NiwidXNlcl9pZCI6ImRLOElKNUc5WjFQZkg4RW5jbGN0NWx1MHZJazEiLCJzdWIiOiJkSzhJSjVHOVoxUGZIOEVuY2xjdDVsdTB2SWsxIiwiaWF0IjoxNTkyOTc5OTk2LCJleHAiOjE1OTI5ODM1OTYsImVtYWlsIjoiZGVqaS5hLmlicmFoaW1AZ21haWwuY29tIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJmaXJlYmFzZSI6eyJpZGVudGl0aWVzIjp7ImVtYWlsIjpbImRlamkuYS5pYnJhaGltQGdtYWlsLmNvbSJdfSwic2lnbl9pbl9wcm92aWRlciI6InBhc3N3b3JkIn19.qTcj7_wouzdZCECKEbkVs_wreCenMpsPhezZcQJcnSL9w0cL3cVu0pJNWEWbKIRxdz7FsEBNkB8p6eQ52mQLnfsVFbLBzNnMBSOZgyOVtgMk46BhCzxWYINgVaLl7hkShf4iD4Q73IEIvtKMN7osFFPYpnn2qCKSUyymvDHyJEx-jhh9zbl6BqDtONvm-Jq-OTAMxtYl7SfE8_vJjg0ndPGhHdDz12pqwpCBPF06oz5HV5U0C53bscpRe1hxP33gqCfyvsN_SWUOPsaESMcaQv_LcDjO29_oDINl-_P83yTaTsTdNwKdFOf4gn71r98SgEVPwhhvjcdwXvGNIWnZQg",
+    "period": "today",
+    "sentiment": "any sentiment",
+    "sources": {
+        "categories": [],
+        "socialmedia": [],
+        "news": [],
+        "others": []
+    },
+    "uid": "dK8IJ5G9Z1PfH8Enclct5lu0vIk1"
+}
+```
+
+> Response: Returns Pdf file for Download
+
+<!-- ``` json
+{
+  "message": "Successful"
+}
+``` -->
+
+> Errors
+
 * 400 - Missing required parameters
 * 401 - Invalid signup token
 * 500 - Backend service error
\ No newline at end of file

From 95d48ee4ed13264f1c44d177c114c97323a6b3a0 Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Thu, 23 Jul 2020 11:58:17 +0100
Subject: [PATCH 62/96] Send SMS

---
 Versus-2.0.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)

diff --git a/Versus-2.0.md b/Versus-2.0.md
index 658db91..47a032f 100644
--- a/Versus-2.0.md
+++ b/Versus-2.0.md
@@ -1,3 +1,37 @@
+# General
+
+These are general purpose endpoints that are not necessarily attached to scout or dashboard functions
+
+## Send SMS
+
+This function leverages Twilio APIs to send SMS to a phone number. 
+Please use the endpoint and sample _authstring_ as is.
+
+> Endpoint: https://us-central1-versus-dev-212614.cloudfunctions.net/versus_v2_send_sms
+
+> Payload
+
+```json
+{
+  "phoneNumber": "+2348123456789",
+  "message": "Text message to be sent",
+  "authstring": "55ad4986-b519-4e44-ab0b-890527299af6"
+}
+```
+
+> Response
+
+```json
+{
+  "message": "Successfully sent SMS"
+}
+```
+
+> Errors
+
+* 400 - Missing parameter phoneNumber, message, authstring || Failed authentication. Invalid authstring || Message exceeds allowed number of characters 150/140
+* 500 - Failed to send SMS
+
 # Scout
 
 This has endpoints for managing scout actions that are unique to Versus 2.0. For other actions refer to v1 docs. 

From 6fa59a0a1f0bed81f4b7aef51330d0d9768c74f1 Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Wed, 2 Sep 2020 09:11:48 +0100
Subject: [PATCH 63/96] docs: document scout_save_device_token endpoint

---
 Versus-2.0.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)

diff --git a/Versus-2.0.md b/Versus-2.0.md
index 47a032f..86016bd 100644
--- a/Versus-2.0.md
+++ b/Versus-2.0.md
@@ -338,6 +338,51 @@ Obtain a list of banks with their codes.
 * 401 - Failed authentication. Authstring invalid or not found in request body
 * 500 - Backend service error
 
+
+## Save Device Token
+
+To save a scout device registration token. It handles both creation of a new record and update of an existing one.
+
+> Endpoint: scout_save_device_token
+
+> Payload
+
+``` json
+{
+  "scoutRef": "+2348123456789",
+  "deviceRegistrationToken": "47b73826-e9b2-412f-b8b4-c055eeec778b",
+  "authstring": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a"
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully created new device registration token record",
+  "scoutRef": "+2348123456789",
+  "deviceRegistrationToken": "47b73826-e9b2-412f-b8b4-c055eeec778b",
+  "deviceRegistrationTokenRef": "dccfb068-de00-40a8-b033-8488430136f3"
+}
+```
+
+``` json
+{
+  "message": "Successfully updated device registration token",
+  "scoutRef": "+2348123456789",
+  "deviceRegistrationToken": "47b73826-e9b2-412f-b8b4-c055eeec778b",
+  "deviceRegistrationTokenRef": "dccfb068-de00-40a8-b033-8488430136f3"
+}
+```
+
+> Errors
+
+* 400 - Missing parameter scoutRef, deviceRegistrationToken
+* 401 - Failed authentication. Authstring invalid or not found in request body
+* 403 - Only POST requests are allowed
+* 500 - Error creating new device registration token record || Error updating existing device registration token record || Error fetching token record
+
+
 # Dashboard
 
 These are endpoints called by v2.0 dashbboard components. 

From f9982f814822d591304dfe09dcce82eeee2340ae Mon Sep 17 00:00:00 2001
From: Oche Onoja <oche@Oches-MacBook-Pro.local>
Date: Mon, 21 Sep 2020 11:37:45 +0100
Subject: [PATCH 64/96] Added comparison pdf

---
 Versus-2.0.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 59 insertions(+)

diff --git a/Versus-2.0.md b/Versus-2.0.md
index 86016bd..07a3e40 100644
--- a/Versus-2.0.md
+++ b/Versus-2.0.md
@@ -1588,6 +1588,30 @@ Generates and downloads Versus pdf report based on filter parameters
 
 > Payload
 
+``` json
+{
+    "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+    "brandName": "The New",
+    "idToken": "eyJhbGciOiJSUzI1NiIsImtpZCI6ImMzZjI3NjU0MmJmZmU0NWU5OGMyMGQ2MDNlYmUyYmExMTc2ZWRhMzMiLCJ0eXAiOiJKV1QifQ.eyJuYW1lIjoiRGVqaSBJYnJhaGltIiwiaXNzIjoiaHR0cHM6Ly9zZWN1cmV0b2tlbi5nb29nbGUuY29tL2NvbG9ycy0yMWNiYyIsImF1ZCI6ImNvbG9ycy0yMWNiYyIsImF1dGhfdGltZSI6MTU5Mjk3OTk5NiwidXNlcl9pZCI6ImRLOElKNUc5WjFQZkg4RW5jbGN0NWx1MHZJazEiLCJzdWIiOiJkSzhJSjVHOVoxUGZIOEVuY2xjdDVsdTB2SWsxIiwiaWF0IjoxNTkyOTc5OTk2LCJleHAiOjE1OTI5ODM1OTYsImVtYWlsIjoiZGVqaS5hLmlicmFoaW1AZ21haWwuY29tIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJmaXJlYmFzZSI6eyJpZGVudGl0aWVzIjp7ImVtYWlsIjpbImRlamkuYS5pYnJhaGltQGdtYWlsLmNvbSJdfSwic2lnbl9pbl9wcm92aWRlciI6InBhc3N3b3JkIn19.qTcj7_wouzdZCECKEbkVs_wreCenMpsPhezZcQJcnSL9w0cL3cVu0pJNWEWbKIRxdz7FsEBNkB8p6eQ52mQLnfsVFbLBzNnMBSOZgyOVtgMk46BhCzxWYINgVaLl7hkShf4iD4Q73IEIvtKMN7osFFPYpnn2qCKSUyymvDHyJEx-jhh9zbl6BqDtONvm-Jq-OTAMxtYl7SfE8_vJjg0ndPGhHdDz12pqwpCBPF06oz5HV5U0C53bscpRe1hxP33gqCfyvsN_SWUOPsaESMcaQv_LcDjO29_oDINl-_P83yTaTsTdNwKdFOf4gn71r98SgEVPwhhvjcdwXvGNIWnZQg",
+    "period": "today",
+    "sentiment": "any sentiment",
+    "sources": {
+        "categories": [],
+        "socialmedia": [],
+        "news": [],
+        "others": []
+    },
+    "uid": "dK8IJ5G9Z1PfH8Enclct5lu0vIk1"
+}
+```
+## Download Listen Report
+
+Generates and downloads Versus pdf report based on filter parameters
+
+> Endpoint: versus_v2_get_pdf_report
+
+> Payload
+
 ``` json
 {
     "clientRef": "nqaXKB0SzWN6xh7RVyzl",
@@ -1613,6 +1637,41 @@ Generates and downloads Versus pdf report based on filter parameters
 }
 ``` -->
 
+> Errors
+
+* 400 - Missing required parameters
+* 401 - Invalid signup token
+* 500 - Backend service error
+
+## Download Comparison Report
+
+Generates and downloads Versus comparison pdf report based on filter parameters
+
+> Endpoint: versus_v2_get_comparison_pdf
+
+> Payload
+
+``` json
+{
+    "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+    "brandName": "The New",
+    "idToken": "eyJhbGciOiJSUzI1NiIsImtpZCI6ImMzZjI3NjU0MmJmZmU0NWU5OGMyMGQ2MDNlYmUyYmExMTc2ZWRhMzMiLCJ0eXAiOiJKV1QifQ.eyJuYW1lIjoiRGVqaSBJYnJhaGltIiwiaXNzIjoiaHR0cHM6Ly9zZWN1cmV0b2tlbi5nb29nbGUuY29tL2NvbG9ycy0yMWNiYyIsImF1ZCI6ImNvbG9ycy0yMWNiYyIsImF1dGhfdGltZSI6MTU5Mjk3OTk5NiwidXNlcl9pZCI6ImRLOElKNUc5WjFQZkg4RW5jbGN0NWx1MHZJazEiLCJzdWIiOiJkSzhJSjVHOVoxUGZIOEVuY2xjdDVsdTB2SWsxIiwiaWF0IjoxNTkyOTc5OTk2LCJleHAiOjE1OTI5ODM1OTYsImVtYWlsIjoiZGVqaS5hLmlicmFoaW1AZ21haWwuY29tIiwiZW1haWxfdmVyaWZpZWQiOmZhbHNlLCJmaXJlYmFzZSI6eyJpZGVudGl0aWVzIjp7ImVtYWlsIjpbImRlamkuYS5pYnJhaGltQGdtYWlsLmNvbSJdfSwic2lnbl9pbl9wcm92aWRlciI6InBhc3N3b3JkIn19.qTcj7_wouzdZCECKEbkVs_wreCenMpsPhezZcQJcnSL9w0cL3cVu0pJNWEWbKIRxdz7FsEBNkB8p6eQ52mQLnfsVFbLBzNnMBSOZgyOVtgMk46BhCzxWYINgVaLl7hkShf4iD4Q73IEIvtKMN7osFFPYpnn2qCKSUyymvDHyJEx-jhh9zbl6BqDtONvm-Jq-OTAMxtYl7SfE8_vJjg0ndPGhHdDz12pqwpCBPF06oz5HV5U0C53bscpRe1hxP33gqCfyvsN_SWUOPsaESMcaQv_LcDjO29_oDINl-_P83yTaTsTdNwKdFOf4gn71r98SgEVPwhhvjcdwXvGNIWnZQg",
+    "period": "lastYear",
+    "sentiment": "any sentiment",
+    "sources": {
+        "categories": [],
+        "socialmedia": [],
+        "news": [],
+        "others": []
+    },
+    "uid": "dK8IJ5G9Z1PfH8Enclct5lu0vIk1",
+    "brands": ["2a304e66-2392-4b25-bd84-f5b7cc6d6aa5", "9da210aa-1033-49ce-aff8-b451b6bece85"]
+}
+```
+
+> Response: Returns Pdf file for Download
+
+
 > Errors
 
 * 400 - Missing required parameters

From 33b5751b667c0a5252015301ad7be14293ade168 Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Thu, 24 Sep 2020 11:59:58 +0100
Subject: [PATCH 65/96] Added new scout property

`requiresBankUpdate`
---
 Scout.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Scout.md b/Scout.md
index 99d1944..975dd44 100644
--- a/Scout.md
+++ b/Scout.md
@@ -262,7 +262,8 @@ Get a scout given the docRef
         "amount": 0
     },
     "verified": false,
-    "twoFA": false
+    "twoFA": false,
+    "requiresBankUpdate": false
 }
 ```
 

From 66923527ff3a03cfd3ca8ab57524cf217685079c Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Wed, 30 Sep 2020 19:01:19 +0100
Subject: [PATCH 66/96] Added unverified scout error message

---
 Versus-2.0.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Versus-2.0.md b/Versus-2.0.md
index 07a3e40..d22afb3 100644
--- a/Versus-2.0.md
+++ b/Versus-2.0.md
@@ -107,6 +107,7 @@ To obtain campaigns that match a scout's demographic.
 
 > Errors
 
+* 400 - Scout is not verified
 * 403 - Missing required param: phoneNumber 
 * 404 - Scout does not exist
 * 500 - Backend service error || Oops! Something broke from our end 

From fbbfeba5fbdd98ee1c014268c365440bbe80eef8 Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Tue, 13 Oct 2020 15:40:52 +0100
Subject: [PATCH 67/96] Documented versus_v2_get_subscription_plan

---
 Versus-2.0.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/Versus-2.0.md b/Versus-2.0.md
index d22afb3..56ab016 100644
--- a/Versus-2.0.md
+++ b/Versus-2.0.md
@@ -1677,4 +1677,39 @@ Generates and downloads Versus comparison pdf report based on filter parameters
 
 * 400 - Missing required parameters
 * 401 - Invalid signup token
+* 500 - Backend service error
+
+## Get Subscription Plan
+
+Obtain details of a subscription plan
+
+> Endpoint: versus_v2_get_subscription_plan
+
+> Payload
+
+``` json
+{
+  "subscriptionPlanRef": "081d4b17-a1f3-4600-920f-6f46d3919873"
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully obtained subscription plan",
+  "subscriptionPlan": {
+    "countriesAllowed": 12,
+    "mentionsAllowed": 100000,
+    "subscriptionPlanName": "Max",
+    "languagesAllowed": 1,
+    "subscriptionPlanRef": "081d4b17-a1f3-4600-920f-6f46d3919873"
+  }
+}
+```
+
+> Errors
+
+* 400 - Missing parameter subscriptionPlanRef
+* 403 - Only POST requests are allowed
 * 500 - Backend service error
\ No newline at end of file

From 73173a5265d022fcf4003e203bf2f677cc59069f Mon Sep 17 00:00:00 2001
From: munnyraht <muniratsulaimon@gmail.com>
Date: Tue, 17 Nov 2020 15:31:03 +0100
Subject: [PATCH 68/96] scouts and dashboard Api documentation updated

---
 .idea/inspectionProfiles/Project_Default.xml |  14 +
 .idea/workspace.xml                          | 105 +------
 Dashboard.md                                 | 311 ++++++++++++++++++-
 Scout.md                                     | 194 +++++++++++-
 Tixy.md                                      |   9 +-
 5 files changed, 534 insertions(+), 99 deletions(-)
 create mode 100644 .idea/inspectionProfiles/Project_Default.xml

diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml
new file mode 100644
index 0000000..e87177d
--- /dev/null
+++ b/.idea/inspectionProfiles/Project_Default.xml
@@ -0,0 +1,14 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="PyPep8NamingInspection" enabled="true" level="WEAK WARNING" enabled_by_default="true">
+      <option name="ignoredErrors">
+        <list>
+          <option value="N806" />
+          <option value="N802" />
+          <option value="N803" />
+        </list>
+      </option>
+    </inspection_tool>
+  </profile>
+</component>
\ No newline at end of file
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index ea3fdbb..2abb447 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -1,65 +1,30 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project version="4">
   <component name="ChangeListManager">
-    <list default="true" id="961d0b92-ea17-47b9-a7f7-a474e5e59d29" name="Default Changelist" comment="" />
-    <ignored path="$PROJECT_DIR$/.tmp/" />
-    <ignored path="$PROJECT_DIR$/temp/" />
-    <ignored path="$PROJECT_DIR$/tmp/" />
-    <option name="EXCLUDED_CONVERTED_TO_IGNORED" value="true" />
+    <list default="true" id="961d0b92-ea17-47b9-a7f7-a474e5e59d29" name="Default Changelist" comment="">
+      <change afterPath="$PROJECT_DIR$/.idea/inspectionProfiles/Project_Default.xml" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/Dashboard.md" beforeDir="false" afterPath="$PROJECT_DIR$/Dashboard.md" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/Scout.md" beforeDir="false" afterPath="$PROJECT_DIR$/Scout.md" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/Tixy.md" beforeDir="false" afterPath="$PROJECT_DIR$/Tixy.md" afterDir="false" />
+    </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
     <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
     <option name="LAST_RESOLUTION" value="IGNORE" />
   </component>
-  <component name="FileEditorManager">
-    <leaf SIDE_TABS_SIZE_LIMIT_KEY="300">
-      <file pinned="false" current-in-tab="true">
-        <entry file="file://$PROJECT_DIR$/Scout.md">
-          <provider selected="true" editor-type-id="split-provider[text-editor;markdown-preview-editor]">
-            <state split_layout="SPLIT">
-              <first_editor relative-caret-position="-5303">
-                <caret line="15" column="13" selection-start-line="15" selection-start-column="13" selection-end-line="15" selection-end-column="13" />
-              </first_editor>
-              <second_editor />
-            </state>
-          </provider>
-        </entry>
-      </file>
-    </leaf>
-  </component>
   <component name="Git.Settings">
     <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
   </component>
-  <component name="IdeDocumentHistory">
-    <option name="CHANGED_PATHS">
-      <list>
-        <option value="$PROJECT_DIR$/Scout.md" />
-      </list>
-    </option>
-  </component>
   <component name="ProjectFrameBounds">
     <option name="y" value="23" />
     <option name="width" value="1440" />
     <option name="height" value="830" />
   </component>
-  <component name="ProjectView">
-    <navigator proportions="" version="1">
-      <foldersAlwaysOnTop value="true" />
-    </navigator>
-    <panes>
-      <pane id="ProjectPane">
-        <subPane>
-          <expand>
-            <path>
-              <item name="flatdoc" type="b2602c69:ProjectViewProjectNode" />
-              <item name="flatdoc" type="462c0819:PsiDirectoryNode" />
-            </path>
-          </expand>
-          <select />
-        </subPane>
-      </pane>
-      <pane id="Scope" />
-    </panes>
+  <component name="ProjectId" id="1kMnmI8NJqFENbUnHHlahoxkjFU" />
+  <component name="ProjectViewState">
+    <option name="hideEmptyMiddlePackages" value="true" />
+    <option name="showLibraryContents" value="true" />
   </component>
   <component name="PropertiesComponent">
     <property name="SHARE_PROJECT_CONFIGURATION_FILES" value="true" />
@@ -69,18 +34,7 @@
     <property name="nodejs_npm_path_reset_for_default_project" value="true" />
     <property name="nodejs_package_manager_path" value="npm" />
   </component>
-  <component name="RunDashboard">
-    <option name="ruleStates">
-      <list>
-        <RuleState>
-          <option name="name" value="ConfigurationTypeDashboardGroupingRule" />
-        </RuleState>
-        <RuleState>
-          <option name="name" value="StatusDashboardGroupingRule" />
-        </RuleState>
-      </list>
-    </option>
-  </component>
+  <component name="SpellCheckerSettings" RuntimeDictionaries="0" Folders="0" CustomDictionaries="0" DefaultDictionary="application-level" UseSingleDictionary="true" transferred="true" />
   <component name="SvnConfiguration">
     <configuration />
   </component>
@@ -99,42 +53,7 @@
   <component name="TimeTrackingManager">
     <option name="totallyTimeSpent" value="3747000" />
   </component>
-  <component name="ToolWindowManager">
-    <frame x="0" y="23" width="1440" height="830" extended-state="0" />
-    <layout>
-      <window_info content_ui="combo" id="Project" order="0" visible="true" weight="0.24947146" />
-      <window_info id="Structure" order="1" side_tool="true" weight="0.25" />
-      <window_info id="npm" order="2" side_tool="true" />
-      <window_info id="Favorites" order="3" side_tool="true" />
-      <window_info anchor="bottom" id="Message" order="0" />
-      <window_info anchor="bottom" id="Find" order="1" />
-      <window_info anchor="bottom" id="Run" order="2" />
-      <window_info anchor="bottom" id="Debug" order="3" weight="0.4" />
-      <window_info anchor="bottom" id="Cvs" order="4" weight="0.25" />
-      <window_info anchor="bottom" id="Inspection" order="5" weight="0.4" />
-      <window_info anchor="bottom" id="TODO" order="6" />
-      <window_info anchor="bottom" id="Docker" order="7" show_stripe_button="false" />
-      <window_info anchor="bottom" id="Version Control" order="8" show_stripe_button="false" />
-      <window_info anchor="bottom" id="Event Log" order="9" side_tool="true" />
-      <window_info active="true" anchor="bottom" id="Terminal" order="10" visible="true" weight="0.50138503" />
-      <window_info anchor="right" id="Commander" internal_type="SLIDING" order="0" type="SLIDING" weight="0.4" />
-      <window_info anchor="right" id="Ant Build" order="1" weight="0.25" />
-      <window_info anchor="right" content_ui="combo" id="Hierarchy" order="2" weight="0.25" />
-    </layout>
-  </component>
   <component name="TypeScriptGeneratedFilesManager">
     <option name="version" value="1" />
   </component>
-  <component name="editorHistoryManager">
-    <entry file="file://$PROJECT_DIR$/Scout.md">
-      <provider selected="true" editor-type-id="split-provider[text-editor;markdown-preview-editor]">
-        <state split_layout="SPLIT">
-          <first_editor relative-caret-position="-5303">
-            <caret line="15" column="13" selection-start-line="15" selection-start-column="13" selection-end-line="15" selection-end-column="13" />
-          </first_editor>
-          <second_editor />
-        </state>
-      </provider>
-    </entry>
-  </component>
 </project>
\ No newline at end of file
diff --git a/Dashboard.md b/Dashboard.md
index 1c674f1..946cd39 100644
--- a/Dashboard.md
+++ b/Dashboard.md
@@ -1795,4 +1795,313 @@ Compare weekly positive sentiment count over a period of one week for clients
   ],
   "total": 8
 }
-```
\ No newline at end of file
+```
+
+## total requests
+Get total number of requests for a client.
+> Endpoint: versus_v2_get_total_requests
+
+> Payload
+
+``` python
+{
+  "clientRef": "12345",
+  "uid": "6789",
+  "idToken": "101112"
+}
+```
+
+> Response
+
+``` python
+{
+  "message":"Successfully obtained total number of requests",
+  "totalNumberOfRequests": 7
+}
+```
+
+## total number of client request respondents.
+Get total number of client request respondents.
+
+> Endpoint: versus_v2_get_total_client_request_respondents
+
+> Payload
+
+``` python
+{
+  "clientRef": "12345",
+  "uid": "6789",
+  "idToken": "101112"
+}
+```
+
+> Response
+
+``` python
+{
+  "message":"Successfully obtained total number of request respondents",
+  "totalNumberOfClientRequestRespondents": 7
+}
+```
+
+
+##  get requests
+Get a list of requests belonging to a client
+
+> Endpoint: versus_v2_get_requests 
+
+> Payload
+
+``` python
+{
+  "clientRef": "12345",
+  "uid": "6789",
+  "idToken": "101112"
+}
+```
+
+> Response
+
+``` python
+{
+  "message":"Successfully obtained requests",
+  [
+    {
+       "clientRef": "12345",
+       "clientName": "The Enterprise",
+       "requestName": "Footage of the Lekki Protest",
+       "description": "Let’s get you started with a simple photo request.",
+       "requestRef": "001a0ad177c-a6d0-44a4-8662-7f2851093b81",
+       "country": "NG",
+       "stateOrRegion": "Lagos",
+       "endAge": 65,
+       "startAge": 16,
+       "gender": "female",
+       "numberOfRespondents": 500,
+       "mediaType": "audio",
+       "status": "live",
+       "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
+    }
+    .
+    .
+  ]
+}
+```
+
+## total number of respondents for a request.
+Get total number of respondents for a request.
+
+> Endpoint: versus_v2_get_total_request_respondents
+
+> Payload
+
+``` python
+{
+  "clientRef": "12345",
+  "requestRef": "12345",
+  "uid": "6789",
+  "idToken": "101112"
+}
+
+```
+
+> Response
+
+``` python
+{
+  "message":"Successfully obtained total number of request respondents",
+  "totalNumberOfRequestRespondents": 7
+}
+```
+
+##  create requests
+Create a new request.
+
+> Endpoint: versus_v2_create_new_request
+
+
+> Payload
+
+``` python
+{
+  "clientRef": "12345",
+  "uid": "6789",
+  "idToken": "101112",
+  "requestName": "Footage of the Lekki Protest",
+  "description": "Let’s get you started with a simple photo request.",
+  "country": "NG",
+  "stateOrRegion": "Lagos",
+  "endAge": 65,
+  "startAge": 16,
+  "gender": "female",
+  "numberOfRespondents": 500,
+  "mediaType": "image"
+}
+
+```
+
+> Response
+
+``` python
+{
+  "message":"Successfully created new request",
+  "request": {
+    "clientRef": "12345",
+    "clientName": "The Enterprise",
+    "requestName": "Footage of the Lekki Protest",
+    "description": "Let’s get you started with a simple photo request.",
+    "requestRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
+    "country": "NG",
+    "stateOrRegion": "Lagos",
+    "endAge": 65,
+    "startAge": 16,
+    "gender": "female",
+    "numberOfRespondents": 500,
+    "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
+    "status": "live"
+  }
+}
+```
+
+##  get requests responses
+Get a list of responses for a request.
+
+> Endpoint: versus_v2_get_request_responses 
+
+> Payload
+
+``` python
+{
+  "clientRef": "12345",
+  "requestRef": "12345",
+  "uid": "6789",
+  "idToken": "101112"
+}
+
+```
+
+> Response
+
+``` python
+{
+  "message":"Successfully obtained request responses",
+    "responses": [
+    {
+      "clientRef": "12345",
+      "requestRef": "12345",
+      "scoutRef": "+2349484757484",
+      "mediaUrls":["https://google.api.com/235617"],
+      "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
+      "mediaType":"audio"
+    },
+    .
+    .
+  ]
+}
+```
+
+## Approve request response
+
+> Endpoint: versus_v2_approve_request_response
+
+> Payload
+
+``` python
+{
+  "clientRef": "12345",
+  "requestRef": "123456",
+  "responseRef": "123456",
+  "uid": "6789",
+  "idToken": "101112"
+}
+
+
+```
+
+> Response
+
+``` python
+{
+  "message":"Successfully approved request response",
+  "responseRef": "12345"
+}
+```
+
+## Reject request response.
+
+> Endpoint: versus_v2_reject_request_response
+
+> Payload
+
+``` python
+{
+  "clientRef": "12345",
+  "requestRef": "123456",
+  "responseRef": "78900",
+  "reasonForRejection": ["Wrong subject matter", "Poor quality", "Inapropriate content"],
+  "optionalMessage": "You are not a very serious scout. Why are you running?",
+  "uid": "6789",
+  "idToken": "101112"
+}
+
+
+```
+
+> Response
+
+``` python
+{
+  "message":"Successfully rejected request response",
+  "responseRef": "78900"
+}
+```
+
+## Batch approve request responses.
+
+> Endpoint: versus_v2_reject_request_response
+
+> Payload
+
+``` python
+{
+  "clientRef": "12345",
+  "requestRef": "123456",
+  "responseRefs": ["123456", "789081", "213634", "234879"],
+  "uid": "6789",
+  "idToken": "101112"
+}
+
+
+```
+> Response
+
+``` python
+{
+  "message":"Successfully batch-approved request responses",
+  "responseRefs": ["123456", "789081", "213634", "234879"],
+}
+```
+# Share request responses.
+
+> Endpoint: versus_v2_share_request_responses
+
+> Payload
+
+``` python
+{
+  "clientRef": "12345",
+  "requestRef": "1234566",
+  "uid": "6789",
+  "idToken": "101112"
+}
+
+
+```
+> Response
+
+``` python
+{
+  "message":"Successfully obtained responses zip url for sharing",
+  "requestResponsesZipUrl": "https://all-the-responses.zip"
+}
+```
diff --git a/Scout.md b/Scout.md
index 975dd44..6d699a6 100644
--- a/Scout.md
+++ b/Scout.md
@@ -478,4 +478,196 @@ Cashout scout credits to local currency
   "currency":"NGN",
   "referenceNumber":"b96f5fc7-722b-4f9e-bf81-a114d45f8dc6"
 }
-```
\ No newline at end of file
+```
+
+
+## get image requests
+
+Get a list of image multimedia requests
+
+> Endpoint: scout_get_image_requests
+
+> Payload
+
+``` python
+{
+  "authstring": "authentication string",
+  "phoneNumber": "+2348045634567"
+}
+```
+
+> Result
+``` python
+{
+  "message": "Successfully obtained image requests",
+   "requests":[
+      {
+        "clientRef": "12345",
+        "clientName": "The Enterprise",
+        "requestName": "Footage of the Lekki Protest",
+        "description": "Let’s get you started with a simple photo request.",
+        "requestRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
+        "country": "NG",
+        "stateOrRegion": "Lagos",
+        "endAge": 65,
+        "startAge": 16,
+        "gender": "female",
+        "numberOfRespondents": 500,
+        "mediaType": "image",
+        "status": "live"
+      }
+    .
+    .
+    .
+  ]
+}
+```
+
+## get audio requests
+
+Get a list of audio multimedia requests
+
+> Endpoint: scout_get_audio_requests
+
+> Payload
+
+``` python
+{
+  "authstring": "authentication string",
+  "phoneNumber": "+2348045634567"
+}
+```
+
+> Result
+``` python
+{
+  "message": "Successfully obtained audio requests",
+   "requests":[
+      {
+        "clientRef": "12345",
+        "clientName": "The Enterprise",
+        "requestName": "Footage of the Lekki Protest",
+        "description": "Let’s get you started with a simple photo request.",
+        "requestRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
+        "country": "NG",
+        "stateOrRegion": "Lagos",
+        "endAge": 65,
+        "startAge": 16,
+        "gender": "female",
+        "numberOfRespondents": 500,
+        "mediaType": "audio",
+        "status": "live"
+      }
+    .
+    .
+    .
+  ]
+}
+```
+
+## get video requests
+
+Get a list of audio multimedia requests
+
+> Endpoint: scout_get_video_requests
+
+> Payload
+
+``` python
+{
+  "authstring": "authentication string",
+  "phoneNumber": "+2348045634567"
+}
+```
+
+> Result
+``` python
+{
+  "message": "Successfully obtained video requests",
+   "requests":[
+      {
+        "clientRef": "12345",
+        "clientName": "The Enterprise",
+        "requestName": "Footage of the Lekki Protest",
+        "description": "Let’s get you started with a simple photo request.",
+        "requestRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
+        "country": "NG",
+        "stateOrRegion": "Lagos",
+        "endAge": 65,
+        "startAge": 16,
+        "gender": "female",
+        "numberOfRespondents": 500,
+        "mediaType": "audio",
+        "status": "live"
+      }
+    .
+    .
+    .
+  ]
+}
+```
+
+## Multimedia responses
+
+Post multimedia request responses
+
+> Endpoint: scout_add_multimedia_request_response
+
+> Payload
+
+``` python
+{
+  "requestRef": "12345",
+  "scoutRef": "239485855559",
+  "mediaUrls":["https://google.api.com/235617"],
+  "mediaType":"audio",
+}
+```
+
+> Result
+``` python
+{
+  "message":"Successfully added multimedia request response",
+  "responseRef": "9596869640495837"
+}
+```
+
+## History
+
+Get completed request responses arranged from the most recent.
+
+> Endpoint: scout_get_request_response_history
+
+> Payload
+
+``` python
+{
+  "authstring": "authentication string",
+  "phoneNumber": "+2348045634567"
+}
+```
+
+> Result
+``` python
+{
+  "message": "Successfully obtained request responses",
+   "requests":[
+      {
+        "clientRef": "12345",
+        "requestRef": "12345",
+        "scoutRef": "+2340927738929",
+        "mediaUrls":["https://google.api.com/235617"],
+        "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
+        "mediaType":"audio",
+        "status": "pending"
+      }
+    .
+    .
+    .
+  ]
+}
+```
+
+
+
+
diff --git a/Tixy.md b/Tixy.md
index 88e8f40..4a027a3 100644
--- a/Tixy.md
+++ b/Tixy.md
@@ -61,7 +61,7 @@ Endpoint for Tixy
 
 ```json
 {
-    "email": "email",
+    "email": "email"
 }
 ```
 
@@ -87,7 +87,7 @@ Endpoint for Tixy
                 "username": "username", 
                 "no_tickets_sold": 62,
                 "revenue": 186000, 
-                "status": "status"},
+                "status": "status"}
 
 }
 ```
@@ -126,7 +126,7 @@ Endpoint for Tixy
                 "username": "username", 
                 "no_tickets_sold": 62,
                 "revenue": 186000, 
-                "status": "status"},
+                "status": "status"}
 
 }
 ```
@@ -165,7 +165,7 @@ Endpoint for Tixy
                 "username": "username", 
                 "no_tickets_sold": 62,
                 "revenue": 186000, 
-                "status": "status"},
+                "status": "status"}
 
 }
 ```
@@ -236,6 +236,7 @@ Endpoint for Tixy
          "amount": 6000,
          "event_name": "Teker Expo", 
          "purchase_date": "2019-05-04T12:30:30.001Z"} 
+}
 
 ```
 

From 58656c6a6dbc272dc7fa94a62ddf3fbc35844030 Mon Sep 17 00:00:00 2001
From: munnyraht <muniratsulaimon@gmail.com>
Date: Tue, 17 Nov 2020 15:42:25 +0100
Subject: [PATCH 69/96] Dashboard Api documentation updated

---
 .idea/workspace.xml |  4 ----
 Dashboard.md        | 24 ++++++++++++++++++++++++
 2 files changed, 24 insertions(+), 4 deletions(-)

diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index 2abb447..f41ea12 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -2,11 +2,7 @@
 <project version="4">
   <component name="ChangeListManager">
     <list default="true" id="961d0b92-ea17-47b9-a7f7-a474e5e59d29" name="Default Changelist" comment="">
-      <change afterPath="$PROJECT_DIR$/.idea/inspectionProfiles/Project_Default.xml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
       <change beforePath="$PROJECT_DIR$/Dashboard.md" beforeDir="false" afterPath="$PROJECT_DIR$/Dashboard.md" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/Scout.md" beforeDir="false" afterPath="$PROJECT_DIR$/Scout.md" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/Tixy.md" beforeDir="false" afterPath="$PROJECT_DIR$/Tixy.md" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
diff --git a/Dashboard.md b/Dashboard.md
index 946cd39..3b5c7cd 100644
--- a/Dashboard.md
+++ b/Dashboard.md
@@ -2105,3 +2105,27 @@ Get a list of responses for a request.
   "requestResponsesZipUrl": "https://all-the-responses.zip"
 }
 ```
+
+# Download request responses..
+
+> Endpoint: versus_v2_download_request_responses
+
+> Payload
+
+``` python
+{
+  "clientRef": "12345",
+  "requestRef": "1234566",
+  "uid": "6789",
+  "idToken": "101112"
+}
+
+
+```
+> Response
+
+``` python
+{
+  
+}
+```

From 4fc8fd4bbfea1741c26fb5867f0dc7240afb40f4 Mon Sep 17 00:00:00 2001
From: munnyraht <muniratsulaimon@gmail.com>
Date: Thu, 19 Nov 2020 12:23:37 +0100
Subject: [PATCH 70/96] scoud.md updated

---
 .idea/workspace.xml |  2 ++
 Dashboard.md        | 20 +++++++-------
 Scout.md            | 64 ++++++++++++++++++++++-----------------------
 3 files changed, 43 insertions(+), 43 deletions(-)

diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index f41ea12..875394d 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -2,7 +2,9 @@
 <project version="4">
   <component name="ChangeListManager">
     <list default="true" id="961d0b92-ea17-47b9-a7f7-a474e5e59d29" name="Default Changelist" comment="">
+      <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
       <change beforePath="$PROJECT_DIR$/Dashboard.md" beforeDir="false" afterPath="$PROJECT_DIR$/Dashboard.md" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/Scout.md" beforeDir="false" afterPath="$PROJECT_DIR$/Scout.md" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
diff --git a/Dashboard.md b/Dashboard.md
index 3b5c7cd..0c3048b 100644
--- a/Dashboard.md
+++ b/Dashboard.md
@@ -1820,7 +1820,7 @@ Get total number of requests for a client.
 }
 ```
 
-## total number of client request respondents.
+## Number of Client Request Respondents.
 Get total number of client request respondents.
 
 > Endpoint: versus_v2_get_total_client_request_respondents
@@ -1845,7 +1845,7 @@ Get total number of client request respondents.
 ```
 
 
-##  get requests
+##  Get Requests
 Get a list of requests belonging to a client
 
 > Endpoint: versus_v2_get_requests 
@@ -1888,7 +1888,7 @@ Get a list of requests belonging to a client
 }
 ```
 
-## total number of respondents for a request.
+## Number Of Respondents For A Request.
 Get total number of respondents for a request.
 
 > Endpoint: versus_v2_get_total_request_respondents
@@ -1914,7 +1914,7 @@ Get total number of respondents for a request.
 }
 ```
 
-##  create requests
+##  Create Requests
 Create a new request.
 
 > Endpoint: versus_v2_create_new_request
@@ -1963,7 +1963,7 @@ Create a new request.
 }
 ```
 
-##  get requests responses
+##  Get Requests Responses
 Get a list of responses for a request.
 
 > Endpoint: versus_v2_get_request_responses 
@@ -2000,7 +2000,7 @@ Get a list of responses for a request.
 }
 ```
 
-## Approve request response
+## Approve Request Response
 
 > Endpoint: versus_v2_approve_request_response
 
@@ -2027,7 +2027,7 @@ Get a list of responses for a request.
 }
 ```
 
-## Reject request response.
+## Reject Request Response.
 
 > Endpoint: versus_v2_reject_request_response
 
@@ -2056,7 +2056,7 @@ Get a list of responses for a request.
 }
 ```
 
-## Batch approve request responses.
+## Batch Approve Request Responses.
 
 > Endpoint: versus_v2_reject_request_response
 
@@ -2081,7 +2081,7 @@ Get a list of responses for a request.
   "responseRefs": ["123456", "789081", "213634", "234879"],
 }
 ```
-# Share request responses.
+# Share Request Responses.
 
 > Endpoint: versus_v2_share_request_responses
 
@@ -2106,7 +2106,7 @@ Get a list of responses for a request.
 }
 ```
 
-# Download request responses..
+# Download Request Responses..
 
 > Endpoint: versus_v2_download_request_responses
 
diff --git a/Scout.md b/Scout.md
index 6d699a6..30bb42a 100644
--- a/Scout.md
+++ b/Scout.md
@@ -485,16 +485,16 @@ Cashout scout credits to local currency
 
 Get a list of image multimedia requests
 
-> Endpoint: scout_get_image_requests
+> Endpoint: scout_get_image_requests?phoneNumber={phoneNumber}&authString={authString}
 
-> Payload
+> Query params
+
+
+| parameters | 
+| -----------| 
+| authstring |
+| phoneNumber| 
 
-``` python
-{
-  "authstring": "authentication string",
-  "phoneNumber": "+2348045634567"
-}
-```
 
 > Result
 ``` python
@@ -527,16 +527,16 @@ Get a list of image multimedia requests
 
 Get a list of audio multimedia requests
 
-> Endpoint: scout_get_audio_requests
+> Endpoint: scout_get_audio_requests?phoneNumber={phoneNumber}&authString={authString}
 
-> Payload
+> Query params
+
+
+| Parameters  | 
+| ----------- | 
+| authstring  |
+| phoneNumber | 
 
-``` python
-{
-  "authstring": "authentication string",
-  "phoneNumber": "+2348045634567"
-}
-```
 
 > Result
 ``` python
@@ -567,18 +567,17 @@ Get a list of audio multimedia requests
 
 ## get video requests
 
-Get a list of audio multimedia requests
+Get a list of video multimedia requests
 
-> Endpoint: scout_get_video_requests
+> Endpoint: scout_get_video_requests?phoneNumber={phoneNumber}&authString={authString}
 
-> Payload
+> Query params
+
+| Parameters  | 
+| ----------- | 
+| authstring  |
+| phoneNumber | 
 
-``` python
-{
-  "authstring": "authentication string",
-  "phoneNumber": "+2348045634567"
-}
-```
 
 > Result
 ``` python
@@ -636,16 +635,15 @@ Post multimedia request responses
 
 Get completed request responses arranged from the most recent.
 
-> Endpoint: scout_get_request_response_history
+> Endpoint: scout_get_request_response_history?phoneNumber={phoneNumber}&authString={authString}
 
-> Payload
+> Query params
+
+| Parameters  | 
+| ----------- | 
+| authstring  |
+| phoneNumber | 
 
-``` python
-{
-  "authstring": "authentication string",
-  "phoneNumber": "+2348045634567"
-}
-```
 
 > Result
 ``` python

From a84605cfc5756de6448ce69591b1cff654c92200 Mon Sep 17 00:00:00 2001
From: munnyraht <muniratsulaimon@gmail.com>
Date: Thu, 19 Nov 2020 15:44:23 +0100
Subject: [PATCH 71/96] flatdoc updated

---
 .idea/workspace.xml |  1 -
 Scout.md            | 50 +++++++++++++++++++++++++++++++++++++++++++--
 2 files changed, 48 insertions(+), 3 deletions(-)

diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index 875394d..a217c65 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -3,7 +3,6 @@
   <component name="ChangeListManager">
     <list default="true" id="961d0b92-ea17-47b9-a7f7-a474e5e59d29" name="Default Changelist" comment="">
       <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/Dashboard.md" beforeDir="false" afterPath="$PROJECT_DIR$/Dashboard.md" afterDir="false" />
       <change beforePath="$PROJECT_DIR$/Scout.md" beforeDir="false" afterPath="$PROJECT_DIR$/Scout.md" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
diff --git a/Scout.md b/Scout.md
index 30bb42a..75e0ccd 100644
--- a/Scout.md
+++ b/Scout.md
@@ -509,6 +509,7 @@ Get a list of image multimedia requests
         "requestRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
         "country": "NG",
         "stateOrRegion": "Lagos",
+        "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
         "endAge": 65,
         "startAge": 16,
         "gender": "female",
@@ -551,6 +552,7 @@ Get a list of audio multimedia requests
         "requestRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
         "country": "NG",
         "stateOrRegion": "Lagos",
+        "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
         "endAge": 65,
         "startAge": 16,
         "gender": "female",
@@ -592,6 +594,7 @@ Get a list of video multimedia requests
         "requestRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
         "country": "NG",
         "stateOrRegion": "Lagos",
+        "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
         "endAge": 65,
         "startAge": 16,
         "gender": "female",
@@ -605,6 +608,49 @@ Get a list of video multimedia requests
   ]
 }
 ```
+## Get A List Of Multimedia Requests A Scout Is Eligible To Send Responses
+Request
+
+Get a list of image multimedia requests
+
+> Endpoint: scout_get_multimedia_requests?phoneNumber={phoneNumber}&authString={authString}
+
+> Query params
+
+
+| parameters | 
+| -----------| 
+| authstring |
+| phoneNumber| 
+
+
+> Result
+``` python
+{
+  "message": "Successfully obtained image requests",
+   "requests":[
+      {
+        "clientRef": "12345",
+        "clientName": "The Enterprise",
+        "requestName": "Footage of the Lekki Protest",
+        "description": "Let’s get you started with a simple photo request.",
+        "requestRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
+        "country": "NG",
+        "stateOrRegion": "Lagos",
+        "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
+        "endAge": 65,
+        "startAge": 16,
+        "gender": "female",
+        "numberOfRespondents": 500,
+        "mediaType": "image",
+        "status": "live"
+      }
+    .
+    .
+    .
+  ]
+}
+```
 
 ## Multimedia responses
 
@@ -631,11 +677,11 @@ Post multimedia request responses
 }
 ```
 
-## History
+## Responses
 
 Get completed request responses arranged from the most recent.
 
-> Endpoint: scout_get_request_response_history?phoneNumber={phoneNumber}&authString={authString}
+> Endpoint: scout_get_request_response?phoneNumber={phoneNumber}&authString={authString}
 
 > Query params
 

From c82b415e15425b7c86b4fcf3164d572dc2ccc548 Mon Sep 17 00:00:00 2001
From: munnyraht <muniratsulaimon@gmail.com>
Date: Thu, 19 Nov 2020 17:39:29 +0100
Subject: [PATCH 72/96] Versus-2.0.md updated

---
 .idea/workspace.xml |   3 +-
 Dashboard.md        | 332 --------------------------------------------
 Versus-2.0.md       | 332 ++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 334 insertions(+), 333 deletions(-)

diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index a217c65..82b7d6e 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -3,7 +3,8 @@
   <component name="ChangeListManager">
     <list default="true" id="961d0b92-ea17-47b9-a7f7-a474e5e59d29" name="Default Changelist" comment="">
       <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/Scout.md" beforeDir="false" afterPath="$PROJECT_DIR$/Scout.md" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/Dashboard.md" beforeDir="false" afterPath="$PROJECT_DIR$/Dashboard.md" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/Versus-2.0.md" beforeDir="false" afterPath="$PROJECT_DIR$/Versus-2.0.md" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
diff --git a/Dashboard.md b/Dashboard.md
index 0c3048b..8dbb589 100644
--- a/Dashboard.md
+++ b/Dashboard.md
@@ -1797,335 +1797,3 @@ Compare weekly positive sentiment count over a period of one week for clients
 }
 ```
 
-## total requests
-Get total number of requests for a client.
-> Endpoint: versus_v2_get_total_requests
-
-> Payload
-
-``` python
-{
-  "clientRef": "12345",
-  "uid": "6789",
-  "idToken": "101112"
-}
-```
-
-> Response
-
-``` python
-{
-  "message":"Successfully obtained total number of requests",
-  "totalNumberOfRequests": 7
-}
-```
-
-## Number of Client Request Respondents.
-Get total number of client request respondents.
-
-> Endpoint: versus_v2_get_total_client_request_respondents
-
-> Payload
-
-``` python
-{
-  "clientRef": "12345",
-  "uid": "6789",
-  "idToken": "101112"
-}
-```
-
-> Response
-
-``` python
-{
-  "message":"Successfully obtained total number of request respondents",
-  "totalNumberOfClientRequestRespondents": 7
-}
-```
-
-
-##  Get Requests
-Get a list of requests belonging to a client
-
-> Endpoint: versus_v2_get_requests 
-
-> Payload
-
-``` python
-{
-  "clientRef": "12345",
-  "uid": "6789",
-  "idToken": "101112"
-}
-```
-
-> Response
-
-``` python
-{
-  "message":"Successfully obtained requests",
-  [
-    {
-       "clientRef": "12345",
-       "clientName": "The Enterprise",
-       "requestName": "Footage of the Lekki Protest",
-       "description": "Let’s get you started with a simple photo request.",
-       "requestRef": "001a0ad177c-a6d0-44a4-8662-7f2851093b81",
-       "country": "NG",
-       "stateOrRegion": "Lagos",
-       "endAge": 65,
-       "startAge": 16,
-       "gender": "female",
-       "numberOfRespondents": 500,
-       "mediaType": "audio",
-       "status": "live",
-       "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
-    }
-    .
-    .
-  ]
-}
-```
-
-## Number Of Respondents For A Request.
-Get total number of respondents for a request.
-
-> Endpoint: versus_v2_get_total_request_respondents
-
-> Payload
-
-``` python
-{
-  "clientRef": "12345",
-  "requestRef": "12345",
-  "uid": "6789",
-  "idToken": "101112"
-}
-
-```
-
-> Response
-
-``` python
-{
-  "message":"Successfully obtained total number of request respondents",
-  "totalNumberOfRequestRespondents": 7
-}
-```
-
-##  Create Requests
-Create a new request.
-
-> Endpoint: versus_v2_create_new_request
-
-
-> Payload
-
-``` python
-{
-  "clientRef": "12345",
-  "uid": "6789",
-  "idToken": "101112",
-  "requestName": "Footage of the Lekki Protest",
-  "description": "Let’s get you started with a simple photo request.",
-  "country": "NG",
-  "stateOrRegion": "Lagos",
-  "endAge": 65,
-  "startAge": 16,
-  "gender": "female",
-  "numberOfRespondents": 500,
-  "mediaType": "image"
-}
-
-```
-
-> Response
-
-``` python
-{
-  "message":"Successfully created new request",
-  "request": {
-    "clientRef": "12345",
-    "clientName": "The Enterprise",
-    "requestName": "Footage of the Lekki Protest",
-    "description": "Let’s get you started with a simple photo request.",
-    "requestRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
-    "country": "NG",
-    "stateOrRegion": "Lagos",
-    "endAge": 65,
-    "startAge": 16,
-    "gender": "female",
-    "numberOfRespondents": 500,
-    "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
-    "status": "live"
-  }
-}
-```
-
-##  Get Requests Responses
-Get a list of responses for a request.
-
-> Endpoint: versus_v2_get_request_responses 
-
-> Payload
-
-``` python
-{
-  "clientRef": "12345",
-  "requestRef": "12345",
-  "uid": "6789",
-  "idToken": "101112"
-}
-
-```
-
-> Response
-
-``` python
-{
-  "message":"Successfully obtained request responses",
-    "responses": [
-    {
-      "clientRef": "12345",
-      "requestRef": "12345",
-      "scoutRef": "+2349484757484",
-      "mediaUrls":["https://google.api.com/235617"],
-      "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
-      "mediaType":"audio"
-    },
-    .
-    .
-  ]
-}
-```
-
-## Approve Request Response
-
-> Endpoint: versus_v2_approve_request_response
-
-> Payload
-
-``` python
-{
-  "clientRef": "12345",
-  "requestRef": "123456",
-  "responseRef": "123456",
-  "uid": "6789",
-  "idToken": "101112"
-}
-
-
-```
-
-> Response
-
-``` python
-{
-  "message":"Successfully approved request response",
-  "responseRef": "12345"
-}
-```
-
-## Reject Request Response.
-
-> Endpoint: versus_v2_reject_request_response
-
-> Payload
-
-``` python
-{
-  "clientRef": "12345",
-  "requestRef": "123456",
-  "responseRef": "78900",
-  "reasonForRejection": ["Wrong subject matter", "Poor quality", "Inapropriate content"],
-  "optionalMessage": "You are not a very serious scout. Why are you running?",
-  "uid": "6789",
-  "idToken": "101112"
-}
-
-
-```
-
-> Response
-
-``` python
-{
-  "message":"Successfully rejected request response",
-  "responseRef": "78900"
-}
-```
-
-## Batch Approve Request Responses.
-
-> Endpoint: versus_v2_reject_request_response
-
-> Payload
-
-``` python
-{
-  "clientRef": "12345",
-  "requestRef": "123456",
-  "responseRefs": ["123456", "789081", "213634", "234879"],
-  "uid": "6789",
-  "idToken": "101112"
-}
-
-
-```
-> Response
-
-``` python
-{
-  "message":"Successfully batch-approved request responses",
-  "responseRefs": ["123456", "789081", "213634", "234879"],
-}
-```
-# Share Request Responses.
-
-> Endpoint: versus_v2_share_request_responses
-
-> Payload
-
-``` python
-{
-  "clientRef": "12345",
-  "requestRef": "1234566",
-  "uid": "6789",
-  "idToken": "101112"
-}
-
-
-```
-> Response
-
-``` python
-{
-  "message":"Successfully obtained responses zip url for sharing",
-  "requestResponsesZipUrl": "https://all-the-responses.zip"
-}
-```
-
-# Download Request Responses..
-
-> Endpoint: versus_v2_download_request_responses
-
-> Payload
-
-``` python
-{
-  "clientRef": "12345",
-  "requestRef": "1234566",
-  "uid": "6789",
-  "idToken": "101112"
-}
-
-
-```
-> Response
-
-``` python
-{
-  
-}
-```
diff --git a/Versus-2.0.md b/Versus-2.0.md
index 56ab016..b23fd7f 100644
--- a/Versus-2.0.md
+++ b/Versus-2.0.md
@@ -1707,6 +1707,338 @@ Obtain details of a subscription plan
   }
 }
 ```
+## Total Requests
+Get total number of requests for a client.
+> Endpoint: versus_v2_get_total_requests
+
+> Payload
+
+``` python
+{
+  "clientRef": "12345",
+  "uid": "6789",
+  "idToken": "101112"
+}
+```
+
+> Response
+
+``` python
+{
+  "message":"Successfully obtained total number of requests",
+  "totalNumberOfRequests": 7
+}
+```
+
+## Number of Client Request Respondents.
+Get total number of client request respondents.
+
+> Endpoint: versus_v2_get_total_client_request_respondents
+
+> Payload
+
+``` python
+{
+  "clientRef": "12345",
+  "uid": "6789",
+  "idToken": "101112"
+}
+```
+
+> Response
+
+``` python
+{
+  "message":"Successfully obtained total number of request respondents",
+  "totalNumberOfClientRequestRespondents": 7
+}
+```
+
+
+##  Get Requests
+Get a list of requests belonging to a client
+
+> Endpoint: versus_v2_get_requests 
+
+> Payload
+
+``` python
+{
+  "clientRef": "12345",
+  "uid": "6789",
+  "idToken": "101112"
+}
+```
+
+> Response
+
+``` python
+{
+  "message":"Successfully obtained requests",
+  [
+    {
+       "clientRef": "12345",
+       "clientName": "The Enterprise",
+       "requestName": "Footage of the Lekki Protest",
+       "description": "Let’s get you started with a simple photo request.",
+       "requestRef": "001a0ad177c-a6d0-44a4-8662-7f2851093b81",
+       "country": "NG",
+       "stateOrRegion": "Lagos",
+       "endAge": 65,
+       "startAge": 16,
+       "gender": "female",
+       "numberOfRespondents": 500,
+       "mediaType": "audio",
+       "status": "live",
+       "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
+    }
+    .
+    .
+  ]
+}
+```
+
+## Number Of Respondents For A Request.
+Get total number of respondents for a request.
+
+> Endpoint: versus_v2_get_total_request_respondents
+
+> Payload
+
+``` python
+{
+  "clientRef": "12345",
+  "requestRef": "12345",
+  "uid": "6789",
+  "idToken": "101112"
+}
+
+```
+
+> Response
+
+``` python
+{
+  "message":"Successfully obtained total number of request respondents",
+  "totalNumberOfRequestRespondents": 7
+}
+```
+
+##  Create Requests
+Create a new request.
+
+> Endpoint: versus_v2_create_new_request
+
+
+> Payload
+
+``` python
+{
+  "clientRef": "12345",
+  "uid": "6789",
+  "idToken": "101112",
+  "requestName": "Footage of the Lekki Protest",
+  "description": "Let’s get you started with a simple photo request.",
+  "country": "NG",
+  "stateOrRegion": "Lagos",
+  "endAge": 65,
+  "startAge": 16,
+  "gender": "female",
+  "numberOfRespondents": 500,
+  "mediaType": "image"
+}
+
+```
+
+> Response
+
+``` python
+{
+  "message":"Successfully created new request",
+  "request": {
+    "clientRef": "12345",
+    "clientName": "The Enterprise",
+    "requestName": "Footage of the Lekki Protest",
+    "description": "Let’s get you started with a simple photo request.",
+    "requestRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
+    "country": "NG",
+    "stateOrRegion": "Lagos",
+    "endAge": 65,
+    "startAge": 16,
+    "gender": "female",
+    "numberOfRespondents": 500,
+    "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
+    "status": "live"
+  }
+}
+```
+
+##  Get Requests Responses
+Get a list of responses for a request.
+
+> Endpoint: versus_v2_get_request_responses 
+
+> Payload
+
+``` python
+{
+  "clientRef": "12345",
+  "requestRef": "12345",
+  "uid": "6789",
+  "idToken": "101112"
+}
+
+```
+
+> Response
+
+``` python
+{
+  "message":"Successfully obtained request responses",
+    "responses": [
+    {
+      "clientRef": "12345",
+      "requestRef": "12345",
+      "scoutRef": "+2349484757484",
+      "mediaUrls":["https://google.api.com/235617"],
+      "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
+      "mediaType":"audio"
+    },
+    .
+    .
+  ]
+}
+```
+
+## Approve Request Response
+
+> Endpoint: versus_v2_approve_request_response
+
+> Payload
+
+``` python
+{
+  "clientRef": "12345",
+  "requestRef": "123456",
+  "responseRef": "123456",
+  "uid": "6789",
+  "idToken": "101112"
+}
+
+
+```
+
+> Response
+
+``` python
+{
+  "message":"Successfully approved request response",
+  "responseRef": "12345"
+}
+```
+
+## Reject Request Response.
+
+> Endpoint: versus_v2_reject_request_response
+
+> Payload
+
+``` python
+{
+  "clientRef": "12345",
+  "requestRef": "123456",
+  "responseRef": "78900",
+  "reasonForRejection": ["Wrong subject matter", "Poor quality", "Inapropriate content"],
+  "optionalMessage": "You are not a very serious scout. Why are you running?",
+  "uid": "6789",
+  "idToken": "101112"
+}
+
+
+```
+
+> Response
+
+``` python
+{
+  "message":"Successfully rejected request response",
+  "responseRef": "78900"
+}
+```
+
+## Batch Approve Request Responses.
+
+> Endpoint: versus_v2_reject_request_response
+
+> Payload
+
+``` python
+{
+  "clientRef": "12345",
+  "requestRef": "123456",
+  "responseRefs": ["123456", "789081", "213634", "234879"],
+  "uid": "6789",
+  "idToken": "101112"
+}
+
+
+```
+> Response
+
+``` python
+{
+  "message":"Successfully batch-approved request responses",
+  "responseRefs": ["123456", "789081", "213634", "234879"],
+}
+```
+# Share Request Responses.
+
+> Endpoint: versus_v2_share_request_responses
+
+> Payload
+
+``` python
+{
+  "clientRef": "12345",
+  "requestRef": "1234566",
+  "uid": "6789",
+  "idToken": "101112"
+}
+
+
+```
+> Response
+
+``` python
+{
+  "message":"Successfully obtained responses zip url for sharing",
+  "requestResponsesZipUrl": "https://all-the-responses.zip"
+}
+```
+
+# Download Request Responses..
+
+> Endpoint: versus_v2_download_request_responses
+
+> Payload
+
+``` python
+{
+  "clientRef": "12345",
+  "requestRef": "1234566",
+  "uid": "6789",
+  "idToken": "101112"
+}
+
+
+```
+> Response
+
+``` python
+{
+  
+}
+```
 
 > Errors
 

From 9f3298d9303838efdd9cd247b287fd41eafb22c3 Mon Sep 17 00:00:00 2001
From: munnyraht <muniratsulaimon@gmail.com>
Date: Tue, 24 Nov 2020 13:13:42 +0100
Subject: [PATCH 73/96] documentation updated

---
 .idea/workspace.xml |  6 ------
 Versus-2.0.md       | 41 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 41 insertions(+), 6 deletions(-)

diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index 82b7d6e..ef5996a 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -3,7 +3,6 @@
   <component name="ChangeListManager">
     <list default="true" id="961d0b92-ea17-47b9-a7f7-a474e5e59d29" name="Default Changelist" comment="">
       <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/Dashboard.md" beforeDir="false" afterPath="$PROJECT_DIR$/Dashboard.md" afterDir="false" />
       <change beforePath="$PROJECT_DIR$/Versus-2.0.md" beforeDir="false" afterPath="$PROJECT_DIR$/Versus-2.0.md" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
@@ -14,11 +13,6 @@
   <component name="Git.Settings">
     <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
   </component>
-  <component name="ProjectFrameBounds">
-    <option name="y" value="23" />
-    <option name="width" value="1440" />
-    <option name="height" value="830" />
-  </component>
   <component name="ProjectId" id="1kMnmI8NJqFENbUnHHlahoxkjFU" />
   <component name="ProjectViewState">
     <option name="hideEmptyMiddlePackages" value="true" />
diff --git a/Versus-2.0.md b/Versus-2.0.md
index b23fd7f..dd05ed4 100644
--- a/Versus-2.0.md
+++ b/Versus-2.0.md
@@ -2040,6 +2040,47 @@ Get a list of responses for a request.
 }
 ```
 
+##  Get Requests Responses
+Get a list of responses for a request.
+
+> Endpoint: versus_v2_get_request_responses 
+
+> Payload
+
+``` python
+{
+  "clientRef": "12345",
+  "requestRef": "12345",
+  "uid": "6789",
+  "idToken": "101112"
+}
+
+```
+
+> Response
+
+``` python
+{
+  "message":"Successfully obtained request",
+  "request": {
+       "clientRef": "12345",
+       "clientName": "The Enterprise",
+       "requestName": "Footage of the Lekki Protest",
+       "description": "Let’s get you started with a simple photo request.",
+       "requestRef": "001a0ad177c-a6d0-44a4-8662-7f2851093b81",
+       "country": "NG",
+       "stateOrRegion": "Lagos",
+       "endAge": 65,
+       "startAge": 16,
+       "gender": "female",
+       "numberOfRespondents": 500,
+       "mediaType": "audio",
+       "status": "live",
+       "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
+  }
+}
+```
+
 > Errors
 
 * 400 - Missing parameter subscriptionPlanRef

From d1cb9416720857fd292689ee8ff299dca2939f0f Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Mon, 30 Nov 2020 17:19:45 +0100
Subject: [PATCH 74/96] added settings doc

---
 Settings.md   | 79 +++++++++++++++++++++++++++++++++++++++++++++++++++
 settings.html | 64 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 143 insertions(+)
 create mode 100644 Settings.md
 create mode 100644 settings.html

diff --git a/Settings.md b/Settings.md
new file mode 100644
index 0000000..9730d61
--- /dev/null
+++ b/Settings.md
@@ -0,0 +1,79 @@
+# Settings
+
+These endpoints can be used to obtain and update scout and client settings.
+
+## Get Scout Settings
+
+Obtains scout settings.
+
+> Endpoint: get_scout_settings
+
+> Method: GET
+
+> Payload
+
+```json
+{
+  "authstring": "55ad4986-b519-4e44-ab0b-890527299af6"
+}
+```
+
+> Response
+
+```json
+{
+  "message": "Successfully obtained scout settings",
+  "scoutSettings": {
+    "creditsPerQuestion_video": 2,
+    "creditsPerQuestion_audio": 2,
+    "usdPerCredit": 0.05,
+    "exchangeRate_NGNperUSD": 360,
+    "creditsPerQuestion_image": 2,
+    "creditsPerQuestion_text": 1
+  }
+}
+```
+
+> Errors
+
+* 401 = Unauthorized request
+* 403 - Only GET requests are allowed
+* 500 - Error getting scout settings
+
+
+## Update Scout Settings
+
+Update scout settings.
+
+> Endpoint: update_scout_settings
+
+> Method: POST
+
+> Payload
+
+``` json
+{
+  "authstring": "13238bee-3ac9-4c77-b3b1-c7c53f113d5a",
+  "creditsPerQuestion_audio": 2,
+  // and more scout settings
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully updated scout settings",
+    "update": {
+      "creditsPerQuestion_audio": 2
+    }
+}
+```
+
+> Errors
+
+* 400 - No required values included for update
+* 401 - Unauthorized request
+* 403 - Only POST requests are allowed
+* 404 - Scout does not exist
+* 500 - Error updating scout settings
diff --git a/settings.html b/settings.html
new file mode 100644
index 0000000..a2531f6
--- /dev/null
+++ b/settings.html
@@ -0,0 +1,64 @@
+<!doctype html>
+<html>
+
+  <head>
+    <meta charset='utf-8'>
+    <meta http-equiv="X-UA-Compatible" content="chrome=1" />
+    <meta name="viewport" content="width=device-width">
+
+    <title>Enterfive Docs - Versus-2.0</title>
+
+    <!-- Flatdoc -->
+    <script src='support/vendor/jquery.js'></script>
+    <script src='legacy.js'></script>
+    <script src='flatdoc.js'></script>
+
+    <!-- Flatdoc theme -->
+    <link href='theme-white/style.css' rel='stylesheet'>
+    <script src='theme-white/script.js'></script>
+    <link href='support/theme.css' rel='stylesheet'>
+
+    <!-- Initializer -->
+    <script>
+      Flatdoc.run({
+        fetcher: Flatdoc.file('Versus-2.0.md')
+      });
+    </script>
+  </head>
+
+  <body role='flatdoc'>
+
+    <div class='header'>
+      <div class='left'>
+        <h1><a href='.'>Enterfive</a></h1>
+        <ul>
+          <li><a href='clients.html'>Clients</a></li>
+          <li><a href='dashboard.html'>Dashboard</a></li>
+          <li><a href='email.html'>Email Templates</a></li>
+          <li><a href='profanity.html'>Profanity Filter</a></li>
+          <li><a href='reference.html'>API reference</a></li>
+          <li><a href='scout.html'>Scouts</a></li>
+          <li><a href='tixy.html'>Tixy</a></li>
+          <li><a href='versus-2.0.html'>Versus-2.0</a></li>
+          <li><a href='powertrack.html'>Powertrack</a></li>
+          <li><a href='settings.html'>Settings</a></li>
+        </ul>
+      </div>
+      <div class='right'>
+        <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;type=follow&amp;count=true"
+          allowtransparency="true" frameborder="0" scrolling="0" width="170" height="20"></iframe>
+        <iframe src="http://ghbtns.com/github-btn.html?user=rstacruz&amp;repo=flatdoc&amp;type=watch&amp;count=true"
+          allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe>
+      </div>
+    </div>
+
+    <div class='content-root'>
+      <div class='menubar'>
+        <div class='menu section' role='flatdoc-menu'></div>
+      </div>
+      <div role='flatdoc-content' class='content'></div>
+    </div>
+
+  </body>
+
+</html>
\ No newline at end of file

From 8e767c41dfcb5cd1630cd76fd714a0521aa086cc Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Mon, 30 Nov 2020 17:20:02 +0100
Subject: [PATCH 75/96] fixed links on diferent pages

---
 clients.html    | 6 +++---
 dashboard.html  | 6 +++---
 email.html      | 6 +++---
 index.html      | 1 +
 profanity.html  | 6 +++---
 scout.html      | 6 +++---
 tixy.html       | 6 +++---
 versus-2.0.html | 1 +
 8 files changed, 20 insertions(+), 18 deletions(-)

diff --git a/clients.html b/clients.html
index 9f09eab..6be68c1 100644
--- a/clients.html
+++ b/clients.html
@@ -36,10 +36,10 @@ <h1><a href='.'>Enterfive</a></h1>
         <li><a href='profanity.html'>Profanity Filter</a></li>
         <li><a href='reference.html'>API reference</a></li>
         <li><a href='scout.html'>Scouts</a></li>
-        <li><a href='powertrack.html'>Powertrack</a></li>
-      </ul>
-      <ul>
         <li><a href='tixy.html'>Tixy</a></li>
+        <li><a href='versus-2.0.html'>Versus-2.0</a></li>
+        <li><a href='powertrack.html'>Powertrack</a></li>
+        <li><a href='settings.html'>Settings</a></li>
       </ul>
     </div>
     <div class='right'>
diff --git a/dashboard.html b/dashboard.html
index 260e125..9e17117 100644
--- a/dashboard.html
+++ b/dashboard.html
@@ -36,10 +36,10 @@ <h1><a href='.'>Enterfive</a></h1>
         <li><a href='profanity.html'>Profanity Filter</a></li>
         <li><a href='reference.html'>API reference</a></li>
         <li><a href='scout.html'>Scouts</a></li>
-        <li><a href='powertrack.html'>Powertrack</a></li>
-      </ul>
-      <ul>
         <li><a href='tixy.html'>Tixy</a></li>
+        <li><a href='versus-2.0.html'>Versus-2.0</a></li>
+        <li><a href='powertrack.html'>Powertrack</a></li>
+        <li><a href='settings.html'>Settings</a></li>
       </ul>
     </div>
     <div class='right'>
diff --git a/email.html b/email.html
index 5bc3dec..65a590c 100644
--- a/email.html
+++ b/email.html
@@ -36,10 +36,10 @@ <h1><a href='.'>Enterfive</a></h1>
             <li><a href='profanity.html'>Profanity Filter</a></li>
             <li><a href='reference.html'>API reference</a></li>
             <li><a href='scout.html'>Scouts</a></li>
-            <li><a href='powertrack.html'>Powertrack</a></li>
-          </ul>
-          <ul>
             <li><a href='tixy.html'>Tixy</a></li>
+            <li><a href='versus-2.0.html'>Versus-2.0</a></li>
+            <li><a href='powertrack.html'>Powertrack</a></li>
+            <li><a href='settings.html'>Settings</a></li>
           </ul>
         </div>
         <div class='right'>
diff --git a/index.html b/index.html
index 64a30b6..4149d4d 100644
--- a/index.html
+++ b/index.html
@@ -60,6 +60,7 @@ <h1><a href='.'>Enterfive</a></h1>
         <li><a href='tixy.html'>Tixy</a></li>
         <li><a href='versus-2.0.html'>Versus-2.0</a></li>
         <li><a href='powertrack.html'>Powertrack</a></li>
+        <li><a href='settings.html'>Settings</a></li>
       </ul>
       <!-- <ul>
         <li><a href='tixy.html'>Tixy</a></li>
diff --git a/profanity.html b/profanity.html
index 1bcdd90..7e623bf 100644
--- a/profanity.html
+++ b/profanity.html
@@ -36,10 +36,10 @@ <h1><a href='.'>Enterfive</a></h1>
             <li><a href='profanity.html'>Profanity Filter</a></li>
             <li><a href='reference.html'>API reference</a></li>
             <li><a href='scout.html'>Scouts</a></li>
-            <li><a href='powertrack.html'>Powertrack</a></li>
-          </ul>
-          <ul>
             <li><a href='tixy.html'>Tixy</a></li>
+            <li><a href='versus-2.0.html'>Versus-2.0</a></li>
+            <li><a href='powertrack.html'>Powertrack</a></li>
+            <li><a href='settings.html'>Settings</a></li>
           </ul>
         </div>
         <div class='right'>
diff --git a/scout.html b/scout.html
index a171958..f5f66a4 100644
--- a/scout.html
+++ b/scout.html
@@ -36,10 +36,10 @@ <h1><a href='.'>Enterfive</a></h1>
             <li><a href='profanity.html'>Profanity Filter</a></li>
             <li><a href='reference.html'>API reference</a></li>
             <li><a href='scout.html'>Scouts</a></li>
-            <li><a href='powertrack.html'>Powertrack</a></li>
-          </ul>
-          <ul>
             <li><a href='tixy.html'>Tixy</a></li>
+            <li><a href='versus-2.0.html'>Versus-2.0</a></li>
+            <li><a href='powertrack.html'>Powertrack</a></li>
+            <li><a href='settings.html'>Settings</a></li>
           </ul>
         </div>
         <div class='right'>
diff --git a/tixy.html b/tixy.html
index 285b3e8..d17dfc4 100644
--- a/tixy.html
+++ b/tixy.html
@@ -36,10 +36,10 @@ <h1><a href='.'>Enterfive</a></h1>
             <li><a href='profanity.html'>Profanity Filter</a></li>
             <li><a href='reference.html'>API reference</a></li>
             <li><a href='scout.html'>Scouts</a></li>
-            <li><a href='powertrack.html'>Powertrack</a></li>
-          </ul>
-          <ul>
             <li><a href='tixy.html'>Tixy</a></li>
+            <li><a href='versus-2.0.html'>Versus-2.0</a></li>
+            <li><a href='powertrack.html'>Powertrack</a></li>
+            <li><a href='settings.html'>Settings</a></li>
           </ul>
         </div>
         <div class='right'>
diff --git a/versus-2.0.html b/versus-2.0.html
index 21901a6..a2531f6 100644
--- a/versus-2.0.html
+++ b/versus-2.0.html
@@ -41,6 +41,7 @@ <h1><a href='.'>Enterfive</a></h1>
           <li><a href='tixy.html'>Tixy</a></li>
           <li><a href='versus-2.0.html'>Versus-2.0</a></li>
           <li><a href='powertrack.html'>Powertrack</a></li>
+          <li><a href='settings.html'>Settings</a></li>
         </ul>
       </div>
       <div class='right'>

From 760fd501bedd40b79ce2440435b6338e2dc8fde1 Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Mon, 30 Nov 2020 17:39:18 +0100
Subject: [PATCH 76/96] fixed settings

---
 powertrack.html | 3 +++
 reference.html  | 5 +++++
 settings.html   | 2 +-
 3 files changed, 9 insertions(+), 1 deletion(-)

diff --git a/powertrack.html b/powertrack.html
index efffa85..e86cb1e 100644
--- a/powertrack.html
+++ b/powertrack.html
@@ -36,7 +36,10 @@ <h1><a href='.'>Enterfive</a></h1>
             <li><a href='profanity.html'>Profanity Filter</a></li>
             <li><a href='reference.html'>API reference</a></li>
             <li><a href='scout.html'>Scouts</a></li>
+            <li><a href='tixy.html'>Tixy</a></li>
+            <li><a href='versus-2.0.html'>Versus-2.0</a></li>
             <li><a href='powertrack.html'>Powertrack</a></li>
+            <li><a href='settings.html'>Settings</a></li>
           </ul>
           <ul>
             <li><a href='tixy.html'>Tixy</a></li>
diff --git a/reference.html b/reference.html
index 227fe80..55e757b 100644
--- a/reference.html
+++ b/reference.html
@@ -33,6 +33,11 @@ <h1><a href='.'>Enterfive</a></h1>
         <li><a href='https://github.com/rstacruz/flatdoc'>View on Github</a></li>
         <li><a href='https://github.com/rstacruz/flatdoc/issues'>Issues</a></li>
         <li><a href='reference.html'>API reference</a></li>
+        <li><a href='scout.html'>Scouts</a></li>
+        <li><a href='tixy.html'>Tixy</a></li>
+        <li><a href='versus-2.0.html'>Versus-2.0</a></li>
+        <li><a href='powertrack.html'>Powertrack</a></li>
+        <li><a href='settings.html'>Settings</a></li>
       </ul>
     </div>
     <div class='right'>
diff --git a/settings.html b/settings.html
index a2531f6..08a36cd 100644
--- a/settings.html
+++ b/settings.html
@@ -21,7 +21,7 @@
     <!-- Initializer -->
     <script>
       Flatdoc.run({
-        fetcher: Flatdoc.file('Versus-2.0.md')
+        fetcher: Flatdoc.file('Settings.md')
       });
     </script>
   </head>

From 82cf0104078c92e602228a8759243d85be9a23ad Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Wed, 9 Dec 2020 10:03:26 +0100
Subject: [PATCH 77/96] client settings endpoints

---
 Settings.md | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 81 insertions(+)

diff --git a/Settings.md b/Settings.md
index 9730d61..9eb6af1 100644
--- a/Settings.md
+++ b/Settings.md
@@ -77,3 +77,84 @@ Update scout settings.
 * 403 - Only POST requests are allowed
 * 404 - Scout does not exist
 * 500 - Error updating scout settings
+
+
+## Get Client Settings
+
+Obtains client settings.
+
+> Endpoint: get_client_settings
+
+> Method: POST
+
+> Payload
+
+```json
+{
+  "uid": "7gPJM7CHa5divxg0BPMdknW8hi03",
+  "idToken": "NlY3VyZXRva2VuLmdvb2dsZS5jb20vdmVyc3VzLXNjb3V0LWRldiIsImF1ZCI6InZlcnN1cy1zY291dC1kZXYiLCJhdXRo"
+}
+```
+
+> Response
+
+```json
+{
+  "message": "Successfully obtained client settings",
+  "clientSettings": {
+    "creditsPerQuestion_audio": 2,
+    "creditsPerQuestion_video": 2,
+    "exchangeRate_NGNperUSD": 360,
+    "usdPerCredit": 0.05,
+    "usdPerRespondent_interact": 0.5,
+    "creditsPerQuestion_image": 2,
+    "creditsPerQuestion_text": 1
+  }
+}
+```
+
+> Errors
+
+* 400 - Missing parameter idToken, uid
+* 401 - User is not authorized to make this request | Error authenticating user
+* 403 - Only POST requests are allowed
+* 500 - Error getting client settings
+
+
+## Update Client Settings
+
+Update client settings.
+
+> Endpoint: update_client_settings
+
+> Method: POST
+
+> Payload
+
+``` json
+{
+  "uid": "7gPJM7CHa5divxg0BPMdknW8hi03",
+  "idToken": "NlY3VyZXRva2VuLmdvb2dsZS5jb20vdmVyc3VzLXNjb3V0LWRldiIsImF1ZCI6InZlcnN1cy1zY291dC1kZXYiLCJhdXRo",
+  "creditsPerQuestion_audio": 2,
+  // and more client settings
+}
+```
+
+> Response
+
+``` json
+{
+  "message": "Successfully updated client settings",
+    "update": {
+      "creditsPerQuestion_audio": 2
+    }
+}
+```
+
+> Errors
+
+* 400 - Missing auth parameter(s) idToken, uid | No required values included for update
+* 401 - User is not authorized to make this request | Error authenticating user
+* 403 - Only POST requests are allowed
+* 404 - Scout does not exist
+* 500 - Error updating client settings

From 682fb5443da4308f1139c5c7110791b3bab395b7 Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Thu, 7 Jan 2021 19:21:07 +0100
Subject: [PATCH 78/96] update add_multimedia_request_response

updated endpoint to include a table of required paramters, their types
and description.
also added error responses associated with endpoint
---
 Scout.md | 25 ++++++++++++++++++++-----
 1 file changed, 20 insertions(+), 5 deletions(-)

diff --git a/Scout.md b/Scout.md
index 75e0ccd..00cea75 100644
--- a/Scout.md
+++ b/Scout.md
@@ -652,15 +652,24 @@ Get a list of image multimedia requests
 }
 ```
 
-## Multimedia responses
+## Add Multimedia Response
 
-Post multimedia request responses
+Add multimedia request responses
+
+| Field | Type | Description |
+| - | - | - |
+| requestRef | string | A unique identifier of the request for which a response is to be sent |
+| scoutRef | string | A unique identifier of the scout sending the response |
+| mediaType | string | The type of media the response is made of. `image`, `audio` or `video`
+| mediaUrls | array | An array of (string) URL(s) pointing to the location which the response media is stored | 
 
 > Endpoint: scout_add_multimedia_request_response
 
-> Payload
+> Method: POST
 
-``` python
+> Sample payload
+
+``` json
 {
   "requestRef": "12345",
   "scoutRef": "239485855559",
@@ -670,13 +679,19 @@ Post multimedia request responses
 ```
 
 > Result
-``` python
+``` json
 {
   "message":"Successfully added multimedia request response",
   "responseRef": "9596869640495837"
 }
 ```
 
+> Errors
+* 400 - Missing parameter requestRef | Invalid param mediaUrls. Should be array of strings | Wrong mediaType. Request is for audio
+* 403 - Only POST requests are allowed
+* 404 - Multimedia request does not exist
+* 500 - Error adding multimedia request response | Error obtaining multimedia request
+
 ## Responses
 
 Get completed request responses arranged from the most recent.

From bdd9071d035107808803696a96b5461a730c4af1 Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Sat, 9 Jan 2021 02:13:33 +0100
Subject: [PATCH 79/96] update scout_get_multimedia_requests

Corrected documentation and added more details about endpoints including
error responses, etc
---
 Scout.md | 62 ++++++++++++++++++++++++++++++++------------------------
 1 file changed, 35 insertions(+), 27 deletions(-)

diff --git a/Scout.md b/Scout.md
index 00cea75..7792b39 100644
--- a/Scout.md
+++ b/Scout.md
@@ -608,43 +608,43 @@ Get a list of video multimedia requests
   ]
 }
 ```
-## Get A List Of Multimedia Requests A Scout Is Eligible To Send Responses
-Request
+## Get Multimedia Requests
 
-Get a list of image multimedia requests
+Get a list of multimedia requests a scout is eligible to send responses.
 
-> Endpoint: scout_get_multimedia_requests?phoneNumber={phoneNumber}&authString={authString}
+> Endpoint: scout_get_multimedia_requests
 
-> Query params
+> Method: GET
 
+> Query params
 
-| parameters | 
-| -----------| 
-| authstring |
-| phoneNumber| 
+| Field | Type | Description |
+| - | - | - |
+| phoneNumber | string | Scout unique identifier |
+| authString | string | Authentication string |
 
 
 > Result
-``` python
+``` json
 {
   "message": "Successfully obtained image requests",
-   "requests":[
-      {
-        "clientRef": "12345",
-        "clientName": "The Enterprise",
-        "requestName": "Footage of the Lekki Protest",
-        "description": "Let’s get you started with a simple photo request.",
-        "requestRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
-        "country": "NG",
-        "stateOrRegion": "Lagos",
-        "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
-        "endAge": 65,
-        "startAge": 16,
-        "gender": "female",
-        "numberOfRespondents": 500,
-        "mediaType": "image",
-        "status": "live"
-      }
+  "requests":[
+    {
+      "clientRef": "12345",
+      "clientName": "The Enterprise",
+      "requestName": "Footage of the Lekki Protest",
+      "description": "Let’s get you started with a simple photo request.",
+      "requestRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
+      "country": "NG",
+      "stateOrRegion": "Lagos",
+      "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
+      "endAge": 65,
+      "startAge": 16,
+      "gender": "female",
+      "numberOfRespondents": 500,
+      "mediaType": "image",
+      "status": "live"
+    }
     .
     .
     .
@@ -652,6 +652,14 @@ Get a list of image multimedia requests
 }
 ```
 
+> Errors
+* 400 - Only GET requests are allowed | Missing query parameter | Invalid param
+* 401 - Invalid authstring
+* 403 - Scout is unverified | Scout is missing demographic field
+* 404 - Scout does not exist | There are no multimedia requests
+* 500 - Error obtaining multimedia requests
+
+
 ## Add Multimedia Response
 
 Add multimedia request responses

From d0bcc861963b34e5e06aeae592d145dd2a827275 Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Sat, 9 Jan 2021 02:19:07 +0100
Subject: [PATCH 80/96] fix: formatted error response section

---
 Scout.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Scout.md b/Scout.md
index 7792b39..18485cd 100644
--- a/Scout.md
+++ b/Scout.md
@@ -653,6 +653,7 @@ Get a list of multimedia requests a scout is eligible to send responses.
 ```
 
 > Errors
+
 * 400 - Only GET requests are allowed | Missing query parameter | Invalid param
 * 401 - Invalid authstring
 * 403 - Scout is unverified | Scout is missing demographic field
@@ -695,6 +696,7 @@ Add multimedia request responses
 ```
 
 > Errors
+
 * 400 - Missing parameter requestRef | Invalid param mediaUrls. Should be array of strings | Wrong mediaType. Request is for audio
 * 403 - Only POST requests are allowed
 * 404 - Multimedia request does not exist

From cf326b4c803494060cd0d2d521bbcfb2998c3d2d Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Sat, 9 Jan 2021 02:33:00 +0100
Subject: [PATCH 81/96] fix: reformatted endpoint details

reformatted endpoint details to keep on code-related info on the right
side
---
 Scout.md | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/Scout.md b/Scout.md
index 18485cd..6a6ea5e 100644
--- a/Scout.md
+++ b/Scout.md
@@ -612,11 +612,13 @@ Get a list of video multimedia requests
 
 Get a list of multimedia requests a scout is eligible to send responses.
 
-> Endpoint: scout_get_multimedia_requests
+**Endpoint** 
+scout_get_multimedia_requests
 
-> Method: GET
+**Method** 
+GET
 
-> Query params
+**Query params**
 
 | Field | Type | Description |
 | - | - | - |
@@ -652,7 +654,7 @@ Get a list of multimedia requests a scout is eligible to send responses.
 }
 ```
 
-> Errors
+**Errors**
 
 * 400 - Only GET requests are allowed | Missing query parameter | Invalid param
 * 401 - Invalid authstring

From 259d1b5d0ab513f272747c6caa9e3bf0cc8d180e Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Mon, 11 Jan 2021 15:12:40 +0100
Subject: [PATCH 82/96] update scout_get_image_requests

---
 Scout.md | 66 +++++++++++++++++++++++++++++++++-----------------------
 1 file changed, 39 insertions(+), 27 deletions(-)

diff --git a/Scout.md b/Scout.md
index 6a6ea5e..3a338de 100644
--- a/Scout.md
+++ b/Scout.md
@@ -481,42 +481,45 @@ Cashout scout credits to local currency
 ```
 
 
-## get image requests
+## Get Image Requests
 
-Get a list of image multimedia requests
+Get a list of multimedia requests of mediaType _image_ a scout is eligible to send responses.
 
-> Endpoint: scout_get_image_requests?phoneNumber={phoneNumber}&authString={authString}
+**Endpoint** 
+scout_get_image_requests
 
-> Query params
+**Method** 
+GET
 
+**Query params**
 
-| parameters | 
-| -----------| 
-| authstring |
-| phoneNumber| 
+| Field | Type | Description |
+| - | - | - |
+| phoneNumber | string | Scout unique identifier |
+| authString | string | Authentication string |
 
 
 > Result
-``` python
+``` json
 {
   "message": "Successfully obtained image requests",
-   "requests":[
-      {
-        "clientRef": "12345",
-        "clientName": "The Enterprise",
-        "requestName": "Footage of the Lekki Protest",
-        "description": "Let’s get you started with a simple photo request.",
-        "requestRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
-        "country": "NG",
-        "stateOrRegion": "Lagos",
-        "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
-        "endAge": 65,
-        "startAge": 16,
-        "gender": "female",
-        "numberOfRespondents": 500,
-        "mediaType": "image",
-        "status": "live"
-      }
+  "requests":[
+    {
+      "clientRef": "12345",
+      "clientName": "The Enterprise",
+      "requestName": "Footage of the Lekki Protest",
+      "description": "Let’s get you started with a simple photo request.",
+      "requestRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
+      "country": "NG",
+      "stateOrRegion": "Lagos",
+      "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
+      "endAge": 65,
+      "startAge": 16,
+      "gender": "female",
+      "numberOfRespondents": 500,
+      "mediaType": "image",
+      "status": "live"
+    }
     .
     .
     .
@@ -524,6 +527,14 @@ Get a list of image multimedia requests
 }
 ```
 
+**Errors**
+
+* 400 - Only GET requests are allowed | Missing query parameter | Invalid param
+* 401 - Invalid authstring
+* 403 - Scout is unverified | Scout is missing demographic field
+* 404 - Scout does not exist | There are no image requests
+* 500 - Error obtaining image requests
+
 ## get audio requests
 
 Get a list of audio multimedia requests
@@ -608,6 +619,7 @@ Get a list of video multimedia requests
   ]
 }
 ```
+
 ## Get Multimedia Requests
 
 Get a list of multimedia requests a scout is eligible to send responses.
@@ -629,7 +641,7 @@ GET
 > Result
 ``` json
 {
-  "message": "Successfully obtained image requests",
+  "message": "Successfully obtained multimedia requests",
   "requests":[
     {
       "clientRef": "12345",

From 251d915ff2f6371bf3597074598f13114ce8d765 Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Mon, 11 Jan 2021 16:33:00 +0100
Subject: [PATCH 83/96] update doc for scout get audio requests

---
 Scout.md | 68 +++++++++++++++++++++++++++++++-------------------------
 1 file changed, 38 insertions(+), 30 deletions(-)

diff --git a/Scout.md b/Scout.md
index 3a338de..ead930a 100644
--- a/Scout.md
+++ b/Scout.md
@@ -535,49 +535,57 @@ GET
 * 404 - Scout does not exist | There are no image requests
 * 500 - Error obtaining image requests
 
-## get audio requests
+## Get Audio Requests
 
-Get a list of audio multimedia requests
+Get a list of multimedia requests of mediaType _audio_ a scout is eligible to send responses.
 
-> Endpoint: scout_get_audio_requests?phoneNumber={phoneNumber}&authString={authString}
+**Endpoint** 
+scout_get_audio_requests
 
-> Query params
+**Method** 
+GET
 
+**Query params**
 
-| Parameters  | 
-| ----------- | 
-| authstring  |
-| phoneNumber | 
+| Field | Type | Description |
+| - | - | - |
+| phoneNumber | string | Scout unique identifier |
+| authString | string | Authentication string |
 
 
 > Result
-``` python
+``` json
 {
-  "message": "Successfully obtained audio requests",
-   "requests":[
-      {
-        "clientRef": "12345",
-        "clientName": "The Enterprise",
-        "requestName": "Footage of the Lekki Protest",
-        "description": "Let’s get you started with a simple photo request.",
-        "requestRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
-        "country": "NG",
-        "stateOrRegion": "Lagos",
-        "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
-        "endAge": 65,
-        "startAge": 16,
-        "gender": "female",
-        "numberOfRespondents": 500,
-        "mediaType": "audio",
-        "status": "live"
-      }
-    .
-    .
-    .
+  "message": "Successfully obtained image requests",
+  "requests":[
+    {
+      "clientRef": "12345",
+      "clientName": "The Enterprise",
+      "requestName": "Footage of the Lekki Protest",
+      "description": "Let’s get you started with a simple photo request.",
+      "requestRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
+      "country": "NG",
+      "stateOrRegion": "Lagos",
+      "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
+      "endAge": 65,
+      "startAge": 16,
+      "gender": "female",
+      "numberOfRespondents": 500,
+      "mediaType": "audio",
+      "status": "live"
+    }
   ]
 }
 ```
 
+**Errors**
+
+* 400 - Only GET requests are allowed | Missing query parameter | Invalid param
+* 401 - Invalid authstring
+* 403 - Scout is unverified | Scout is missing demographic field
+* 404 - Scout does not exist | There are no audio requests
+* 500 - Error obtaining audio requests
+
 ## get video requests
 
 Get a list of video multimedia requests

From 78d1b78a85382fbdb984b25e003fd85f9ebccb85 Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Mon, 11 Jan 2021 21:02:22 +0100
Subject: [PATCH 84/96] update scout get video requests

---
 Scout.md | 69 ++++++++++++++++++++++++++++++++------------------------
 1 file changed, 39 insertions(+), 30 deletions(-)

diff --git a/Scout.md b/Scout.md
index ead930a..2403f8b 100644
--- a/Scout.md
+++ b/Scout.md
@@ -586,48 +586,57 @@ GET
 * 404 - Scout does not exist | There are no audio requests
 * 500 - Error obtaining audio requests
 
-## get video requests
+## Get Video Requests
 
-Get a list of video multimedia requests
+Get a list of multimedia requests of mediaType _video_ a scout is eligible to send responses.
 
-> Endpoint: scout_get_video_requests?phoneNumber={phoneNumber}&authString={authString}
+**Endpoint** 
+scout_get_video_requests
 
-> Query params
+**Method** 
+GET
 
-| Parameters  | 
-| ----------- | 
-| authstring  |
-| phoneNumber | 
+**Query params**
+
+| Field | Type | Description |
+| - | - | - |
+| phoneNumber | string | Scout unique identifier |
+| authString | string | Authentication string |
 
 
 > Result
-``` python
+``` json
 {
-  "message": "Successfully obtained video requests",
-   "requests":[
-      {
-        "clientRef": "12345",
-        "clientName": "The Enterprise",
-        "requestName": "Footage of the Lekki Protest",
-        "description": "Let’s get you started with a simple photo request.",
-        "requestRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
-        "country": "NG",
-        "stateOrRegion": "Lagos",
-        "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
-        "endAge": 65,
-        "startAge": 16,
-        "gender": "female",
-        "numberOfRespondents": 500,
-        "mediaType": "audio",
-        "status": "live"
-      }
-    .
-    .
-    .
+  "message": "Successfully obtained image requests",
+  "requests":[
+    {
+      "clientRef": "12345",
+      "clientName": "The Enterprise",
+      "requestName": "Footage of the Lekki Protest",
+      "description": "Let’s get you started with a simple photo request.",
+      "requestRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
+      "country": "NG",
+      "stateOrRegion": "Lagos",
+      "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
+      "endAge": 65,
+      "startAge": 16,
+      "gender": "female",
+      "numberOfRespondents": 500,
+      "mediaType": "video",
+      "status": "live"
+    }
   ]
 }
 ```
 
+**Errors**
+
+* 400 - Only GET requests are allowed | Missing query parameter | Invalid param
+* 401 - Invalid authstring
+* 403 - Scout is unverified | Scout is missing demographic field
+* 404 - Scout does not exist | There are no video requests
+* 500 - Error obtaining video requests
+
 ## Get Multimedia Requests
 
 Get a list of multimedia requests a scout is eligible to send responses.

From 2efda781ec1c6f1dca082a5839285a5f1eef294a Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Wed, 13 Jan 2021 18:22:59 +0100
Subject: [PATCH 85/96] docs: updated scout get request responses

---
 Scout.md | 48 ++++++++++++++++++++++++++----------------------
 1 file changed, 26 insertions(+), 22 deletions(-)

diff --git a/Scout.md b/Scout.md
index 2403f8b..890cd59 100644
--- a/Scout.md
+++ b/Scout.md
@@ -733,41 +733,45 @@ Add multimedia request responses
 * 404 - Multimedia request does not exist
 * 500 - Error adding multimedia request response | Error obtaining multimedia request
 
-## Responses
+## Get Multimedia Responses
 
 Get completed request responses arranged from the most recent.
 
-> Endpoint: scout_get_request_response?phoneNumber={phoneNumber}&authString={authString}
+**Endpoint** 
+scout_get_request_responses
 
-> Query params
+**Method** 
+GET
 
-| Parameters  | 
-| ----------- | 
-| authstring  |
-| phoneNumber | 
+**Query params**
+
+| Field | Type | Description |
+| - | - | - |
+| phoneNumber | string | Scout unique identifier |
+| authString | string | Authentication string |
 
 
 > Result
-``` python
+``` json
 {
   "message": "Successfully obtained request responses",
-   "requests":[
-      {
-        "clientRef": "12345",
-        "requestRef": "12345",
-        "scoutRef": "+2340927738929",
-        "mediaUrls":["https://google.api.com/235617"],
-        "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
-        "mediaType":"audio",
-        "status": "pending"
-      }
-    .
-    .
-    .
+  "responses":[
+    {
+      "clientRef": "12345",
+      "requestRef": "12345",
+      "scoutRef": "+2340927738929",
+      "mediaUrls":["https://google.api.com/235617"],
+      "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
+      "mediaType":"audio",
+      "status": "pending"
+    }
   ]
 }
 ```
 
+**Errors**
 
-
+* 400 - Only GET requests are allowed | Missing query parameter | Invalid param
+* 401 - Invalid authstring
+* 500 - Error fetching request responses
 

From ec9aa9a8a4fcef62d5c331c9896398bd5b36cccf Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Thu, 14 Jan 2021 09:11:09 +0100
Subject: [PATCH 86/96] docs: updated endpoints

updated documentation for three endpoints
---
 Versus-2.0.md | 58 +++++++++++++++++++++++----------------------------
 1 file changed, 26 insertions(+), 32 deletions(-)

diff --git a/Versus-2.0.md b/Versus-2.0.md
index dd05ed4..fda28e8 100644
--- a/Versus-2.0.md
+++ b/Versus-2.0.md
@@ -1707,13 +1707,14 @@ Obtain details of a subscription plan
   }
 }
 ```
-## Total Requests
+## Get Total Requests
 Get total number of requests for a client.
-> Endpoint: versus_v2_get_total_requests
+
+**Endpoint** versus_v2_get_total_requests
 
 > Payload
 
-``` python
+``` json
 {
   "clientRef": "12345",
   "uid": "6789",
@@ -1723,21 +1724,21 @@ Get total number of requests for a client.
 
 > Response
 
-``` python
+``` json
 {
   "message":"Successfully obtained total number of requests",
   "totalNumberOfRequests": 7
 }
 ```
 
-## Number of Client Request Respondents.
+## Get Total Client Request Respondents
 Get total number of client request respondents.
 
-> Endpoint: versus_v2_get_total_client_request_respondents
+**Endpoint** versus_v2_get_total_client_request_respondents
 
 > Payload
 
-``` python
+``` json
 {
   "clientRef": "12345",
   "uid": "6789",
@@ -1747,7 +1748,7 @@ Get total number of client request respondents.
 
 > Response
 
-``` python
+``` json
 {
   "message":"Successfully obtained total number of request respondents",
   "totalNumberOfClientRequestRespondents": 7
@@ -1798,14 +1799,14 @@ Get a list of requests belonging to a client
 }
 ```
 
-## Number Of Respondents For A Request.
+## Get Total Request Respondents
 Get total number of respondents for a request.
 
-> Endpoint: versus_v2_get_total_request_respondents
+**Endpoint** versus_v2_get_total_request_respondents
 
 > Payload
 
-``` python
+``` json
 {
   "clientRef": "12345",
   "requestRef": "12345",
@@ -1817,24 +1818,24 @@ Get total number of respondents for a request.
 
 > Response
 
-``` python
+``` json
 {
   "message":"Successfully obtained total number of request respondents",
   "totalNumberOfRequestRespondents": 7
 }
 ```
 
-##  Create Requests
-Create a new request.
+##  Create Request
+Create a new multimedia request.
 
 > Endpoint: versus_v2_create_new_request
 
-
 > Payload
 
-``` python
+``` json
 {
   "clientRef": "12345",
+  "clientName": "The enterprise",
   "uid": "6789",
   "idToken": "101112",
   "requestName": "Footage of the Lekki Protest",
@@ -1852,27 +1853,20 @@ Create a new request.
 
 > Response
 
-``` python
+``` json
 {
   "message":"Successfully created new request",
-  "request": {
-    "clientRef": "12345",
-    "clientName": "The Enterprise",
-    "requestName": "Footage of the Lekki Protest",
-    "description": "Let’s get you started with a simple photo request.",
-    "requestRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
-    "country": "NG",
-    "stateOrRegion": "Lagos",
-    "endAge": 65,
-    "startAge": 16,
-    "gender": "female",
-    "numberOfRespondents": 500,
-    "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
-    "status": "live"
-  }
+  "requestRef": "1234567890-09876543234567890-0987654"
 }
 ```
 
+> Errors
+
+* 400 - Missing parameter clientRef, clientName, requestName, etc | Invalid param description. Should be type string
+* 401 - User is not authorized to make this request | Error authenticating user
+* 403 - Only POST requests are allowed
+* 500 - Error creating new request
+
 ##  Get Requests Responses
 Get a list of responses for a request.
 

From 04d0f4b4efcc3caf50f63b06d1310347d367e397 Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Thu, 14 Jan 2021 20:33:10 +0100
Subject: [PATCH 87/96] docs: update endpoint

---
 Versus-2.0.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/Versus-2.0.md b/Versus-2.0.md
index fda28e8..2b21f93 100644
--- a/Versus-2.0.md
+++ b/Versus-2.0.md
@@ -1707,6 +1707,7 @@ Obtain details of a subscription plan
   }
 }
 ```
+
 ## Get Total Requests
 Get total number of requests for a client.
 
@@ -1731,6 +1732,15 @@ Get total number of requests for a client.
 }
 ```
 
+**Errors**
+
+* 400 - Missing parameter | Invalid param ... Should be of type ...
+* 401 - User is not authorized to make this request | Error authenticating user
+* 403 - Only POST requests are allowed | Unauthorized request
+* 404 - Team does not exist for client | Multimedia requests do not exist
+* 500 - Error obtaining multimedia requests | Error obtaining client team for authorization
+
+
 ## Get Total Client Request Respondents
 Get total number of client request respondents.
 
@@ -1755,6 +1765,14 @@ Get total number of client request respondents.
 }
 ```
 
+**Errors**
+
+* 400 - Missing parameter | Invalid param ... Should be of type ...
+* 401 - User is not authorized to make this request | Error authenticating user
+* 403 - Only POST requests are allowed | Unauthorized request
+* 404 - Team does not exist for client | Multimedia requests do not exist
+* 500 - Error obtaining total number of client request responses | Error obtaining client team for authorization
+
 
 ##  Get Requests
 Get a list of requests belonging to a client
@@ -1800,6 +1818,7 @@ Get a list of requests belonging to a client
 ```
 
 ## Get Total Request Respondents
+
 Get total number of respondents for a request.
 
 **Endpoint** versus_v2_get_total_request_respondents
@@ -1825,6 +1844,14 @@ Get total number of respondents for a request.
 }
 ```
 
+**Errors**
+
+* 400 - Missing parameter | Invalid param ... Should be of type ...
+* 401 - User is not authorized to make this request | Error authenticating user
+* 403 - Only POST requests are allowed | Unauthorized request
+* 404 - Team does not exist for client | Multimedia requests do not exist
+* 500 - Error obtaining total number of request respondents | Error obtaining client team for authorization
+
 ##  Create Request
 Create a new multimedia request.
 

From 7d8e0059c4a46cf67d06ea68b44e46aa85aff89c Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Thu, 14 Jan 2021 21:49:00 +0100
Subject: [PATCH 88/96] docs: update documentation

included error responses
---
 Versus-2.0.md | 21 ++++++++++++++-------
 1 file changed, 14 insertions(+), 7 deletions(-)

diff --git a/Versus-2.0.md b/Versus-2.0.md
index 2b21f93..f473c79 100644
--- a/Versus-2.0.md
+++ b/Versus-2.0.md
@@ -1894,14 +1894,15 @@ Create a new multimedia request.
 * 403 - Only POST requests are allowed
 * 500 - Error creating new request
 
-##  Get Requests Responses
+##  Get Request Responses
+
 Get a list of responses for a request.
 
-> Endpoint: versus_v2_get_request_responses 
+**Endpoint** versus_v2_get_request_responses 
 
 > Payload
 
-``` python
+``` json
 {
   "clientRef": "12345",
   "requestRef": "12345",
@@ -1913,7 +1914,7 @@ Get a list of responses for a request.
 
 > Response
 
-``` python
+``` json
 {
   "message":"Successfully obtained request responses",
     "responses": [
@@ -1924,13 +1925,19 @@ Get a list of responses for a request.
       "mediaUrls":["https://google.api.com/235617"],
       "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
       "mediaType":"audio"
-    },
-    .
-    .
+    }
   ]
 }
 ```
 
+**Errors**
+
+* 400 - Missing parameter | Invalid param ... Should be of type ...
+* 401 - User is not authorized to make this request | Error authenticating user
+* 403 - Only POST requests are allowed | Unauthorized request
+* 404 - Team does not exist for client | Multimedia requests do not exist
+* 500 - Error obtaining request responses | Error obtaining client team for authorization
+
 ## Approve Request Response
 
 > Endpoint: versus_v2_approve_request_response

From 625c6f41cecda2bc0320f82a159b367a30f799c9 Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Thu, 21 Jan 2021 16:45:18 +0100
Subject: [PATCH 89/96] update authstring requirement

---
 Scout.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Scout.md b/Scout.md
index 890cd59..7c9b798 100644
--- a/Scout.md
+++ b/Scout.md
@@ -702,6 +702,7 @@ Add multimedia request responses
 | scoutRef | string | A unique identifier of the scout sending the response |
 | mediaType | string | The type of media the response is made of. `image`, `audio` or `video`
 | mediaUrls | array | An array of (string) URL(s) pointing to the location which the response media is stored | 
+| authString | string | Authentication string |
 
 > Endpoint: scout_add_multimedia_request_response
 
@@ -728,7 +729,7 @@ Add multimedia request responses
 
 > Errors
 
-* 400 - Missing parameter requestRef | Invalid param mediaUrls. Should be array of strings | Wrong mediaType. Request is for audio
+* 400 - Missing parameter requestRef | Invalid param mediaUrls. Should be array of strings | Wrong mediaType. Request is for audio | Failed authentication. Authstring invalid or not found in request body
 * 403 - Only POST requests are allowed
 * 404 - Multimedia request does not exist
 * 500 - Error adding multimedia request response | Error obtaining multimedia request

From 1949bca2e5928a86b402d00290217d0f044afe88 Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Thu, 21 Jan 2021 16:50:27 +0100
Subject: [PATCH 90/96] add authstring to sample payload

---
 Scout.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Scout.md b/Scout.md
index 7c9b798..74b7469 100644
--- a/Scout.md
+++ b/Scout.md
@@ -702,7 +702,7 @@ Add multimedia request responses
 | scoutRef | string | A unique identifier of the scout sending the response |
 | mediaType | string | The type of media the response is made of. `image`, `audio` or `video`
 | mediaUrls | array | An array of (string) URL(s) pointing to the location which the response media is stored | 
-| authString | string | Authentication string |
+| authstring | string | Authentication string |
 
 > Endpoint: scout_add_multimedia_request_response
 
@@ -716,6 +716,7 @@ Add multimedia request responses
   "scoutRef": "239485855559",
   "mediaUrls":["https://google.api.com/235617"],
   "mediaType":"audio",
+  "authstring": "123567890987654321"
 }
 ```
 

From 0f10d6ae239786148140603f3e1741a144b23340 Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Fri, 29 Jan 2021 12:24:52 +0100
Subject: [PATCH 91/96] doc: added optional param and errors

---
 Scout.md | 24 +++++++++++++++++++-----
 1 file changed, 19 insertions(+), 5 deletions(-)

diff --git a/Scout.md b/Scout.md
index 74b7469..2d8e509 100644
--- a/Scout.md
+++ b/Scout.md
@@ -163,20 +163,29 @@ Get a Scout reference given a phoneNumber.
 
 Get the questions associated with a campaign.
 
+| Field | Type | Required | Description |
+| - | - | - | - |
+| docRef | string | required | A unique identifier of the campaign |
+| scoutRef | string | optional | Scout unique identifier |
+|
 
-> Endpoint: scout_get_questions
 
-> Payload
+**Endpoint** scout_get_questions
 
-``` javascript
+**Method** POST
+ 
+> Sample payload
+``` json
 {
-  "docRef": "0b3cf5bd-bea9-429b-b374-8f65e5473ed9"
+  "docRef": "0b3cf5bd-bea9-429b-b374-8f65e5473ed9",
+  "scoutRef": "+2341234567890"
 }
 ```
 
 > Result
-``` javascript
+``` json
 {
+  "message": "Successfully obtained questions",
   "questions": [
     {
       "campaignName": "campaignRef",
@@ -191,6 +200,11 @@ Get the questions associated with a campaign.
 }
 ```
 
+**Errors**
+* 400 - Invalid param | Missing docRef
+* 404 - Scout does not exist
+* 500 - Error obtaining scout | error encountered while reading from db
+
 ## Get Responses
 
 Get the responses associated with a question.

From 786d8cc69b1f049bbeff49bb35727b303d31b91b Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Fri, 29 Jan 2021 13:10:51 +0100
Subject: [PATCH 92/96] doc: fixed formatting

---
 Scout.md | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/Scout.md b/Scout.md
index 2d8e509..907c4d3 100644
--- a/Scout.md
+++ b/Scout.md
@@ -167,14 +167,14 @@ Get the questions associated with a campaign.
 | - | - | - | - |
 | docRef | string | required | A unique identifier of the campaign |
 | scoutRef | string | optional | Scout unique identifier |
-|
+
 
 
 **Endpoint** scout_get_questions
 
 **Method** POST
  
-> Sample payload
+**Sample payload**
 ``` json
 {
   "docRef": "0b3cf5bd-bea9-429b-b374-8f65e5473ed9",
@@ -182,7 +182,7 @@ Get the questions associated with a campaign.
 }
 ```
 
-> Result
+**Result**
 ``` json
 {
   "message": "Successfully obtained questions",
@@ -201,10 +201,12 @@ Get the questions associated with a campaign.
 ```
 
 **Errors**
+
 * 400 - Invalid param | Missing docRef
 * 404 - Scout does not exist
 * 500 - Error obtaining scout | error encountered while reading from db
 
+
 ## Get Responses
 
 Get the responses associated with a question.

From eac147da866517213968af96b5e5b523f06889af Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Wed, 10 Feb 2021 10:49:17 +0100
Subject: [PATCH 93/96] docs: added field spotsLeft to multimedia requests

---
 Scout.md      | 27 ++++++++++++++-------------
 Versus-2.0.md | 34 +++++++++++++++++-----------------
 2 files changed, 31 insertions(+), 30 deletions(-)

diff --git a/Scout.md b/Scout.md
index 907c4d3..f37858b 100644
--- a/Scout.md
+++ b/Scout.md
@@ -515,7 +515,7 @@ GET
 | authString | string | Authentication string |
 
 
-> Result
+> Sample response
 ``` json
 {
   "message": "Successfully obtained image requests",
@@ -533,12 +533,10 @@ GET
       "startAge": 16,
       "gender": "female",
       "numberOfRespondents": 500,
+      "spotsLeft": 500,
       "mediaType": "image",
       "status": "live"
     }
-    .
-    .
-    .
   ]
 }
 ```
@@ -551,6 +549,7 @@ GET
 * 404 - Scout does not exist | There are no image requests
 * 500 - Error obtaining image requests
 
+
 ## Get Audio Requests
 
 Get a list of multimedia requests of mediaType _audio_ a scout is eligible to send responses.
@@ -569,7 +568,7 @@ GET
 | authString | string | Authentication string |
 
 
-> Result
+> Sample response
 ``` json
 {
   "message": "Successfully obtained image requests",
@@ -587,6 +586,7 @@ GET
       "startAge": 16,
       "gender": "female",
       "numberOfRespondents": 500,
+      "spotsLeft": 500,
       "mediaType": "audio",
       "status": "live"
     }
@@ -602,6 +602,7 @@ GET
 * 404 - Scout does not exist | There are no audio requests
 * 500 - Error obtaining audio requests
 
+
 ## Get Video Requests
 
 Get a list of multimedia requests of mediaType _video_ a scout is eligible to send responses.
@@ -620,7 +621,7 @@ GET
 | authString | string | Authentication string |
 
 
-> Result
+> Sample response
 ``` json
 {
   "message": "Successfully obtained image requests",
@@ -638,6 +639,7 @@ GET
       "startAge": 16,
       "gender": "female",
       "numberOfRespondents": 500,
+      "spotsLeft": 500,
       "mediaType": "video",
       "status": "live"
     }
@@ -671,7 +673,7 @@ GET
 | authString | string | Authentication string |
 
 
-> Result
+> Sample response
 ``` json
 {
   "message": "Successfully obtained multimedia requests",
@@ -689,12 +691,10 @@ GET
       "startAge": 16,
       "gender": "female",
       "numberOfRespondents": 500,
+      "spotsLeft": 500,
       "mediaType": "image",
       "status": "live"
     }
-    .
-    .
-    .
   ]
 }
 ```
@@ -736,7 +736,7 @@ Add multimedia request responses
 }
 ```
 
-> Result
+> Sample response
 ``` json
 {
   "message":"Successfully added multimedia request response",
@@ -744,13 +744,14 @@ Add multimedia request responses
 }
 ```
 
-> Errors
+**Errors**
 
 * 400 - Missing parameter requestRef | Invalid param mediaUrls. Should be array of strings | Wrong mediaType. Request is for audio | Failed authentication. Authstring invalid or not found in request body
 * 403 - Only POST requests are allowed
 * 404 - Multimedia request does not exist
 * 500 - Error adding multimedia request response | Error obtaining multimedia request
 
+
 ## Get Multimedia Responses
 
 Get completed request responses arranged from the most recent.
@@ -769,7 +770,7 @@ GET
 | authString | string | Authentication string |
 
 
-> Result
+> Sample Response
 ``` json
 {
   "message": "Successfully obtained request responses",
diff --git a/Versus-2.0.md b/Versus-2.0.md
index f473c79..7debc2b 100644
--- a/Versus-2.0.md
+++ b/Versus-2.0.md
@@ -1887,7 +1887,7 @@ Create a new multimedia request.
 }
 ```
 
-> Errors
+**Errors**
 
 * 400 - Missing parameter clientRef, clientName, requestName, etc | Invalid param description. Should be type string
 * 401 - User is not authorized to make this request | Error authenticating user
@@ -1900,7 +1900,7 @@ Get a list of responses for a request.
 
 **Endpoint** versus_v2_get_request_responses 
 
-> Payload
+> Sample payload
 
 ``` json
 {
@@ -1912,7 +1912,7 @@ Get a list of responses for a request.
 
 ```
 
-> Response
+> Sample response
 
 ``` json
 {
@@ -1940,11 +1940,13 @@ Get a list of responses for a request.
 
 ## Approve Request Response
 
-> Endpoint: versus_v2_approve_request_response
+**Endpoint**
 
-> Payload
+versus_v2_approve_request_response
 
-``` python
+> Sample payload
+
+```json
 {
   "clientRef": "12345",
   "requestRef": "123456",
@@ -1952,13 +1954,11 @@ Get a list of responses for a request.
   "uid": "6789",
   "idToken": "101112"
 }
-
-
 ```
 
-> Response
+> Sample response
 
-``` python
+```json
 {
   "message":"Successfully approved request response",
   "responseRef": "12345"
@@ -1967,11 +1967,13 @@ Get a list of responses for a request.
 
 ## Reject Request Response.
 
-> Endpoint: versus_v2_reject_request_response
+**Endpoint** 
 
-> Payload
+versus_v2_reject_request_response
 
-``` python
+> Sample payload
+
+```json
 {
   "clientRef": "12345",
   "requestRef": "123456",
@@ -1981,13 +1983,11 @@ Get a list of responses for a request.
   "uid": "6789",
   "idToken": "101112"
 }
-
-
 ```
 
-> Response
+> Sample response
 
-``` python
+```json
 {
   "message":"Successfully rejected request response",
   "responseRef": "78900"

From f6e303c5409032c4c7ad780cfccf6e1948b216cc Mon Sep 17 00:00:00 2001
From: John Otu <johnne01@gmail.com>
Date: Wed, 10 Feb 2021 12:04:21 +0100
Subject: [PATCH 94/96] docs: pause requests if capped

---
 Versus-2.0.md | 32 +++++++++++++++++++++++++++++++-
 1 file changed, 31 insertions(+), 1 deletion(-)

diff --git a/Versus-2.0.md b/Versus-2.0.md
index 7debc2b..91da8bd 100644
--- a/Versus-2.0.md
+++ b/Versus-2.0.md
@@ -2113,4 +2113,34 @@ Get a list of responses for a request.
 
 * 400 - Missing parameter subscriptionPlanRef
 * 403 - Only POST requests are allowed
-* 500 - Backend service error
\ No newline at end of file
+* 500 - Backend service error
+
+
+## Pause Request If Capped
+
+Pause multimedia request when allotment is reached.
+
+**Endpoint** versus_v2_pause_request_if_capped
+
+**Method** POST
+
+> Sample payload
+```json
+{
+  "requestRef": "1234567890987654321"
+}
+```
+
+> Sample response
+```json
+{ 
+  "message": "Successfully paused client multimedia request",
+  "requestRef": "123567890987654321"
+}
+```
+
+**Errors**
+
+* 400 - Only POST requests are allowed | Missing parameter requestRef
+* 404 - Request does not exist
+* 500 - Error updating request status | Error obtaining number of request respondents

From 1f6b4ef791d76899d02a75eb6df790fa4fc58132 Mon Sep 17 00:00:00 2001
From: Ocheben <ocheben@gmail.com>
Date: Fri, 12 Feb 2021 13:42:31 +0100
Subject: [PATCH 95/96] Updated Scout Endpoints

---
 Scout.md      | 410 ++++++++++++++++++++++++++++++++++++++++----------
 Versus-2.0.md |   3 +-
 2 files changed, 331 insertions(+), 82 deletions(-)

diff --git a/Scout.md b/Scout.md
index f37858b..249d9d5 100644
--- a/Scout.md
+++ b/Scout.md
@@ -104,7 +104,8 @@ Get all campaigns on the system
       "occupation": null,
       "religion": null,
       "startAge": 20,
-      "startDate": "2000-10-10 00:00:00"
+      "startDate": "2000-10-10 00:00:00",
+      "versusCreditsAccruing": 0
     }
   ]
 }
@@ -519,24 +520,27 @@ GET
 ``` json
 {
   "message": "Successfully obtained image requests",
-  "requests":[
-    {
-      "clientRef": "12345",
-      "clientName": "The Enterprise",
-      "requestName": "Footage of the Lekki Protest",
-      "description": "Let’s get you started with a simple photo request.",
-      "requestRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
-      "country": "NG",
-      "stateOrRegion": "Lagos",
-      "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
-      "endAge": 65,
-      "startAge": 16,
-      "gender": "female",
-      "numberOfRespondents": 500,
-      "spotsLeft": 500,
-      "mediaType": "image",
-      "status": "live"
-    }
+   "requests":[
+      {
+        "clientRef": "12345",
+        "clientName": "The Enterprise",
+        "requestName": "Footage of the Lekki Protest",
+        "description": "Let’s get you started with a simple photo request.",
+        "requestRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
+        "country": "NG",
+        "stateOrRegion": "Lagos",
+        "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
+        "endAge": 65,
+        "startAge": 16,
+        "gender": "female",
+        "numberOfRespondents": 500,
+        "mediaType": "image",
+        "status": "live",
+        "versusCreditsAccruing": 2
+      }
+    .
+    .
+    .
   ]
 }
 ```
@@ -560,36 +564,31 @@ scout_get_audio_requests
 **Method** 
 GET
 
-**Query params**
-
-| Field | Type | Description |
-| - | - | - |
-| phoneNumber | string | Scout unique identifier |
-| authString | string | Authentication string |
-
-
-> Sample response
-``` json
+> Result
+``` python
 {
-  "message": "Successfully obtained image requests",
-  "requests":[
-    {
-      "clientRef": "12345",
-      "clientName": "The Enterprise",
-      "requestName": "Footage of the Lekki Protest",
-      "description": "Let’s get you started with a simple photo request.",
-      "requestRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
-      "country": "NG",
-      "stateOrRegion": "Lagos",
-      "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
-      "endAge": 65,
-      "startAge": 16,
-      "gender": "female",
-      "numberOfRespondents": 500,
-      "spotsLeft": 500,
-      "mediaType": "audio",
-      "status": "live"
-    }
+  "message": "Successfully obtained audio requests",
+   "requests":[
+      {
+        "clientRef": "12345",
+        "clientName": "The Enterprise",
+        "requestName": "Footage of the Lekki Protest",
+        "description": "Let’s get you started with a simple photo request.",
+        "requestRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
+        "country": "NG",
+        "stateOrRegion": "Lagos",
+        "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
+        "endAge": 65,
+        "startAge": 16,
+        "gender": "female",
+        "numberOfRespondents": 500,
+        "mediaType": "audio",
+        "status": "live",
+        "versusCreditsAccruing": 2
+      }
+    .
+    .
+    .
   ]
 }
 ```
@@ -610,39 +609,31 @@ Get a list of multimedia requests of mediaType _video_ a scout is eligible to se
 **Endpoint** 
 scout_get_video_requests
 
-**Method** 
-GET
-
-**Query params**
-
-| Field | Type | Description |
-| - | - | - |
-| phoneNumber | string | Scout unique identifier |
-| authString | string | Authentication string |
-
-
-> Sample response
-``` json
+> Result
+``` python
 {
-  "message": "Successfully obtained image requests",
-  "requests":[
-    {
-      "clientRef": "12345",
-      "clientName": "The Enterprise",
-      "requestName": "Footage of the Lekki Protest",
-      "description": "Let’s get you started with a simple photo request.",
-      "requestRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
-      "country": "NG",
-      "stateOrRegion": "Lagos",
-      "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
-      "endAge": 65,
-      "startAge": 16,
-      "gender": "female",
-      "numberOfRespondents": 500,
-      "spotsLeft": 500,
-      "mediaType": "video",
-      "status": "live"
-    }
+  "message": "Successfully obtained video requests",
+   "requests":[
+      {
+        "clientRef": "12345",
+        "clientName": "The Enterprise",
+        "requestName": "Footage of the Lekki Protest",
+        "description": "Let’s get you started with a simple photo request.",
+        "requestRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
+        "country": "NG",
+        "stateOrRegion": "Lagos",
+        "created": "Thu Nov 12 2020 14:20:50 GMT+0100 (West Africa Standard Time)",
+        "endAge": 65,
+        "startAge": 16,
+        "gender": "female",
+        "numberOfRespondents": 500,
+        "mediaType": "audio",
+        "status": "live",
+        "versusCreditsAccruing": 2
+      }
+    .
+    .
+    .
   ]
 }
 ```
@@ -693,7 +684,8 @@ GET
       "numberOfRespondents": 500,
       "spotsLeft": 500,
       "mediaType": "image",
-      "status": "live"
+      "status": "live",
+      "versusCreditsAccruing": 2
     }
   ]
 }
@@ -794,3 +786,259 @@ GET
 * 401 - Invalid authstring
 * 500 - Error fetching request responses
 
+
+## Get Scouts Paystack Cashout
+
+Get scouts Paystack Cashouts and Chart.
+
+> Endpoint: scout_get_scouts_paystack_cashouts
+
+> Payload
+``` python
+{
+    "idToken": "eyJhbGciOiJSUzI1NiIs...",
+    "uid": "db3aLSS5AtalI7xqCa...",
+    "period": "lastMonth"
+}
+```
+
+> Result
+``` python
+{
+  "status": true,
+  "message": "Successful",
+  "totalPages": 12,
+  "totalCashouts": 114,
+  "pageSize": 10,
+  "currentPage": 1,
+   "cashouts": [
+      {
+          "scoutRef": "+2349017766085",
+          "data": {
+              "updatedAt": "2020-09-12T15:24:10.805Z",
+              "reference": "009f685e-604f-4140-9b6f-00408eaadb56",
+              "status": "success",
+              "recipient": 8758390,
+              "amount": 189000,
+              "reason": "Redeem Versus scout credits",
+              "integration": 146241,
+              "domain": "test",
+              "source": "balance",
+              "currency": "NGN",
+              "transfer_code": "TRF_63y76ctdr8a8cr7",
+              "createdAt": "2020-09-12T15:24:10.805Z",
+              "id": 32768223
+          },
+          "message": "Transfer has been queued",
+          "status": true
+      }
+    .
+    .
+    .
+  ],
+  "cashoutsChart": [
+    {
+        "date": "Dec 25",
+        "successfulCount": 2,
+        "successfulAmount": 70100,
+        "failedCount": 0,
+        "failedAmount": 0
+    }
+    .
+    .
+    .
+  ]
+}
+```
+
+
+## Get Scouts Paga Cashout
+
+Get scouts Paga Cashouts and Chart.
+
+> Endpoint: scout_get_scouts_paga_cashouts
+
+> Payload
+``` python
+{
+    "idToken": "eyJhbGciOiJSUzI1NiIs...",
+    "uid": "db3aLSS5AtalI7xqCa...",
+    "period": "lastMonth"
+}
+```
+
+> Result
+``` python
+{
+  "status": true,
+  "message": "Successful",
+  "totalPages": 12,
+  "totalCashouts": 114,
+  "pageSize": 10,
+  "currentPage": 1,
+   "cashouts": [
+      {
+          "updatedAt": "2021-01-05T11:13:35.252Z",
+          "exchangeRate": null,
+          "amount": 54,
+          "responseCode": 0,
+          "withdrawalCode": null,
+          "receiverRegistrationStatus": "UNREGISTERED",
+          "referenceNumber": "3cdf95cc-54fc-4e1b-bb68-23a0e912ee89",
+          "message": "You have successfully sent N54.00 to +2347030287520. Paga Txn ID: WG7H2. Thank you for using Paga!",
+          "transactionId": "WG7H2",
+          "currency": "NGN",
+          "fee": 150
+      }
+    .
+    .
+    .
+  ],
+  "cashoutsChart": [
+    {
+        "date": "Dec 25",
+        "successfulCount": 2,
+        "successfulAmount": 70100,
+        "failedCount": 0,
+        "failedAmount": 0
+    }
+    .
+    .
+    .
+  ]
+}
+```
+
+## Get Scout Statistics
+
+Get scouts statistics.
+
+> Endpoint: scout_get_scouts_statistics
+
+> Payload
+``` python
+{
+    "idToken": "eyJhbGciOiJSUzI1NiIs...",
+    "uid": "db3aLSS5AtalI7xqCa..."
+}
+```
+
+> Result
+``` python
+{
+  "status": true,
+  "message": 'Successful',
+  "data": {
+    "scouts": {
+      "total": 1222,
+      "usingPayStack": 600,
+      "usingPaga": 622
+    },
+    "tokens": {
+      "total": 1222,
+      "usingPayStack": 600,
+      "usingPaga": 62
+    },
+    "naira": {
+      "total": 1222,
+      "usingPayStack": 600,
+      "usingPaga": 622
+    }
+  }
+}
+```
+
+
+
+## Missing Data Notification
+
+Get scouts statistics.
+
+> Endpoint: scout_missing_data_notification
+
+> Payload
+``` python
+{
+    "idToken": "eyJhbGciOiJSUzI1NiIs...",
+    "uid": "db3aLSS5AtalI7xqCa...",
+    "scoutRef": "+23480343233
+}
+```
+
+> Result
+``` python
+{
+  "status": true,
+  "message": 'Successfully notified scout',
+}
+```
+
+
+
+## Missing Data Notification
+
+Notify scout with missing responses in demographic survey
+
+> Endpoint: scout_missing_data_notification
+
+> Payload
+``` python
+{
+    "authString": "dfbeavt4h463234255dsR"
+    "scoutRef": "+23480343233
+}
+```
+
+> Result
+``` python
+{
+  "status": true,
+  "message": 'Successfully notified scout',
+}
+```
+
+## Get Missing Data
+Get missing responses in demographic survey
+
+> Endpoint: scout_get_missing_data
+
+> Payload
+``` python
+{
+    "authString": "dfbeavt4h463234255dsR"
+    "scoutRef": "+23480343233
+}
+```
+
+> Result
+``` python
+{
+  "status": true,
+  "message": "Successfully obtained missing questions",
+  "questions": []
+}
+```
+
+
+## Image Is Safe
+Verify that an image is suitable for upload
+
+> Endpoint: scout_image_is_safe
+
+> Payload
+``` python
+{
+    "authString": "dfbeavt4h463234255dsR"
+    "scoutRef": "+23480343233
+}
+```
+
+> Result
+``` python
+{
+  "status": true,
+  "message": "Image is suitable for submission"
+}
+```
+
+
diff --git a/Versus-2.0.md b/Versus-2.0.md
index 91da8bd..9fb1c71 100644
--- a/Versus-2.0.md
+++ b/Versus-2.0.md
@@ -99,7 +99,8 @@ To obtain campaigns that match a scout's demographic.
       "clientName": "The Enterprise",
       "clientRef": "nqaXKB0SzWN6xh7RVyzlzl",
       "endAge": 65,
-      "startAge": 16
+      "startAge": 16,
+      "versusCreditsAccruing": 0
     }
   ]
 }

From 0b00292c82f4f7804ecf0b1f938d083f9e8382ba Mon Sep 17 00:00:00 2001
From: BABABUSOLA <queenbusola1@gmail.com>
Date: Tue, 10 Aug 2021 09:42:46 +0100
Subject: [PATCH 96/96] updated scout_get_questions

---
 Scout.md | 46 ++++++++++++++++++++++++++++++++++++----------
 1 file changed, 36 insertions(+), 10 deletions(-)

diff --git a/Scout.md b/Scout.md
index 249d9d5..8172e6d 100644
--- a/Scout.md
+++ b/Scout.md
@@ -178,7 +178,7 @@ Get the questions associated with a campaign.
 **Sample payload**
 ``` json
 {
-  "docRef": "0b3cf5bd-bea9-429b-b374-8f65e5473ed9",
+  "docRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
   "scoutRef": "+2341234567890"
 }
 ```
@@ -188,15 +188,41 @@ Get the questions associated with a campaign.
 {
   "message": "Successfully obtained questions",
   "questions": [
-    {
-      "campaignName": "campaignRef",
-      "campaignRef": "0b3cf5bd-bea9-429b-b374-8f65e5473ed9",
-      "clientName": "clientName",
-      "clientRef": "clientRef",
-      "options": "1,2,3",
-      "question": "Big question",
-      "questionRef": "c30e78b6-ff88-49a5-91e9-bb7fb46f1455"
-    }
+        {
+            "questionRef": "9d2eb846-41f9-4745-af85-6d0a9951ecdc",
+            "campaignRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
+            "clientRef": "nqaXKB0SzWN6xh7RVyzl",
+            "campaignName": "Demographics Survey",
+            "clientName": "The Enterprise",
+            "question": "What is your highest education level?",
+            "options": {
+                "range": [],
+                "options_list": [
+                    "No schooling completed",
+                    "Nursery school to 8th grade",
+                    "Some high school no diploma",
+                    "High school graduate diploma or the equivalent (for example: GED)",
+                    "Some college credit no degree",
+                    "Trade/technical/vocational training",
+                    "Associate degree",
+                    "Bachelors degree",
+                    "Masters degree",
+                    "Professional degree",
+                    "Doctorate degree"
+                ],
+                "unit": "single_select",
+                "type": "multiplechoice"
+            },
+            "sequence": null,
+            "optionsListNG": [],
+            "optionsListGH": [],
+            "optionsListKE": [],
+            "optionsUnitNG": null,
+            "optionsUnitGH": null,
+            "optionsUnitKE": null,
+            "optionsUnitTZ": null,
+            "optionsListTZ": []
+        }
   ]
 }
 ```