` and `` blocks to leave code alone.
+* Custom Alerts: Notify an admin that custom alerts have been set for their account
-> "From a certain point onward there is no longer any turning back. That is the
-> point that must be reached."
-> --Franz Kafka
+* Dashboard Ready: Notify an admin that the Versus Sentiment dashboard has data for viewing
-#### Buttons
+* Designated Primary Email: Notify an admin that they have been designated as a primary contact
-If your link text has a `>` at the end (for instance: `Continue >`), they show
-up as buttons.
+* Designated Team Member: Notify someone that they have been added as a team member to Versus Sentiment
-> [View in GitHub >][project]
+* Request a Demo: Let a potential user request a demo
-Customizing
-===========
+* Respond to Article: Notify a recipient to respond to a social media post
-Basic
------
+* Welcome to Versus: Notify the recipient that their Versus Sentiment account has been created
-### Theme options
+* Your Report: Dispatch a periodic report
-For the default theme (*theme-white*), You can set theme options by adding
-classes to the `` element. The available options are:
+# Profanity Filter
-#### big-h3
-Makes 3rd-level headings bigger.
+This function will take a string and return a HTML formattted string with tags that decorate profane words.
-``` html
-
-```
+# Scouts
-#### no-literate
-Disables "literate" mode, where code appears on the right and content text
-appear on the left.
+This has functions required for scouts to interact with campaigns:
-``` html
-
-```
+* Add Response
-#### large-brief
-Makes the opening paragraph large.
+* Create Scout
-``` html
-
-```
+* Get Campaigns
-### Adding more markup
+* Get DocRef
-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.
+* Get Questions
-Here are some ideas to get you started.
+* Get Responses
- * 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`).
+* Get Scout
-### JavaScript hooks
+# Tixy API Endpoints
-Flatdoc emits the events `flatdoc:loading` and `flatdoc:ready` to help you make
-custom behavior when the document loads.
+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
-``` js
-$(document).on('flatdoc:ready', function() {
- // I don't like this section to appear
- $("#acknowledgements").remove();
-});
-```
+# Versus-2.0 API Endpoints
-Full customization
-------------------
+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.
-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.
+* Scouts
-[Get blank template >][template]
+* Dashboard
-Misc
-====
+# Getting started
-Inspirations
-------------
+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.
-The following projects have inspired Flatdoc.
+> Method: POST
- * [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
+> Base_URL: https://us-central1-versus-dev-212614.cloudfunctions.net/
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]*
+
+[](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
+ Hola, mundo
+ ```
+
+#### 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
+`` and `` 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 `` element. The available options are:
+
+#### big-h3
+Makes 3rd-level headings bigger.
+
+``` html
+
+```
+
+#### no-literate
+Disables "literate" mode, where code appears on the right and content text
+appear on the left.
+
+``` html
+
+```
+
+#### large-brief
+Makes the opening paragraph large.
+
+``` html
+
+```
+
+### 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/Scout.md b/Scout.md
new file mode 100644
index 0000000..8172e6d
--- /dev/null
+++ b/Scout.md
@@ -0,0 +1,1070 @@
+# Scout
+
+Endpoints for Versus Scouts
+
+## Add Response
+
+Add a response to a question.
+
+
+> Endpoint: scout_add_response
+
+> Payload
+
+``` javascript
+{
+ "cRef": "",
+ "qRef": "",
+ "sRef": "",
+ "response": "",
+ "clientRef": ""
+}
+```
+
+> Result
+``` javascript
+{
+ "response": {
+ "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 - firstName, lastName and phoneNumber are required
+
+
+> Endpoint: scout_create_scout
+
+> Payload
+
+``` javascript
+{
+ "firstName": "James",
+ "lastName": "Austin",
+ "phoneNumber": "+2347023004000",
+ "bankName": "Prudential",
+ "bankCode": "002",
+ "accountNumber": "10-2-200-5",
+ "bvn": "bvn",
+ "emailAddress": "a@test.com",
+ "dob": "2017-12-31",
+ "gender": "Female",
+ "education": "education",
+ "maritalStatus": "maritalStatus",
+ "religion": "religion",
+ "occupation": "occupation",
+ "country": "country",
+ "state": "state",
+ "language": "English"
+}
+```
+
+> Result
+``` javascript
+{
+ "scoutRef": "ea7ca901-9217-4a04-9af4-3c6c21ccc3a2"
+}
+```
+
+## Get Campaigns
+
+Get all campaigns on the system
+
+
+> Endpoint: scout_get_campaigns
+
+> Payload
+
+``` javascript
+{}
+```
+
+> Result
+``` javascript
+{
+ "campaigns": [
+ {
+ "campaignName": "Biq Query",
+ "campaignRef": "0b3cf5bd-bea9-429b-b374-8f65e5473ed9",
+ "clientName": "The Enterprise",
+ "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",
+ "versusCreditsAccruing": 0
+ }
+ ]
+}
+```
+
+## Get DocRef
+
+Get a Scout reference given a phoneNumber.
+
+
+> Endpoint: scout_get_docref
+
+> Payload
+
+``` javascript
+{
+ "phoneNumber": "08023004000"
+}
+```
+
+> Result
+``` javascript
+{
+ "scouts": [
+ {
+ "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
+ }
+ ]
+}
+```
+
+## Get Questions
+
+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
+
+**Method** POST
+
+**Sample payload**
+``` json
+{
+ "docRef": "a0ad177c-a6d0-44a4-8662-7f2851093b81",
+ "scoutRef": "+2341234567890"
+}
+```
+
+**Result**
+``` json
+{
+ "message": "Successfully obtained questions",
+ "questions": [
+ {
+ "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": []
+ }
+ ]
+}
+```
+
+**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.
+
+
+> Endpoint: scout_get_questions
+
+> Payload
+
+``` javascript
+{
+ "docRef": "0b3cf5bd-bea9-429b-b374-8f65e5473ed9"
+}
+```
+
+> Result
+``` javascript
+{
+ "questions": [
+ {
+ "campaignRef": "0b3cf5bd-bea9-429b-b374-8f65e5473ed9",
+ "questionRef": "c30e78b6-ff88-49a5-91e9-bb7fb46f1455"
+ "scoutRef": "ea7ca901-9217-4a04-9af4-3c6c21ccc3a2",
+ "response": "response",
+ "clientRef": "clientRef"
+ }
+ ]
+}
+```
+
+## Get Scout
+
+Get a scout given the docRef
+
+
+> Endpoint: scout_get_scout
+
+> Payload
+
+``` javascript
+{
+ "docRef": "ea7ca901-9217-4a04-9af4-3c6c21ccc3a2"
+}
+```
+
+> Result
+``` javascript
+{
+ "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,
+ "requiresBankUpdate": false
+}
+```
+
+## 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"
+}
+```
+
+## 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"
+}
+```
+
+## 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",
+ "accountNumber":"1234567890",
+ "accountName":"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"
+}
+```
+
+
+## Get Image Requests
+
+Get a list of multimedia requests of mediaType _image_ a scout is eligible to send responses.
+
+**Endpoint**
+scout_get_image_requests
+
+**Method**
+GET
+
+**Query params**
+
+| Field | Type | Description |
+| - | - | - |
+| phoneNumber | string | Scout unique identifier |
+| authString | string | Authentication string |
+
+
+> Sample response
+``` 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",
+ "versusCreditsAccruing": 2
+ }
+ .
+ .
+ .
+ ]
+}
+```
+
+**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 multimedia requests of mediaType _audio_ a scout is eligible to send responses.
+
+**Endpoint**
+scout_get_audio_requests
+
+**Method**
+GET
+
+> 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",
+ "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
+ }
+ .
+ .
+ .
+ ]
+}
+```
+
+**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 multimedia requests of mediaType _video_ a scout is eligible to send responses.
+
+**Endpoint**
+scout_get_video_requests
+
+> 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",
+ "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
+ }
+ .
+ .
+ .
+ ]
+}
+```
+
+**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.
+
+**Endpoint**
+scout_get_multimedia_requests
+
+**Method**
+GET
+
+**Query params**
+
+| Field | Type | Description |
+| - | - | - |
+| phoneNumber | string | Scout unique identifier |
+| authString | string | Authentication string |
+
+
+> Sample response
+``` json
+{
+ "message": "Successfully obtained multimedia 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",
+ "versusCreditsAccruing": 2
+ }
+ ]
+}
+```
+
+**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
+
+| 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 |
+| authstring | string | Authentication string |
+
+> Endpoint: scout_add_multimedia_request_response
+
+> Method: POST
+
+> Sample payload
+
+``` json
+{
+ "requestRef": "12345",
+ "scoutRef": "239485855559",
+ "mediaUrls":["https://google.api.com/235617"],
+ "mediaType":"audio",
+ "authstring": "123567890987654321"
+}
+```
+
+> Sample response
+``` 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 | 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.
+
+**Endpoint**
+scout_get_request_responses
+
+**Method**
+GET
+
+**Query params**
+
+| Field | Type | Description |
+| - | - | - |
+| phoneNumber | string | Scout unique identifier |
+| authString | string | Authentication string |
+
+
+> Sample Response
+``` json
+{
+ "message": "Successfully obtained request responses",
+ "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
+
+
+## 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/Settings.md b/Settings.md
new file mode 100644
index 0000000..9eb6af1
--- /dev/null
+++ b/Settings.md
@@ -0,0 +1,160 @@
+# 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
+
+
+## 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
diff --git a/Tixy.md b/Tixy.md
new file mode 100644
index 0000000..4a027a3
--- /dev/null
+++ b/Tixy.md
@@ -0,0 +1,310 @@
+# Tixy
+
+Endpoint for Tixy
+
+## Create an account (Sign up)
+
+> Endpoint: tixy_register
+
+> 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": ""
+ }
+}
+
+```
+## 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
diff --git a/Versus-2.0.md b/Versus-2.0.md
new file mode 100644
index 0000000..9fb1c71
--- /dev/null
+++ b/Versus-2.0.md
@@ -0,0 +1,2147 @@
+# 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.
+
+## 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 || Scout has already completed this campaign
+* 404 - Scout does not exist
+* 500 - Backend service error || Oops! Something happened from our end
+
+## 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,
+ "versusCreditsAccruing": 0
+ }
+ ]
+}
+```
+
+> 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
+
+## 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 || Oops! Something broke from our end
+
+## 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 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
+
+## 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 body parameters ... || Error verifying account number || Error creating recipient
+* 401 - Failed authentication. Authstring invalid or not found in request body
+* 404 - Scout does not exist
+* 500 - Backend service error || Error verifying account || Error obtaining scout
+
+## 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 || 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
+
+## 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
+
+* 400 - Error obtaining banks list
+* 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.
+
+## 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
+
+** To be deprecated soon
+
+> 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
+
+** To be deprecated soon
+
+> 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
+
+** To be deprecated soon
+
+> 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
+
+** To be deprecated soon
+
+> 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
+
+## 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"
+}
+```
+## Download Listen Report
+
+Generates and downloads Versus pdf report based on filter parameters
+
+> Endpoint: versus_v2_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
+
+
+
+> 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
+* 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"
+ }
+}
+```
+
+## Get Total Requests
+Get total number of requests for a client.
+
+**Endpoint** versus_v2_get_total_requests
+
+> Payload
+
+``` json
+{
+ "clientRef": "12345",
+ "uid": "6789",
+ "idToken": "101112"
+}
+```
+
+> Response
+
+``` json
+{
+ "message":"Successfully obtained total number of requests",
+ "totalNumberOfRequests": 7
+}
+```
+
+**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.
+
+**Endpoint** versus_v2_get_total_client_request_respondents
+
+> Payload
+
+``` json
+{
+ "clientRef": "12345",
+ "uid": "6789",
+ "idToken": "101112"
+}
+```
+
+> Response
+
+``` json
+{
+ "message":"Successfully obtained total number of request respondents",
+ "totalNumberOfClientRequestRespondents": 7
+}
+```
+
+**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
+
+> 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)",
+ }
+ .
+ .
+ ]
+}
+```
+
+## Get Total Request Respondents
+
+Get total number of respondents for a request.
+
+**Endpoint** versus_v2_get_total_request_respondents
+
+> Payload
+
+``` json
+{
+ "clientRef": "12345",
+ "requestRef": "12345",
+ "uid": "6789",
+ "idToken": "101112"
+}
+
+```
+
+> Response
+
+``` json
+{
+ "message":"Successfully obtained total number of request respondents",
+ "totalNumberOfRequestRespondents": 7
+}
+```
+
+**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.
+
+> Endpoint: versus_v2_create_new_request
+
+> Payload
+
+``` json
+{
+ "clientRef": "12345",
+ "clientName": "The enterprise",
+ "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
+
+``` json
+{
+ "message":"Successfully created new request",
+ "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 Request Responses
+
+Get a list of responses for a request.
+
+**Endpoint** versus_v2_get_request_responses
+
+> Sample payload
+
+``` json
+{
+ "clientRef": "12345",
+ "requestRef": "12345",
+ "uid": "6789",
+ "idToken": "101112"
+}
+
+```
+
+> Sample response
+
+``` json
+{
+ "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"
+ }
+ ]
+}
+```
+
+**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
+
+> Sample payload
+
+```json
+{
+ "clientRef": "12345",
+ "requestRef": "123456",
+ "responseRef": "123456",
+ "uid": "6789",
+ "idToken": "101112"
+}
+```
+
+> Sample response
+
+```json
+{
+ "message":"Successfully approved request response",
+ "responseRef": "12345"
+}
+```
+
+## Reject Request Response.
+
+**Endpoint**
+
+versus_v2_reject_request_response
+
+> Sample payload
+
+```json
+{
+ "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"
+}
+```
+
+> Sample response
+
+```json
+{
+ "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
+{
+
+}
+```
+
+## 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
+* 403 - Only POST requests are allowed
+* 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
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
diff --git a/clients.html b/clients.html
new file mode 100644
index 0000000..6be68c1
--- /dev/null
+++ b/clients.html
@@ -0,0 +1,59 @@
+
+
+
+
+
+
+
+ Enterfive Docs - Clients
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Enterfive
+
+ - Clients
+ - Dashboard
+ - Email Templates
+ - Profanity Filter
+ - API reference
+ - Scouts
+ - Tixy
+ - Versus-2.0
+ - Powertrack
+ - Settings
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/dashboard.html b/dashboard.html
new file mode 100644
index 0000000..9e17117
--- /dev/null
+++ b/dashboard.html
@@ -0,0 +1,59 @@
+
+
+
+
+
+
+
+ Enterfive Docs - Dashboard
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Enterfive
+
+ - Clients
+ - Dashboard
+ - Email Templates
+ - Profanity Filter
+ - API reference
+ - Scouts
+ - Tixy
+ - Versus-2.0
+ - Powertrack
+ - Settings
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/email.html b/email.html
new file mode 100644
index 0000000..65a590c
--- /dev/null
+++ b/email.html
@@ -0,0 +1,59 @@
+
+
+
+
+
+
+
+ Enterfive Docs - Email
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Enterfive
+
+ - Clients
+ - Dashboard
+ - Email Templates
+ - Profanity Filter
+ - API reference
+ - Scouts
+ - Tixy
+ - Versus-2.0
+ - Powertrack
+ - Settings
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/index.html b/index.html
index 45a95e6..4149d4d 100644
--- a/index.html
+++ b/index.html
@@ -5,7 +5,7 @@
- Flatdoc
+ Enterfive Docs
@@ -29,33 +29,42 @@
-
-
+
+
-
-
+
- Documentation is easy.
- Flatdoc is the fastest way to create a site for your open source project.
- Flatdoc
+ Enterfive API Documentation.
+ .
+ Powered by Flatdoc
- Flatdoc
+ Enterfive
- - View on GitHub
- - Issues
+ - Clients
+ - Dashboard
+ - Email Templates
+ - Profanity Filter
- API reference
+ - Scouts
+ - Tixy
+ - Versus-2.0
+ - Powertrack
+ - Settings
+
diff --git a/powertrack.html b/powertrack.html
new file mode 100644
index 0000000..e86cb1e
--- /dev/null
+++ b/powertrack.html
@@ -0,0 +1,62 @@
+
+
+
+
+
+
+
+ Enterfive Docs - Powertrack
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Enterfive
+
+ - Clients
+ - Dashboard
+ - Email Templates
+ - Profanity Filter
+ - API reference
+ - Scouts
+ - Tixy
+ - Versus-2.0
+ - Powertrack
+ - Settings
+
+
+ - Tixy
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/profanity.html b/profanity.html
new file mode 100644
index 0000000..7e623bf
--- /dev/null
+++ b/profanity.html
@@ -0,0 +1,59 @@
+
+
+
+
+
+
+
+ Enterfive Docs - Profanity
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Enterfive
+
+ - Clients
+ - Dashboard
+ - Email Templates
+ - Profanity Filter
+ - API reference
+ - Scouts
+ - Tixy
+ - Versus-2.0
+ - Powertrack
+ - Settings
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/reference.html b/reference.html
index a9b8523..55e757b 100644
--- a/reference.html
+++ b/reference.html
@@ -5,7 +5,7 @@
- Flatdoc
+ Enterfive Docs - API Reference
@@ -28,11 +28,16 @@
diff --git a/scout.html b/scout.html
new file mode 100644
index 0000000..f5f66a4
--- /dev/null
+++ b/scout.html
@@ -0,0 +1,59 @@
+
+
+
+
+
+
+
+ Enterfive Docs - Scouts
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Enterfive
+
+ - Clients
+ - Dashboard
+ - Email Templates
+ - Profanity Filter
+ - API reference
+ - Scouts
+ - Tixy
+ - Versus-2.0
+ - Powertrack
+ - Settings
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/settings.html b/settings.html
new file mode 100644
index 0000000..08a36cd
--- /dev/null
+++ b/settings.html
@@ -0,0 +1,64 @@
+
+
+
+
+
+
+
+
+ Enterfive Docs - Versus-2.0
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Enterfive
+
+ - Clients
+ - Dashboard
+ - Email Templates
+ - Profanity Filter
+ - API reference
+ - Scouts
+ - Tixy
+ - Versus-2.0
+ - Powertrack
+ - Settings
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/tixy.html b/tixy.html
new file mode 100644
index 0000000..d17dfc4
--- /dev/null
+++ b/tixy.html
@@ -0,0 +1,59 @@
+
+
+
+
+
+
+
+ Enterfive Docs - Tixy
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Enterfive
+
+ - Clients
+ - Dashboard
+ - Email Templates
+ - Profanity Filter
+ - API reference
+ - Scouts
+ - Tixy
+ - Versus-2.0
+ - Powertrack
+ - Settings
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/versus-2.0.html b/versus-2.0.html
new file mode 100644
index 0000000..a2531f6
--- /dev/null
+++ b/versus-2.0.html
@@ -0,0 +1,64 @@
+
+
+
+
+
+
+
+
+ Enterfive Docs - Versus-2.0
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Enterfive
+
+ - Clients
+ - Dashboard
+ - Email Templates
+ - Profanity Filter
+ - API reference
+ - Scouts
+ - Tixy
+ - Versus-2.0
+ - Powertrack
+ - Settings
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file