Users API folder update

The content of the Users API docs is still to be completed.
APIs that are from the same url were merged in the same file.
./docs/users.md not yet completed

README.md

@@ -12,11 +12,15 @@ This work is in progress, I will update it when I have time available. The booya
 
 Any useful contribution to the documentation is appreciated :)
 
+>What does it mean when an entry says Private and Public in the docs?
+
+Means whether an API is accessible to everyone (Public) or only to your own user (Private).
+
 ## ↓ Docs ↓
 
 ### Get users information
 
-[Users API](./docs/users.md) (Incomplete)
+[Users API](./docs/users.md) (File listing and URLs complete, Docs incomplete)
 
 ### Get channels information
 

docs/channels.md

@@ -5,7 +5,7 @@ Work in progress...
 ## Tree 🌲
 
 ```less
-channels
+.channels
 ├── alert-configs.md
 ├── stats.md
 ├── stream-keys.md

docs/chatrooms.md

@@ -5,7 +5,7 @@ Work in progress...
 ## Tree 🌲
 
 ```less
-chatrooms
+.chatrooms
 ├── audiences-count.md
 └── chatrooms.md
 ```

docs/games.md

@@ -5,7 +5,7 @@ Work in progress...
 ## Tree 🌲
 
 ```less
-games
+.games
 ├── games-1-rewards.json
 ├── games-1-rewards.md
 └── games.md

docs/users.md

@@ -5,26 +5,47 @@ Work in progress...
 ## Tree 🌲
 
 ```less
-users
+.users
 ├── blocks.md
 ├── bug-report-claims.md
 ├── cash-coins.md
+├── clip-feeds.md
 ├── coins.md
+├── content-tags.md
 ├── daily-logins.md
+├── device-tokens.md
+├── fb-pages.md
 ├── followers.md
+├── followings.md
 ├── free-gifts.md
-├── push-message-sessions.md
-└── userID.md
+├── game-followings.md
+├── liked-playbacks.md
+├── linked-games.md
+├── linked-platforms.md
+├── playbacks.md
+├── push-message.md
+├── real-life-prizes.md
+├── received-likes-count.md
+├── recommended-streamers.md
+├── recommended-streams.md
+├── userID.md
+└── withdraw-info.md
 ```
 
 ### Public Access
 
 [Info about some account (/userID)](./users/userID.md)
 
-[Info about the follower count of some user (/followers)](./users/followers.md)
+[Get the list of the 100 latest followers (/followers)](./users/followers.md)
+
+[Info about the follower count of some user (/followers/count)](./users/followers-count.md)
+
+[(/content-tags)](./users/content-tags.md)
 
 ### Private Access
 
+[Get the linked facebook page in the user channel (/fb-pages)](./users/fb-pages.md)
+
 [Get a list of users blocked (/blocks)](./users/blocks.md)
 
 [Info about daily login (/daily-logins)](./users/daily-logins.md)
@@ -38,3 +59,9 @@ users
 [Info about some Free gifts/tickets (/free-gifts)](./users/free-gifts.md)
 
 [Info about some bug report or something else (/bug-report-claims)](./users/bug-report-claims.md)
+
+### Unknown
+
+[(/clip-feeds)](./users/clip-feeds.md)
+
+[(/device-tokens)](./users/device-tokens.md)

docs/users/blocks.md

@@ -1,4 +1,4 @@
-# Blocks
+# Blocks - Private
 
 Request Method: GET
 

docs/users/bug-report-claims.md

@@ -1,4 +1,4 @@
-# Bug Report Claims
+# Bug Report Claims - Private
 
 * */api/v3/users/`userID`/bug-report-claims* = Bug report claims by user
   * Response Example:

docs/users/cash-coins.md

@@ -1,8 +1,41 @@
-# Cash Coins
+# Cash Coins - Private Access
 
 Request Method: GET
 
-* */api/v3/users/`userID`/cash-coins* = Something about cashout and money in the account
+* */api/v3/users/`userID`/cash-coins* = Get the money balance in your account
+  * Response Example:
+  
+    ```js
+    {
+        "cash_coin": "0.00",
+        "currency": "USD",
+        "currency_amount": "0",
+        "currency_exchange_rate": "0.0035",
+        "min_currency_amount": "40.00",
+        "max_currency_amount": "5000.00",
+        "withdraw_sub_code": 400005,
+        "withdraw_sub_msg": "You need to apply for a minimum amount of 40.00USD to cashout",
+        "withdraw_sub_title": "Lower than minimum amount"
+    }
+    ```
+
+## Withdrawals
+
+Request Method: GET
+
+* */api/v3/users/`userID`/cash-coins/withdrawals* = Get the withdrawals list in your account (I am not sure)
+  * Response Example:
+  
+    ```js
+    {
+    "next_cursor": 0,
+    "withdrawal_list": []
+    }
+    ```
+
+Request Method: POST
+
+* */api/v3/users/`userID`/cash-coins/withdrawals* = Get the money balance in your account
   * Response Example:
   
     ```js

docs/users/clip-feeds.md

@@ -0,0 +1,16 @@
+# Clip Feeds
+
+Request Method: GET
+
+* */users/`userID`/clip-feeds* = Get the list of clips in the feed
+  * Response Example: Response to long for be posted here, fetch it yourself
+
+Request Method: DELETE
+
+* */users/`userID`/clip-feeds/{uuidList}* = Delete a clip in the feed, only for admins i think
+  * Response Example: Response to long for be posted here, fetch it yourself
+
+Request Method: GET
+
+* */users/`userID`/verified-clip-feeds* = Get the channels followed by this user
+  * Response Example: Response to long for be posted here, fetch it yourself

docs/users/coins.md

@@ -1,4 +1,4 @@
-# Coins
+# Coins - Private
 
 Request Method: GET
 

docs/users/content-tags.md

@@ -0,0 +1,21 @@
+# Content Tags - Public Access
+
+Request Method: GET
+
+* */users/`userID`/content-tags* = 
+  * Response Example:
+
+    ```js
+    {
+    "tag_uniq_list": []
+    }
+    ```
+
+Request Method: PATCH
+
+* */users/`userID`/content-tags* = 
+  * Response Example: No response for now
+
+    ```js
+
+    ```

docs/users/daily-logins.md

@@ -1,4 +1,4 @@
-# Daily Logins
+# Daily Logins - Private
 
 Request Method: GET
 

docs/users/device-tokens.md

@@ -0,0 +1,13 @@
+# Device Tokens - Unknown
+
+Request Method: POST
+
+* */users/`userID`/device-tokens* = No info about this
+  * Response Example:
+
+     ```js
+     {
+    "code": 400,
+    "message": "invalid input"
+    }
+     ```

docs/users/fb-pages.md

@@ -0,0 +1,14 @@
+# FB Pages - Public
+
+Request Method: GET
+
+* */users/`userID`/fb/pages* = Get the linked facebook page in the user channel
+  * Response Example (if the user don't has a facebook page linked):
+
+     ```js
+    {
+    "code": 400,
+    "message": "facebook link not found"
+    }
+     ```
+  

docs/users/followers.md

@@ -1,7 +1,29 @@
-# Followers Count
+# Followers
 
 Request Method: GET
 
+* */users/`userID`/followers/* = Get the last 100 followers of the channel with info about the users.
+  * Response Example:
+
+     ```js
+     {
+    "cursor": 12345678, // Unknown ID, It means I don't know where it comes from
+    "follower_list": [{
+        "uid": userID,
+        "nickname": "Nickname",
+        "nickname_next_update_time": 2592000, // Unix time // If the value is 2592000, it means the user has not changed nickname
+        "thumbnail": "https://resmambet-a.akamaihd.net/mambet-storage/Channel/Avatar/userID/userID.avatar",
+        "gender": 0,
+        "gender_next_update_time": 0,
+        "age": 0,
+        "birthday": 0,
+        "birthday_next_update_time": 0,
+        "platform": 0,
+        "following_count": 0,
+        "follower_count": 0
+    }
+     ```
+
 * */users/`userID`/followers/count* = Get the follower count of channelID
   * Response Example:
 

docs/users/followings.md

@@ -0,0 +1,43 @@
+# Followings
+
+Request Method: GET
+
+* */users/`userID`/followings/* = Get the channels followed by this user
+  * Response Example:
+
+     ```js
+     {
+    "cursor": 0,
+    "following_list": [{
+        "uid": userID,
+        "nickname": "Nickname",
+        "nickname_next_update_time": 2592000, // Unix time // If the value is 2592000, it means the user has not changed nickname
+        "thumbnail": "https://resmambet-a.akamaihd.net/mambet-storage/Web/Avatar/userID/image-1629340142035.jpeg",
+        "gender": 0,
+        "gender_next_update_time": 1629263003,
+        "age": 0,
+        "birthday": 0,
+        "birthday_next_update_time": 1629263031,
+        "platform": 8, 
+        "following_count": 15,
+        "follower_count": 39,
+        "follow_time": 1629267379,
+        "followed_time": 1628928291,
+        "notification": 1 // 0 = Notifications about streams disabled, 1 = Notifications enabled
+    }
+     ```
+
+* */users/`userID`/followings/count* = Get the count of channels followed by this user
+  * Response Example:
+
+     ```js
+     {"count":1337} // Followings Count
+     ```
+
+* */users/`userID`/followings/streams* = ***Pending***
+  * Response Example:
+
+     ```js
+     Pending
+     ```
+  

docs/users/game-followings.md

@@ -0,0 +1,28 @@
+# Game Followings - Private
+
+Request Method: GET
+
+* */users/`userID`/game-followings* = Get the games followed by you
+  * Response Example:
+
+     ```js
+     {"count":1337} // Follower Count
+     ```
+
+Request Method: POST
+
+* */users/`userID`/game-followings* =
+  * Response Example:
+
+     ```js
+     {"count":1337} // Follower Count
+     ```
+
+Request Method: DELETE
+
+* */users/`userID`/game-followings* = Delete a game followed by you
+  * Response Example:
+
+     ```js
+     {"count":1337} // Follower Count
+     ```

docs/users/liked-playbacks.md

@@ -0,0 +1,23 @@
+# Liked Playbacks - Public
+
+Request Method: GET
+
+* */users/`userID`/liked-playblacks* = Get liked playbacks of the user
+  * Response Example:
+
+     ```js
+     {
+    "cursor": 0,
+    "playback_list": []
+    }
+     ```
+
+* */users/`userID`/liked-playblacks/count* = Get liked playbacks count of the user
+  * Response Example:
+
+     ```js
+     {
+    "count": 0
+    }
+     ```
+  

docs/users/linked-games.md

@@ -0,0 +1,37 @@
+# Liked Games - Unknown
+
+Request Method: GET
+
+* */users/`userID`/liked-games* = Get the channels followed by this user
+  * Response Example:
+
+     ```js
+     {"count":1337} // Follower Count
+     ```
+
+Request Method: DELETE
+
+* */users/`userID`/liked-games/{gameid}* = Get the channels followed by this user
+  * Response Example:
+
+     ```js
+     {"count":1337} // Follower Count
+     ```
+
+Request Method: GET
+
+* */users/`userID`/liked-games/{gameid}* = Get the channels followed by this user
+  * Response Example:
+
+     ```js
+     {"count":1337} // Follower Count
+     ```
+
+Request Method: POST
+
+* */users/`userID`/liked-games/{gameid}/{token}* = Get the channels followed by this user
+  * Response Example:
+
+     ```js
+     {"count":1337} // Follower Count
+     ```

docs/users/linked-platforms.md

@@ -0,0 +1,48 @@
+# Liked Patforms - Public
+
+Request Method: GET
+
+* */users/`userID`/linked-platforms* = Get the channels followed by this user
+  * Response Example:
+
+     ```js
+     {"count":1337} // Follower Count
+     ```
+
+Request Method: DELETE
+
+* */users/`userID`/linked-platforms/{platform}* = Get the channels followed by this user
+  * Response Example:
+
+     ```js
+     {"count":1337} // Follower Count
+     ```
+
+Request Method: PATCH
+
+* */users/`userID`/linked-platforms/{platform}* = Get the channels followed by this user
+  * Response Example:
+
+     ```js
+     {"count":1337} // Follower Count
+     ```
+
+Request Method: POST
+
+* */users/`userID`/linked-platforms/{platform}* = Get the channels followed by this user
+  * Response Example:
+
+     ```js
+     {"count":1337} // Follower Count
+     ```
+
+## Forwarders
+
+Request Method: DELETE
+
+* */users/`userID`/forwarders/{platformID}* = Get the channels followed by this user
+  * Response Example:
+
+     ```js
+     {"count":1337} // Follower Count
+     ```

docs/users/playbacks.md

@@ -0,0 +1,16 @@
+# Playbacks - Public
+
+Request Method: GET
+
+* */users/`userID`/playblacks/count* = Probably the number of times a user has replayed a VOD
+  * Response Example:
+
+     ```js
+    {
+    "total_count": 3,
+    "count_by_game": [{
+        "game_id": 0,
+        "count": 3
+    }]
+    }
+     ```

docs/users/push-message-sessions.md

@@ -1,14 +0,0 @@
-# Push Message Sessions
-
-Request Method: GET
-
-* */users/`userID`/push-message-sessions* = Get Somethings about the notificactions
-  * Response Example:
-
-    ```js
-    {
-    "read_msg_id": "20randomnumbersherex", // Some random numbers with id
-    "unread_msg_count": 0, // Unreaded notifications
-    "latest_msg_id": "20randomnumbersherex" // Latest id of msg
-    }
-    ```

docs/users/push-message.md

@@ -0,0 +1,42 @@
+# Push Message - Private
+
+Request Method: GET
+
+* */users/`userID`/push-messages?to_msg_id=&count=20* = Get the list of push messages in your account
+  * Response Example: Response to long for be posted here, fetch it yourself
+
+Request Method: GET
+
+## Push Message Sessions
+
+* */users/`userID`/push-messages-sessions* = Get id of the notifications, and the unread count
+  * Response Example:
+
+    ```js
+    {
+    "read_msg_id": "20randomnumbersherex", // Some random numbers with id
+    "unread_msg_count": 0, // Unreaded notifications
+    "latest_msg_id": "20randomnumbersherex" // Latest id of msg
+    }
+    ```
+
+Request Method: PATCH
+
+* */users/`userID`/push-message-sessions* = This request is invoked when the user reads the notifications.
+  * Request Example:
+
+    ```js
+    {
+    "read_msg_id":"13667911151371411783"
+    }
+    ```
+
+  * Response Example:
+
+    ```js
+    {
+    "read_msg_id": "13667911151371411783",
+    "unread_msg_count": 0,
+    "latest_msg_id": "13667911151371411783"
+    }
+    ```

docs/users/real-life-prizes.md

@@ -0,0 +1,21 @@
+# Real Life Prices - Public
+
+Request Method: GET
+
+* */users/`userID`/real-life-prizes* = Get the channels followed by this user
+  * Response Example:
+
+    ```js
+    {
+    "prize_list": []
+    }
+    ```
+
+Request Method: POST
+
+* */users/`userID`/real-life-prizes* = Get the channels followed by this user
+  * Response Example:
+
+     ```js
+     {"count":1337} // Follower Count
+     ```

docs/users/received-likes-count.md

@@ -0,0 +1,12 @@
+# Recieved Likes Count - Public
+
+Request Method: GET
+
+* */users/`userID`/received-likes/count* = Get the channels followed by this user
+  * Response Example:
+
+     ```js
+     {
+    "count": 1241
+    }
+     ```

docs/users/recommended-streamers.md

@@ -0,0 +1,6 @@
+# Recommended Streamers - Private
+
+Request Method: GET
+
+* */users/`userID`/recommended-streamers* = Get a list of recommended streamers for you
+  * Response Example: Response to long for be posted here, fetch it yourself

docs/users/recommended-streams.md

@@ -0,0 +1,6 @@
+# Recommended Streams - Public
+
+Request Method: GET
+
+* */users/`userID`/recommended-streams* = Get the channels followed by this user
+  * Response Example: Response to long for be posted here, fetch it yourself

docs/users/withdraw-info.md

@@ -0,0 +1,24 @@
+# Withdraw Info - Private
+
+Request Method: GET
+
+* */users/`userID`/withdraw-info* = Get the info about withdraw iin your account
+  * Response Example:
+
+     ```js
+    {
+    "user_withdraw_info": {
+        "uid": userID,
+        "region": "US",
+        "region_updated": false,
+        "phone": "",
+        "email": "",
+        "id_number": "",
+        "id_front_url": "",
+        "bank_account": "",
+        "bank_book_url": "",
+        "home_address": "",
+        "pay_pal_email": ""
+    }
+    }
+     ```