add table of contents

botisimo · Mar 4, 2022 · a9f0fb9 · a9f0fb9
1 parent 5802819
commit a9f0fb9
Showing 1 changed file with 45 additions and 14 deletions.
diff --git a/docs/loyalty/documentation/index.rst b/docs/loyalty/documentation/index.rst
@@ -2,15 +2,23 @@
 Loyalty API Documentation
 =========================
 
+- `API Endpoint`_
+- `Get Team Info`_
+- `Sign Up`_
+- `Log In`_
+- `Upgrade Tier`_
+- `Confirm Upgrade Tier`_
+- `Manage Billing`_
+
 API Endpoint
 ============
 
 The API is located at the following URL. You should replace ``:team`` with your team's name in your Botisimo account
 
 ``https://botisimo.com/api/v1/loyalty/:team``
 
-Get Team
---------
+Get Team Info
+-------------
 
 Get the information about the team
 
@@ -72,24 +80,24 @@ user                        object   Information about the logged in user
 user.avatar                 string   URL to to user avatar
 user.createdAt              string   When the user was created
 user.dateOfBirth            string   Date of birth formatted as ``MM/DD/YYYY``
-user.id                     string   The ID of the user
+user.id                     number   The ID of the user
 user.loyaltyTier            object   The tier the user is subscribed to
 user.loyaltyTier.id         number   The ID of the tier
 user.loyaltyTier.name       string   The name of the tier
 user.loyaltyTier.priceMonth number   The cost of the tier per month in cents
 user.loyaltyTier.priceYear  number   The cost of the tier per year in cents
 user.loyaltyTier.resourceId number   The resource ID of the tier badge icon
 user.name                   string   The name of the user
-user.notifications          string   The last time the user read the notifications
+user.notifications          string   The last time the user read the notifications formatted as ISO date string
 user.shippingAddressCity    string   Shipping info for the user
 user.shippingAddressCountry string   Shipping info for the user
 user.shippingAddressName    string   Shipping info for the user
 user.shippingAddressState   string   Shipping info for the user
 user.shippingAddressStreet  string   Shipping info for the user
 user.shippingAddressSuite   string   Shipping info for the user
 user.shippingAddressZip     string   Shipping info for the user
-user.tags                   string   List of tags the user is interested in
-user.tags.id                string   The ID of the tag
+user.tags                   object[] List of tags the user is interested in
+user.tags.id                number   The ID of the tag
 user.tags.name              string   The name of the tag
 =========================== ======== =================================================================================
 
@@ -109,12 +117,35 @@ password    string
 
 Response
 
-=========== ======== ======================================================
-Field       Type     Description
-=========== ======== ======================================================
-token       string   Token for future requests that require authentication
-user        object   Information about the logged in user
-=========== ======== ======================================================
+=========================== ======== ==========================================================================
+Field                       Type     Description
+=========================== ======== ==========================================================================
+token                       string   Token for future requests that require authentication
+user                        object   Information about the logged in user
+user                        object   Information about the logged in user
+user.avatar                 string   URL to to user avatar
+user.createdAt              string   When the user was created
+user.dateOfBirth            string   Date of birth formatted as ``MM/DD/YYYY``
+user.id                     number   The ID of the user
+user.loyaltyTier            object   The tier the user is subscribed to
+user.loyaltyTier.id         number   The ID of the tier
+user.loyaltyTier.name       string   The name of the tier
+user.loyaltyTier.priceMonth number   The cost of the tier per month in cents
+user.loyaltyTier.priceYear  number   The cost of the tier per year in cents
+user.loyaltyTier.resourceId number   The resource ID of the tier badge icon
+user.name                   string   The name of the user
+user.notifications          string   The last time the user read the notifications formatted as ISO date string
+user.shippingAddressCity    string   Shipping info for the user
+user.shippingAddressCountry string   Shipping info for the user
+user.shippingAddressName    string   Shipping info for the user
+user.shippingAddressState   string   Shipping info for the user
+user.shippingAddressStreet  string   Shipping info for the user
+user.shippingAddressSuite   string   Shipping info for the user
+user.shippingAddressZip     string   Shipping info for the user
+user.tags                   object[] List of tags the user is interested in
+user.tags.id                number   The ID of the tag
+user.tags.name              string   The name of the tag
+=========================== ======== ==========================================================================
 
 Upgrade Tier
 ------------
@@ -134,8 +165,8 @@ interval    string   The billing interval. Should be ``month`` or ``year``
 tier        number   Tier ID
 =========== ======== ======================================================
 
-Confirm Upgrade
----------------
+Confirm Upgrade Tier
+--------------------
 
 This endpoint should ONLY be used after first using the ``/billing/upgrade`` endpoint and prompting the user to confirm the transaction.