Merge pull request VictorFrWu#73 from VictorFrWu/BybitVictor

VictorFrWu · web-flow · commit 71ec12a6fe6e · 2024-09-12T20:44:39.000+02:00
add broker rewards endpoints
diff --git a/README.md b/README.md
@@ -40,27 +40,20 @@ Maven Example
 <dependency>
     <groupId>io.github.wuhewuhe</groupId>
     <artifactId>bybit-java-api</artifactId>
-    <version>1.2.6</version>
+    <version>1.2.8</version>
 </dependency>
 ```
 Gradle Example
 ```java
-implementation group: 'io.github.wuhewuhe', name: 'bybit-java-api', version: '1.2.6'
+implementation group: 'io.github.wuhewuhe', name: 'bybit-java-api', version: '1.2.8'
 ```
 Furthermore, build tool, please check [sonar type central repository](https://central.sonatype.com/artifact/io.github.wuhewuhe/bybit-java-api/1.2.3)
 
 ## Release-Notes
 ### Rest API
-- Fix spot margin toogle 
-- Fix spot margin set leverage
-- Add Broker to convert coin
-- Add get sub uids unlimited endpoint
-- Add get all sub uid api keys info endpoint
-- Add convert request quote endpoint
-- Add convert confirm quote endpoint
-- Add convert get status endpoint
-- Add convert get coin list quote endpoint
-- Add convert get history quote endpoint
+- Add Broker Reward Query Voucher Spec endpoint
+- Add Issue Voucher endpoint
+- Add Query Issued Voucher endpoint
 
 ## Usage
 Note: Replace placeholders (like YOUR_API_KEY, links, or other details) with the actual information. You can also customize this template to better fit the actual state and details of your Java API.
diff --git a/pom.xml b/pom.xml
@@ -6,7 +6,7 @@
 
     <groupId>io.github.wuhewuhe</groupId>
     <artifactId>bybit-java-api</artifactId>
-    <version>1.2.7</version>
+    <version>1.2.8-SNAPSHOT</version>
     <name>bybit-java-api</name>
     <url>https://github.com/VictorFrWu/bybit-java-api</url>
 
diff --git a/src/main/java/com/bybit/api/client/domain/broker/BrokerDataRequest.java b/src/main/java/com/bybit/api/client/domain/broker/BrokerDataRequest.java
diff --git a/src/main/java/com/bybit/api/client/domain/broker/request/BrokerDataRequest.java b/src/main/java/com/bybit/api/client/domain/broker/request/BrokerDataRequest.java
@@ -0,0 +1,31 @@
+package com.bybit.api.client.domain.broker.request;
+
+import com.bybit.api.client.domain.broker.BusinessType;
+import com.bybit.api.client.domain.broker.WithUsedAmount;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import lombok.Builder;
+import lombok.Getter;
+import lombok.Setter;
+import lombok.ToString;
+
+@Getter
+@Setter
+@ToString
+@Builder
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class BrokerDataRequest {
+    private BusinessType bizType;
+    private String subMemberId;
+    private String coin;
+    private Long startTime;
+    private Long endTime;
+    private Integer limit;
+    private String cursor;
+    private String id; // mandatory; voucher ID in query voucher spec
+    private String accountId; // mandatory;
+    private String awardId; // mandatory; voucher ID in issue voucher and query issued voucher
+    private String specCode; // mandatory;
+    private String amount; // mandatory;
+    private String brokerId; // mandatory;
+    private WithUsedAmount withUsedAmount;
+}
diff --git a/src/main/java/com/bybit/api/client/domain/broker/request/BrokerGetIssuedVoucherRequest.java b/src/main/java/com/bybit/api/client/domain/broker/request/BrokerGetIssuedVoucherRequest.java
@@ -1,5 +1,6 @@
-package com.bybit.api.client.domain.broker;
+package com.bybit.api.client.domain.broker.request;
 
+import com.bybit.api.client.domain.broker.WithUsedAmount;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import lombok.Builder;
 import lombok.Getter;
@@ -15,5 +16,5 @@ public class BrokerGetIssuedVoucherRequest {
     private String accountId;
     private String awardId;
     private String specCode;
-    private WithUsedAmount withUsedAmount;
+    private Boolean withUsedAmount;
 }
diff --git a/src/main/java/com/bybit/api/client/domain/broker/request/BrokerIssueVoucherRequest.java b/src/main/java/com/bybit/api/client/domain/broker/request/BrokerIssueVoucherRequest.java
@@ -1,4 +1,4 @@
-package com.bybit.api.client.domain.broker;
+package com.bybit.api.client.domain.broker.request;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import lombok.Builder;
diff --git a/src/main/java/com/bybit/api/client/domain/broker/request/BrokerVoucherSpecRequest.java b/src/main/java/com/bybit/api/client/domain/broker/request/BrokerVoucherSpecRequest.java
@@ -1,4 +1,4 @@
-package com.bybit.api.client.domain.broker;
+package com.bybit.api.client.domain.broker.request;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 import lombok.Builder;
diff --git a/src/main/java/com/bybit/api/client/impl/BybitApBrokerRestClientImpl.java b/src/main/java/com/bybit/api/client/impl/BybitApBrokerRestClientImpl.java
@@ -2,7 +2,7 @@
 
 import com.bybit.api.client.restApi.BybitApiBrokerRestClient;
 import com.bybit.api.client.restApi.BybitApiService;
-import com.bybit.api.client.domain.broker.BrokerDataRequest;
+import com.bybit.api.client.domain.broker.request.BrokerDataRequest;
 import com.bybit.api.client.service.BybitJsonConverter;
 
 import static com.bybit.api.client.service.BybitApiServiceGenerator.createService;
@@ -44,6 +44,11 @@ public Object getSubAccountsDeposits(BrokerDataRequest brokerDataRequest) {
         ));
     }
 
+    @Override
+    public Object getSubAccountsDeposits() {
+        return executeSync(bybitApiService.getBrokerSubDeposits());
+    }
+
     @Override
     public Object getVoucherSpec(BrokerDataRequest voucherSpecRequest) {
         var request = converter.mapToBrokerVoucherSpecRequest(voucherSpecRequest);
diff --git a/src/main/java/com/bybit/api/client/impl/BybitApiAsyncBrokerRestClientImpl.java b/src/main/java/com/bybit/api/client/impl/BybitApiAsyncBrokerRestClientImpl.java
@@ -3,7 +3,7 @@
 import com.bybit.api.client.restApi.BybitApiAsyncBrokerRestClient;
 import com.bybit.api.client.restApi.BybitApiCallback;
 import com.bybit.api.client.restApi.BybitApiService;
-import com.bybit.api.client.domain.broker.BrokerDataRequest;
+import com.bybit.api.client.domain.broker.request.BrokerDataRequest;
 import com.bybit.api.client.service.BybitJsonConverter;
 
 import static com.bybit.api.client.service.BybitApiServiceGenerator.createService;
@@ -43,6 +43,11 @@ public void getSubAccountsDeposits(BrokerDataRequest brokerDataRequest, BybitApi
         ).enqueue(new BybitApiCallbackAdapter<>(callback));
     }
 
+    @Override
+    public void getSubAccountsDeposits(BybitApiCallback<Object> callback) {
+        bybitApiService.getBrokerSubDeposits().enqueue(new BybitApiCallbackAdapter<>(callback));
+    }
+
     @Override
     public void getVoucherSpec(BrokerDataRequest voucherSpecRequest, BybitApiCallback<Object> callback) {
         var request = converter.mapToBrokerVoucherSpecRequest(voucherSpecRequest);
diff --git a/src/main/java/com/bybit/api/client/restApi/BybitApiAsyncBrokerRestClient.java b/src/main/java/com/bybit/api/client/restApi/BybitApiAsyncBrokerRestClient.java
@@ -1,12 +1,13 @@
 package com.bybit.api.client.restApi;
 
-import com.bybit.api.client.domain.broker.BrokerDataRequest;
+import com.bybit.api.client.domain.broker.request.BrokerDataRequest;
 
 public interface BybitApiAsyncBrokerRestClient {
     // Broker endpoints
     void getBrokerEarningData(BrokerDataRequest brokerDataRequest, BybitApiCallback<Object> callback);
     void getBrokerAccountInfo(BybitApiCallback<Object> callback);
     void getSubAccountsDeposits(BrokerDataRequest brokerDataRequest, BybitApiCallback<Object> callback);
+    void getSubAccountsDeposits(BybitApiCallback<Object> callback);
     void getVoucherSpec(BrokerDataRequest brokerDataRequest, BybitApiCallback<Object> callback);
     void issueVoucher(BrokerDataRequest brokerDataRequest, BybitApiCallback<Object> callback);
     void getIssuedVoucher(BrokerDataRequest brokerDataRequest, BybitApiCallback<Object> callback);
diff --git a/src/main/java/com/bybit/api/client/restApi/BybitApiBrokerRestClient.java b/src/main/java/com/bybit/api/client/restApi/BybitApiBrokerRestClient.java
@@ -1,12 +1,13 @@
 package com.bybit.api.client.restApi;
 
-import com.bybit.api.client.domain.broker.BrokerDataRequest;
+import com.bybit.api.client.domain.broker.request.BrokerDataRequest;
 
 public interface BybitApiBrokerRestClient {
     // Broker endpoints
     Object getBrokerEarningData(BrokerDataRequest brokerDataRequest);
     Object getBrokerAccountInfo();
     Object getSubAccountsDeposits(BrokerDataRequest brokerDataRequest);
+    Object getSubAccountsDeposits();
     Object getVoucherSpec(BrokerDataRequest brokerDataRequest);
     Object issueVoucher(BrokerDataRequest brokerDataRequest);
     Object getIssuedVoucher(BrokerDataRequest brokerDataRequest);
diff --git a/src/main/java/com/bybit/api/client/restApi/BybitApiService.java b/src/main/java/com/bybit/api/client/restApi/BybitApiService.java
@@ -3,9 +3,9 @@
 import com.bybit.api.client.constant.BybitApiConstants;
 import com.bybit.api.client.domain.account.request.*;
 import com.bybit.api.client.domain.asset.request.*;
-import com.bybit.api.client.domain.broker.BrokerGetIssuedVoucherRequest;
-import com.bybit.api.client.domain.broker.BrokerIssueVoucherRequest;
-import com.bybit.api.client.domain.broker.BrokerVoucherSpecRequest;
+import com.bybit.api.client.domain.broker.request.BrokerGetIssuedVoucherRequest;
+import com.bybit.api.client.domain.broker.request.BrokerIssueVoucherRequest;
+import com.bybit.api.client.domain.broker.request.BrokerVoucherSpecRequest;
 import com.bybit.api.client.domain.institution.clientLending.ClientLendingFundsRequest;
 import com.bybit.api.client.domain.institution.insLending.UpdateInstitutionLoadUidRequest;
 import com.bybit.api.client.domain.position.request.ConfirmNewRiskLimitRequest;
@@ -5090,6 +5090,10 @@ Call<Object> getBrokerSubDeposits(@Query("subMemberId") String subMemberId,
                                       @Query("limit") Integer limit,
                                       @Query("cursor") String cursor);
 
+    @Headers(BybitApiConstants.ENDPOINT_SECURITY_TYPE_SIGNED_HEADER)
+    @GET("/v5/broker/asset/query-sub-member-deposit-record")
+    Call<Object> getBrokerSubDeposits();
+
     /**
      * Get Exchange Broker Account Info
      * INFO
@@ -5114,24 +5118,68 @@ Call<Object> getBrokerSubDeposits(@Query("subMemberId") String subMemberId,
     Call<Object> getBrokerAccountInfo();
 
     /**
-     * Get Voucher Spec
+     * Query Voucher Spec
+     * HTTP Request
+     * POST /v5/broker/award/info
+     *
      * https://bybit-exchange.github.io/docs/v5/broker/reward/voucher
+     *
+     * @param voucherSpecRequest id	true	string	Voucher ID
+     * @return Response Parameters
+     * Parameter	Type	Comments
+     * id	string	Voucher ID
+     * coin	string	Coin
+     * amountUnit	string
+     * AWARD_AMOUNT_UNIT_USD
+     * AWARD_AMOUNT_UNIT_COIN
+     * productLine	string	Product line
+     * subProductLine	string	Sub product line
+     * totalAmount	Object	Total amount of voucher
+     * usedAmount	string	Used amount of voucher
      */
     @Headers(BybitApiConstants.ENDPOINT_SECURITY_TYPE_SIGNED_HEADER)
     @POST("/v5/broker/award/info")
     Call<Object> getVoucherSpec(@Body BrokerVoucherSpecRequest voucherSpecRequest);
 
     /**
      * Issue Voucher
+     * HTTP Request
+     * POST /v5/broker/award/distribute-award
      * https://bybit-exchange.github.io/docs/v5/broker/reward/issue-voucher
+     * @param issueVoucherRequest   accountId	true	string	User ID
+     *                              awardId	true	string	Voucher ID
+     *                              specCode	true	string	Customised unique spec code, up to 8 characters
+     *                              amount	true	string	Issue amount
+     *                              Spot airdrop supports up to 16 decimals
+     *                              Other types supports up to 4 decimals
+     *                              brokerId	true	string	Broker ID
+     * @return None
      */
     @Headers(BybitApiConstants.ENDPOINT_SECURITY_TYPE_SIGNED_HEADER)
     @POST("/v5/broker/award/distribute-award")
     Call<Object> issueVoucher(@Body BrokerIssueVoucherRequest issueVoucherRequest);
 
     /**
-     * Get Issued Voucher
+     * Query Issued Voucher
+     * HTTP Request
+     * POST /v5/broker/award/distribution-record
      * https://bybit-exchange.github.io/docs/v5/broker/reward/get-issue-voucher
+     * @param getIssuedVoucherRequest accountId	true	string	User ID
+     *                                  awardId	true	string	Voucher ID
+     *                                  specCode	true	string	Customised unique spec code, up to 8 characters
+     *                                  withUsedAmount	false	boolean	Whether to return the amount used by the user
+     * @return Response Parameters
+     * Parameter	Type	Comments
+     * accountId	string	User ID
+     * awardId	string	Voucher ID
+     * specCode	string	Spec code
+     * amount	string	Amount of voucher
+     * isClaimed	boolean	true, false
+     * startAt	string	Claim start timestamp (sec)
+     * endAt	string	Claim end timestamp (sec)
+     * effectiveAt	string	Voucher effective timestamp (sec) after claimed
+     * ineffectiveAt	string	Voucher inactive timestamp (sec) after claimed
+     * usedAmount	string	Amount used by the user
      */
     @Headers(BybitApiConstants.ENDPOINT_SECURITY_TYPE_SIGNED_HEADER)
     @POST("/v5/broker/award/distribution-record")
diff --git a/src/main/java/com/bybit/api/client/service/BybitJsonConverter.java b/src/main/java/com/bybit/api/client/service/BybitJsonConverter.java
@@ -10,11 +10,10 @@
 import com.bybit.api.client.domain.account.request.SetMarginModeRequest;
 import com.bybit.api.client.domain.asset.request.AssetDataRequest;
 import com.bybit.api.client.domain.asset.request.*;
-import com.bybit.api.client.domain.broker.BrokerDataRequest;
-import com.bybit.api.client.domain.broker.BrokerGetIssuedVoucherRequest;
-import com.bybit.api.client.domain.broker.BrokerIssueVoucherRequest;
-import com.bybit.api.client.domain.broker.BrokerVoucherSpecRequest;
-import com.bybit.api.client.domain.broker.WithUsedAmount;
+import com.bybit.api.client.domain.broker.request.BrokerDataRequest;
+import com.bybit.api.client.domain.broker.request.BrokerGetIssuedVoucherRequest;
+import com.bybit.api.client.domain.broker.request.BrokerIssueVoucherRequest;
+import com.bybit.api.client.domain.broker.request.BrokerVoucherSpecRequest;
 import com.bybit.api.client.domain.institution.LendingDataRequest;
 import com.bybit.api.client.domain.institution.clientLending.ClientLendingFundsRequest;
 import com.bybit.api.client.domain.institution.insLending.UpdateInstitutionLoadUidRequest;
@@ -628,6 +627,7 @@ public AssetQuoteRequest mapToAssetQuoteRequest(AssetDataRequest assetQuoteReque
   
     public ConfirmQuoteRequest mapToAssetConfirmQuoteRequest(AssetDataRequest assetQuoteRequest) {
         return ConfirmQuoteRequest.builder().quoteTxId(assetQuoteRequest.getQuoteTxId()).build();
+    }
     
     // Broker Reward Convert Requests
     public BrokerVoucherSpecRequest mapToBrokerVoucherSpecRequest(BrokerDataRequest brokerDataRequest) {
@@ -651,7 +651,7 @@ public BrokerGetIssuedVoucherRequest mapToBrokerGetIssuedVoucherRequest(BrokerDa
                 .accountId(brokerDataRequest.getAccountId())
                 .awardId(brokerDataRequest.getAwardId())
                 .specCode(brokerDataRequest.getSpecCode())
-                .withUsedAmount(brokerDataRequest.getWithUsedAmount() == null ? null : brokerDataRequest.getWithUsedAmount().getValue()) // FIXME: there is an issue here
+                .withUsedAmount(brokerDataRequest.getWithUsedAmount() == null ? null : brokerDataRequest.getWithUsedAmount().getValue())
                 .build();
     }
 }
diff --git a/src/test/java/com/bybit/api/examples/http/async/BrokerAsyncExample.java b/src/test/java/com/bybit/api/examples/http/async/BrokerAsyncExample.java
@@ -1,24 +1,37 @@
 package com.bybit.api.examples.http.async;
 
 import com.bybit.api.client.config.BybitApiConfig;
-import com.bybit.api.client.domain.broker.BrokerDataRequest;
+import com.bybit.api.client.domain.broker.WithUsedAmount;
+import com.bybit.api.client.domain.broker.request.BrokerDataRequest;
 import com.bybit.api.client.domain.broker.BusinessType;
 import com.bybit.api.client.service.BybitApiClientFactory;
 
 public class BrokerAsyncExample {
     public static void main(String[] args) {
         // Borker API key
-        var client = BybitApiClientFactory.newInstance("YOUR_API_KEY", "YOUR_API_SECRET", BybitApiConfig.TESTNET_DOMAIN).newAsyncBrokerRestClient();
+        var client = BybitApiClientFactory.newInstance("YOUR_API_KEY", "YOUR_API_SECRET").newAsyncBrokerRestClient();
 
         // Get Broker Earning
         var brokerEarningRequest = BrokerDataRequest.builder().bizType(BusinessType.SPOT).build();
         client.getBrokerEarningData(brokerEarningRequest, System.out::println);
 
-        // Get Broker Earning
+        // Get Broker Account Info
         client.getBrokerAccountInfo(System.out::println);
 
         // Get Broker Sub Deposits
         var brokerDepositsRequest = BrokerDataRequest.builder().build();
         client.getSubAccountsDeposits(brokerDepositsRequest, System.out::println);
+
+        // Query Voucher Spec
+        var brokerVoucherRequest = BrokerDataRequest.builder().id("80209").build();
+        client.getVoucherSpec(brokerVoucherRequest, System.out::println);
+
+        // Issue voucher
+        var brokerIssueVoucherRequest = BrokerDataRequest.builder().accountId("2846381").awardId("123456").specCode("award-001").amount("100").brokerId("v-28478").build();
+        client.issueVoucher(brokerIssueVoucherRequest, System.out::println);
+
+        // Query Issued Voucher
+        var brokerQueryVoucherRequest = BrokerDataRequest.builder().accountId("5714139").awardId("189528").specCode("demo000").withUsedAmount(WithUsedAmount.NOT_QUERY).build();
+        client.getIssuedVoucher(brokerQueryVoucherRequest, System.out::println);
     }
 }
diff --git a/src/test/java/com/bybit/api/examples/http/sync/BrokerExample.java b/src/test/java/com/bybit/api/examples/http/sync/BrokerExample.java

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package com.bybit.api.client.domain.broker;`
	`1`	`+package com.bybit.api.client.domain.broker.request;`
`2`	`2`
`3`	`3`	`import com.fasterxml.jackson.annotation.JsonInclude;`
`4`	`4`	`import lombok.Builder;`