@orbis-systems/orbis-api-clients 0.7.2 → 0.7.4
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/aesmidas/index.d.ts +223 -51
- package/dist/aesmidas/index.d.ts.map +1 -1
- package/dist/aesmidas/index.esm.js +1 -1
- package/dist/aesmidas/index.esm.js.map +1 -1
- package/dist/aesmidas/index.js +1 -1
- package/dist/aesmidas/index.js.map +1 -1
- package/dist/bridgewise/index.d.ts +659 -538
- package/dist/bridgewise/index.d.ts.map +1 -1
- package/dist/bridgewise/index.esm.js +1 -1
- package/dist/bridgewise/index.esm.js.map +1 -1
- package/dist/bridgewise/index.js +1 -1
- package/dist/bridgewise/index.js.map +1 -1
- package/dist/insight/index.d.ts +1039 -1018
- package/dist/insight/index.d.ts.map +1 -1
- package/dist/insight/index.esm.js +1 -1
- package/dist/insight/index.esm.js.map +1 -1
- package/dist/insight/index.js +1 -1
- package/dist/insight/index.js.map +1 -1
- package/dist/middleware/index.d.ts +107 -107
- package/dist/middleware/index.d.ts.map +1 -1
- package/dist/middleware/index.esm.js +1 -1
- package/dist/middleware/index.esm.js.map +1 -1
- package/dist/middleware/index.js +1 -1
- package/dist/middleware/index.js.map +1 -1
- package/dist/orbis/index.d.ts +4105 -4062
- package/dist/orbis/index.d.ts.map +1 -1
- package/dist/orbis/index.esm.js +1 -1
- package/dist/orbis/index.esm.js.map +1 -1
- package/dist/orbis/index.js +1 -1
- package/dist/orbis/index.js.map +1 -1
- package/dist/uma/index.d.ts +638 -638
- package/dist/uma/index.d.ts.map +1 -1
- package/dist/uma/index.esm.js +1 -1
- package/dist/uma/index.esm.js.map +1 -1
- package/dist/uma/index.js +1 -1
- package/dist/uma/index.js.map +1 -1
- package/dist/zerohash/index.d.ts +811 -811
- package/dist/zerohash/index.d.ts.map +1 -1
- package/dist/zerohash/index.esm.js +1 -1
- package/dist/zerohash/index.esm.js.map +1 -1
- package/dist/zerohash/index.js +1 -1
- package/dist/zerohash/index.js.map +1 -1
- package/package.json +1 -1
package/dist/zerohash/index.d.ts
CHANGED
|
@@ -77,6 +77,349 @@ declare class JwtClient<HandleError extends boolean = boolean, AuthData extends
|
|
|
77
77
|
setRenewTokenCallback(renewTokenCallback: () => Promise<AuthData>): void;
|
|
78
78
|
protected prepareAuthRequestConfig(): Promise<Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>>;
|
|
79
79
|
}
|
|
80
|
+
declare class TransfersRelationships<HandleError extends boolean = boolean> {
|
|
81
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
82
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
83
|
+
/**
|
|
84
|
+
* @tags Transfers Relationships
|
|
85
|
+
* @name List
|
|
86
|
+
* @summary List
|
|
87
|
+
* @request GET:/transfer/relationship/list/{account}
|
|
88
|
+
* @secure
|
|
89
|
+
*/
|
|
90
|
+
list(account: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
91
|
+
/**
|
|
92
|
+
* @tags Transfers Relationships
|
|
93
|
+
* @name GetInfo
|
|
94
|
+
* @summary Get Info
|
|
95
|
+
* @request GET:/transfer/relationship/get
|
|
96
|
+
* @secure
|
|
97
|
+
*/
|
|
98
|
+
getInfo(query?: {
|
|
99
|
+
/**
|
|
100
|
+
* Account number
|
|
101
|
+
* @example "ABC123"
|
|
102
|
+
*/
|
|
103
|
+
account?: any;
|
|
104
|
+
/**
|
|
105
|
+
* Desired entry ID
|
|
106
|
+
* @example "123"
|
|
107
|
+
*/
|
|
108
|
+
entryId?: any;
|
|
109
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
110
|
+
/**
|
|
111
|
+
* @tags Transfers Relationships
|
|
112
|
+
* @name PaymentMethods
|
|
113
|
+
* @summary Payment methods
|
|
114
|
+
* @request GET:/transfer/bank/paymentMethods
|
|
115
|
+
* @secure
|
|
116
|
+
*/
|
|
117
|
+
paymentMethods(query?: {
|
|
118
|
+
/** @example "IND" */
|
|
119
|
+
country?: any;
|
|
120
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
121
|
+
/**
|
|
122
|
+
* @tags Transfers Relationships
|
|
123
|
+
* @name PaymentMethodsViaAddress
|
|
124
|
+
* @summary Payment methods (via address)
|
|
125
|
+
* @request POST:/transfer/bank/paymentMethods
|
|
126
|
+
* @secure
|
|
127
|
+
*/
|
|
128
|
+
paymentMethodsViaAddress(data: {
|
|
129
|
+
/** @example "Mumbai" */
|
|
130
|
+
city?: any;
|
|
131
|
+
/** @example "IND" */
|
|
132
|
+
country?: any;
|
|
133
|
+
/** @example "400018" */
|
|
134
|
+
postalCode?: any;
|
|
135
|
+
/** @example "Maharashtra" */
|
|
136
|
+
stateProvince?: any;
|
|
137
|
+
/** @example ["716 /a, Poonam Chem, Dr.annie Besant Road, Opp.atre Mall, Worli"] */
|
|
138
|
+
streetAddress?: any;
|
|
139
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
140
|
+
/**
|
|
141
|
+
* @tags Transfers Relationships
|
|
142
|
+
* @name BankCodes
|
|
143
|
+
* @summary Bank Codes
|
|
144
|
+
* @request GET:/transfer/bank/bankCodes
|
|
145
|
+
* @secure
|
|
146
|
+
*/
|
|
147
|
+
bankCodes(query?: {
|
|
148
|
+
/** @example "IND|MEX" */
|
|
149
|
+
country?: any;
|
|
150
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
151
|
+
/**
|
|
152
|
+
* @tags Transfers Relationships
|
|
153
|
+
* @name BankCodesViaAddress
|
|
154
|
+
* @summary Bank Codes (via address)
|
|
155
|
+
* @request POST:/transfer/bank/bankCodes
|
|
156
|
+
* @secure
|
|
157
|
+
*/
|
|
158
|
+
bankCodesViaAddress(data: {
|
|
159
|
+
/** @example "Mumbai" */
|
|
160
|
+
city?: any;
|
|
161
|
+
/** @example "IND" */
|
|
162
|
+
country?: any;
|
|
163
|
+
/** @example "400018" */
|
|
164
|
+
postalCode?: any;
|
|
165
|
+
/** @example "Maharashtra" */
|
|
166
|
+
stateProvince?: any;
|
|
167
|
+
/** @example ["716 /a, Poonam Chem, Dr.annie Besant Road, Opp.atre Mall, Worli"] */
|
|
168
|
+
streetAddress?: any;
|
|
169
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
170
|
+
/**
|
|
171
|
+
* @tags Transfers Relationships
|
|
172
|
+
* @name Create
|
|
173
|
+
* @summary Create
|
|
174
|
+
* @request POST:/transfer/relationship/create
|
|
175
|
+
* @secure
|
|
176
|
+
*/
|
|
177
|
+
create(data: {
|
|
178
|
+
/** @example "5VA0XXXX" */
|
|
179
|
+
account?: any;
|
|
180
|
+
/** @example "111111" */
|
|
181
|
+
bankAccount?: any;
|
|
182
|
+
/** @example "John Doe" */
|
|
183
|
+
bankAccountOwnerName?: any;
|
|
184
|
+
/** @example "CHECKING" */
|
|
185
|
+
bankAccountType?: any;
|
|
186
|
+
/** @example "010101010" */
|
|
187
|
+
bankRoutingNumber?: any;
|
|
188
|
+
/** @example "Test" */
|
|
189
|
+
nickname?: any;
|
|
190
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
191
|
+
/**
|
|
192
|
+
* @tags Transfers Relationships
|
|
193
|
+
* @name WireInformation
|
|
194
|
+
* @summary Wire information
|
|
195
|
+
* @request POST:/transfer/relationship/wire/create
|
|
196
|
+
* @secure
|
|
197
|
+
*/
|
|
198
|
+
wireInformation(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
199
|
+
/**
|
|
200
|
+
* @tags Transfers Relationships
|
|
201
|
+
* @name BankingRelationship
|
|
202
|
+
* @summary Banking relationship
|
|
203
|
+
* @request POST:/transfer/relationship/bank/create
|
|
204
|
+
* @secure
|
|
205
|
+
*/
|
|
206
|
+
bankingRelationship(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
207
|
+
/**
|
|
208
|
+
* @tags Transfers Relationships
|
|
209
|
+
* @name Approve
|
|
210
|
+
* @summary Approve
|
|
211
|
+
* @request POST:/transfer/relationship/approve
|
|
212
|
+
* @secure
|
|
213
|
+
*/
|
|
214
|
+
approve(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
215
|
+
/**
|
|
216
|
+
* @tags Transfers Relationships
|
|
217
|
+
* @name Cancel
|
|
218
|
+
* @summary Cancel
|
|
219
|
+
* @request POST:/transfer/relationship/cancel/{entryId}
|
|
220
|
+
* @secure
|
|
221
|
+
*/
|
|
222
|
+
cancel(entryId: string, data: {
|
|
223
|
+
/** @example "2QC05208" */
|
|
224
|
+
account?: any;
|
|
225
|
+
/** @example "USER CANCELED" */
|
|
226
|
+
reason?: any;
|
|
227
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
228
|
+
/**
|
|
229
|
+
* @tags Transfers Relationships
|
|
230
|
+
* @name Rename
|
|
231
|
+
* @summary Rename
|
|
232
|
+
* @request POST:/transfer/relationship/rename/{entryId}
|
|
233
|
+
* @secure
|
|
234
|
+
*/
|
|
235
|
+
rename(entryId: string, data: {
|
|
236
|
+
/** @example "Citi Checking 2" */
|
|
237
|
+
nickname?: any;
|
|
238
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
239
|
+
/**
|
|
240
|
+
* @tags Transfers Relationships
|
|
241
|
+
* @name AdvisorPolicyUpdate
|
|
242
|
+
* @summary Advisor Policy Update
|
|
243
|
+
* @request POST:/transfer/relationship/policy
|
|
244
|
+
* @secure
|
|
245
|
+
*/
|
|
246
|
+
advisorPolicyUpdate(data: {
|
|
247
|
+
account?: {
|
|
248
|
+
/** @example 0 */
|
|
249
|
+
accountId?: number;
|
|
250
|
+
/** @example "{optional}" */
|
|
251
|
+
accountNumber?: string;
|
|
252
|
+
};
|
|
253
|
+
/** @example 123 */
|
|
254
|
+
entryId?: any;
|
|
255
|
+
/** @example true */
|
|
256
|
+
esigned?: any;
|
|
257
|
+
/** @example "AllowWithdrawal|Disallow" */
|
|
258
|
+
policy?: any;
|
|
259
|
+
/** @example "" */
|
|
260
|
+
remoteAddr?: any;
|
|
261
|
+
/** @example "" */
|
|
262
|
+
remoteDevice?: any;
|
|
263
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
264
|
+
/**
|
|
265
|
+
* @tags Transfers Relationships
|
|
266
|
+
* @name DocumentUpload
|
|
267
|
+
* @summary Document upload
|
|
268
|
+
* @request POST:/transfer/relationship/wire/upload
|
|
269
|
+
* @secure
|
|
270
|
+
*/
|
|
271
|
+
documentUpload(data: {
|
|
272
|
+
/**
|
|
273
|
+
* Wire relationship ID
|
|
274
|
+
* @example ""
|
|
275
|
+
*/
|
|
276
|
+
entryId?: string;
|
|
277
|
+
/**
|
|
278
|
+
* Document file
|
|
279
|
+
* @format binary
|
|
280
|
+
*/
|
|
281
|
+
file?: File;
|
|
282
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
283
|
+
/**
|
|
284
|
+
* @tags Transfers Relationships
|
|
285
|
+
* @name MfaReInitiation
|
|
286
|
+
* @summary 2FA re-initiation
|
|
287
|
+
* @request POST:/transfer/relationship/wire/2fa/reinitiate
|
|
288
|
+
* @secure
|
|
289
|
+
*/
|
|
290
|
+
mfaReInitiation(data: {
|
|
291
|
+
/** @example 123 */
|
|
292
|
+
entryId?: any;
|
|
293
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
294
|
+
/**
|
|
295
|
+
* @tags Transfers Relationships
|
|
296
|
+
* @name SupplementWire
|
|
297
|
+
* @summary Supplement wire
|
|
298
|
+
* @request POST:/transfer/relationship/wire/supplement
|
|
299
|
+
* @secure
|
|
300
|
+
*/
|
|
301
|
+
supplementWire(data: {
|
|
302
|
+
/** @example 123456 */
|
|
303
|
+
entryId?: any;
|
|
304
|
+
recipientBank?: {
|
|
305
|
+
/** @example "Capital City" */
|
|
306
|
+
city?: string;
|
|
307
|
+
identifier?: {
|
|
308
|
+
/** @example "AAA-123-2587964" */
|
|
309
|
+
id?: string;
|
|
310
|
+
/** @example "BIC" */
|
|
311
|
+
type?: string;
|
|
312
|
+
};
|
|
313
|
+
/** @example "ABC 123" */
|
|
314
|
+
postalCode?: string;
|
|
315
|
+
/** @example "NJ" */
|
|
316
|
+
stateProvince?: string;
|
|
317
|
+
};
|
|
318
|
+
userAccount?: {
|
|
319
|
+
/** @example "AB12345" */
|
|
320
|
+
accountNumber?: string;
|
|
321
|
+
};
|
|
322
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
323
|
+
}
|
|
324
|
+
declare class TransfersInstantAccountVerification<HandleError extends boolean = boolean> {
|
|
325
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
326
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
327
|
+
/**
|
|
328
|
+
* @tags Transfers Instant Account Verification
|
|
329
|
+
* @name Initiate
|
|
330
|
+
* @summary Initiate
|
|
331
|
+
* @request GET:/iav/init
|
|
332
|
+
* @secure
|
|
333
|
+
*/
|
|
334
|
+
initiate(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
335
|
+
/**
|
|
336
|
+
* @tags Transfers Instant Account Verification
|
|
337
|
+
* @name InitiatePost
|
|
338
|
+
* @summary Initiate Post
|
|
339
|
+
* @request POST:/iav/init
|
|
340
|
+
* @secure
|
|
341
|
+
*/
|
|
342
|
+
initiatePost(query: object, data: {
|
|
343
|
+
/** @example "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" */
|
|
344
|
+
subject?: string;
|
|
345
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
346
|
+
/**
|
|
347
|
+
* @tags Transfers Instant Account Verification
|
|
348
|
+
* @name Complete
|
|
349
|
+
* @summary Complete
|
|
350
|
+
* @request POST:/iav/complete
|
|
351
|
+
* @secure
|
|
352
|
+
*/
|
|
353
|
+
complete(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
354
|
+
/**
|
|
355
|
+
* @tags Transfers Instant Account Verification
|
|
356
|
+
* @name ListBankAccounts
|
|
357
|
+
* @summary List Bank Accounts
|
|
358
|
+
* @request POST:/iav/list
|
|
359
|
+
* @secure
|
|
360
|
+
*/
|
|
361
|
+
listBankAccounts(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
362
|
+
/**
|
|
363
|
+
* @tags Transfers Instant Account Verification
|
|
364
|
+
* @name LinkBankAccount
|
|
365
|
+
* @summary Link Bank Account
|
|
366
|
+
* @request POST:/iav/link
|
|
367
|
+
* @secure
|
|
368
|
+
*/
|
|
369
|
+
linkBankAccount(data: {
|
|
370
|
+
/** @example "5VXXXXX" */
|
|
371
|
+
account?: any;
|
|
372
|
+
/** @example "XXXXXXX" */
|
|
373
|
+
bankAccountId?: any;
|
|
374
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
375
|
+
/**
|
|
376
|
+
* @tags Transfers Instant Account Verification
|
|
377
|
+
* @name ImportWithPlaid
|
|
378
|
+
* @summary Import With Plaid
|
|
379
|
+
* @request POST:/iav/import
|
|
380
|
+
* @secure
|
|
381
|
+
*/
|
|
382
|
+
importWithPlaid(data: {
|
|
383
|
+
/** @example "3AB123456" */
|
|
384
|
+
account?: any;
|
|
385
|
+
/** @example "123456" */
|
|
386
|
+
bankAccountNumber?: any;
|
|
387
|
+
/** @example "John Smith" */
|
|
388
|
+
bankAccountOwnerName?: any;
|
|
389
|
+
/** @example "checking" */
|
|
390
|
+
bankAccountType?: any;
|
|
391
|
+
/** @example "122105155" */
|
|
392
|
+
bankRoutingNumber?: any;
|
|
393
|
+
/** @example "Checking x456" */
|
|
394
|
+
nickname?: any;
|
|
395
|
+
/** @example "{optional}" */
|
|
396
|
+
note?: any;
|
|
397
|
+
/** @example "{optional}" */
|
|
398
|
+
remoteAddr?: any;
|
|
399
|
+
/** @example "{optional}" */
|
|
400
|
+
remoteDevice?: any;
|
|
401
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
402
|
+
}
|
|
403
|
+
declare class TransfersAch<HandleError extends boolean = boolean> {
|
|
404
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
405
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
406
|
+
/**
|
|
407
|
+
* @tags Transfers Ach
|
|
408
|
+
* @name Deposit
|
|
409
|
+
* @summary Deposit
|
|
410
|
+
* @request POST:/transfer/ach/deposit
|
|
411
|
+
* @secure
|
|
412
|
+
*/
|
|
413
|
+
deposit(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
414
|
+
/**
|
|
415
|
+
* @tags Transfers Ach
|
|
416
|
+
* @name Withdraw
|
|
417
|
+
* @summary Withdraw
|
|
418
|
+
* @request POST:/transfer/ach/withdraw
|
|
419
|
+
* @secure
|
|
420
|
+
*/
|
|
421
|
+
withdraw(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
422
|
+
}
|
|
80
423
|
declare class TransfersAcats<HandleError extends boolean = boolean> {
|
|
81
424
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
82
425
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -210,233 +553,80 @@ declare class TransfersAcats<HandleError extends boolean = boolean> {
|
|
|
210
553
|
type?: string;
|
|
211
554
|
}[], config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
212
555
|
}
|
|
213
|
-
declare class
|
|
214
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
215
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
216
|
-
/**
|
|
217
|
-
* @tags Transfers Ach
|
|
218
|
-
* @name Deposit
|
|
219
|
-
* @summary Deposit
|
|
220
|
-
* @request POST:/transfer/ach/deposit
|
|
221
|
-
* @secure
|
|
222
|
-
*/
|
|
223
|
-
deposit(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
224
|
-
/**
|
|
225
|
-
* @tags Transfers Ach
|
|
226
|
-
* @name Withdraw
|
|
227
|
-
* @summary Withdraw
|
|
228
|
-
* @request POST:/transfer/ach/withdraw
|
|
229
|
-
* @secure
|
|
230
|
-
*/
|
|
231
|
-
withdraw(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
232
|
-
}
|
|
233
|
-
declare class TransfersBank<HandleError extends boolean = boolean> {
|
|
234
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
235
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
236
|
-
/**
|
|
237
|
-
* @tags Transfers Bank
|
|
238
|
-
* @name FundTransfer
|
|
239
|
-
* @summary Fund transfer
|
|
240
|
-
* @request POST:/transfer/bank/{direction}
|
|
241
|
-
* @secure
|
|
242
|
-
*/
|
|
243
|
-
fundTransfer(direction: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
244
|
-
}
|
|
245
|
-
declare class TransfersCheques<HandleError extends boolean = boolean> {
|
|
246
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
247
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
248
|
-
/**
|
|
249
|
-
* @tags Transfers Cheques
|
|
250
|
-
* @name Withdrawal
|
|
251
|
-
* @summary Withdrawal
|
|
252
|
-
* @request POST:/transfer/check/outgoing
|
|
253
|
-
* @secure
|
|
254
|
-
*/
|
|
255
|
-
withdrawal(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
256
|
-
}
|
|
257
|
-
declare class TransfersInstantAccountVerification<HandleError extends boolean = boolean> {
|
|
258
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
259
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
260
|
-
/**
|
|
261
|
-
* @tags Transfers Instant Account Verification
|
|
262
|
-
* @name Initiate
|
|
263
|
-
* @summary Initiate
|
|
264
|
-
* @request GET:/iav/init
|
|
265
|
-
* @secure
|
|
266
|
-
*/
|
|
267
|
-
initiate(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
268
|
-
/**
|
|
269
|
-
* @tags Transfers Instant Account Verification
|
|
270
|
-
* @name InitiatePost
|
|
271
|
-
* @summary Initiate Post
|
|
272
|
-
* @request POST:/iav/init
|
|
273
|
-
* @secure
|
|
274
|
-
*/
|
|
275
|
-
initiatePost(query: object, data: {
|
|
276
|
-
/** @example "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" */
|
|
277
|
-
subject?: string;
|
|
278
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
279
|
-
/**
|
|
280
|
-
* @tags Transfers Instant Account Verification
|
|
281
|
-
* @name Complete
|
|
282
|
-
* @summary Complete
|
|
283
|
-
* @request POST:/iav/complete
|
|
284
|
-
* @secure
|
|
285
|
-
*/
|
|
286
|
-
complete(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
287
|
-
/**
|
|
288
|
-
* @tags Transfers Instant Account Verification
|
|
289
|
-
* @name ListBankAccounts
|
|
290
|
-
* @summary List Bank Accounts
|
|
291
|
-
* @request POST:/iav/list
|
|
292
|
-
* @secure
|
|
293
|
-
*/
|
|
294
|
-
listBankAccounts(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
295
|
-
/**
|
|
296
|
-
* @tags Transfers Instant Account Verification
|
|
297
|
-
* @name LinkBankAccount
|
|
298
|
-
* @summary Link Bank Account
|
|
299
|
-
* @request POST:/iav/link
|
|
300
|
-
* @secure
|
|
301
|
-
*/
|
|
302
|
-
linkBankAccount(data: {
|
|
303
|
-
/** @example "5VXXXXX" */
|
|
304
|
-
account?: any;
|
|
305
|
-
/** @example "XXXXXXX" */
|
|
306
|
-
bankAccountId?: any;
|
|
307
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
308
|
-
/**
|
|
309
|
-
* @tags Transfers Instant Account Verification
|
|
310
|
-
* @name ImportWithPlaid
|
|
311
|
-
* @summary Import With Plaid
|
|
312
|
-
* @request POST:/iav/import
|
|
313
|
-
* @secure
|
|
314
|
-
*/
|
|
315
|
-
importWithPlaid(data: {
|
|
316
|
-
/** @example "3AB123456" */
|
|
317
|
-
account?: any;
|
|
318
|
-
/** @example "123456" */
|
|
319
|
-
bankAccountNumber?: any;
|
|
320
|
-
/** @example "John Smith" */
|
|
321
|
-
bankAccountOwnerName?: any;
|
|
322
|
-
/** @example "checking" */
|
|
323
|
-
bankAccountType?: any;
|
|
324
|
-
/** @example "122105155" */
|
|
325
|
-
bankRoutingNumber?: any;
|
|
326
|
-
/** @example "Checking x456" */
|
|
327
|
-
nickname?: any;
|
|
328
|
-
/** @example "{optional}" */
|
|
329
|
-
note?: any;
|
|
330
|
-
/** @example "{optional}" */
|
|
331
|
-
remoteAddr?: any;
|
|
332
|
-
/** @example "{optional}" */
|
|
333
|
-
remoteDevice?: any;
|
|
334
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
335
|
-
}
|
|
336
|
-
declare class TransfersInstantCashTransfers<HandleError extends boolean = boolean> {
|
|
556
|
+
declare class TransfersWires<HandleError extends boolean = boolean> {
|
|
337
557
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
338
558
|
constructor(apiClient: JwtClient<HandleError>);
|
|
339
559
|
/**
|
|
340
|
-
* @tags Transfers
|
|
341
|
-
* @name
|
|
342
|
-
* @summary
|
|
343
|
-
* @request POST:/transfer/
|
|
560
|
+
* @tags Transfers Wires
|
|
561
|
+
* @name Outgoing
|
|
562
|
+
* @summary Outgoing
|
|
563
|
+
* @request POST:/transfer/wire/outgoing
|
|
344
564
|
* @secure
|
|
345
565
|
*/
|
|
346
|
-
|
|
347
|
-
/** @example "
|
|
566
|
+
outgoing(data: {
|
|
567
|
+
/** @example "TRACCOUNT" */
|
|
348
568
|
account?: any;
|
|
349
|
-
/** @example
|
|
569
|
+
/** @example 200 */
|
|
350
570
|
amount?: any;
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
571
|
+
beneficiary?: {
|
|
572
|
+
/** @example "AAA012345" */
|
|
573
|
+
account?: string;
|
|
574
|
+
/** @example "CHECKING|SAVINGS" */
|
|
575
|
+
accountType?: string;
|
|
354
576
|
address?: {
|
|
355
577
|
/** @example "Central City" */
|
|
356
578
|
city?: string;
|
|
357
579
|
/** @example "USA" */
|
|
358
580
|
country?: string;
|
|
359
|
-
/** @example "
|
|
581
|
+
/** @example "11235" */
|
|
360
582
|
postalCode?: string;
|
|
361
|
-
/** @example "
|
|
583
|
+
/** @example "ST" */
|
|
362
584
|
stateProvince?: string;
|
|
363
585
|
/** @example ["123 Main St"] */
|
|
364
586
|
streetAddress?: string[];
|
|
365
587
|
};
|
|
366
|
-
/** @example "John" */
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
accountNumber?: string;
|
|
371
|
-
/** @example "Central City Central Bank" */
|
|
372
|
-
name?: string;
|
|
373
|
-
};
|
|
374
|
-
/** @example "Smith" */
|
|
375
|
-
lastName?: string;
|
|
588
|
+
/** @example "John Smith" */
|
|
589
|
+
name?: string;
|
|
590
|
+
/** @example false */
|
|
591
|
+
thirdParty?: boolean;
|
|
376
592
|
};
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
/** @example "James" */
|
|
402
|
-
firstName?: string;
|
|
403
|
-
institution?: {
|
|
404
|
-
/** @example "123456" */
|
|
405
|
-
accountNumber?: string;
|
|
406
|
-
/** @example "Royal Central Bank" */
|
|
407
|
-
name?: string;
|
|
593
|
+
/** @example "Partial|Full" */
|
|
594
|
+
disbursementType?: any;
|
|
595
|
+
/** @example 1234 */
|
|
596
|
+
entryId?: any;
|
|
597
|
+
/** @example false */
|
|
598
|
+
international?: any;
|
|
599
|
+
iraDetails?: {
|
|
600
|
+
/** @example "" */
|
|
601
|
+
contributionType?: string;
|
|
602
|
+
/** @example 2020 */
|
|
603
|
+
contributionYear?: number;
|
|
604
|
+
};
|
|
605
|
+
recipientBank?: {
|
|
606
|
+
/** @example "" */
|
|
607
|
+
additionalInformation?: string;
|
|
608
|
+
/** @example "" */
|
|
609
|
+
city?: string;
|
|
610
|
+
/** @example "" */
|
|
611
|
+
country?: string;
|
|
612
|
+
identifier?: {
|
|
613
|
+
/** @example "021202162" */
|
|
614
|
+
id?: string;
|
|
615
|
+
/** @example "ABA|BIC" */
|
|
616
|
+
type?: string;
|
|
408
617
|
};
|
|
409
|
-
/** @example "
|
|
410
|
-
|
|
618
|
+
/** @example "" */
|
|
619
|
+
name?: string;
|
|
620
|
+
/** @example "" */
|
|
621
|
+
postalCode?: string;
|
|
622
|
+
/** @example "" */
|
|
623
|
+
stateProvince?: string;
|
|
411
624
|
};
|
|
412
|
-
/** @example "
|
|
413
|
-
currency?: any;
|
|
414
|
-
/** @example "1.1.1.1" */
|
|
625
|
+
/** @example "0.0.0.0" */
|
|
415
626
|
remoteAddr?: any;
|
|
416
|
-
/** @example "
|
|
627
|
+
/** @example "ultra fast browser 1.1" */
|
|
417
628
|
remoteDevice?: any;
|
|
418
629
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
419
|
-
/**
|
|
420
|
-
* @tags Transfers Instant Cash Transfers
|
|
421
|
-
* @name ObtainTheReport
|
|
422
|
-
* @summary Obtain the report
|
|
423
|
-
* @request POST:/transfer/reports/obtain
|
|
424
|
-
* @secure
|
|
425
|
-
*/
|
|
426
|
-
obtainTheReport(data: {
|
|
427
|
-
/** @example "MM/DD/YYYY HH:MM:SS ZZZ" */
|
|
428
|
-
date?: any;
|
|
429
|
-
/** @example "RETAIL_BANKING" */
|
|
430
|
-
reportType?: any;
|
|
431
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
432
|
-
/**
|
|
433
|
-
* @tags Transfers Instant Cash Transfers
|
|
434
|
-
* @name ListReports
|
|
435
|
-
* @summary List reports
|
|
436
|
-
* @request GET:/transfer/reports
|
|
437
|
-
* @secure
|
|
438
|
-
*/
|
|
439
|
-
listReports(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
440
630
|
}
|
|
441
631
|
declare class TransfersJournals<HandleError extends boolean = boolean> {
|
|
442
632
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -504,367 +694,177 @@ declare class TransfersJournals<HandleError extends boolean = boolean> {
|
|
|
504
694
|
};
|
|
505
695
|
/** @example "PLACED|SENT|..." */
|
|
506
696
|
status?: any;
|
|
507
|
-
/** @example "AB123456" */
|
|
508
|
-
transferId?: any;
|
|
509
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
510
|
-
}
|
|
511
|
-
declare class TransfersPositions<HandleError extends boolean = boolean> {
|
|
512
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
513
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
514
|
-
/**
|
|
515
|
-
* @tags Transfers Positions
|
|
516
|
-
* @name TransferRequest
|
|
517
|
-
* @summary Transfer request
|
|
518
|
-
* @request POST:/transfer/position/request
|
|
519
|
-
* @secure
|
|
520
|
-
*/
|
|
521
|
-
transferRequest(data: {
|
|
522
|
-
deliverFrom?: {
|
|
523
|
-
/** @example 124 */
|
|
524
|
-
accountId?: number;
|
|
525
|
-
/** @example "ABC123456" */
|
|
526
|
-
accountNumber?: string;
|
|
527
|
-
};
|
|
528
|
-
deliverTo?: {
|
|
529
|
-
/** @example 456 */
|
|
530
|
-
accountId?: number;
|
|
531
|
-
/** @example "DEF123456" */
|
|
532
|
-
accountNumber?: string;
|
|
533
|
-
};
|
|
534
|
-
/** @example "NoPurpose|Gift" */
|
|
535
|
-
purpose?: any;
|
|
536
|
-
/** @example 1000 */
|
|
537
|
-
quantity?: any;
|
|
538
|
-
quote?: {
|
|
539
|
-
/** @example "IBM" */
|
|
540
|
-
symbol?: string;
|
|
541
|
-
};
|
|
542
|
-
/** @example "" */
|
|
543
|
-
reason?: any;
|
|
544
|
-
/** @example "0.0.0.0" */
|
|
545
|
-
remoteAddr?: any;
|
|
546
|
-
/** @example "Ultra fast proxy" */
|
|
547
|
-
remoteDevice?: any;
|
|
548
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
549
|
-
}
|
|
550
|
-
declare class TransfersRelationships<HandleError extends boolean = boolean> {
|
|
551
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
552
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
553
|
-
/**
|
|
554
|
-
* @tags Transfers Relationships
|
|
555
|
-
* @name List
|
|
556
|
-
* @summary List
|
|
557
|
-
* @request GET:/transfer/relationship/list/{account}
|
|
558
|
-
* @secure
|
|
559
|
-
*/
|
|
560
|
-
list(account: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
561
|
-
/**
|
|
562
|
-
* @tags Transfers Relationships
|
|
563
|
-
* @name GetInfo
|
|
564
|
-
* @summary Get Info
|
|
565
|
-
* @request GET:/transfer/relationship/get
|
|
566
|
-
* @secure
|
|
567
|
-
*/
|
|
568
|
-
getInfo(query?: {
|
|
569
|
-
/**
|
|
570
|
-
* Account number
|
|
571
|
-
* @example "ABC123"
|
|
572
|
-
*/
|
|
573
|
-
account?: any;
|
|
574
|
-
/**
|
|
575
|
-
* Desired entry ID
|
|
576
|
-
* @example "123"
|
|
577
|
-
*/
|
|
578
|
-
entryId?: any;
|
|
579
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
580
|
-
/**
|
|
581
|
-
* @tags Transfers Relationships
|
|
582
|
-
* @name PaymentMethods
|
|
583
|
-
* @summary Payment methods
|
|
584
|
-
* @request GET:/transfer/bank/paymentMethods
|
|
585
|
-
* @secure
|
|
586
|
-
*/
|
|
587
|
-
paymentMethods(query?: {
|
|
588
|
-
/** @example "IND" */
|
|
589
|
-
country?: any;
|
|
590
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
591
|
-
/**
|
|
592
|
-
* @tags Transfers Relationships
|
|
593
|
-
* @name PaymentMethodsViaAddress
|
|
594
|
-
* @summary Payment methods (via address)
|
|
595
|
-
* @request POST:/transfer/bank/paymentMethods
|
|
596
|
-
* @secure
|
|
597
|
-
*/
|
|
598
|
-
paymentMethodsViaAddress(data: {
|
|
599
|
-
/** @example "Mumbai" */
|
|
600
|
-
city?: any;
|
|
601
|
-
/** @example "IND" */
|
|
602
|
-
country?: any;
|
|
603
|
-
/** @example "400018" */
|
|
604
|
-
postalCode?: any;
|
|
605
|
-
/** @example "Maharashtra" */
|
|
606
|
-
stateProvince?: any;
|
|
607
|
-
/** @example ["716 /a, Poonam Chem, Dr.annie Besant Road, Opp.atre Mall, Worli"] */
|
|
608
|
-
streetAddress?: any;
|
|
609
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
610
|
-
/**
|
|
611
|
-
* @tags Transfers Relationships
|
|
612
|
-
* @name BankCodes
|
|
613
|
-
* @summary Bank Codes
|
|
614
|
-
* @request GET:/transfer/bank/bankCodes
|
|
615
|
-
* @secure
|
|
616
|
-
*/
|
|
617
|
-
bankCodes(query?: {
|
|
618
|
-
/** @example "IND|MEX" */
|
|
619
|
-
country?: any;
|
|
620
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
621
|
-
/**
|
|
622
|
-
* @tags Transfers Relationships
|
|
623
|
-
* @name BankCodesViaAddress
|
|
624
|
-
* @summary Bank Codes (via address)
|
|
625
|
-
* @request POST:/transfer/bank/bankCodes
|
|
626
|
-
* @secure
|
|
627
|
-
*/
|
|
628
|
-
bankCodesViaAddress(data: {
|
|
629
|
-
/** @example "Mumbai" */
|
|
630
|
-
city?: any;
|
|
631
|
-
/** @example "IND" */
|
|
632
|
-
country?: any;
|
|
633
|
-
/** @example "400018" */
|
|
634
|
-
postalCode?: any;
|
|
635
|
-
/** @example "Maharashtra" */
|
|
636
|
-
stateProvince?: any;
|
|
637
|
-
/** @example ["716 /a, Poonam Chem, Dr.annie Besant Road, Opp.atre Mall, Worli"] */
|
|
638
|
-
streetAddress?: any;
|
|
639
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
640
|
-
/**
|
|
641
|
-
* @tags Transfers Relationships
|
|
642
|
-
* @name Create
|
|
643
|
-
* @summary Create
|
|
644
|
-
* @request POST:/transfer/relationship/create
|
|
645
|
-
* @secure
|
|
646
|
-
*/
|
|
647
|
-
create(data: {
|
|
648
|
-
/** @example "5VA0XXXX" */
|
|
649
|
-
account?: any;
|
|
650
|
-
/** @example "111111" */
|
|
651
|
-
bankAccount?: any;
|
|
652
|
-
/** @example "John Doe" */
|
|
653
|
-
bankAccountOwnerName?: any;
|
|
654
|
-
/** @example "CHECKING" */
|
|
655
|
-
bankAccountType?: any;
|
|
656
|
-
/** @example "010101010" */
|
|
657
|
-
bankRoutingNumber?: any;
|
|
658
|
-
/** @example "Test" */
|
|
659
|
-
nickname?: any;
|
|
660
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
661
|
-
/**
|
|
662
|
-
* @tags Transfers Relationships
|
|
663
|
-
* @name WireInformation
|
|
664
|
-
* @summary Wire information
|
|
665
|
-
* @request POST:/transfer/relationship/wire/create
|
|
666
|
-
* @secure
|
|
667
|
-
*/
|
|
668
|
-
wireInformation(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
669
|
-
/**
|
|
670
|
-
* @tags Transfers Relationships
|
|
671
|
-
* @name BankingRelationship
|
|
672
|
-
* @summary Banking relationship
|
|
673
|
-
* @request POST:/transfer/relationship/bank/create
|
|
674
|
-
* @secure
|
|
675
|
-
*/
|
|
676
|
-
bankingRelationship(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
677
|
-
/**
|
|
678
|
-
* @tags Transfers Relationships
|
|
679
|
-
* @name Approve
|
|
680
|
-
* @summary Approve
|
|
681
|
-
* @request POST:/transfer/relationship/approve
|
|
682
|
-
* @secure
|
|
683
|
-
*/
|
|
684
|
-
approve(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
685
|
-
/**
|
|
686
|
-
* @tags Transfers Relationships
|
|
687
|
-
* @name Cancel
|
|
688
|
-
* @summary Cancel
|
|
689
|
-
* @request POST:/transfer/relationship/cancel/{entryId}
|
|
690
|
-
* @secure
|
|
691
|
-
*/
|
|
692
|
-
cancel(entryId: string, data: {
|
|
693
|
-
/** @example "2QC05208" */
|
|
694
|
-
account?: any;
|
|
695
|
-
/** @example "USER CANCELED" */
|
|
696
|
-
reason?: any;
|
|
697
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
698
|
-
/**
|
|
699
|
-
* @tags Transfers Relationships
|
|
700
|
-
* @name Rename
|
|
701
|
-
* @summary Rename
|
|
702
|
-
* @request POST:/transfer/relationship/rename/{entryId}
|
|
703
|
-
* @secure
|
|
704
|
-
*/
|
|
705
|
-
rename(entryId: string, data: {
|
|
706
|
-
/** @example "Citi Checking 2" */
|
|
707
|
-
nickname?: any;
|
|
708
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
709
|
-
/**
|
|
710
|
-
* @tags Transfers Relationships
|
|
711
|
-
* @name AdvisorPolicyUpdate
|
|
712
|
-
* @summary Advisor Policy Update
|
|
713
|
-
* @request POST:/transfer/relationship/policy
|
|
714
|
-
* @secure
|
|
715
|
-
*/
|
|
716
|
-
advisorPolicyUpdate(data: {
|
|
717
|
-
account?: {
|
|
718
|
-
/** @example 0 */
|
|
719
|
-
accountId?: number;
|
|
720
|
-
/** @example "{optional}" */
|
|
721
|
-
accountNumber?: string;
|
|
722
|
-
};
|
|
723
|
-
/** @example 123 */
|
|
724
|
-
entryId?: any;
|
|
725
|
-
/** @example true */
|
|
726
|
-
esigned?: any;
|
|
727
|
-
/** @example "AllowWithdrawal|Disallow" */
|
|
728
|
-
policy?: any;
|
|
729
|
-
/** @example "" */
|
|
730
|
-
remoteAddr?: any;
|
|
731
|
-
/** @example "" */
|
|
732
|
-
remoteDevice?: any;
|
|
733
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
734
|
-
/**
|
|
735
|
-
* @tags Transfers Relationships
|
|
736
|
-
* @name DocumentUpload
|
|
737
|
-
* @summary Document upload
|
|
738
|
-
* @request POST:/transfer/relationship/wire/upload
|
|
739
|
-
* @secure
|
|
740
|
-
*/
|
|
741
|
-
documentUpload(data: {
|
|
742
|
-
/**
|
|
743
|
-
* Wire relationship ID
|
|
744
|
-
* @example ""
|
|
745
|
-
*/
|
|
746
|
-
entryId?: string;
|
|
747
|
-
/**
|
|
748
|
-
* Document file
|
|
749
|
-
* @format binary
|
|
750
|
-
*/
|
|
751
|
-
file?: File;
|
|
752
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
753
|
-
/**
|
|
754
|
-
* @tags Transfers Relationships
|
|
755
|
-
* @name MfaReInitiation
|
|
756
|
-
* @summary 2FA re-initiation
|
|
757
|
-
* @request POST:/transfer/relationship/wire/2fa/reinitiate
|
|
758
|
-
* @secure
|
|
759
|
-
*/
|
|
760
|
-
mfaReInitiation(data: {
|
|
761
|
-
/** @example 123 */
|
|
762
|
-
entryId?: any;
|
|
697
|
+
/** @example "AB123456" */
|
|
698
|
+
transferId?: any;
|
|
763
699
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
700
|
+
}
|
|
701
|
+
declare class TransfersPositions<HandleError extends boolean = boolean> {
|
|
702
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
703
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
764
704
|
/**
|
|
765
|
-
* @tags Transfers
|
|
766
|
-
* @name
|
|
767
|
-
* @summary
|
|
768
|
-
* @request POST:/transfer/
|
|
705
|
+
* @tags Transfers Positions
|
|
706
|
+
* @name TransferRequest
|
|
707
|
+
* @summary Transfer request
|
|
708
|
+
* @request POST:/transfer/position/request
|
|
769
709
|
* @secure
|
|
770
710
|
*/
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
/** @example "
|
|
776
|
-
|
|
777
|
-
identifier?: {
|
|
778
|
-
/** @example "AAA-123-2587964" */
|
|
779
|
-
id?: string;
|
|
780
|
-
/** @example "BIC" */
|
|
781
|
-
type?: string;
|
|
782
|
-
};
|
|
783
|
-
/** @example "ABC 123" */
|
|
784
|
-
postalCode?: string;
|
|
785
|
-
/** @example "NJ" */
|
|
786
|
-
stateProvince?: string;
|
|
711
|
+
transferRequest(data: {
|
|
712
|
+
deliverFrom?: {
|
|
713
|
+
/** @example 124 */
|
|
714
|
+
accountId?: number;
|
|
715
|
+
/** @example "ABC123456" */
|
|
716
|
+
accountNumber?: string;
|
|
787
717
|
};
|
|
788
|
-
|
|
789
|
-
/** @example
|
|
718
|
+
deliverTo?: {
|
|
719
|
+
/** @example 456 */
|
|
720
|
+
accountId?: number;
|
|
721
|
+
/** @example "DEF123456" */
|
|
790
722
|
accountNumber?: string;
|
|
791
723
|
};
|
|
724
|
+
/** @example "NoPurpose|Gift" */
|
|
725
|
+
purpose?: any;
|
|
726
|
+
/** @example 1000 */
|
|
727
|
+
quantity?: any;
|
|
728
|
+
quote?: {
|
|
729
|
+
/** @example "IBM" */
|
|
730
|
+
symbol?: string;
|
|
731
|
+
};
|
|
732
|
+
/** @example "" */
|
|
733
|
+
reason?: any;
|
|
734
|
+
/** @example "0.0.0.0" */
|
|
735
|
+
remoteAddr?: any;
|
|
736
|
+
/** @example "Ultra fast proxy" */
|
|
737
|
+
remoteDevice?: any;
|
|
792
738
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
793
739
|
}
|
|
794
|
-
declare class
|
|
740
|
+
declare class TransfersBank<HandleError extends boolean = boolean> {
|
|
795
741
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
796
742
|
constructor(apiClient: JwtClient<HandleError>);
|
|
797
743
|
/**
|
|
798
|
-
* @tags Transfers
|
|
799
|
-
* @name
|
|
800
|
-
* @summary
|
|
801
|
-
* @request POST:/transfer/
|
|
744
|
+
* @tags Transfers Bank
|
|
745
|
+
* @name FundTransfer
|
|
746
|
+
* @summary Fund transfer
|
|
747
|
+
* @request POST:/transfer/bank/{direction}
|
|
802
748
|
* @secure
|
|
803
749
|
*/
|
|
804
|
-
|
|
805
|
-
|
|
750
|
+
fundTransfer(direction: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
751
|
+
}
|
|
752
|
+
declare class TransfersInstantCashTransfers<HandleError extends boolean = boolean> {
|
|
753
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
754
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
755
|
+
/**
|
|
756
|
+
* @tags Transfers Instant Cash Transfers
|
|
757
|
+
* @name DepositWithdrawal
|
|
758
|
+
* @summary Deposit/Withdrawal
|
|
759
|
+
* @request POST:/transfer/ict/${direction}
|
|
760
|
+
* @secure
|
|
761
|
+
*/
|
|
762
|
+
depositWithdrawal(direction: string, data: {
|
|
763
|
+
/** @example "ABC123456" */
|
|
806
764
|
account?: any;
|
|
807
|
-
/** @example
|
|
765
|
+
/** @example 100 */
|
|
808
766
|
amount?: any;
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
/** @example "CHECKING|SAVINGS" */
|
|
813
|
-
accountType?: string;
|
|
767
|
+
/** @example "USD" */
|
|
768
|
+
currency?: any;
|
|
769
|
+
originator?: {
|
|
814
770
|
address?: {
|
|
815
771
|
/** @example "Central City" */
|
|
816
772
|
city?: string;
|
|
817
773
|
/** @example "USA" */
|
|
818
774
|
country?: string;
|
|
819
|
-
/** @example "
|
|
775
|
+
/** @example "12345" */
|
|
820
776
|
postalCode?: string;
|
|
821
|
-
/** @example "
|
|
777
|
+
/** @example "NY" */
|
|
822
778
|
stateProvince?: string;
|
|
823
779
|
/** @example ["123 Main St"] */
|
|
824
780
|
streetAddress?: string[];
|
|
825
781
|
};
|
|
826
|
-
/** @example "John
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
international?: any;
|
|
837
|
-
iraDetails?: {
|
|
838
|
-
/** @example "" */
|
|
839
|
-
contributionType?: string;
|
|
840
|
-
/** @example 2020 */
|
|
841
|
-
contributionYear?: number;
|
|
782
|
+
/** @example "John" */
|
|
783
|
+
firstName?: string;
|
|
784
|
+
institution?: {
|
|
785
|
+
/** @example "123456789" */
|
|
786
|
+
accountNumber?: string;
|
|
787
|
+
/** @example "Central City Central Bank" */
|
|
788
|
+
name?: string;
|
|
789
|
+
};
|
|
790
|
+
/** @example "Smith" */
|
|
791
|
+
lastName?: string;
|
|
842
792
|
};
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
|
|
793
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
794
|
+
/**
|
|
795
|
+
* @tags Transfers Instant Cash Transfers
|
|
796
|
+
* @name DepositWithdrawalV2
|
|
797
|
+
* @summary Deposit/Withdrawal V2
|
|
798
|
+
* @request POST:/transfer/v2/ict/${direction}
|
|
799
|
+
* @secure
|
|
800
|
+
*/
|
|
801
|
+
depositWithdrawalV2(direction: string, data: {
|
|
802
|
+
/** @example "AB123456" */
|
|
803
|
+
account?: any;
|
|
804
|
+
/** @example 100.32 */
|
|
805
|
+
amount?: any;
|
|
806
|
+
counterparty?: {
|
|
807
|
+
address?: {
|
|
808
|
+
/** @example "Central City" */
|
|
809
|
+
city?: string;
|
|
810
|
+
/** @example "12345" */
|
|
811
|
+
postalCode?: string;
|
|
812
|
+
/** @example "CC" */
|
|
813
|
+
stateProvince?: string;
|
|
814
|
+
/** @example ["225 Baker St"] */
|
|
815
|
+
streetAddress?: string[];
|
|
855
816
|
};
|
|
856
|
-
/** @example "" */
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
817
|
+
/** @example "James" */
|
|
818
|
+
firstName?: string;
|
|
819
|
+
institution?: {
|
|
820
|
+
/** @example "123456" */
|
|
821
|
+
accountNumber?: string;
|
|
822
|
+
/** @example "Royal Central Bank" */
|
|
823
|
+
name?: string;
|
|
824
|
+
};
|
|
825
|
+
/** @example "Bond" */
|
|
826
|
+
lastName?: string;
|
|
862
827
|
};
|
|
863
|
-
/** @example "
|
|
828
|
+
/** @example "USD" */
|
|
829
|
+
currency?: any;
|
|
830
|
+
/** @example "1.1.1.1" */
|
|
864
831
|
remoteAddr?: any;
|
|
865
|
-
/** @example "
|
|
832
|
+
/** @example "Droid Phone" */
|
|
866
833
|
remoteDevice?: any;
|
|
867
834
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
835
|
+
/**
|
|
836
|
+
* @tags Transfers Instant Cash Transfers
|
|
837
|
+
* @name ObtainTheReport
|
|
838
|
+
* @summary Obtain the report
|
|
839
|
+
* @request POST:/transfer/reports/obtain
|
|
840
|
+
* @secure
|
|
841
|
+
*/
|
|
842
|
+
obtainTheReport(data: {
|
|
843
|
+
/** @example "MM/DD/YYYY HH:MM:SS ZZZ" */
|
|
844
|
+
date?: any;
|
|
845
|
+
/** @example "RETAIL_BANKING" */
|
|
846
|
+
reportType?: any;
|
|
847
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
848
|
+
/**
|
|
849
|
+
* @tags Transfers Instant Cash Transfers
|
|
850
|
+
* @name ListReports
|
|
851
|
+
* @summary List reports
|
|
852
|
+
* @request GET:/transfer/reports
|
|
853
|
+
* @secure
|
|
854
|
+
*/
|
|
855
|
+
listReports(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
856
|
+
}
|
|
857
|
+
declare class TransfersCheques<HandleError extends boolean = boolean> {
|
|
858
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
859
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
860
|
+
/**
|
|
861
|
+
* @tags Transfers Cheques
|
|
862
|
+
* @name Withdrawal
|
|
863
|
+
* @summary Withdrawal
|
|
864
|
+
* @request POST:/transfer/check/outgoing
|
|
865
|
+
* @secure
|
|
866
|
+
*/
|
|
867
|
+
withdrawal(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
868
868
|
}
|
|
869
869
|
declare class _Transfers1<HandleError extends boolean = boolean> {
|
|
870
870
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -13022,7 +13022,56 @@ export class Trades<HandleError extends boolean = boolean> {
|
|
|
13022
13022
|
* @request POST:/trades/batch
|
|
13023
13023
|
* @secure
|
|
13024
13024
|
*/
|
|
13025
|
-
submitBatchOfTrades(data: ZeroHashPostTradesBatchBody, headers?: {
|
|
13025
|
+
submitBatchOfTrades(data: ZeroHashPostTradesBatchBody, headers?: {
|
|
13026
|
+
/**
|
|
13027
|
+
* Signature for your request.
|
|
13028
|
+
* @default "[WEB] auto-generated on fly"
|
|
13029
|
+
*/
|
|
13030
|
+
'X-SCX-SIGNED'?: string;
|
|
13031
|
+
/**
|
|
13032
|
+
* UNIX timestamp.
|
|
13033
|
+
* @default "[WEB] auto-generated on fly"
|
|
13034
|
+
*/
|
|
13035
|
+
'X-SCX-TIMESTAMP'?: string;
|
|
13036
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostTradesBatchResponse, HandleError>>;
|
|
13037
|
+
/**
|
|
13038
|
+
* @description Retrieves trade details for a specific trade.
|
|
13039
|
+
* @tags Trades
|
|
13040
|
+
* @name GetTrade
|
|
13041
|
+
* @summary Get trade
|
|
13042
|
+
* @request GET:/trades/{trade_id}
|
|
13043
|
+
* @secure
|
|
13044
|
+
*/
|
|
13045
|
+
getTrade(tradeId: string, headers?: {
|
|
13046
|
+
/**
|
|
13047
|
+
* Signature for your request.
|
|
13048
|
+
* @default "[WEB] auto-generated on fly"
|
|
13049
|
+
*/
|
|
13050
|
+
'X-SCX-SIGNED'?: string;
|
|
13051
|
+
/**
|
|
13052
|
+
* UNIX timestamp.
|
|
13053
|
+
* @default "[WEB] auto-generated on fly"
|
|
13054
|
+
*/
|
|
13055
|
+
'X-SCX-TIMESTAMP'?: string;
|
|
13056
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetTradeResponse, HandleError>>;
|
|
13057
|
+
}
|
|
13058
|
+
export class Positions<HandleError extends boolean = boolean> {
|
|
13059
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
13060
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
13061
|
+
/**
|
|
13062
|
+
* @description Retrieve all positions maintained at Zero Hash.
|
|
13063
|
+
* @tags Positions
|
|
13064
|
+
* @name GetPositions
|
|
13065
|
+
* @summary Get positions
|
|
13066
|
+
* @request GET:/positions
|
|
13067
|
+
* @secure
|
|
13068
|
+
*/
|
|
13069
|
+
getPositions(query?: {
|
|
13070
|
+
/** Filters for positions based on the specific platform */
|
|
13071
|
+
platform_code?: string;
|
|
13072
|
+
/** Filters for positions based on the account_label */
|
|
13073
|
+
account_label?: string;
|
|
13074
|
+
}, headers?: {
|
|
13026
13075
|
/**
|
|
13027
13076
|
* Signature for your request.
|
|
13028
13077
|
* @default "[WEB] auto-generated on fly"
|
|
@@ -13033,16 +13082,26 @@ export class Trades<HandleError extends boolean = boolean> {
|
|
|
13033
13082
|
* @default "[WEB] auto-generated on fly"
|
|
13034
13083
|
*/
|
|
13035
13084
|
'X-SCX-TIMESTAMP'?: string;
|
|
13036
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
13085
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetPositionsResponse, HandleError>>;
|
|
13037
13086
|
/**
|
|
13038
|
-
* @description
|
|
13039
|
-
* @tags
|
|
13040
|
-
* @name
|
|
13041
|
-
* @summary Get
|
|
13042
|
-
* @request GET:/
|
|
13087
|
+
* @description Retrieve all platform positions maintained at Zero Hash.
|
|
13088
|
+
* @tags Positions
|
|
13089
|
+
* @name GetPlatformPositions
|
|
13090
|
+
* @summary Get platform positions
|
|
13091
|
+
* @request GET:/positions/platform/{platform_code}
|
|
13043
13092
|
* @secure
|
|
13044
13093
|
*/
|
|
13045
|
-
|
|
13094
|
+
getPlatformPositions(platformCode: string, query?: {
|
|
13095
|
+
/**
|
|
13096
|
+
* Filters for positions based on the specific participant.
|
|
13097
|
+
*
|
|
13098
|
+
* Note: multiple participant codes can be provided in the query string, separated by ampersands.
|
|
13099
|
+
* E.g. `participant_code=PLAT01&participant_code=PLAT02`
|
|
13100
|
+
*/
|
|
13101
|
+
participant_code?: string;
|
|
13102
|
+
/** Filters for positions based on the account_label */
|
|
13103
|
+
account_label?: string;
|
|
13104
|
+
}, headers?: {
|
|
13046
13105
|
/**
|
|
13047
13106
|
* Signature for your request.
|
|
13048
13107
|
* @default "[WEB] auto-generated on fly"
|
|
@@ -13053,7 +13112,7 @@ export class Trades<HandleError extends boolean = boolean> {
|
|
|
13053
13112
|
* @default "[WEB] auto-generated on fly"
|
|
13054
13113
|
*/
|
|
13055
13114
|
'X-SCX-TIMESTAMP'?: string;
|
|
13056
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
13115
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetPlatformPositionsResponse, HandleError>>;
|
|
13057
13116
|
}
|
|
13058
13117
|
export class Accounts<HandleError extends boolean = boolean> {
|
|
13059
13118
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -13185,65 +13244,6 @@ export class Accounts<HandleError extends boolean = boolean> {
|
|
|
13185
13244
|
'X-SCX-TIMESTAMP'?: string;
|
|
13186
13245
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetRunHistoryResponse, HandleError>>;
|
|
13187
13246
|
}
|
|
13188
|
-
export class Positions<HandleError extends boolean = boolean> {
|
|
13189
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
13190
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
13191
|
-
/**
|
|
13192
|
-
* @description Retrieve all positions maintained at Zero Hash.
|
|
13193
|
-
* @tags Positions
|
|
13194
|
-
* @name GetPositions
|
|
13195
|
-
* @summary Get positions
|
|
13196
|
-
* @request GET:/positions
|
|
13197
|
-
* @secure
|
|
13198
|
-
*/
|
|
13199
|
-
getPositions(query?: {
|
|
13200
|
-
/** Filters for positions based on the specific platform */
|
|
13201
|
-
platform_code?: string;
|
|
13202
|
-
/** Filters for positions based on the account_label */
|
|
13203
|
-
account_label?: string;
|
|
13204
|
-
}, headers?: {
|
|
13205
|
-
/**
|
|
13206
|
-
* Signature for your request.
|
|
13207
|
-
* @default "[WEB] auto-generated on fly"
|
|
13208
|
-
*/
|
|
13209
|
-
'X-SCX-SIGNED'?: string;
|
|
13210
|
-
/**
|
|
13211
|
-
* UNIX timestamp.
|
|
13212
|
-
* @default "[WEB] auto-generated on fly"
|
|
13213
|
-
*/
|
|
13214
|
-
'X-SCX-TIMESTAMP'?: string;
|
|
13215
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetPositionsResponse, HandleError>>;
|
|
13216
|
-
/**
|
|
13217
|
-
* @description Retrieve all platform positions maintained at Zero Hash.
|
|
13218
|
-
* @tags Positions
|
|
13219
|
-
* @name GetPlatformPositions
|
|
13220
|
-
* @summary Get platform positions
|
|
13221
|
-
* @request GET:/positions/platform/{platform_code}
|
|
13222
|
-
* @secure
|
|
13223
|
-
*/
|
|
13224
|
-
getPlatformPositions(platformCode: string, query?: {
|
|
13225
|
-
/**
|
|
13226
|
-
* Filters for positions based on the specific participant.
|
|
13227
|
-
*
|
|
13228
|
-
* Note: multiple participant codes can be provided in the query string, separated by ampersands.
|
|
13229
|
-
* E.g. `participant_code=PLAT01&participant_code=PLAT02`
|
|
13230
|
-
*/
|
|
13231
|
-
participant_code?: string;
|
|
13232
|
-
/** Filters for positions based on the account_label */
|
|
13233
|
-
account_label?: string;
|
|
13234
|
-
}, headers?: {
|
|
13235
|
-
/**
|
|
13236
|
-
* Signature for your request.
|
|
13237
|
-
* @default "[WEB] auto-generated on fly"
|
|
13238
|
-
*/
|
|
13239
|
-
'X-SCX-SIGNED'?: string;
|
|
13240
|
-
/**
|
|
13241
|
-
* UNIX timestamp.
|
|
13242
|
-
* @default "[WEB] auto-generated on fly"
|
|
13243
|
-
*/
|
|
13244
|
-
'X-SCX-TIMESTAMP'?: string;
|
|
13245
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetPlatformPositionsResponse, HandleError>>;
|
|
13246
|
-
}
|
|
13247
13247
|
export class Deposits<HandleError extends boolean = boolean> {
|
|
13248
13248
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
13249
13249
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -14589,6 +14589,35 @@ export class Liquidity<HandleError extends boolean = boolean> {
|
|
|
14589
14589
|
'X-SCX-TIMESTAMP'?: string;
|
|
14590
14590
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostExecuteQuoteResponse, HandleError>>;
|
|
14591
14591
|
}
|
|
14592
|
+
export class Rewards<HandleError extends boolean = boolean> {
|
|
14593
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
14594
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
14595
|
+
/**
|
|
14596
|
+
* @description Completes a transaction involving a designated asset and disperses rewards.
|
|
14597
|
+
* @tags Rewards
|
|
14598
|
+
* @name DisperseRewards
|
|
14599
|
+
* @summary Disperse rewards
|
|
14600
|
+
* @request POST:/rewards
|
|
14601
|
+
* @secure
|
|
14602
|
+
*/
|
|
14603
|
+
disperseRewards(data: ZeroHashPostRewardsBody, headers?: {
|
|
14604
|
+
/**
|
|
14605
|
+
* Signature for your request.
|
|
14606
|
+
* @default "[WEB] auto-generated on fly"
|
|
14607
|
+
*/
|
|
14608
|
+
'X-SCX-SIGNED'?: string;
|
|
14609
|
+
/**
|
|
14610
|
+
* UNIX timestamp.
|
|
14611
|
+
* @default "[WEB] auto-generated on fly"
|
|
14612
|
+
*/
|
|
14613
|
+
'X-SCX-TIMESTAMP'?: string;
|
|
14614
|
+
/**
|
|
14615
|
+
* Optional request ID for idempotency purposes. Required format: [uuid v4](https://www.uuidtools.com/uuid-versions-explained#version-4)
|
|
14616
|
+
* @default "[WEB] auto-generated on fly"
|
|
14617
|
+
*/
|
|
14618
|
+
'X-Request-Id'?: string;
|
|
14619
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostRewardsResponse, HandleError>>;
|
|
14620
|
+
}
|
|
14592
14621
|
export class Awards<HandleError extends boolean = boolean> {
|
|
14593
14622
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
14594
14623
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -14633,18 +14662,46 @@ export class Awards<HandleError extends boolean = boolean> {
|
|
|
14633
14662
|
'X-SCX-TIMESTAMP'?: string;
|
|
14634
14663
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostAwardsDistributeResponse, HandleError>>;
|
|
14635
14664
|
}
|
|
14636
|
-
export class
|
|
14665
|
+
export class ConvertAndWithdraw<HandleError extends boolean = boolean> {
|
|
14637
14666
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
14638
14667
|
constructor(apiClient: JwtClient<HandleError>);
|
|
14639
14668
|
/**
|
|
14640
|
-
* @description
|
|
14641
|
-
* @tags
|
|
14642
|
-
* @name
|
|
14643
|
-
* @summary
|
|
14644
|
-
* @request
|
|
14669
|
+
* @description Retrieves a quote for the purchase of an asset and the network fees associated with an eminent and automatic withdrawal of the asset.
|
|
14670
|
+
* @tags Convert and Withdraw
|
|
14671
|
+
* @name GetQuote
|
|
14672
|
+
* @summary Get quote
|
|
14673
|
+
* @request GET:/convert_withdraw/rfq
|
|
14645
14674
|
* @secure
|
|
14646
14675
|
*/
|
|
14647
|
-
|
|
14676
|
+
getQuote(query: {
|
|
14677
|
+
/** Allows platforms to specify the side of the quote */
|
|
14678
|
+
side: ZeroHashGetQuoteParams2SideEnum;
|
|
14679
|
+
/** Allows platforms to specify the underlying asset */
|
|
14680
|
+
underlying: ZeroHashUnderlyingCurrency;
|
|
14681
|
+
/** Allows platforms to specify the quoted asset */
|
|
14682
|
+
quoted_currency: ZeroHashQuotedCurrency;
|
|
14683
|
+
/** The `quantity` of the `underlying` asset requested in the quote */
|
|
14684
|
+
quantity?: string;
|
|
14685
|
+
/** The `total` of the `quoted_currency` asset requested in the quote */
|
|
14686
|
+
total?: string;
|
|
14687
|
+
/** The participant requesting a quote to buy or sell an asset */
|
|
14688
|
+
participant_code?: string;
|
|
14689
|
+
/** The account_label that's used to fund the trade */
|
|
14690
|
+
account_label?: string;
|
|
14691
|
+
/** The on-chain address where the withdrawal should be sent */
|
|
14692
|
+
withdrawal_address: string;
|
|
14693
|
+
/**
|
|
14694
|
+
* Allows platforms to specify if fees are inclusive
|
|
14695
|
+
* This parameter is only applicable for requests made by `total`
|
|
14696
|
+
*/
|
|
14697
|
+
fee_inclusive?: boolean;
|
|
14698
|
+
/** Allows the platform to define the quote spread in basis points */
|
|
14699
|
+
spread?: string;
|
|
14700
|
+
/** The destination tag or memo ID associated with the transaction. If the asset is EOS, XLM or XRP and no_destination_tag is false, then this is required */
|
|
14701
|
+
destination_tag?: string;
|
|
14702
|
+
/** Whether or not the specific withdrawal and destination address requires a destination tag. If the asset is EOS, XLM or XRP, this field is required. Note: Zero Hash requires that no_destination_tag be false for EOS */
|
|
14703
|
+
no_destination_tag?: string;
|
|
14704
|
+
}, headers?: {
|
|
14648
14705
|
/**
|
|
14649
14706
|
* Signature for your request.
|
|
14650
14707
|
* @default "[WEB] auto-generated on fly"
|
|
@@ -14655,12 +14712,49 @@ export class Rewards<HandleError extends boolean = boolean> {
|
|
|
14655
14712
|
* @default "[WEB] auto-generated on fly"
|
|
14656
14713
|
*/
|
|
14657
14714
|
'X-SCX-TIMESTAMP'?: string;
|
|
14715
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetRequestForCWQuoteResponse, HandleError>>;
|
|
14716
|
+
/**
|
|
14717
|
+
* @description Retrieves a quote for the purchase of an asset and the network fees associated with an eminent and automatic withdrawal of the asset.
|
|
14718
|
+
* @tags Convert and Withdraw
|
|
14719
|
+
* @name GetQuote2
|
|
14720
|
+
* @summary Get quote
|
|
14721
|
+
* @request POST:/convert_withdraw/rfq
|
|
14722
|
+
* @originalName getQuote
|
|
14723
|
+
* @duplicate
|
|
14724
|
+
* @secure
|
|
14725
|
+
*/
|
|
14726
|
+
getQuote2(data: ZeroHashPostCWRequestForQuoteBody, headers?: {
|
|
14658
14727
|
/**
|
|
14659
|
-
*
|
|
14728
|
+
* Signature for your request.
|
|
14660
14729
|
* @default "[WEB] auto-generated on fly"
|
|
14661
14730
|
*/
|
|
14662
|
-
'X-
|
|
14663
|
-
|
|
14731
|
+
'X-SCX-SIGNED'?: string;
|
|
14732
|
+
/**
|
|
14733
|
+
* UNIX timestamp.
|
|
14734
|
+
* @default "[WEB] auto-generated on fly"
|
|
14735
|
+
*/
|
|
14736
|
+
'X-SCX-TIMESTAMP'?: string;
|
|
14737
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetRequestForCWQuoteResponse, HandleError>>;
|
|
14738
|
+
/**
|
|
14739
|
+
* @description Executes a quote. The underlying asset will be purchased and automatically withdrawn. You can take the `withdrawal_request_id` from the response and then query `GET /withdrawals/requests/id` endpoint to view the status of the withdrawal.
|
|
14740
|
+
* @tags Convert and Withdraw
|
|
14741
|
+
* @name ExecuteQuote
|
|
14742
|
+
* @summary Execute quote
|
|
14743
|
+
* @request POST:/convert_withdraw/execute
|
|
14744
|
+
* @secure
|
|
14745
|
+
*/
|
|
14746
|
+
executeQuote(data: ZeroHashPostCWExecuteQuoteBody, headers?: {
|
|
14747
|
+
/**
|
|
14748
|
+
* Signature for your request.
|
|
14749
|
+
* @default "[WEB] auto-generated on fly"
|
|
14750
|
+
*/
|
|
14751
|
+
'X-SCX-SIGNED'?: string;
|
|
14752
|
+
/**
|
|
14753
|
+
* UNIX timestamp.
|
|
14754
|
+
* @default "[WEB] auto-generated on fly"
|
|
14755
|
+
*/
|
|
14756
|
+
'X-SCX-TIMESTAMP'?: string;
|
|
14757
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostCWExecuteQuoteResponse, HandleError>>;
|
|
14664
14758
|
}
|
|
14665
14759
|
export class Payments<HandleError extends boolean = boolean> {
|
|
14666
14760
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -14996,45 +15090,44 @@ export class Payments<HandleError extends boolean = boolean> {
|
|
|
14996
15090
|
'X-SCX-TIMESTAMP'?: string;
|
|
14997
15091
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostPaymentsExecutePaymentResponse, HandleError>>;
|
|
14998
15092
|
}
|
|
14999
|
-
export class
|
|
15093
|
+
export class MarketData<HandleError extends boolean = boolean> {
|
|
15000
15094
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
15001
15095
|
constructor(apiClient: JwtClient<HandleError>);
|
|
15002
15096
|
/**
|
|
15003
|
-
* @description Retrieves a
|
|
15004
|
-
* @tags
|
|
15005
|
-
* @name
|
|
15006
|
-
* @summary Get
|
|
15007
|
-
* @request GET:/
|
|
15097
|
+
* @description Retrieves a list of symbols and their market data.
|
|
15098
|
+
* @tags Market Data
|
|
15099
|
+
* @name GetSymbolData
|
|
15100
|
+
* @summary Get symbol data
|
|
15101
|
+
* @request GET:/market_data/symbol_data
|
|
15008
15102
|
* @secure
|
|
15009
15103
|
*/
|
|
15010
|
-
|
|
15011
|
-
/**
|
|
15012
|
-
|
|
15013
|
-
/**
|
|
15014
|
-
|
|
15015
|
-
|
|
15016
|
-
|
|
15017
|
-
|
|
15018
|
-
|
|
15019
|
-
|
|
15020
|
-
|
|
15021
|
-
|
|
15022
|
-
|
|
15023
|
-
|
|
15024
|
-
|
|
15025
|
-
/**
|
|
15026
|
-
|
|
15027
|
-
/**
|
|
15028
|
-
|
|
15029
|
-
|
|
15030
|
-
|
|
15031
|
-
|
|
15032
|
-
|
|
15033
|
-
|
|
15034
|
-
|
|
15035
|
-
|
|
15036
|
-
|
|
15037
|
-
no_destination_tag?: string;
|
|
15104
|
+
getSymbolData(query?: {
|
|
15105
|
+
/** Filter for underlying asset */
|
|
15106
|
+
underlying?: string;
|
|
15107
|
+
/** Filter for quoted_currency */
|
|
15108
|
+
quoted_currency?: string;
|
|
15109
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetSymbolDataResponse, HandleError>>;
|
|
15110
|
+
/**
|
|
15111
|
+
* @description Retrieves an list of historical data of open, high, low, close, underlying_volume and quoted_volume.
|
|
15112
|
+
* @tags Market Data
|
|
15113
|
+
* @name GetOhlcvData
|
|
15114
|
+
* @summary Get OHLCV data
|
|
15115
|
+
* @request GET:/market_data/ohlcv
|
|
15116
|
+
* @secure
|
|
15117
|
+
*/
|
|
15118
|
+
getOhlcvData(query: {
|
|
15119
|
+
/** Filter for underlying asset */
|
|
15120
|
+
underlying: string;
|
|
15121
|
+
/** Filter for quoted asset */
|
|
15122
|
+
quoted_currency: string;
|
|
15123
|
+
/** Filter for maximum number of data points to be returned */
|
|
15124
|
+
limit?: string;
|
|
15125
|
+
/** Filter for objects before given timestamp */
|
|
15126
|
+
data_end_date?: string;
|
|
15127
|
+
/** Filter for all data(daily `time_frame`) */
|
|
15128
|
+
all_data?: boolean;
|
|
15129
|
+
/** Filter for time_frame */
|
|
15130
|
+
time_frame: ZeroHashGetOhlcvDataParamsTimeFrameEnum;
|
|
15038
15131
|
}, headers?: {
|
|
15039
15132
|
/**
|
|
15040
15133
|
* Signature for your request.
|
|
@@ -15046,18 +15139,60 @@ export class ConvertAndWithdraw<HandleError extends boolean = boolean> {
|
|
|
15046
15139
|
* @default "[WEB] auto-generated on fly"
|
|
15047
15140
|
*/
|
|
15048
15141
|
'X-SCX-TIMESTAMP'?: string;
|
|
15049
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
15142
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetOHLCVResponse, HandleError>>;
|
|
15050
15143
|
/**
|
|
15051
|
-
* @description Retrieves a
|
|
15052
|
-
* @tags
|
|
15053
|
-
* @name
|
|
15144
|
+
* @description Retrieves a list of market news articles filtered using given parameters.
|
|
15145
|
+
* @tags Market Data
|
|
15146
|
+
* @name GetNewsArticles
|
|
15147
|
+
* @summary Get news articles
|
|
15148
|
+
* @request GET:/market_data/news/latest
|
|
15149
|
+
* @secure
|
|
15150
|
+
*/
|
|
15151
|
+
getNewsArticles(query?: {
|
|
15152
|
+
/** Sources (feeds) of news articles, options can be fetched from /news/feeds */
|
|
15153
|
+
news_source?: string;
|
|
15154
|
+
/** Categories of news articles, options can be fetched from /news/categories */
|
|
15155
|
+
categories?: string;
|
|
15156
|
+
/** Categories of news articles to be excluded from result, options can be fetched from /news/categories */
|
|
15157
|
+
exclude_categories?: string;
|
|
15158
|
+
/** UNIX timestamp, is used to fetch articles before the given time */
|
|
15159
|
+
lookback?: string;
|
|
15160
|
+
/** Language of articles to be fetched. Format: `EN` (English) or `PT` (Portuguese) */
|
|
15161
|
+
language?: string;
|
|
15162
|
+
/** Sorting order of news articles. Can be either `popular` or `latest` */
|
|
15163
|
+
sort_by?: string;
|
|
15164
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetLatestNewsResponse, HandleError>>;
|
|
15165
|
+
/**
|
|
15166
|
+
* @description Retrieves a list of available market data feeds, which can be used to query articles.
|
|
15167
|
+
* @tags Market Data
|
|
15168
|
+
* @name GetNewsFeeds
|
|
15169
|
+
* @summary Get news feeds
|
|
15170
|
+
* @request GET:/market_data/news/feeds
|
|
15171
|
+
* @secure
|
|
15172
|
+
*/
|
|
15173
|
+
getNewsFeeds(config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetNewsFeedsResponse, HandleError>>;
|
|
15174
|
+
/**
|
|
15175
|
+
* @description Retrieves a list of available market data categories, which can be used to query articles.
|
|
15176
|
+
* @tags Market Data
|
|
15177
|
+
* @name GetCategories
|
|
15178
|
+
* @summary Get categories
|
|
15179
|
+
* @request GET:/market_data/news/categories
|
|
15180
|
+
* @secure
|
|
15181
|
+
*/
|
|
15182
|
+
getCategories(config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetNewsCategoriesResponse, HandleError>>;
|
|
15183
|
+
}
|
|
15184
|
+
export class Fund<HandleError extends boolean = boolean> {
|
|
15185
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
15186
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
15187
|
+
/**
|
|
15188
|
+
* @description Retrieves a quote for a fund event for a given participant code and asset. This endpoint response indicates the rate by which a subsequent on-chain deposit will be honored at.
|
|
15189
|
+
* @tags Fund
|
|
15190
|
+
* @name GetQuote
|
|
15054
15191
|
* @summary Get quote
|
|
15055
|
-
* @request POST:/
|
|
15056
|
-
* @originalName getQuote
|
|
15057
|
-
* @duplicate
|
|
15192
|
+
* @request POST:/fund/rfq
|
|
15058
15193
|
* @secure
|
|
15059
15194
|
*/
|
|
15060
|
-
|
|
15195
|
+
getQuote(data: ZeroHashPostFundRfqBody, headers?: {
|
|
15061
15196
|
/**
|
|
15062
15197
|
* Signature for your request.
|
|
15063
15198
|
* @default "[WEB] auto-generated on fly"
|
|
@@ -15068,16 +15203,31 @@ export class ConvertAndWithdraw<HandleError extends boolean = boolean> {
|
|
|
15068
15203
|
* @default "[WEB] auto-generated on fly"
|
|
15069
15204
|
*/
|
|
15070
15205
|
'X-SCX-TIMESTAMP'?: string;
|
|
15071
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
15206
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostFundRfqResponse, HandleError>>;
|
|
15072
15207
|
/**
|
|
15073
|
-
* @description
|
|
15074
|
-
* @tags
|
|
15075
|
-
* @name
|
|
15076
|
-
* @summary
|
|
15077
|
-
* @request
|
|
15208
|
+
* @description You can use the `fund_id` in the response as the “parent” to query `GET /movements?parent_link_id=[fund_id]` to view a trail of all movements related to this fund event.
|
|
15209
|
+
* @tags Fund
|
|
15210
|
+
* @name GetTransactions
|
|
15211
|
+
* @summary Get transactions
|
|
15212
|
+
* @request GET:/fund/transactions
|
|
15078
15213
|
* @secure
|
|
15079
15214
|
*/
|
|
15080
|
-
|
|
15215
|
+
getTransactions(query?: {
|
|
15216
|
+
/** Participant code of the end customer */
|
|
15217
|
+
participant_code?: string;
|
|
15218
|
+
/** The asset sent on-chain by the end customer in order to fund an account */
|
|
15219
|
+
fund_asset?: string;
|
|
15220
|
+
/** The address provided by Zero Hash that the end customer will send to */
|
|
15221
|
+
deposit_address?: string;
|
|
15222
|
+
/** The Zero Hash-generated unique identifier associated with an executed fund event */
|
|
15223
|
+
fund_id?: string;
|
|
15224
|
+
/** Filters for a specific page (pagination) */
|
|
15225
|
+
page?: string;
|
|
15226
|
+
/** The number of results returned per page, with a maximum of 50 transactions per page */
|
|
15227
|
+
page_size?: string;
|
|
15228
|
+
/** Filters transactions by successful status. This is a boolean field, please specify either `true` or `false` */
|
|
15229
|
+
success?: string;
|
|
15230
|
+
}, headers?: {
|
|
15081
15231
|
/**
|
|
15082
15232
|
* Signature for your request.
|
|
15083
15233
|
* @default "[WEB] auto-generated on fly"
|
|
@@ -15088,7 +15238,7 @@ export class ConvertAndWithdraw<HandleError extends boolean = boolean> {
|
|
|
15088
15238
|
* @default "[WEB] auto-generated on fly"
|
|
15089
15239
|
*/
|
|
15090
15240
|
'X-SCX-TIMESTAMP'?: string;
|
|
15091
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
15241
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetFundTransactionsResponse, HandleError>>;
|
|
15092
15242
|
}
|
|
15093
15243
|
export class Clob<HandleError extends boolean = boolean> {
|
|
15094
15244
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -15303,156 +15453,6 @@ export class Clob<HandleError extends boolean = boolean> {
|
|
|
15303
15453
|
'X-SCX-TIMESTAMP'?: string;
|
|
15304
15454
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostTradeStatsResponse, HandleError>>;
|
|
15305
15455
|
}
|
|
15306
|
-
export class Fund<HandleError extends boolean = boolean> {
|
|
15307
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
15308
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
15309
|
-
/**
|
|
15310
|
-
* @description Retrieves a quote for a fund event for a given participant code and asset. This endpoint response indicates the rate by which a subsequent on-chain deposit will be honored at.
|
|
15311
|
-
* @tags Fund
|
|
15312
|
-
* @name GetQuote
|
|
15313
|
-
* @summary Get quote
|
|
15314
|
-
* @request POST:/fund/rfq
|
|
15315
|
-
* @secure
|
|
15316
|
-
*/
|
|
15317
|
-
getQuote(data: ZeroHashPostFundRfqBody, headers?: {
|
|
15318
|
-
/**
|
|
15319
|
-
* Signature for your request.
|
|
15320
|
-
* @default "[WEB] auto-generated on fly"
|
|
15321
|
-
*/
|
|
15322
|
-
'X-SCX-SIGNED'?: string;
|
|
15323
|
-
/**
|
|
15324
|
-
* UNIX timestamp.
|
|
15325
|
-
* @default "[WEB] auto-generated on fly"
|
|
15326
|
-
*/
|
|
15327
|
-
'X-SCX-TIMESTAMP'?: string;
|
|
15328
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostFundRfqResponse, HandleError>>;
|
|
15329
|
-
/**
|
|
15330
|
-
* @description You can use the `fund_id` in the response as the “parent” to query `GET /movements?parent_link_id=[fund_id]` to view a trail of all movements related to this fund event.
|
|
15331
|
-
* @tags Fund
|
|
15332
|
-
* @name GetTransactions
|
|
15333
|
-
* @summary Get transactions
|
|
15334
|
-
* @request GET:/fund/transactions
|
|
15335
|
-
* @secure
|
|
15336
|
-
*/
|
|
15337
|
-
getTransactions(query?: {
|
|
15338
|
-
/** Participant code of the end customer */
|
|
15339
|
-
participant_code?: string;
|
|
15340
|
-
/** The asset sent on-chain by the end customer in order to fund an account */
|
|
15341
|
-
fund_asset?: string;
|
|
15342
|
-
/** The address provided by Zero Hash that the end customer will send to */
|
|
15343
|
-
deposit_address?: string;
|
|
15344
|
-
/** The Zero Hash-generated unique identifier associated with an executed fund event */
|
|
15345
|
-
fund_id?: string;
|
|
15346
|
-
/** Filters for a specific page (pagination) */
|
|
15347
|
-
page?: string;
|
|
15348
|
-
/** The number of results returned per page, with a maximum of 50 transactions per page */
|
|
15349
|
-
page_size?: string;
|
|
15350
|
-
/** Filters transactions by successful status. This is a boolean field, please specify either `true` or `false` */
|
|
15351
|
-
success?: string;
|
|
15352
|
-
}, headers?: {
|
|
15353
|
-
/**
|
|
15354
|
-
* Signature for your request.
|
|
15355
|
-
* @default "[WEB] auto-generated on fly"
|
|
15356
|
-
*/
|
|
15357
|
-
'X-SCX-SIGNED'?: string;
|
|
15358
|
-
/**
|
|
15359
|
-
* UNIX timestamp.
|
|
15360
|
-
* @default "[WEB] auto-generated on fly"
|
|
15361
|
-
*/
|
|
15362
|
-
'X-SCX-TIMESTAMP'?: string;
|
|
15363
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetFundTransactionsResponse, HandleError>>;
|
|
15364
|
-
}
|
|
15365
|
-
export class MarketData<HandleError extends boolean = boolean> {
|
|
15366
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
15367
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
15368
|
-
/**
|
|
15369
|
-
* @description Retrieves a list of symbols and their market data.
|
|
15370
|
-
* @tags Market Data
|
|
15371
|
-
* @name GetSymbolData
|
|
15372
|
-
* @summary Get symbol data
|
|
15373
|
-
* @request GET:/market_data/symbol_data
|
|
15374
|
-
* @secure
|
|
15375
|
-
*/
|
|
15376
|
-
getSymbolData(query?: {
|
|
15377
|
-
/** Filter for underlying asset */
|
|
15378
|
-
underlying?: string;
|
|
15379
|
-
/** Filter for quoted_currency */
|
|
15380
|
-
quoted_currency?: string;
|
|
15381
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetSymbolDataResponse, HandleError>>;
|
|
15382
|
-
/**
|
|
15383
|
-
* @description Retrieves an list of historical data of open, high, low, close, underlying_volume and quoted_volume.
|
|
15384
|
-
* @tags Market Data
|
|
15385
|
-
* @name GetOhlcvData
|
|
15386
|
-
* @summary Get OHLCV data
|
|
15387
|
-
* @request GET:/market_data/ohlcv
|
|
15388
|
-
* @secure
|
|
15389
|
-
*/
|
|
15390
|
-
getOhlcvData(query: {
|
|
15391
|
-
/** Filter for underlying asset */
|
|
15392
|
-
underlying: string;
|
|
15393
|
-
/** Filter for quoted asset */
|
|
15394
|
-
quoted_currency: string;
|
|
15395
|
-
/** Filter for maximum number of data points to be returned */
|
|
15396
|
-
limit?: string;
|
|
15397
|
-
/** Filter for objects before given timestamp */
|
|
15398
|
-
data_end_date?: string;
|
|
15399
|
-
/** Filter for all data(daily `time_frame`) */
|
|
15400
|
-
all_data?: boolean;
|
|
15401
|
-
/** Filter for time_frame */
|
|
15402
|
-
time_frame: ZeroHashGetOhlcvDataParamsTimeFrameEnum;
|
|
15403
|
-
}, headers?: {
|
|
15404
|
-
/**
|
|
15405
|
-
* Signature for your request.
|
|
15406
|
-
* @default "[WEB] auto-generated on fly"
|
|
15407
|
-
*/
|
|
15408
|
-
'X-SCX-SIGNED'?: string;
|
|
15409
|
-
/**
|
|
15410
|
-
* UNIX timestamp.
|
|
15411
|
-
* @default "[WEB] auto-generated on fly"
|
|
15412
|
-
*/
|
|
15413
|
-
'X-SCX-TIMESTAMP'?: string;
|
|
15414
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetOHLCVResponse, HandleError>>;
|
|
15415
|
-
/**
|
|
15416
|
-
* @description Retrieves a list of market news articles filtered using given parameters.
|
|
15417
|
-
* @tags Market Data
|
|
15418
|
-
* @name GetNewsArticles
|
|
15419
|
-
* @summary Get news articles
|
|
15420
|
-
* @request GET:/market_data/news/latest
|
|
15421
|
-
* @secure
|
|
15422
|
-
*/
|
|
15423
|
-
getNewsArticles(query?: {
|
|
15424
|
-
/** Sources (feeds) of news articles, options can be fetched from /news/feeds */
|
|
15425
|
-
news_source?: string;
|
|
15426
|
-
/** Categories of news articles, options can be fetched from /news/categories */
|
|
15427
|
-
categories?: string;
|
|
15428
|
-
/** Categories of news articles to be excluded from result, options can be fetched from /news/categories */
|
|
15429
|
-
exclude_categories?: string;
|
|
15430
|
-
/** UNIX timestamp, is used to fetch articles before the given time */
|
|
15431
|
-
lookback?: string;
|
|
15432
|
-
/** Language of articles to be fetched. Format: `EN` (English) or `PT` (Portuguese) */
|
|
15433
|
-
language?: string;
|
|
15434
|
-
/** Sorting order of news articles. Can be either `popular` or `latest` */
|
|
15435
|
-
sort_by?: string;
|
|
15436
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetLatestNewsResponse, HandleError>>;
|
|
15437
|
-
/**
|
|
15438
|
-
* @description Retrieves a list of available market data feeds, which can be used to query articles.
|
|
15439
|
-
* @tags Market Data
|
|
15440
|
-
* @name GetNewsFeeds
|
|
15441
|
-
* @summary Get news feeds
|
|
15442
|
-
* @request GET:/market_data/news/feeds
|
|
15443
|
-
* @secure
|
|
15444
|
-
*/
|
|
15445
|
-
getNewsFeeds(config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetNewsFeedsResponse, HandleError>>;
|
|
15446
|
-
/**
|
|
15447
|
-
* @description Retrieves a list of available market data categories, which can be used to query articles.
|
|
15448
|
-
* @tags Market Data
|
|
15449
|
-
* @name GetCategories
|
|
15450
|
-
* @summary Get categories
|
|
15451
|
-
* @request GET:/market_data/news/categories
|
|
15452
|
-
* @secure
|
|
15453
|
-
*/
|
|
15454
|
-
getCategories(config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetNewsCategoriesResponse, HandleError>>;
|
|
15455
|
-
}
|
|
15456
15456
|
export class ZeroHashApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
15457
15457
|
readonly config: JwtClientConfig<HandleError>;
|
|
15458
15458
|
accounts: Accounts<HandleError>;
|