@binance/rebate 3.0.0 → 3.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/chunk.mjs ADDED
@@ -0,0 +1,13 @@
1
+ //#region rolldown:runtime
2
+ var __defProp = Object.defineProperty;
3
+ var __export = (all) => {
4
+ let target = {};
5
+ for (var name in all) __defProp(target, name, {
6
+ get: all[name],
7
+ enumerable: true
8
+ });
9
+ return target;
10
+ };
11
+
12
+ //#endregion
13
+ export { __export as t };
package/dist/index.d.mts CHANGED
@@ -1,5 +1,6 @@
1
- import { RestApiResponse, ConfigurationRestAPI } from '@binance/common';
2
- export { BadRequestError, ConnectorClientError, ForbiddenError, NetworkError, NotFoundError, REBATE_REST_API_PROD_URL, RateLimitBanError, RequiredError, ServerError, TooManyRequestsError, UnauthorizedError } from '@binance/common';
1
+ import { BadRequestError, ConfigurationRestAPI, ConnectorClientError, ForbiddenError, NetworkError, NotFoundError, REBATE_REST_API_PROD_URL, RateLimitBanError, RequiredError, RestApiResponse, ServerError, TooManyRequestsError, UnauthorizedError } from "@binance/common";
2
+
3
+ //#region src/rest-api/types/get-spot-rebate-history-records-response-data-data-inner.d.ts
3
4
 
4
5
  /**
5
6
  * Binance Rebate REST API
@@ -19,44 +20,33 @@ export { BadRequestError, ConnectorClientError, ForbiddenError, NetworkError, No
19
20
  * @interface GetSpotRebateHistoryRecordsResponseDataDataInner
20
21
  */
21
22
  interface GetSpotRebateHistoryRecordsResponseDataDataInner {
22
- /**
23
- *
24
- * @type {string}
25
- * @memberof GetSpotRebateHistoryRecordsResponseDataDataInner
26
- */
27
- asset?: string;
28
- /**
29
- *
30
- * @type {number | bigint}
31
- * @memberof GetSpotRebateHistoryRecordsResponseDataDataInner
32
- */
33
- type?: number | bigint;
34
- /**
35
- *
36
- * @type {string}
37
- * @memberof GetSpotRebateHistoryRecordsResponseDataDataInner
38
- */
39
- amount?: string;
40
- /**
41
- *
42
- * @type {number | bigint}
43
- * @memberof GetSpotRebateHistoryRecordsResponseDataDataInner
44
- */
45
- updateTime?: number | bigint;
23
+ /**
24
+ *
25
+ * @type {string}
26
+ * @memberof GetSpotRebateHistoryRecordsResponseDataDataInner
27
+ */
28
+ asset?: string;
29
+ /**
30
+ *
31
+ * @type {number | bigint}
32
+ * @memberof GetSpotRebateHistoryRecordsResponseDataDataInner
33
+ */
34
+ type?: number | bigint;
35
+ /**
36
+ *
37
+ * @type {string}
38
+ * @memberof GetSpotRebateHistoryRecordsResponseDataDataInner
39
+ */
40
+ amount?: string;
41
+ /**
42
+ *
43
+ * @type {number | bigint}
44
+ * @memberof GetSpotRebateHistoryRecordsResponseDataDataInner
45
+ */
46
+ updateTime?: number | bigint;
46
47
  }
47
-
48
- /**
49
- * Binance Rebate REST API
50
- *
51
- * OpenAPI Specification for the Binance Rebate REST API
52
- *
53
- * The version of the OpenAPI document: 1.0.0
54
- *
55
- *
56
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
57
- * https://openapi-generator.tech
58
- * Do not edit the class manually.
59
- */
48
+ //#endregion
49
+ //#region src/rest-api/types/get-spot-rebate-history-records-response-data.d.ts
60
50
 
61
51
  /**
62
52
  *
@@ -64,44 +54,33 @@ interface GetSpotRebateHistoryRecordsResponseDataDataInner {
64
54
  * @interface GetSpotRebateHistoryRecordsResponseData
65
55
  */
66
56
  interface GetSpotRebateHistoryRecordsResponseData {
67
- /**
68
- *
69
- * @type {number | bigint}
70
- * @memberof GetSpotRebateHistoryRecordsResponseData
71
- */
72
- page?: number | bigint;
73
- /**
74
- *
75
- * @type {number | bigint}
76
- * @memberof GetSpotRebateHistoryRecordsResponseData
77
- */
78
- totalRecords?: number | bigint;
79
- /**
80
- *
81
- * @type {number | bigint}
82
- * @memberof GetSpotRebateHistoryRecordsResponseData
83
- */
84
- totalPageNum?: number | bigint;
85
- /**
86
- *
87
- * @type {Array<GetSpotRebateHistoryRecordsResponseDataDataInner>}
88
- * @memberof GetSpotRebateHistoryRecordsResponseData
89
- */
90
- data?: Array<GetSpotRebateHistoryRecordsResponseDataDataInner>;
57
+ /**
58
+ *
59
+ * @type {number | bigint}
60
+ * @memberof GetSpotRebateHistoryRecordsResponseData
61
+ */
62
+ page?: number | bigint;
63
+ /**
64
+ *
65
+ * @type {number | bigint}
66
+ * @memberof GetSpotRebateHistoryRecordsResponseData
67
+ */
68
+ totalRecords?: number | bigint;
69
+ /**
70
+ *
71
+ * @type {number | bigint}
72
+ * @memberof GetSpotRebateHistoryRecordsResponseData
73
+ */
74
+ totalPageNum?: number | bigint;
75
+ /**
76
+ *
77
+ * @type {Array<GetSpotRebateHistoryRecordsResponseDataDataInner>}
78
+ * @memberof GetSpotRebateHistoryRecordsResponseData
79
+ */
80
+ data?: Array<GetSpotRebateHistoryRecordsResponseDataDataInner>;
91
81
  }
92
-
93
- /**
94
- * Binance Rebate REST API
95
- *
96
- * OpenAPI Specification for the Binance Rebate REST API
97
- *
98
- * The version of the OpenAPI document: 1.0.0
99
- *
100
- *
101
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
102
- * https://openapi-generator.tech
103
- * Do not edit the class manually.
104
- */
82
+ //#endregion
83
+ //#region src/rest-api/types/get-spot-rebate-history-records-response.d.ts
105
84
 
106
85
  /**
107
86
  *
@@ -109,213 +88,168 @@ interface GetSpotRebateHistoryRecordsResponseData {
109
88
  * @interface GetSpotRebateHistoryRecordsResponse
110
89
  */
111
90
  interface GetSpotRebateHistoryRecordsResponse {
112
- /**
113
- *
114
- * @type {string}
115
- * @memberof GetSpotRebateHistoryRecordsResponse
116
- */
117
- status?: string;
118
- /**
119
- *
120
- * @type {string}
121
- * @memberof GetSpotRebateHistoryRecordsResponse
122
- */
123
- type?: string;
124
- /**
125
- *
126
- * @type {string}
127
- * @memberof GetSpotRebateHistoryRecordsResponse
128
- */
129
- code?: string;
130
- /**
131
- *
132
- * @type {GetSpotRebateHistoryRecordsResponseData}
133
- * @memberof GetSpotRebateHistoryRecordsResponse
134
- */
135
- data?: GetSpotRebateHistoryRecordsResponseData;
91
+ /**
92
+ *
93
+ * @type {string}
94
+ * @memberof GetSpotRebateHistoryRecordsResponse
95
+ */
96
+ status?: string;
97
+ /**
98
+ *
99
+ * @type {string}
100
+ * @memberof GetSpotRebateHistoryRecordsResponse
101
+ */
102
+ type?: string;
103
+ /**
104
+ *
105
+ * @type {string}
106
+ * @memberof GetSpotRebateHistoryRecordsResponse
107
+ */
108
+ code?: string;
109
+ /**
110
+ *
111
+ * @type {GetSpotRebateHistoryRecordsResponseData}
112
+ * @memberof GetSpotRebateHistoryRecordsResponse
113
+ */
114
+ data?: GetSpotRebateHistoryRecordsResponseData;
136
115
  }
137
-
138
- /**
139
- * Binance Rebate REST API
140
- *
141
- * OpenAPI Specification for the Binance Rebate REST API
142
- *
143
- * The version of the OpenAPI document: 1.0.0
144
- *
145
- *
146
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
147
- * https://openapi-generator.tech
148
- * Do not edit the class manually.
149
- */
150
-
116
+ //#endregion
117
+ //#region src/rest-api/modules/rebate-api.d.ts
151
118
  /**
152
119
  * RebateApi - interface
153
120
  * @interface RebateApi
154
121
  */
155
122
  interface RebateApiInterface {
156
- /**
157
- * Get Spot Rebate History Records
158
- *
159
- * The max interval between startTime and endTime is 30 days.
160
- * If startTime and endTime are not sent, the recent 7 days' data will be returned.
161
- * The earliest startTime is supported on June 10, 2020
162
- * Return up to 200 records per request.
163
- *
164
- * Weight: 12000
165
- *
166
- * @summary Get Spot Rebate History Records (USER_DATA)
167
- * @param {GetSpotRebateHistoryRecordsRequest} requestParameters Request parameters.
168
- *
169
- * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
170
- * @memberof RebateApiInterface
171
- */
172
- getSpotRebateHistoryRecords(requestParameters?: GetSpotRebateHistoryRecordsRequest): Promise<RestApiResponse<GetSpotRebateHistoryRecordsResponse>>;
123
+ /**
124
+ * Get Spot Rebate History Records
125
+ *
126
+ * The max interval between startTime and endTime is 30 days.
127
+ * If startTime and endTime are not sent, the recent 7 days' data will be returned.
128
+ * The earliest startTime is supported on June 10, 2020
129
+ * Return up to 200 records per request.
130
+ *
131
+ * Weight: 12000
132
+ *
133
+ * @summary Get Spot Rebate History Records (USER_DATA)
134
+ * @param {GetSpotRebateHistoryRecordsRequest} requestParameters Request parameters.
135
+ *
136
+ * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
137
+ * @memberof RebateApiInterface
138
+ */
139
+ getSpotRebateHistoryRecords(requestParameters?: GetSpotRebateHistoryRecordsRequest): Promise<RestApiResponse<GetSpotRebateHistoryRecordsResponse>>;
173
140
  }
174
141
  /**
175
142
  * Request parameters for getSpotRebateHistoryRecords operation in RebateApi.
176
143
  * @interface GetSpotRebateHistoryRecordsRequest
177
144
  */
178
145
  interface GetSpotRebateHistoryRecordsRequest {
179
- /**
180
- *
181
- * @type {number}
182
- * @memberof RebateApiGetSpotRebateHistoryRecords
183
- */
184
- readonly startTime?: number;
185
- /**
186
- *
187
- * @type {number}
188
- * @memberof RebateApiGetSpotRebateHistoryRecords
189
- */
190
- readonly endTime?: number;
191
- /**
192
- * Default 1
193
- * @type {number}
194
- * @memberof RebateApiGetSpotRebateHistoryRecords
195
- */
196
- readonly page?: number;
197
- /**
198
- *
199
- * @type {number}
200
- * @memberof RebateApiGetSpotRebateHistoryRecords
201
- */
202
- readonly recvWindow?: number;
146
+ /**
147
+ *
148
+ * @type {number | bigint}
149
+ * @memberof RebateApiGetSpotRebateHistoryRecords
150
+ */
151
+ readonly startTime?: number | bigint;
152
+ /**
153
+ *
154
+ * @type {number | bigint}
155
+ * @memberof RebateApiGetSpotRebateHistoryRecords
156
+ */
157
+ readonly endTime?: number | bigint;
158
+ /**
159
+ * Default 1
160
+ * @type {number | bigint}
161
+ * @memberof RebateApiGetSpotRebateHistoryRecords
162
+ */
163
+ readonly page?: number | bigint;
164
+ /**
165
+ *
166
+ * @type {number | bigint}
167
+ * @memberof RebateApiGetSpotRebateHistoryRecords
168
+ */
169
+ readonly recvWindow?: number | bigint;
203
170
  }
204
171
  /**
205
172
  * RebateApi - object-oriented interface
206
173
  * @class RebateApi
207
174
  */
208
175
  declare class RebateApi implements RebateApiInterface {
209
- private readonly configuration;
210
- private localVarAxiosParamCreator;
211
- constructor(configuration: ConfigurationRestAPI);
212
- /**
213
- * Get Spot Rebate History Records
214
- *
215
- * The max interval between startTime and endTime is 30 days.
216
- * If startTime and endTime are not sent, the recent 7 days' data will be returned.
217
- * The earliest startTime is supported on June 10, 2020
218
- * Return up to 200 records per request.
219
- *
220
- * Weight: 12000
221
- *
222
- * @summary Get Spot Rebate History Records (USER_DATA)
223
- * @param {GetSpotRebateHistoryRecordsRequest} requestParameters Request parameters.
224
- * @returns {Promise<RestApiResponse<GetSpotRebateHistoryRecordsResponse>>}
225
- * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
226
- * @memberof RebateApi
227
- * @see {@link https://developers.binance.com/docs/rebate/rest-api/Get-Spot-Rebate-History-Records Binance API Documentation}
228
- */
229
- getSpotRebateHistoryRecords(requestParameters?: GetSpotRebateHistoryRecordsRequest): Promise<RestApiResponse<GetSpotRebateHistoryRecordsResponse>>;
176
+ private readonly configuration;
177
+ private localVarAxiosParamCreator;
178
+ constructor(configuration: ConfigurationRestAPI);
179
+ /**
180
+ * Get Spot Rebate History Records
181
+ *
182
+ * The max interval between startTime and endTime is 30 days.
183
+ * If startTime and endTime are not sent, the recent 7 days' data will be returned.
184
+ * The earliest startTime is supported on June 10, 2020
185
+ * Return up to 200 records per request.
186
+ *
187
+ * Weight: 12000
188
+ *
189
+ * @summary Get Spot Rebate History Records (USER_DATA)
190
+ * @param {GetSpotRebateHistoryRecordsRequest} requestParameters Request parameters.
191
+ * @returns {Promise<RestApiResponse<GetSpotRebateHistoryRecordsResponse>>}
192
+ * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
193
+ * @memberof RebateApi
194
+ * @see {@link https://developers.binance.com/docs/rebate/rest-api/Get-Spot-Rebate-History-Records Binance API Documentation}
195
+ */
196
+ getSpotRebateHistoryRecords(requestParameters?: GetSpotRebateHistoryRecordsRequest): Promise<RestApiResponse<GetSpotRebateHistoryRecordsResponse>>;
230
197
  }
231
-
232
- /**
233
- * Binance Rebate REST API
234
- *
235
- * OpenAPI Specification for the Binance Rebate REST API
236
- *
237
- * The version of the OpenAPI document: 1.0.0
238
- *
239
- *
240
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
241
- * https://openapi-generator.tech
242
- * Do not edit the class manually.
243
- */
244
-
198
+ //#endregion
199
+ //#region src/rest-api/rest-api.d.ts
245
200
  declare class RestAPI {
246
- private configuration;
247
- private rebateApi;
248
- constructor(configuration: ConfigurationRestAPI);
249
- /**
250
- * Generic function to send a request.
251
- * @param endpoint - The API endpoint to call.
252
- * @param method - HTTP method to use (GET, POST, DELETE, etc.).
253
- * @param params - Query parameters for the request.
254
- *
255
- * @returns A promise resolving to the response data object.
256
- */
257
- sendRequest<T>(endpoint: string, method: 'GET' | 'POST' | 'DELETE' | 'PUT' | 'PATCH', params?: Record<string, unknown>): Promise<RestApiResponse<T>>;
258
- /**
259
- * Generic function to send a signed request.
260
- * @param endpoint - The API endpoint to call.
261
- * @param method - HTTP method to use (GET, POST, DELETE, etc.).
262
- * @param params - Query parameters for the request.
263
- *
264
- * @returns A promise resolving to the response data object.
265
- */
266
- sendSignedRequest<T>(endpoint: string, method: 'GET' | 'POST' | 'DELETE' | 'PUT' | 'PATCH', params?: Record<string, unknown>): Promise<RestApiResponse<T>>;
267
- /**
268
- * Get Spot Rebate History Records
269
- *
270
- * The max interval between startTime and endTime is 30 days.
271
- * If startTime and endTime are not sent, the recent 7 days' data will be returned.
272
- * The earliest startTime is supported on June 10, 2020
273
- * Return up to 200 records per request.
274
- *
275
- * Weight: 12000
276
- *
277
- * @summary Get Spot Rebate History Records (USER_DATA)
278
- * @param {GetSpotRebateHistoryRecordsRequest} requestParameters Request parameters.
279
- *
280
- * @returns {Promise<RestApiResponse<GetSpotRebateHistoryRecordsResponse>>}
281
- * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
282
- * @see {@link https://developers.binance.com/docs/rebate/rest-api/Get-Spot-Rebate-History-Records Binance API Documentation}
283
- */
284
- getSpotRebateHistoryRecords(requestParameters?: GetSpotRebateHistoryRecordsRequest): Promise<RestApiResponse<GetSpotRebateHistoryRecordsResponse>>;
201
+ private configuration;
202
+ private rebateApi;
203
+ constructor(configuration: ConfigurationRestAPI);
204
+ /**
205
+ * Generic function to send a request.
206
+ * @param endpoint - The API endpoint to call.
207
+ * @param method - HTTP method to use (GET, POST, DELETE, etc.).
208
+ * @param params - Query parameters for the request.
209
+ *
210
+ * @returns A promise resolving to the response data object.
211
+ */
212
+ sendRequest<T>(endpoint: string, method: 'GET' | 'POST' | 'DELETE' | 'PUT' | 'PATCH', params?: Record<string, unknown>): Promise<RestApiResponse<T>>;
213
+ /**
214
+ * Generic function to send a signed request.
215
+ * @param endpoint - The API endpoint to call.
216
+ * @param method - HTTP method to use (GET, POST, DELETE, etc.).
217
+ * @param params - Query parameters for the request.
218
+ *
219
+ * @returns A promise resolving to the response data object.
220
+ */
221
+ sendSignedRequest<T>(endpoint: string, method: 'GET' | 'POST' | 'DELETE' | 'PUT' | 'PATCH', params?: Record<string, unknown>): Promise<RestApiResponse<T>>;
222
+ /**
223
+ * Get Spot Rebate History Records
224
+ *
225
+ * The max interval between startTime and endTime is 30 days.
226
+ * If startTime and endTime are not sent, the recent 7 days' data will be returned.
227
+ * The earliest startTime is supported on June 10, 2020
228
+ * Return up to 200 records per request.
229
+ *
230
+ * Weight: 12000
231
+ *
232
+ * @summary Get Spot Rebate History Records (USER_DATA)
233
+ * @param {GetSpotRebateHistoryRecordsRequest} requestParameters Request parameters.
234
+ *
235
+ * @returns {Promise<RestApiResponse<GetSpotRebateHistoryRecordsResponse>>}
236
+ * @throws {RequiredError | ConnectorClientError | UnauthorizedError | ForbiddenError | TooManyRequestsError | RateLimitBanError | ServerError | NotFoundError | NetworkError | BadRequestError}
237
+ * @see {@link https://developers.binance.com/docs/rebate/rest-api/Get-Spot-Rebate-History-Records Binance API Documentation}
238
+ */
239
+ getSpotRebateHistoryRecords(requestParameters?: GetSpotRebateHistoryRecordsRequest): Promise<RestApiResponse<GetSpotRebateHistoryRecordsResponse>>;
285
240
  }
286
-
287
- /**
288
- * Binance Rebate REST API
289
- *
290
- * OpenAPI Specification for the Binance Rebate REST API
291
- *
292
- * The version of the OpenAPI document: 1.0.0
293
- *
294
- *
295
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
296
- * https://openapi-generator.tech
297
- * Do not edit the class manually.
298
- */
299
-
300
- type index_GetSpotRebateHistoryRecordsRequest = GetSpotRebateHistoryRecordsRequest;
301
- type index_GetSpotRebateHistoryRecordsResponse = GetSpotRebateHistoryRecordsResponse;
302
- type index_GetSpotRebateHistoryRecordsResponseData = GetSpotRebateHistoryRecordsResponseData;
303
- type index_GetSpotRebateHistoryRecordsResponseDataDataInner = GetSpotRebateHistoryRecordsResponseDataDataInner;
304
- type index_RebateApi = RebateApi;
305
- declare const index_RebateApi: typeof RebateApi;
306
- type index_RebateApiInterface = RebateApiInterface;
307
- type index_RestAPI = RestAPI;
308
- declare const index_RestAPI: typeof RestAPI;
309
- declare namespace index {
310
- export { type index_GetSpotRebateHistoryRecordsRequest as GetSpotRebateHistoryRecordsRequest, type index_GetSpotRebateHistoryRecordsResponse as GetSpotRebateHistoryRecordsResponse, type index_GetSpotRebateHistoryRecordsResponseData as GetSpotRebateHistoryRecordsResponseData, type index_GetSpotRebateHistoryRecordsResponseDataDataInner as GetSpotRebateHistoryRecordsResponseDataDataInner, index_RebateApi as RebateApi, type index_RebateApiInterface as RebateApiInterface, index_RestAPI as RestAPI };
241
+ declare namespace index_d_exports {
242
+ export { GetSpotRebateHistoryRecordsRequest, GetSpotRebateHistoryRecordsResponse, GetSpotRebateHistoryRecordsResponseData, GetSpotRebateHistoryRecordsResponseDataDataInner, RebateApi, RebateApiInterface, RestAPI };
311
243
  }
312
-
244
+ //#endregion
245
+ //#region src/rebate.d.ts
313
246
  interface ConfigurationRebate {
314
- configurationRestAPI?: ConfigurationRestAPI;
247
+ configurationRestAPI?: ConfigurationRestAPI;
315
248
  }
316
249
  declare class Rebate {
317
- restAPI: RestAPI;
318
- constructor(config: ConfigurationRebate);
250
+ restAPI: RestAPI;
251
+ constructor(config: ConfigurationRebate);
319
252
  }
320
-
321
- export { type ConfigurationRebate, Rebate, index as RebateRestAPI };
253
+ //#endregion
254
+ export { BadRequestError, ConfigurationRebate, ConnectorClientError, ForbiddenError, NetworkError, NotFoundError, REBATE_REST_API_PROD_URL, RateLimitBanError, Rebate, index_d_exports as RebateRestAPI, RequiredError, ServerError, TooManyRequestsError, UnauthorizedError };
255
+ //# sourceMappingURL=index.d.mts.map