docs: add params and model docs

Author: Insmael

pom.xml

@@ -80,6 +80,9 @@
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-javadoc-plugin</artifactId>
         <version>3.5.0</version>
+        <configuration>
+          <excludePackageNames>com.cryptomarket.sdk.requests</excludePackageNames>
+        </configuration>
         <executions>
           <execution>
             <id>attach-javadocs</id>
@@ -165,4 +168,4 @@
     <maven.compiler.target>17</maven.compiler.target>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
   </properties>
-</project>
+</project>

src/main/java/com/cryptomarket/params/AccountType.java

@@ -1,7 +1,12 @@
 package com.cryptomarket.params;
 
+/**
+ * Account type
+ */
 public enum AccountType {
+  /** Account type wallet */
   WALLET("wallet"),
+  /** Account type spot */
   SPOT("spot");
 
   private final String label;
@@ -10,6 +15,7 @@ private AccountType(String label) {
     this.label = label;
   }
 
+  @Override
   public String toString() {
     return label;
   }

src/main/java/com/cryptomarket/params/ContingencyType.java

@@ -2,13 +2,18 @@
 
 import com.squareup.moshi.Json;
 
+/** Contingency type */
 public enum ContingencyType {
+  /** Contingency type all or none */
   @Json(name = "allOrNone")
   ALL_OR_NONE("allOrNone"),
+  /** Contingency type one cancel other */
   @Json(name = "oneCancelOther")
   ONE_CANCEL_OTHER("oneCancelOther"),
+  /** Contingency type one trigger other */
   @Json(name = "oneTriggerOther")
   ONE_TRIGGER_OTHER("oneTriggerOther"),
+  /** Contingency type one trigger one cancel other */
   @Json(name = "oneTriggerOneCancelOther")
   ONE_TRIGGER_ONE_CANCEL_OTHER("oneTriggerOneCancelOther");
 
@@ -18,6 +23,7 @@ private ContingencyType(String label) {
     this.label = label;
   }
 
+  @Override
   public String toString() {
     return label;
   }

src/main/java/com/cryptomarket/params/Depth.java

@@ -1,8 +1,12 @@
 package com.cryptomarket.params;
 
+/** Orderbook depth */
 public enum Depth {
+  /** 5 prices of depth */
   _5("D5"),
+  /** 10 prices of depth */
   _10("D10"),
+  /** 20 prices of depth */
   _20("D20");
 
   private final String label;
@@ -11,6 +15,7 @@ private Depth(String label) {
     this.label = label;
   }
 
+  @Override
   public String toString() {
     return label;
   }

src/main/java/com/cryptomarket/params/IdentifyBy.java

@@ -1,16 +1,20 @@
 package com.cryptomarket.params;
 
+/** Identify user by */
 public enum IdentifyBy {
-    EMAIL("email"),
-    USERNAME("username");
+  /** Identify by email */
+  EMAIL("email"),
+  /** Identify by username */
+  USERNAME("username");
 
-    private final String label;
+  private final String label;
 
-    private IdentifyBy(String label) {
-        this.label = label;
-    }
+  private IdentifyBy(String label) {
+    this.label = label;
+  }
 
-    public String toString() {
-        return label;
-    }
-}
+  @Override
+  public String toString() {
+    return label;
+  }
+}

src/main/java/com/cryptomarket/params/NotificationType.java

@@ -1,9 +1,14 @@
 package com.cryptomarket.params;
 
+/** Notification type of a websocket subscription */
 public enum NotificationType {
+  /** Snapshot notification type */
   SNAPSHOT("snapshot"),
+  /** Update notification type */
   UPDATE("update"),
+  /** Data notification type */
   DATA("data"),
+  /** Type used to signal parse erroors */
   PARSE_ERROR("error");
 
   private final String label;
@@ -12,24 +17,29 @@ private NotificationType(String label) {
     this.label = label;
   }
 
+  @Override
   public String toString() {
     return label;
   }
 
+  /** True if it is snapshot */
   public boolean isSnapshot() {
     return this == NotificationType.SNAPSHOT;
   }
 
+  /** True if it is update */
   public boolean isUpdate() {
     return this == NotificationType.UPDATE;
   }
 
+  /** True if it is data */
   public boolean isData() {
     return this == NotificationType.DATA;
   }
 
+  /** True if it is a type of error */
   public boolean isError() {
     return this == NotificationType.PARSE_ERROR;
   }
 
-}
+}

src/main/java/com/cryptomarket/params/OBSpeed.java

@@ -1,8 +1,12 @@
 package com.cryptomarket.params;
 
+/** Order book speed */
 public enum OBSpeed {
+  /** Speed of 100 miliseconds */
   _100_MILISECONDS("100ms"),
+  /** Speed of 500 miliseconds */
   _500_MILISECONDS("500ms"),
+  /** Speed of 1000 miliseconds */
   _1000_MILISECONDS("1000ms");
 
   private final String label;
@@ -11,6 +15,7 @@ private OBSpeed(String label) {
     this.label = label;
   }
 
+  @Override
   public String toString() {
     return label;
   }

src/main/java/com/cryptomarket/params/OrderBuilder.java

@@ -2,6 +2,7 @@
 
 import com.squareup.moshi.Json;
 
+/** Order builder, used in order requests. used as a method chain */
 @SuppressWarnings("unused")
 public class OrderBuilder {
   @Json(name = "client_order_id")
@@ -33,66 +34,144 @@ public class OrderBuilder {
   @Json(name = "make_rate")
   private String makeRate;
 
+  /**
+   * Sets the client order id of the order
+   *
+   * @param clientOrderId The client order id of the order
+   * @return The order builder
+   */
   public OrderBuilder clientOrderId(String clientOrderId) {
     this.clientOrderId = clientOrderId;
     return this;
   }
 
+  /**
+   * Sets the symbol of the order
+   *
+   * @param symbol The symbol of the order
+   * @return The order builder
+   */
   public OrderBuilder symbol(String symbol) {
     this.symbol = symbol;
     return this;
   }
 
+  /**
+   * Sets the side of the order
+   *
+   * @param side The side of the order
+   * @return The order builder
+   */
   public OrderBuilder side(Side side) {
     this.side = side;
     return this;
   }
 
+  /**
+   * Sets the type of the order
+   *
+   * @param type The type of the order
+   * @return The order builder
+   */
   public OrderBuilder orderType(OrderType type) {
     this.type = type;
     return this;
   }
 
+  /**
+   * Sets the time in force of the order
+   *
+   * @param timeInForce The time in force of the order
+   * @return The order builder
+   */
   public OrderBuilder timeInForce(TimeInForce timeInForce) {
     this.timeInForce = timeInForce;
     return this;
   }
 
-  public OrderBuilder quantity(String quanity) {
-    this.quantity = quanity;
+  /**
+   * Sets the quantity of the order
+   *
+   * @param quantity The quantity of the order
+   * @return The order builder
+   */
+  public OrderBuilder quantity(String quantity) {
+    this.quantity = quantity;
     return this;
   }
 
+  /**
+   * Sets the price of the order
+   *
+   * @param price The price of the order
+   * @return The order builder
+   */
   public OrderBuilder price(String price) {
     this.price = price;
     return this;
   }
 
+  /**
+   * Sets the stop price of the order
+   *
+   * @param stopPrice The stop price of the order
+   * @return The order builder
+   */
   public OrderBuilder stopPrice(String stopPrice) {
     this.stopPrice = stopPrice;
     return this;
   }
 
+  /**
+   * Sets the expire time of the order
+   *
+   * @param expireTime The expire time of the order
+   * @return The order builder
+   */
   public OrderBuilder expireTime(String expireTime) {
     this.expireTime = expireTime;
     return this;
   }
 
+  /**
+   * Sets the strict validate of the order
+   *
+   * @param strictValidate The strict validate of the order
+   * @return The order builder
+   */
   public OrderBuilder strictValidate(Boolean strictValidate) {
     this.strictValidate = strictValidate;
     return this;
   }
 
+  /**
+   * Sets the post only of the order
+   *
+   * @param postOnly The post only of the order
+   * @return The order builder
+   */
   public OrderBuilder postOnly(Boolean postOnly) {
     this.postOnly = postOnly;
     return this;
   }
 
+  /**
+   * Sets the take rate of the order
+   *
+   * @param takeRate The take rate of the order
+   * @return The order builder
+   */
   public OrderBuilder takeRate(String takeRate) {
     this.takeRate = takeRate;
     return this;
   }
 
+  /**
+   * Sets the make rate of the order
+   *
+   * @param makeRate The make rate of the order
+   * @return The order builder
+   */
   public OrderBuilder makeRate(String makeRate) {
     this.makeRate = makeRate;
     return this;

src/main/java/com/cryptomarket/params/OrderStatus.java

@@ -1,12 +1,19 @@
 package com.cryptomarket.params;
 
+/** Status of an order */
 public enum OrderStatus {
 
+  /** New order */
   NEW("new"),
+  /** Suspended order */
   SUSPENDED("suspended"),
+  /** Partially filled order */
   PARTIALLY_FILLED("partiallyFilled"),
+  /** Fully filled order */
   FILLED("filled"),
+  /** Canceled order */
   CANCELED("canceled"),
+  /** Expired order */
   EXPIRED("expired");
 
   private final String label;
@@ -15,6 +22,7 @@ private OrderStatus(String label) {
     this.label = label;
   }
 
+  @Override
   public String toString() {
     return label;
   }