add loyalty admin api

botisimo · Sep 23, 2022 · e623811 · e623811
1 parent 5d4525e
commit e623811
Show file tree

Hide file tree

Showing 16 changed files with 100 additions and 4 deletions.
diff --git a/docs/loyalty/admin-documentation/index.rst b/docs/loyalty/admin-documentation/index.rst
@@ -0,0 +1,54 @@
+Admin API Documentation
+=======================
+
+- `API Endpoint`_
+- `Errors`_
+- :doc:`User API <user>`
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-loyalty-admin-documentation
+   :hidden:
+
+   user
+
+API Endpoint
+------------
+
+The API is located at the following URL::
+
+   https://botisimo.com/api/v1/loyalty/admin
+
+Authenticating Requests
+-----------------------
+
+Authenticated requests should include a ``Client ID`` generated from your Botisimo account `profile <https://botisimo.com/account/profile>`_ as a header on the request ``client-id``
+
+.. code-block:: js
+
+   const response = await axios.post('https://botisimo.com/api/v1/loyalty/admin/user/1/points', { ... }, {
+      headers: {
+         'client-id': 'xxxxx-xxxxx-xxxxx-xxxxx',
+      },
+   });
+
+Errors
+------
+
+Any errors will be returned with a non-2XX status code.
+
+Response
+
+=========== ======== ==========================================
+Field       Type     Description
+=========== ======== ==========================================
+message     string   The message describing the error
+=========== ======== ==========================================
+
+Example
+
+.. code-block:: js
+
+   {
+      message: "An error has occurred"
+   }
diff --git a/docs/loyalty/admin-documentation/user.rst b/docs/loyalty/admin-documentation/user.rst
@@ -0,0 +1,41 @@
+User API
+========
+
+- `Add Points`_
+
+Add Points
+----------
+
+Add points to a user
+
+- **POST** /user/:id/points
+
+Request
+
+=========== ======== =============================================================================================================
+Field       Type     Description
+=========== ======== =============================================================================================================
+points      number   The amount of points to add to the user
+message     string   The message to log with the transaction
+key         [string] If included, transactions will be limited to one key per user (this will prevent duplicate point assignments)
+=========== ======== =============================================================================================================
+
+.. code-block:: js
+
+   const response = await axios.post('https://botisimo.com/api/v1/loyalty/admin/user/1/points', {
+      points: 100,
+      message: 'Watched VOD content',
+      key: '12345xyz',
+   }, {
+      headers: {
+         'client-id': 'xxxxx-xxxxx-xxxxx-xxxxx',
+      },
+   });
+
+Response
+
+================================== ======== =================================================================================
+Field                              Type     Description
+================================== ======== =================================================================================
+success                            boolean  always true
+================================== ======== =================================================================================
diff --git a/docs/loyalty/index.rst b/docs/loyalty/index.rst
@@ -5,4 +5,5 @@ Loyalty
    :maxdepth: 1
    :name: toc-loyalty
 
-   documentation/index
+   user-documentation/index
+   admin-documentation/index
diff --git a/.../loyalty/documentation/authentication.rst → ...lty/user-documentation/authentication.rst b/.../loyalty/documentation/authentication.rst → ...lty/user-documentation/authentication.rst
diff --git a/docs/loyalty/documentation/billing.rst → docs/loyalty/user-documentation/billing.rst b/docs/loyalty/documentation/billing.rst → docs/loyalty/user-documentation/billing.rst
diff --git a/docs/loyalty/documentation/creators.rst → docs/loyalty/user-documentation/creators.rst b/docs/loyalty/documentation/creators.rst → docs/loyalty/user-documentation/creators.rst
diff --git a/docs/loyalty/documentation/events.rst → docs/loyalty/user-documentation/events.rst b/docs/loyalty/documentation/events.rst → docs/loyalty/user-documentation/events.rst
diff --git a/docs/loyalty/documentation/index.rst → docs/loyalty/user-documentation/index.rst b/docs/loyalty/documentation/index.rst → docs/loyalty/user-documentation/index.rst
@@ -1,5 +1,5 @@
-API Documentation
-=================
+User API Documentation
+======================
 
 - `API Endpoint`_
 - `Errors`_
@@ -18,7 +18,7 @@ API Documentation
 
 .. toctree::
    :maxdepth: 1
-   :name: toc-loyalty-documentation
+   :name: toc-loyalty-user-documentation
    :hidden:
 
    team

diff --git a/docs/loyalty/documentation/memberships.rst → ...oyalty/user-documentation/memberships.rst b/docs/loyalty/documentation/memberships.rst → ...oyalty/user-documentation/memberships.rst
diff --git a/docs/loyalty/documentation/missions.rst → docs/loyalty/user-documentation/missions.rst b/docs/loyalty/documentation/missions.rst → docs/loyalty/user-documentation/missions.rst
diff --git a/docs/loyalty/documentation/notifications.rst → ...alty/user-documentation/notifications.rst b/docs/loyalty/documentation/notifications.rst → ...alty/user-documentation/notifications.rst
diff --git a/docs/loyalty/documentation/shopItems.rst → .../loyalty/user-documentation/shopItems.rst b/docs/loyalty/documentation/shopItems.rst → .../loyalty/user-documentation/shopItems.rst
diff --git a/docs/loyalty/documentation/team.rst → docs/loyalty/user-documentation/team.rst b/docs/loyalty/documentation/team.rst → docs/loyalty/user-documentation/team.rst
diff --git a/docs/loyalty/documentation/tiers.rst → docs/loyalty/user-documentation/tiers.rst b/docs/loyalty/documentation/tiers.rst → docs/loyalty/user-documentation/tiers.rst
diff --git a/docs/loyalty/documentation/transactions.rst → ...yalty/user-documentation/transactions.rst b/docs/loyalty/documentation/transactions.rst → ...yalty/user-documentation/transactions.rst
diff --git a/docs/loyalty/documentation/user.rst → docs/loyalty/user-documentation/user.rst b/docs/loyalty/documentation/user.rst → docs/loyalty/user-documentation/user.rst