Let's go for 5.0.0

Author: Andre601

.all-contributorsrc

@@ -1,6 +1,5 @@
 {
   "files": [
-    "README.md",
     "contributors.md"
   ],
   "imageSize": 100,

CHANGELOG.md

@@ -78,6 +78,30 @@ dependencies{
 ```
 </details>
 
+____
+## v5
+- ### 5.0.0
+  - Deprecated `GetAction`
+    - It is now split up into `GetBotAction` and `GetListAction`
+  - Many new methods for `/api/lists` endpoint.
+    - `getApiField(String, Site|String, ApiField)`
+    - `getBotWidgetUrl(String, Site|String)`
+    - `getDescription(String, Site|String)`
+    - `getDiscordInvite(String, Site|String)`
+    - `getFeatures(String, Site|String)`
+    - `getFilteredList(String)`
+    - `getIcon(String, Site|String)`
+    - `getId(String, Site|String)`
+    - `getLanguage(String, Site|String)`
+    - `getList(String, Site|String)`
+    - `getLists(String)`
+    - `getName(String, Site|String)`
+    - `getOwners(String, Site|String)`
+    - `getTimeAdded(String, Site|String)`
+    - `getUrl(String, Site|String)`
+    - `isDefunct(String, Site|String)`
+    - `isDiscordOnly(String, Site|String)`
+
 ____
 ## v4
 - ### v4.0.0_0

README.md

@@ -25,14 +25,8 @@
 [JetBrains annotations]: https://github.com/JetBrains/java-annotations
 [Caffeine]: https://github.com/ben-manes/caffeine
 
-<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[contributorsBadge]: https://img.shields.io/badge/Contributors_✨-3-green.svg?style=plastic
-<!-- ALL-CONTRIBUTORS-BADGE:END -->
-
 ![image]
 
-[![contributorsBadge]](#contributors-)
-
 JavaBotBlockAPI is a continued and updated Java Wrapper for [BotBlock], a website that makes it possible to update guild counts on multiple lists with one API.  
 This wrapper is a fork of [BotBlock4J] and was updated and improved to make it as userfriendly as possible.
 
@@ -67,180 +61,9 @@ For maven use this code snippet:
 ```
 
 # Usage
-To use the Wrapper you have to follow these steps.
-
-## Notes
-In the below examples do I use a JDA instance called `jda`.  
-This will also work with ShardManager.
-
-## POST methods
-You can post you guild counts to the different Botlists using the BotBlock API.
-
-### Creating an instance of BotBlockAPI
-For posting your guild counts towards the BotBlock API you first need to create an instance of the BotBlockAPI class.  
-To do this it's recommended to use `BotBlockAPI.Builder()`.
-
-Here is an example of how it could look like.
-```java
-BotBlockAPI api = new BotBlockAPI.Builder()
-    .addAuthToken("lbots.org", "MySecretToken123")
-    .addAuthToken("botlist.space", "MySecretToken456")
-    .build();
-```
-Remember to use `.build();` at the end to create the class.
-
-### Auto Posting
-JavaBotBlockAPI allows you to post the guild counts automatically every X minutes.  
-To do this, you first need to get an instance of the PostAction and then call `.enableAutoPost(...)`.
-
-Here is an example:
-```java
-PostAction postAction = new PostAction();
-
-// api is the instance of the BotBlockAPI
-postAction.enableAutoPost(jda, api);
-```
-The delay in which you post the guild counts is set through the `.setUpdateInterval(int)` method in the BotBlockAPI.Builder().
+Please visit the [wiki] for all available POST and GET methods, as the amount of GET methods alone is quite large.
 
-### Cancel auto posting
-To cancel the auto posting just call `.disableAutoPost();` in the RequestHandler and it should cancel the scheduler.
-
-### Manually posting
-There are methods that allow you to post the guild counts manually.  
-To Post your guild counts, just call the `.postGuilds(...)` method in the PostAction.
-
-```java
-PostAction postAction = new PostAction();
-
-// api is the instance of the BotBlockAPI
-postAction.postGuilds(jda, api);
-```
-
-## GET methods
-Since version 2.0.0 of JavaBotBlockAPI can you get certain information of a bot or the available Bot lists on the BotBlock API.  
-All methods listed below can be used through the `GetAction` class.
-
-### All available Bot lists
-You can call `.getBotLists()` to receive a JSONObject with all available Botlists in the BotBlockAPI.
-
-The returned JSONObject could look like this:
-```json
-{
-    "botlist.space": {
-        "api_docs": "https://docs.botlist.space",
-        "api_post": "https://api.botlist.space/v1/bots/:id",
-        "api_field": "server_count",
-        "api_shard_id": null,
-        "api_shard_count": null,
-        "api_shards": "shards",
-        "api_get": "https://api.botlist.space/v1/bots/:id"
-    },
-    "lbots.org": {
-        "api_docs": "https://lbots.org/api/docs",
-        "api_post": "https://lbots.org/api/v1/bots/:id/stats",
-        "api_field": "guild_count",
-        "api_shard_id": "shard_id",
-        "api_shard_count": "shard_count",
-        "api_shards": null,
-        "api_get": null
-    }
-}
-```
-
-### Single Bot list
-Calling `.getBotList(String, Site|String)` returns a specific Botlist as JSONObject.  
-For example does `.getBotList("123456789012345678", "lbots.org")` return the following JSONObject:
-```json
-{
-    "api_docs": "https://lbots.org/api/docs",
-    "api_post": "https://lbots.org/api/v1/bots/:id/stats",
-    "api_field": "guild_count",
-    "api_shard_id": "shard_id",
-    "api_shard_count": "shard_count",
-    "api_shards": null,
-    "api_get": null
-}
-```
-
-The first String parameter is used for the internal caching.
-
-### Complete Bot info
-Calling `.getBotInfo(Long|String)` returns a JSONObject from all the botlists and with some general information.
-
-The JSONObject can look like this:
-```json
-{
-    "id": "123456789012345678",
-    "name": "MyBot",
-    "discriminator": "1234",
-    "owners": [
-        "234567890123456789"
-    ],
-    "server_count": 100,
-    "invite": "https://discordapp.com/oauth2/authorize?client_id=123456789012345678&scope=bot",
-    "list_data": {
-        "botlist.space": [
-            {"data"},
-            200
-        ],
-        "lbots.org": [
-            {"data"},
-            404
-        ]
-    }
-}
-```
-
-`{"data"}` is the JSON that is returned by the provided Botlist meaning it's different for each site.  
-`name`, `discriminator`, `owners`, `server_count` and `invite` are based on the most common appearances of the data.
-
-### Bot info from all Bot lists
-You can call `.getBotListInfo(Long|String)` to only receive the bot info from all the Botlists.
-
-The returned JSONObject can look like this:
-```json
-{
-    "botlist.space": [
-        {"data"},
-        200
-    ],
-    "lbots.org": [
-        {"data"},
-        404
-    ]
-}
-```
-`{"data"}` is the JSON that is returned by the provided Botlist meaning it's different for each site.
-
-### Bot info of a single site
-With `.getBotListInfo(Long|String, Site|String)` can you receive the info of a specific site.  
-The returned data depends on the selected site and can be different for each one.
-
-### Invite
-The method `.getInvite(Long|String)` allows you to get the OAuth invite of the bot.  
-The invite is based on the most common appearance on the different bot lists.
-
-### Server count
-`.getServerCount(Long|String)` gives you the server count of the bot.  
-The server count is based on the most common appearance on the different bot lists.
-
-### Owners
-You can call `.getOwners(Long|String)` to get the owners of a Bot from all the Botlists.  
-The info is returned as ArrayList and is based on how often the info is provided by the botlists.
-
-## Exceptions
-When you post the guild counts could you encounter certain Exceptions.  
-You can receive the following exceptions:
-- `IOException`  
-The Request couldn't be performed properly. This can be f.e. the case when BotBlock.org denies access (403).
-- `RatelimitedException`  
-When we exceed the ratelimit of BotBlock.org  
-This is usually not the case when using the auto-post method because of the minimal delay being 2 minutes.  
-The GET method would also not call this as the result is cached for 2 minutes (unless disabled).
-- `NullPointerException`  
-Thrown when BotBlock.org sends an empty response, meaning something got messed up on their side.
-
-# Libraries
+# Libraries/Dependencies
 JavaBotBlockAPI utilizes different APIs to provide the functionality it offers right now.  
 We have a list of those libraries listed here.
 - [JDA] - Java library used for creating bots.
@@ -259,22 +82,5 @@ Here are some useful links:
 - [BotBlock4J] Original Wrapper from which this one originates.
 
 ## Contributors ✨
-
-Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
-
-<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
-<!-- prettier-ignore-start -->
-<!-- markdownlint-disable -->
-<table>
-  <tr>
-    <td align="center"><a href="https://tkachuk.tech"><img src="https://avatars1.githubusercontent.com/u/1907079?v=4" width="100px;" alt=""/><br /><sub><b>Dave</b></sub></a><br /><a href="#ideas-DavidRockin" title="Ideas, Planning, & Feedback">🤔</a></td>
-    <td align="center"><a href="http://linkedin.dv8tion.net"><img src="https://avatars1.githubusercontent.com/u/1479909?v=4" width="100px;" alt=""/><br /><sub><b>Austin Keener</b></sub></a><br /><a href="#plugin-DV8FromTheWorld" title="Plugin/utility libraries">🔌</a></td>
-    <td align="center"><a href="https://ci.codemc.io/"><img src="https://avatars2.githubusercontent.com/u/37156340?v=4" width="100px;" alt=""/><br /><sub><b>CodeMC</b></sub></a><br /><a href="#infra-CodeMC" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
-  </tr>
-</table>
-
-<!-- markdownlint-enable -->
-<!-- prettier-ignore-end -->
-<!-- ALL-CONTRIBUTORS-LIST:END -->
-
-This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+We appreciate any contribution from others towards this project.  
+All contributors are listed on the [contributors.md] file.

contributors.md

@@ -1,4 +1,10 @@
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[contributorsBadge]: https://img.shields.io/badge/Contributors_✨-3-green.svg?style=plastic
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+
 # Contributors
+![contributorsBadge]
+
 We appreciate any kind of contribution to the JavaBotBlockAPI, as it is our goal to improve over time.
 
 Contributions aren't just limited to PRs or code examples.  
@@ -16,6 +22,8 @@ Suggesting new featires, improvements or giving general feedback.
 Developes a library used by this project.
 - 🚇 (Infra)  
 Provides a site, service or similar that is used by the project (e.g. CI-Server).
+- 🚧 (Maintenance)  
+Helps maintaining this project, being it updating dependencies, or adding new features.
 
 # List of current contributors
 Below can you find a list of all currently aknowledged Contributors to our project.

docs/allclasses-index.html

@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (11.0.4) on Mon Jan 13 00:18:16 CET 2020 -->
+<!-- Generated by javadoc (11.0.4) on Mon Jan 13 15:43:58 CET 2020 -->
 <title>All Classes (JavaBotBlockAPI 4.3.0 API)</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="dc.created" content="2020-01-13">
@@ -28,7 +28,7 @@
     catch(err) {
     }
 //-->
-var data = {"i0":2,"i1":2,"i2":32,"i3":2,"i4":2,"i5":2,"i6":4};
+var data = {"i0":2,"i1":2,"i2":32,"i3":2,"i4":2,"i5":2,"i6":4,"i7":2,"i8":2,"i9":4};
 var tabs = {65535:["t0","All Classes"],2:["t2","Class Summary"],4:["t3","Enum Summary"],32:["t6","Annotation Types Summary"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
@@ -131,24 +131,43 @@ <h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><a href="org/botblock/javabotblockapi/requests/GetAction.html" title="class in org.botblock.javabotblockapi.requests">GetAction</a></td>
-<th class="colLast" scope="row">
-<div class="block">Class to perform GET actions with.</div>
+<th class="colLast" scope="row">Deprecated.
+<div class="deprecationComment">Use <a href="org/botblock/javabotblockapi/requests/GetBotAction.html" title="class in org.botblock.javabotblockapi.requests"><code>GetBotAction</code></a> for Bot related and
+             <a href="org/botblock/javabotblockapi/requests/GetListAction.html" title="class in org.botblock.javabotblockapi.requests"><code>GetListAction</code></a> for List related actions.</div>
 </th>
 </tr>
 <tr id="i4" class="altColor">
+<td class="colFirst"><a href="org/botblock/javabotblockapi/requests/GetBotAction.html" title="class in org.botblock.javabotblockapi.requests">GetBotAction</a></td>
+<th class="colLast" scope="row">
+<div class="block">Class used to perform GET actions on the <a href="https://botblock.org/api/docs#bots" target="_blank"><code>/bots/:id</code> endpoint</a>.</div>
+</th>
+</tr>
+<tr id="i5" class="rowColor">
+<td class="colFirst"><a href="org/botblock/javabotblockapi/requests/GetListAction.html" title="class in org.botblock.javabotblockapi.requests">GetListAction</a></td>
+<th class="colLast" scope="row">
+<div class="block">Class used to perform GET actions on the <a href="https://botblock.org/api/docs#lists" target="_blank"><code>/lists</code> endpoint</a>.</div>
+</th>
+</tr>
+<tr id="i6" class="altColor">
+<td class="colFirst"><a href="org/botblock/javabotblockapi/requests/GetListAction.ApiField.html" title="enum in org.botblock.javabotblockapi.requests">GetListAction.ApiField</a></td>
+<th class="colLast" scope="row">
+<div class="block">Enum containing the different API fields a bot list may have.</div>
+</th>
+</tr>
+<tr id="i7" class="rowColor">
 <td class="colFirst"><a href="org/botblock/javabotblockapi/requests/PostAction.html" title="class in org.botblock.javabotblockapi.requests">PostAction</a></td>
 <th class="colLast" scope="row">
 <div class="block">Class to perform post actions with.</div>
 </th>
 </tr>
-<tr id="i5" class="rowColor">
+<tr id="i8" class="altColor">
 <td class="colFirst"><a href="org/botblock/javabotblockapi/exceptions/RatelimitedException.html" title="class in org.botblock.javabotblockapi.exceptions">RatelimitedException</a></td>
 <th class="colLast" scope="row">
 <div class="block">Indicates that the Java-Wrapper (Bot) was rate-limited by BotBlock.org (Received error code 429)
  <br>The returned error message contains the route, Bot ID, IP and delay for when rate limit is removed.</div>
 </th>
 </tr>
-<tr id="i6" class="altColor">
+<tr id="i9" class="rowColor">
 <td class="colFirst"><a href="org/botblock/javabotblockapi/Site.html" title="enum in org.botblock.javabotblockapi">Site</a></td>
 <th class="colLast" scope="row">
 <div class="block">Enum class containing all sites currently supported by BotBlock.org.</div>

docs/allclasses.html

@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (11.0.4) on Mon Jan 13 00:18:16 CET 2020 -->
+<!-- Generated by javadoc (11.0.4) on Mon Jan 13 15:43:58 CET 2020 -->
 <title>All Classes (JavaBotBlockAPI 4.3.0 API)</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="dc.created" content="2020-01-13">
@@ -26,6 +26,9 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="org/botblock/javabotblockapi/BotBlockAPI.Builder.html" title="class in org.botblock.javabotblockapi">BotBlockAPI.Builder</a></li>
 <li><a href="org/botblock/javabotblockapi/annotations/DeprecatedSince.html" title="annotation in org.botblock.javabotblockapi.annotations">DeprecatedSince</a></li>
 <li><a href="org/botblock/javabotblockapi/requests/GetAction.html" title="class in org.botblock.javabotblockapi.requests">GetAction</a></li>
+<li><a href="org/botblock/javabotblockapi/requests/GetBotAction.html" title="class in org.botblock.javabotblockapi.requests">GetBotAction</a></li>
+<li><a href="org/botblock/javabotblockapi/requests/GetListAction.html" title="class in org.botblock.javabotblockapi.requests">GetListAction</a></li>
+<li><a href="org/botblock/javabotblockapi/requests/GetListAction.ApiField.html" title="enum in org.botblock.javabotblockapi.requests">GetListAction.ApiField</a></li>
 <li><a href="org/botblock/javabotblockapi/requests/PostAction.html" title="class in org.botblock.javabotblockapi.requests">PostAction</a></li>
 <li><a href="org/botblock/javabotblockapi/exceptions/RatelimitedException.html" title="class in org.botblock.javabotblockapi.exceptions">RatelimitedException</a></li>
 <li><a href="org/botblock/javabotblockapi/Site.html" title="enum in org.botblock.javabotblockapi">Site</a></li>

docs/allpackages-index.html

@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (11.0.4) on Mon Jan 13 00:18:16 CET 2020 -->
+<!-- Generated by javadoc (11.0.4) on Mon Jan 13 15:43:58 CET 2020 -->
 <title>All Packages (JavaBotBlockAPI 4.3.0 API)</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="dc.created" content="2020-01-13">

docs/constant-values.html

@@ -2,7 +2,7 @@
 <!-- NewPage -->
 <html lang="de">
 <head>
-<!-- Generated by javadoc (11.0.4) on Mon Jan 13 00:18:16 CET 2020 -->
+<!-- Generated by javadoc (11.0.4) on Mon Jan 13 15:43:58 CET 2020 -->
 <title>Constant Field Values (JavaBotBlockAPI 4.3.0 API)</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="dc.created" content="2020-01-13">