add loyalty notifications API docs

botisimo · Jul 22, 2022 · 90f50bf · 90f50bf
1 parent a0a1e1a
commit 90f50bf
Show file tree

Hide file tree

Showing 6 changed files with 55 additions and 1 deletion.
diff --git a/docs/loyalty/documentation/creators.rst b/docs/loyalty/documentation/creators.rst
@@ -32,7 +32,7 @@ Response
 Field                                            Type     Description
 ================================================ ======== =======================================
 creators                                         object[]
-creators.id                                      string   The ID of the creator
+creators.id                                      number   The ID of the creator
 creators.hasTwitch                               boolean
 creators.twitchConnections                       object[]
 creators.twitchConnections.twitchId              string

diff --git a/docs/loyalty/documentation/events.rst b/docs/loyalty/documentation/events.rst
@@ -33,6 +33,7 @@ Response
 Field               Type     Description
 =================== ======== =======================================
 events              object[]
+events.id           number   The ID of the event
 events.name         string   The name of the event
 events.description  string   The event description
 events.url          string   The event URL
@@ -76,6 +77,7 @@ Response
 Field              Type     Description
 ================== ======== ==================================================
 event              object
+event.id           number   The ID of the event
 event.name         string   The name of the event
 event.description  string   The event description
 event.url          string   The event URL

diff --git a/docs/loyalty/documentation/index.rst b/docs/loyalty/documentation/index.rst
@@ -13,6 +13,7 @@ API Documentation
 - :doc:`Missions API <missions>`
 - :doc:`Shop Items API <shopItems>`
 - :doc:`Events API <events>`
+- :doc:`Notifications API <notifications>`
 
 .. toctree::
    :maxdepth: 1
@@ -29,6 +30,7 @@ API Documentation
    missions
    shopItems
    events
+   notifications
 
 API Endpoint
 ------------

diff --git a/docs/loyalty/documentation/missions.rst b/docs/loyalty/documentation/missions.rst
@@ -36,6 +36,7 @@ Response
 Field                Type     Description
 ==================== ======== =======================================
 missions             object[]
+missions.id          number   The ID of the mission
 missions.name        string   The name of the mission
 missions.description string   The mission description
 missions.type        string   The mission type
@@ -75,6 +76,7 @@ Response
 Field               Type     Description
 =================== ======== =======================================
 mission             object
+mission.id          number   The ID of the mission
 mission.name        string   The name of the mission
 mission.description string   The mission description
 mission.type        string   The mission type
@@ -114,6 +116,7 @@ Response
 Field               Type     Description
 =================== ======== =======================================
 mission             object
+mission.id          number   The ID of the mission
 mission.name        string   The name of the mission
 mission.description string   The mission description
 mission.type        string   The mission type

diff --git a/docs/loyalty/documentation/notifications.rst b/docs/loyalty/documentation/notifications.rst
@@ -0,0 +1,44 @@
+Events API
+==========
+
+- `List Notifications`_
+- `Read Event`_
+
+List Notifications
+-----------------
+
+List notifications
+
+- **GET** /notification/list
+
+Request
+
+=========== ======== ==========================================
+Field       Type     Description
+=========== ======== ==========================================
+\-          \-       \-
+=========== ======== ==========================================
+
+.. code-block:: js
+
+   const response = await axios.get('https://botisimo.com/api/v1/loyalty/:team/notification/list', {
+      headers: {
+         'x-user-auth-token': 'xxxxxxx',
+      },
+   });
+
+Response
+
+========================== ======== =======================================
+Field                      Type     Description
+========================== ======== =======================================
+notifications              object[]
+notifications.id           number   The ID of the notification
+notifications.timestamp    string   The ISO date of when the notification was created
+notifications.body         string   The notification display text
+notifications.event        [object] The event connected to the notification, if one exists
+notifications.mission      [object] The mission connected to the notification, if one exists
+notifications.rpgShopItem  [object] The shop item connected to the notification, if one exists
+notifications.resourceId   [number]   The resource ID of the notification image. You should use the resource ID from the ``event``, ``mission``, or ``rpgShopItem`` if they exist
+notifications.link         [string] The URL link related to the notification, if one exists
+========================== ======== =======================================
diff --git a/docs/loyalty/documentation/shopItems.rst b/docs/loyalty/documentation/shopItems.rst
@@ -34,6 +34,7 @@ Response
 Field                   Type     Description
 ======================= ======== =======================================
 shopItems               object[]
+shopItems.id            number   The ID of the shop item
 shopItems.name          string   The name of the shop item
 shopItems.description   string   The shop item description
 shopItems.type          string   The shop item type
@@ -75,6 +76,7 @@ Response
 Field                  Type     Description
 ====================== ======== =======================================
 shopItem               object
+shopItem.id            number   The ID of the shop item
 shopItem.name          string   The name of the shop item
 shopItem.description   string   The shop item description
 shopItem.type          string   The shop item type
@@ -116,6 +118,7 @@ Response
 Field                  Type     Description
 ====================== ======== =======================================
 shopItem               object
+shopItem.id            number   The ID of the shop item
 shopItem.name          string   The name of the shop item
 shopItem.description   string   The shop item description
 shopItem.type          string   The shop item type