Skip to content

Commit cb21754

Browse files
committed
fix document issues; add missing Contract field
1 parent 5ff42e4 commit cb21754

15 files changed

Lines changed: 145 additions & 125 deletions

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,28 @@
1-
## gate-api@4.15.2
1+
## gate-api@4.15.3
22

33
TypeScript NodeJS client for gate-api.
44

55
APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf.
66

77
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
88

9-
- API version: 4.15.2
9+
- API version: 4.15.3
1010
- Package version:
1111
- Build package: org.openapitools.codegen.languages.TypeScriptNodeClientCodegen
1212
For more information, please visit [https://www.gate.io/page/contacts](https://www.gate.io/page/contacts)
1313

14+
Environment
15+
16+
* Node.js
17+
18+
Language level
19+
20+
* ES2017
21+
22+
It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via `package.json`. ([Reference](http://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html))
23+
This package is targeting Node.js applications only, because it's not safe to store API secret in browser.
24+
[gateapi-js](https://github.com/gateio/gateapi-js) can be used in browser but with public endpoints only.
25+
1426
## Versioning
1527

1628
Trying our best to follow the [semantic versioning](https://semver.org/), while enjoying recent features
@@ -35,18 +47,6 @@ If MAJOR version is incremented, make sure you read the release note on
3547
[Releases](https://github.com/gateio/gateapi-nodejs/releases)
3648
page
3749

38-
Environment
39-
40-
* Node.js
41-
42-
Language level
43-
44-
* ES2017
45-
46-
It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via `package.json`. ([Reference](http://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html))
47-
This package is targeting Node.js applications only, because it's not safe to store API secret in browser.
48-
[gateapi-js](https://github.com/gateio/gateapi-js) can be used in browser but with public endpoints only.
49-
5050
### Building
5151

5252
To build and compile the typescript sources to javascript use:

docs/Contract.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ Name | Type | Description | Notes
3535
**positionSize** | **number** | Current total long position size | [optional] [default to undefined]
3636
**configChangeTime** | **number** | Configuration\'s last changed time | [optional] [default to undefined]
3737
**inDelisting** | **boolean** | Contract is delisting | [optional] [default to undefined]
38+
**ordersLimit** | **number** | Maximum number of open orders | [optional] [default to undefined]
3839

3940
## Enum: Contract.Type
4041

docs/DeliveryApi.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Name | Type | Description | Notes
6464

6565
### Return type
6666

67-
Promise<{ response: http.IncomingMessage; body: Array<DeliveryContract>; }(DeliveryContract.md)
67+
Promise<{ response: AxiosResponse; body: Array<DeliveryContract>; }> [DeliveryContract](DeliveryContract.md)
6868

6969
### Authorization
7070

@@ -107,7 +107,7 @@ Name | Type | Description | Notes
107107

108108
### Return type
109109

110-
Promise<{ response: http.IncomingMessage; body: DeliveryContract; }(DeliveryContract.md)
110+
Promise<{ response: AxiosResponse; body: DeliveryContract; }> [DeliveryContract](DeliveryContract.md)
111111

112112
### Authorization
113113

@@ -158,7 +158,7 @@ Name | Type | Description | Notes
158158

159159
### Return type
160160

161-
Promise<{ response: http.IncomingMessage; body: FuturesOrderBook; }(FuturesOrderBook.md)
161+
Promise<{ response: AxiosResponse; body: FuturesOrderBook; }> [FuturesOrderBook](FuturesOrderBook.md)
162162

163163
### Authorization
164164

@@ -211,7 +211,7 @@ Name | Type | Description | Notes
211211

212212
### Return type
213213

214-
Promise<{ response: http.IncomingMessage; body: Array<FuturesTrade>; }(FuturesTrade.md)
214+
Promise<{ response: AxiosResponse; body: Array<FuturesTrade>; }> [FuturesTrade](FuturesTrade.md)
215215

216216
### Authorization
217217

@@ -266,7 +266,7 @@ Name | Type | Description | Notes
266266

267267
### Return type
268268

269-
Promise<{ response: http.IncomingMessage; body: Array<FuturesCandlestick>; }(FuturesCandlestick.md)
269+
Promise<{ response: AxiosResponse; body: Array<FuturesCandlestick>; }> [FuturesCandlestick](FuturesCandlestick.md)
270270

271271
### Authorization
272272

@@ -311,7 +311,7 @@ Name | Type | Description | Notes
311311

312312
### Return type
313313

314-
Promise<{ response: http.IncomingMessage; body: Array<FuturesTicker>; }(FuturesTicker.md)
314+
Promise<{ response: AxiosResponse; body: Array<FuturesTicker>; }> [FuturesTicker](FuturesTicker.md)
315315

316316
### Authorization
317317

@@ -356,7 +356,7 @@ Name | Type | Description | Notes
356356

357357
### Return type
358358

359-
Promise<{ response: http.IncomingMessage; body: Array<InsuranceRecord>; }(InsuranceRecord.md)
359+
Promise<{ response: AxiosResponse; body: Array<InsuranceRecord>; }> [InsuranceRecord](InsuranceRecord.md)
360360

361361
### Authorization
362362

@@ -399,7 +399,7 @@ Name | Type | Description | Notes
399399

400400
### Return type
401401

402-
Promise<{ response: http.IncomingMessage; body: FuturesAccount; }(FuturesAccount.md)
402+
Promise<{ response: AxiosResponse; body: FuturesAccount; }> [FuturesAccount](FuturesAccount.md)
403403

404404
### Authorization
405405

@@ -452,7 +452,7 @@ Name | Type | Description | Notes
452452

453453
### Return type
454454

455-
Promise<{ response: http.IncomingMessage; body: Array<FuturesAccountBook>; }(FuturesAccountBook.md)
455+
Promise<{ response: AxiosResponse; body: Array<FuturesAccountBook>; }> [FuturesAccountBook](FuturesAccountBook.md)
456456

457457
### Authorization
458458

@@ -495,7 +495,7 @@ Name | Type | Description | Notes
495495

496496
### Return type
497497

498-
Promise<{ response: http.IncomingMessage; body: Array<Position>; }(Position.md)
498+
Promise<{ response: AxiosResponse; body: Array<Position>; }> [Position](Position.md)
499499

500500
### Authorization
501501

@@ -540,7 +540,7 @@ Name | Type | Description | Notes
540540

541541
### Return type
542542

543-
Promise<{ response: http.IncomingMessage; body: Position; }(Position.md)
543+
Promise<{ response: AxiosResponse; body: Position; }> [Position](Position.md)
544544

545545
### Authorization
546546

@@ -587,7 +587,7 @@ Name | Type | Description | Notes
587587

588588
### Return type
589589

590-
Promise<{ response: http.IncomingMessage; body: Position; }(Position.md)
590+
Promise<{ response: AxiosResponse; body: Position; }> [Position](Position.md)
591591

592592
### Authorization
593593

@@ -634,7 +634,7 @@ Name | Type | Description | Notes
634634

635635
### Return type
636636

637-
Promise<{ response: http.IncomingMessage; body: Position; }(Position.md)
637+
Promise<{ response: AxiosResponse; body: Position; }> [Position](Position.md)
638638

639639
### Authorization
640640

@@ -681,7 +681,7 @@ Name | Type | Description | Notes
681681

682682
### Return type
683683

684-
Promise<{ response: http.IncomingMessage; body: Position; }(Position.md)
684+
Promise<{ response: AxiosResponse; body: Position; }> [Position](Position.md)
685685

686686
### Authorization
687687

@@ -740,7 +740,7 @@ Name | Type | Description | Notes
740740

741741
### Return type
742742

743-
Promise<{ response: http.IncomingMessage; body: Array<FuturesOrder>; }(FuturesOrder.md)
743+
Promise<{ response: AxiosResponse; body: Array<FuturesOrder>; }> [FuturesOrder](FuturesOrder.md)
744744

745745
### Authorization
746746

@@ -787,7 +787,7 @@ Name | Type | Description | Notes
787787

788788
### Return type
789789

790-
Promise<{ response: http.IncomingMessage; body: FuturesOrder; }(FuturesOrder.md)
790+
Promise<{ response: AxiosResponse; body: FuturesOrder; }> [FuturesOrder](FuturesOrder.md)
791791

792792
### Authorization
793793

@@ -838,7 +838,7 @@ Name | Type | Description | Notes
838838

839839
### Return type
840840

841-
Promise<{ response: http.IncomingMessage; body: Array<FuturesOrder>; }(FuturesOrder.md)
841+
Promise<{ response: AxiosResponse; body: Array<FuturesOrder>; }> [FuturesOrder](FuturesOrder.md)
842842

843843
### Authorization
844844

@@ -885,7 +885,7 @@ Name | Type | Description | Notes
885885

886886
### Return type
887887

888-
Promise<{ response: http.IncomingMessage; body: FuturesOrder; }(FuturesOrder.md)
888+
Promise<{ response: AxiosResponse; body: FuturesOrder; }> [FuturesOrder](FuturesOrder.md)
889889

890890
### Authorization
891891

@@ -930,7 +930,7 @@ Name | Type | Description | Notes
930930

931931
### Return type
932932

933-
Promise<{ response: http.IncomingMessage; body: FuturesOrder; }(FuturesOrder.md)
933+
Promise<{ response: AxiosResponse; body: FuturesOrder; }> [FuturesOrder](FuturesOrder.md)
934934

935935
### Authorization
936936

@@ -987,7 +987,7 @@ Name | Type | Description | Notes
987987

988988
### Return type
989989

990-
Promise<{ response: http.IncomingMessage; body: Array<MyFuturesTrade>; }(MyFuturesTrade.md)
990+
Promise<{ response: AxiosResponse; body: Array<MyFuturesTrade>; }> [MyFuturesTrade](MyFuturesTrade.md)
991991

992992
### Authorization
993993

@@ -1036,7 +1036,7 @@ Name | Type | Description | Notes
10361036

10371037
### Return type
10381038

1039-
Promise<{ response: http.IncomingMessage; body: Array<PositionClose>; }(PositionClose.md)
1039+
Promise<{ response: AxiosResponse; body: Array<PositionClose>; }> [PositionClose](PositionClose.md)
10401040

10411041
### Authorization
10421042

@@ -1087,7 +1087,7 @@ Name | Type | Description | Notes
10871087

10881088
### Return type
10891089

1090-
Promise<{ response: http.IncomingMessage; body: Array<FuturesLiquidate>; }(FuturesLiquidate.md)
1090+
Promise<{ response: AxiosResponse; body: Array<FuturesLiquidate>; }> [FuturesLiquidate](FuturesLiquidate.md)
10911091

10921092
### Authorization
10931093

@@ -1138,7 +1138,7 @@ Name | Type | Description | Notes
11381138

11391139
### Return type
11401140

1141-
Promise<{ response: http.IncomingMessage; body: Array<DeliverySettlement>; }(DeliverySettlement.md)
1141+
Promise<{ response: AxiosResponse; body: Array<DeliverySettlement>; }> [DeliverySettlement](DeliverySettlement.md)
11421142

11431143
### Authorization
11441144

@@ -1191,7 +1191,7 @@ Name | Type | Description | Notes
11911191

11921192
### Return type
11931193

1194-
Promise<{ response: http.IncomingMessage; body: Array<FuturesPriceTriggeredOrder>; }(FuturesPriceTriggeredOrder.md)
1194+
Promise<{ response: AxiosResponse; body: Array<FuturesPriceTriggeredOrder>; }> [FuturesPriceTriggeredOrder](FuturesPriceTriggeredOrder.md)
11951195

11961196
### Authorization
11971197

@@ -1236,7 +1236,7 @@ Name | Type | Description | Notes
12361236

12371237
### Return type
12381238

1239-
Promise<{ response: http.IncomingMessage; body: TriggerOrderResponse; }(TriggerOrderResponse.md)
1239+
Promise<{ response: AxiosResponse; body: TriggerOrderResponse; }> [TriggerOrderResponse](TriggerOrderResponse.md)
12401240

12411241
### Authorization
12421242

@@ -1281,7 +1281,7 @@ Name | Type | Description | Notes
12811281

12821282
### Return type
12831283

1284-
Promise<{ response: http.IncomingMessage; body: Array<FuturesPriceTriggeredOrder>; }(FuturesPriceTriggeredOrder.md)
1284+
Promise<{ response: AxiosResponse; body: Array<FuturesPriceTriggeredOrder>; }> [FuturesPriceTriggeredOrder](FuturesPriceTriggeredOrder.md)
12851285

12861286
### Authorization
12871287

@@ -1326,7 +1326,7 @@ Name | Type | Description | Notes
13261326

13271327
### Return type
13281328

1329-
Promise<{ response: http.IncomingMessage; body: FuturesPriceTriggeredOrder; }(FuturesPriceTriggeredOrder.md)
1329+
Promise<{ response: AxiosResponse; body: FuturesPriceTriggeredOrder; }> [FuturesPriceTriggeredOrder](FuturesPriceTriggeredOrder.md)
13301330

13311331
### Authorization
13321332

@@ -1371,7 +1371,7 @@ Name | Type | Description | Notes
13711371

13721372
### Return type
13731373

1374-
Promise<{ response: http.IncomingMessage; body: FuturesPriceTriggeredOrder; }(FuturesPriceTriggeredOrder.md)
1374+
Promise<{ response: AxiosResponse; body: FuturesPriceTriggeredOrder; }> [FuturesPriceTriggeredOrder](FuturesPriceTriggeredOrder.md)
13751375

13761376
### Authorization
13771377

docs/DeliveryContract.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ Name | Type | Description | Notes
4141
**positionSize** | **number** | Current total long position size | [optional] [default to undefined]
4242
**configChangeTime** | **number** | Configuration\&#39;s last changed time | [optional] [default to undefined]
4343
**inDelisting** | **boolean** | Contract is delisting | [optional] [default to undefined]
44+
**ordersLimit** | **number** | Maximum number of open orders | [optional] [default to undefined]
4445

4546
## Enum: DeliveryContract.Cycle
4647

0 commit comments

Comments
 (0)