@orbis-systems/orbis-api-clients 0.7.2 → 0.7.3
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 +132 -132
- 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 +553 -553
- 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 +1156 -1156
- 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 +101 -101
- 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 +4299 -4264
- 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 +660 -660
- 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 +713 -713
- 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,424 @@ 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
|
+
}
|
|
423
|
+
declare class TransfersWires<HandleError extends boolean = boolean> {
|
|
424
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
425
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
426
|
+
/**
|
|
427
|
+
* @tags Transfers Wires
|
|
428
|
+
* @name Outgoing
|
|
429
|
+
* @summary Outgoing
|
|
430
|
+
* @request POST:/transfer/wire/outgoing
|
|
431
|
+
* @secure
|
|
432
|
+
*/
|
|
433
|
+
outgoing(data: {
|
|
434
|
+
/** @example "TRACCOUNT" */
|
|
435
|
+
account?: any;
|
|
436
|
+
/** @example 200 */
|
|
437
|
+
amount?: any;
|
|
438
|
+
beneficiary?: {
|
|
439
|
+
/** @example "AAA012345" */
|
|
440
|
+
account?: string;
|
|
441
|
+
/** @example "CHECKING|SAVINGS" */
|
|
442
|
+
accountType?: string;
|
|
443
|
+
address?: {
|
|
444
|
+
/** @example "Central City" */
|
|
445
|
+
city?: string;
|
|
446
|
+
/** @example "USA" */
|
|
447
|
+
country?: string;
|
|
448
|
+
/** @example "11235" */
|
|
449
|
+
postalCode?: string;
|
|
450
|
+
/** @example "ST" */
|
|
451
|
+
stateProvince?: string;
|
|
452
|
+
/** @example ["123 Main St"] */
|
|
453
|
+
streetAddress?: string[];
|
|
454
|
+
};
|
|
455
|
+
/** @example "John Smith" */
|
|
456
|
+
name?: string;
|
|
457
|
+
/** @example false */
|
|
458
|
+
thirdParty?: boolean;
|
|
459
|
+
};
|
|
460
|
+
/** @example "Partial|Full" */
|
|
461
|
+
disbursementType?: any;
|
|
462
|
+
/** @example 1234 */
|
|
463
|
+
entryId?: any;
|
|
464
|
+
/** @example false */
|
|
465
|
+
international?: any;
|
|
466
|
+
iraDetails?: {
|
|
467
|
+
/** @example "" */
|
|
468
|
+
contributionType?: string;
|
|
469
|
+
/** @example 2020 */
|
|
470
|
+
contributionYear?: number;
|
|
471
|
+
};
|
|
472
|
+
recipientBank?: {
|
|
473
|
+
/** @example "" */
|
|
474
|
+
additionalInformation?: string;
|
|
475
|
+
/** @example "" */
|
|
476
|
+
city?: string;
|
|
477
|
+
/** @example "" */
|
|
478
|
+
country?: string;
|
|
479
|
+
identifier?: {
|
|
480
|
+
/** @example "021202162" */
|
|
481
|
+
id?: string;
|
|
482
|
+
/** @example "ABA|BIC" */
|
|
483
|
+
type?: string;
|
|
484
|
+
};
|
|
485
|
+
/** @example "" */
|
|
486
|
+
name?: string;
|
|
487
|
+
/** @example "" */
|
|
488
|
+
postalCode?: string;
|
|
489
|
+
/** @example "" */
|
|
490
|
+
stateProvince?: string;
|
|
491
|
+
};
|
|
492
|
+
/** @example "0.0.0.0" */
|
|
493
|
+
remoteAddr?: any;
|
|
494
|
+
/** @example "ultra fast browser 1.1" */
|
|
495
|
+
remoteDevice?: any;
|
|
496
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
497
|
+
}
|
|
80
498
|
declare class TransfersAcats<HandleError extends boolean = boolean> {
|
|
81
499
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
82
500
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -197,246 +615,18 @@ declare class TransfersAcats<HandleError extends boolean = boolean> {
|
|
|
197
615
|
/** @example "" */
|
|
198
616
|
contraTitle?: string;
|
|
199
617
|
/** @example "" */
|
|
200
|
-
participantNumber?: string;
|
|
201
|
-
/** @example "" */
|
|
202
|
-
primaryTaxId?: string;
|
|
203
|
-
/** @example "{optional}" */
|
|
204
|
-
remoteDevice?: string;
|
|
205
|
-
/** @example "{optional}" */
|
|
206
|
-
remoteIp?: string;
|
|
207
|
-
/** @example "" */
|
|
208
|
-
secondaryTaxId?: string;
|
|
209
|
-
/** @example "Full|Partial" */
|
|
210
|
-
type?: string;
|
|
211
|
-
}[], config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
212
|
-
}
|
|
213
|
-
declare class TransfersAch<HandleError extends boolean = boolean> {
|
|
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> {
|
|
337
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
338
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
339
|
-
/**
|
|
340
|
-
* @tags Transfers Instant Cash Transfers
|
|
341
|
-
* @name DepositWithdrawal
|
|
342
|
-
* @summary Deposit/Withdrawal
|
|
343
|
-
* @request POST:/transfer/ict/${direction}
|
|
344
|
-
* @secure
|
|
345
|
-
*/
|
|
346
|
-
depositWithdrawal(direction: string, data: {
|
|
347
|
-
/** @example "ABC123456" */
|
|
348
|
-
account?: any;
|
|
349
|
-
/** @example 100 */
|
|
350
|
-
amount?: any;
|
|
351
|
-
/** @example "USD" */
|
|
352
|
-
currency?: any;
|
|
353
|
-
originator?: {
|
|
354
|
-
address?: {
|
|
355
|
-
/** @example "Central City" */
|
|
356
|
-
city?: string;
|
|
357
|
-
/** @example "USA" */
|
|
358
|
-
country?: string;
|
|
359
|
-
/** @example "12345" */
|
|
360
|
-
postalCode?: string;
|
|
361
|
-
/** @example "NY" */
|
|
362
|
-
stateProvince?: string;
|
|
363
|
-
/** @example ["123 Main St"] */
|
|
364
|
-
streetAddress?: string[];
|
|
365
|
-
};
|
|
366
|
-
/** @example "John" */
|
|
367
|
-
firstName?: string;
|
|
368
|
-
institution?: {
|
|
369
|
-
/** @example "123456789" */
|
|
370
|
-
accountNumber?: string;
|
|
371
|
-
/** @example "Central City Central Bank" */
|
|
372
|
-
name?: string;
|
|
373
|
-
};
|
|
374
|
-
/** @example "Smith" */
|
|
375
|
-
lastName?: string;
|
|
376
|
-
};
|
|
377
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
378
|
-
/**
|
|
379
|
-
* @tags Transfers Instant Cash Transfers
|
|
380
|
-
* @name DepositWithdrawalV2
|
|
381
|
-
* @summary Deposit/Withdrawal V2
|
|
382
|
-
* @request POST:/transfer/v2/ict/${direction}
|
|
383
|
-
* @secure
|
|
384
|
-
*/
|
|
385
|
-
depositWithdrawalV2(direction: string, data: {
|
|
386
|
-
/** @example "AB123456" */
|
|
387
|
-
account?: any;
|
|
388
|
-
/** @example 100.32 */
|
|
389
|
-
amount?: any;
|
|
390
|
-
counterparty?: {
|
|
391
|
-
address?: {
|
|
392
|
-
/** @example "Central City" */
|
|
393
|
-
city?: string;
|
|
394
|
-
/** @example "12345" */
|
|
395
|
-
postalCode?: string;
|
|
396
|
-
/** @example "CC" */
|
|
397
|
-
stateProvince?: string;
|
|
398
|
-
/** @example ["225 Baker St"] */
|
|
399
|
-
streetAddress?: string[];
|
|
400
|
-
};
|
|
401
|
-
/** @example "James" */
|
|
402
|
-
firstName?: string;
|
|
403
|
-
institution?: {
|
|
404
|
-
/** @example "123456" */
|
|
405
|
-
accountNumber?: string;
|
|
406
|
-
/** @example "Royal Central Bank" */
|
|
407
|
-
name?: string;
|
|
408
|
-
};
|
|
409
|
-
/** @example "Bond" */
|
|
410
|
-
lastName?: string;
|
|
411
|
-
};
|
|
412
|
-
/** @example "USD" */
|
|
413
|
-
currency?: any;
|
|
414
|
-
/** @example "1.1.1.1" */
|
|
415
|
-
remoteAddr?: any;
|
|
416
|
-
/** @example "Droid Phone" */
|
|
417
|
-
remoteDevice?: any;
|
|
418
|
-
}, 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>>;
|
|
618
|
+
participantNumber?: string;
|
|
619
|
+
/** @example "" */
|
|
620
|
+
primaryTaxId?: string;
|
|
621
|
+
/** @example "{optional}" */
|
|
622
|
+
remoteDevice?: string;
|
|
623
|
+
/** @example "{optional}" */
|
|
624
|
+
remoteIp?: string;
|
|
625
|
+
/** @example "" */
|
|
626
|
+
secondaryTaxId?: string;
|
|
627
|
+
/** @example "Full|Partial" */
|
|
628
|
+
type?: string;
|
|
629
|
+
}[], 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>;
|
|
@@ -547,324 +737,134 @@ declare class TransfersPositions<HandleError extends boolean = boolean> {
|
|
|
547
737
|
remoteDevice?: any;
|
|
548
738
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
549
739
|
}
|
|
550
|
-
declare class
|
|
740
|
+
declare class TransfersBank<HandleError extends boolean = boolean> {
|
|
551
741
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
552
742
|
constructor(apiClient: JwtClient<HandleError>);
|
|
553
743
|
/**
|
|
554
|
-
* @tags Transfers
|
|
555
|
-
* @name
|
|
556
|
-
* @summary
|
|
557
|
-
* @request
|
|
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;
|
|
763
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
764
|
-
/**
|
|
765
|
-
* @tags Transfers Relationships
|
|
766
|
-
* @name SupplementWire
|
|
767
|
-
* @summary Supplement wire
|
|
768
|
-
* @request POST:/transfer/relationship/wire/supplement
|
|
744
|
+
* @tags Transfers Bank
|
|
745
|
+
* @name FundTransfer
|
|
746
|
+
* @summary Fund transfer
|
|
747
|
+
* @request POST:/transfer/bank/{direction}
|
|
769
748
|
* @secure
|
|
770
|
-
*/
|
|
771
|
-
|
|
772
|
-
/** @example 123456 */
|
|
773
|
-
entryId?: any;
|
|
774
|
-
recipientBank?: {
|
|
775
|
-
/** @example "Capital City" */
|
|
776
|
-
city?: string;
|
|
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;
|
|
787
|
-
};
|
|
788
|
-
userAccount?: {
|
|
789
|
-
/** @example "AB12345" */
|
|
790
|
-
accountNumber?: string;
|
|
791
|
-
};
|
|
792
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
749
|
+
*/
|
|
750
|
+
fundTransfer(direction: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
793
751
|
}
|
|
794
|
-
declare class
|
|
752
|
+
declare class TransfersCheques<HandleError extends boolean = boolean> {
|
|
795
753
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
796
754
|
constructor(apiClient: JwtClient<HandleError>);
|
|
797
755
|
/**
|
|
798
|
-
* @tags Transfers
|
|
799
|
-
* @name
|
|
800
|
-
* @summary
|
|
801
|
-
* @request POST:/transfer/
|
|
756
|
+
* @tags Transfers Cheques
|
|
757
|
+
* @name Withdrawal
|
|
758
|
+
* @summary Withdrawal
|
|
759
|
+
* @request POST:/transfer/check/outgoing
|
|
802
760
|
* @secure
|
|
803
761
|
*/
|
|
804
|
-
|
|
805
|
-
|
|
762
|
+
withdrawal(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
763
|
+
}
|
|
764
|
+
declare class TransfersInstantCashTransfers<HandleError extends boolean = boolean> {
|
|
765
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
766
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
767
|
+
/**
|
|
768
|
+
* @tags Transfers Instant Cash Transfers
|
|
769
|
+
* @name DepositWithdrawal
|
|
770
|
+
* @summary Deposit/Withdrawal
|
|
771
|
+
* @request POST:/transfer/ict/${direction}
|
|
772
|
+
* @secure
|
|
773
|
+
*/
|
|
774
|
+
depositWithdrawal(direction: string, data: {
|
|
775
|
+
/** @example "ABC123456" */
|
|
806
776
|
account?: any;
|
|
807
|
-
/** @example
|
|
777
|
+
/** @example 100 */
|
|
808
778
|
amount?: any;
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
/** @example "CHECKING|SAVINGS" */
|
|
813
|
-
accountType?: string;
|
|
779
|
+
/** @example "USD" */
|
|
780
|
+
currency?: any;
|
|
781
|
+
originator?: {
|
|
814
782
|
address?: {
|
|
815
783
|
/** @example "Central City" */
|
|
816
784
|
city?: string;
|
|
817
785
|
/** @example "USA" */
|
|
818
786
|
country?: string;
|
|
819
|
-
/** @example "
|
|
787
|
+
/** @example "12345" */
|
|
820
788
|
postalCode?: string;
|
|
821
|
-
/** @example "
|
|
789
|
+
/** @example "NY" */
|
|
822
790
|
stateProvince?: string;
|
|
823
791
|
/** @example ["123 Main St"] */
|
|
824
792
|
streetAddress?: string[];
|
|
825
793
|
};
|
|
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;
|
|
794
|
+
/** @example "John" */
|
|
795
|
+
firstName?: string;
|
|
796
|
+
institution?: {
|
|
797
|
+
/** @example "123456789" */
|
|
798
|
+
accountNumber?: string;
|
|
799
|
+
/** @example "Central City Central Bank" */
|
|
800
|
+
name?: string;
|
|
801
|
+
};
|
|
802
|
+
/** @example "Smith" */
|
|
803
|
+
lastName?: string;
|
|
842
804
|
};
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
|
|
805
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
806
|
+
/**
|
|
807
|
+
* @tags Transfers Instant Cash Transfers
|
|
808
|
+
* @name DepositWithdrawalV2
|
|
809
|
+
* @summary Deposit/Withdrawal V2
|
|
810
|
+
* @request POST:/transfer/v2/ict/${direction}
|
|
811
|
+
* @secure
|
|
812
|
+
*/
|
|
813
|
+
depositWithdrawalV2(direction: string, data: {
|
|
814
|
+
/** @example "AB123456" */
|
|
815
|
+
account?: any;
|
|
816
|
+
/** @example 100.32 */
|
|
817
|
+
amount?: any;
|
|
818
|
+
counterparty?: {
|
|
819
|
+
address?: {
|
|
820
|
+
/** @example "Central City" */
|
|
821
|
+
city?: string;
|
|
822
|
+
/** @example "12345" */
|
|
823
|
+
postalCode?: string;
|
|
824
|
+
/** @example "CC" */
|
|
825
|
+
stateProvince?: string;
|
|
826
|
+
/** @example ["225 Baker St"] */
|
|
827
|
+
streetAddress?: string[];
|
|
855
828
|
};
|
|
856
|
-
/** @example "" */
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
829
|
+
/** @example "James" */
|
|
830
|
+
firstName?: string;
|
|
831
|
+
institution?: {
|
|
832
|
+
/** @example "123456" */
|
|
833
|
+
accountNumber?: string;
|
|
834
|
+
/** @example "Royal Central Bank" */
|
|
835
|
+
name?: string;
|
|
836
|
+
};
|
|
837
|
+
/** @example "Bond" */
|
|
838
|
+
lastName?: string;
|
|
862
839
|
};
|
|
863
|
-
/** @example "
|
|
840
|
+
/** @example "USD" */
|
|
841
|
+
currency?: any;
|
|
842
|
+
/** @example "1.1.1.1" */
|
|
864
843
|
remoteAddr?: any;
|
|
865
|
-
/** @example "
|
|
844
|
+
/** @example "Droid Phone" */
|
|
866
845
|
remoteDevice?: any;
|
|
867
846
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
847
|
+
/**
|
|
848
|
+
* @tags Transfers Instant Cash Transfers
|
|
849
|
+
* @name ObtainTheReport
|
|
850
|
+
* @summary Obtain the report
|
|
851
|
+
* @request POST:/transfer/reports/obtain
|
|
852
|
+
* @secure
|
|
853
|
+
*/
|
|
854
|
+
obtainTheReport(data: {
|
|
855
|
+
/** @example "MM/DD/YYYY HH:MM:SS ZZZ" */
|
|
856
|
+
date?: any;
|
|
857
|
+
/** @example "RETAIL_BANKING" */
|
|
858
|
+
reportType?: any;
|
|
859
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
860
|
+
/**
|
|
861
|
+
* @tags Transfers Instant Cash Transfers
|
|
862
|
+
* @name ListReports
|
|
863
|
+
* @summary List reports
|
|
864
|
+
* @request GET:/transfer/reports
|
|
865
|
+
* @secure
|
|
866
|
+
*/
|
|
867
|
+
listReports(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>;
|
|
@@ -13055,6 +13055,65 @@ export class Trades<HandleError extends boolean = boolean> {
|
|
|
13055
13055
|
'X-SCX-TIMESTAMP'?: string;
|
|
13056
13056
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetTradeResponse, HandleError>>;
|
|
13057
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?: {
|
|
13075
|
+
/**
|
|
13076
|
+
* Signature for your request.
|
|
13077
|
+
* @default "[WEB] auto-generated on fly"
|
|
13078
|
+
*/
|
|
13079
|
+
'X-SCX-SIGNED'?: string;
|
|
13080
|
+
/**
|
|
13081
|
+
* UNIX timestamp.
|
|
13082
|
+
* @default "[WEB] auto-generated on fly"
|
|
13083
|
+
*/
|
|
13084
|
+
'X-SCX-TIMESTAMP'?: string;
|
|
13085
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetPositionsResponse, HandleError>>;
|
|
13086
|
+
/**
|
|
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}
|
|
13092
|
+
* @secure
|
|
13093
|
+
*/
|
|
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?: {
|
|
13105
|
+
/**
|
|
13106
|
+
* Signature for your request.
|
|
13107
|
+
* @default "[WEB] auto-generated on fly"
|
|
13108
|
+
*/
|
|
13109
|
+
'X-SCX-SIGNED'?: string;
|
|
13110
|
+
/**
|
|
13111
|
+
* UNIX timestamp.
|
|
13112
|
+
* @default "[WEB] auto-generated on fly"
|
|
13113
|
+
*/
|
|
13114
|
+
'X-SCX-TIMESTAMP'?: string;
|
|
13115
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetPlatformPositionsResponse, HandleError>>;
|
|
13116
|
+
}
|
|
13058
13117
|
export class Accounts<HandleError extends boolean = boolean> {
|
|
13059
13118
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
13060
13119
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -13168,70 +13227,11 @@ export class Accounts<HandleError extends boolean = boolean> {
|
|
|
13168
13227
|
* @description Retrieves the history of grouped settlements, deposits, withdrawals and other changes that have been applied to an account to lead up to its current balance.
|
|
13169
13228
|
* @tags Accounts
|
|
13170
13229
|
* @name GetAccountRunHistory
|
|
13171
|
-
* @summary Get account run history
|
|
13172
|
-
* @request GET:/accounts/{account_id}/run_history
|
|
13173
|
-
* @secure
|
|
13174
|
-
*/
|
|
13175
|
-
getAccountRunHistory(accountId: string, headers?: {
|
|
13176
|
-
/**
|
|
13177
|
-
* Signature for your request.
|
|
13178
|
-
* @default "[WEB] auto-generated on fly"
|
|
13179
|
-
*/
|
|
13180
|
-
'X-SCX-SIGNED'?: string;
|
|
13181
|
-
/**
|
|
13182
|
-
* UNIX timestamp.
|
|
13183
|
-
* @default "[WEB] auto-generated on fly"
|
|
13184
|
-
*/
|
|
13185
|
-
'X-SCX-TIMESTAMP'?: string;
|
|
13186
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetRunHistoryResponse, HandleError>>;
|
|
13187
|
-
}
|
|
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}
|
|
13230
|
+
* @summary Get account run history
|
|
13231
|
+
* @request GET:/accounts/{account_id}/run_history
|
|
13222
13232
|
* @secure
|
|
13223
13233
|
*/
|
|
13224
|
-
|
|
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?: {
|
|
13234
|
+
getAccountRunHistory(accountId: string, headers?: {
|
|
13235
13235
|
/**
|
|
13236
13236
|
* Signature for your request.
|
|
13237
13237
|
* @default "[WEB] auto-generated on fly"
|
|
@@ -13242,7 +13242,7 @@ export class Positions<HandleError extends boolean = boolean> {
|
|
|
13242
13242
|
* @default "[WEB] auto-generated on fly"
|
|
13243
13243
|
*/
|
|
13244
13244
|
'X-SCX-TIMESTAMP'?: string;
|
|
13245
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
13245
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetRunHistoryResponse, HandleError>>;
|
|
13246
13246
|
}
|
|
13247
13247
|
export class Deposits<HandleError extends boolean = boolean> {
|
|
13248
13248
|
protected readonly 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,35 +14662,6 @@ 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 Rewards<HandleError extends boolean = boolean> {
|
|
14637
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
14638
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
14639
|
-
/**
|
|
14640
|
-
* @description Completes a transaction involving a designated asset and disperses rewards.
|
|
14641
|
-
* @tags Rewards
|
|
14642
|
-
* @name DisperseRewards
|
|
14643
|
-
* @summary Disperse rewards
|
|
14644
|
-
* @request POST:/rewards
|
|
14645
|
-
* @secure
|
|
14646
|
-
*/
|
|
14647
|
-
disperseRewards(data: ZeroHashPostRewardsBody, headers?: {
|
|
14648
|
-
/**
|
|
14649
|
-
* Signature for your request.
|
|
14650
|
-
* @default "[WEB] auto-generated on fly"
|
|
14651
|
-
*/
|
|
14652
|
-
'X-SCX-SIGNED'?: string;
|
|
14653
|
-
/**
|
|
14654
|
-
* UNIX timestamp.
|
|
14655
|
-
* @default "[WEB] auto-generated on fly"
|
|
14656
|
-
*/
|
|
14657
|
-
'X-SCX-TIMESTAMP'?: string;
|
|
14658
|
-
/**
|
|
14659
|
-
* Optional request ID for idempotency purposes. Required format: [uuid v4](https://www.uuidtools.com/uuid-versions-explained#version-4)
|
|
14660
|
-
* @default "[WEB] auto-generated on fly"
|
|
14661
|
-
*/
|
|
14662
|
-
'X-Request-Id'?: string;
|
|
14663
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostRewardsResponse, HandleError>>;
|
|
14664
|
-
}
|
|
14665
14665
|
export class Payments<HandleError extends boolean = boolean> {
|
|
14666
14666
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
14667
14667
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -14996,6 +14996,97 @@ export class Payments<HandleError extends boolean = boolean> {
|
|
|
14996
14996
|
'X-SCX-TIMESTAMP'?: string;
|
|
14997
14997
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostPaymentsExecutePaymentResponse, HandleError>>;
|
|
14998
14998
|
}
|
|
14999
|
+
export class MarketData<HandleError extends boolean = boolean> {
|
|
15000
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
15001
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
15002
|
+
/**
|
|
15003
|
+
* @description Retrieves a list of symbols and their market data.
|
|
15004
|
+
* @tags Market Data
|
|
15005
|
+
* @name GetSymbolData
|
|
15006
|
+
* @summary Get symbol data
|
|
15007
|
+
* @request GET:/market_data/symbol_data
|
|
15008
|
+
* @secure
|
|
15009
|
+
*/
|
|
15010
|
+
getSymbolData(query?: {
|
|
15011
|
+
/** Filter for underlying asset */
|
|
15012
|
+
underlying?: string;
|
|
15013
|
+
/** Filter for quoted_currency */
|
|
15014
|
+
quoted_currency?: string;
|
|
15015
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetSymbolDataResponse, HandleError>>;
|
|
15016
|
+
/**
|
|
15017
|
+
* @description Retrieves an list of historical data of open, high, low, close, underlying_volume and quoted_volume.
|
|
15018
|
+
* @tags Market Data
|
|
15019
|
+
* @name GetOhlcvData
|
|
15020
|
+
* @summary Get OHLCV data
|
|
15021
|
+
* @request GET:/market_data/ohlcv
|
|
15022
|
+
* @secure
|
|
15023
|
+
*/
|
|
15024
|
+
getOhlcvData(query: {
|
|
15025
|
+
/** Filter for underlying asset */
|
|
15026
|
+
underlying: string;
|
|
15027
|
+
/** Filter for quoted asset */
|
|
15028
|
+
quoted_currency: string;
|
|
15029
|
+
/** Filter for maximum number of data points to be returned */
|
|
15030
|
+
limit?: string;
|
|
15031
|
+
/** Filter for objects before given timestamp */
|
|
15032
|
+
data_end_date?: string;
|
|
15033
|
+
/** Filter for all data(daily `time_frame`) */
|
|
15034
|
+
all_data?: boolean;
|
|
15035
|
+
/** Filter for time_frame */
|
|
15036
|
+
time_frame: ZeroHashGetOhlcvDataParamsTimeFrameEnum;
|
|
15037
|
+
}, headers?: {
|
|
15038
|
+
/**
|
|
15039
|
+
* Signature for your request.
|
|
15040
|
+
* @default "[WEB] auto-generated on fly"
|
|
15041
|
+
*/
|
|
15042
|
+
'X-SCX-SIGNED'?: string;
|
|
15043
|
+
/**
|
|
15044
|
+
* UNIX timestamp.
|
|
15045
|
+
* @default "[WEB] auto-generated on fly"
|
|
15046
|
+
*/
|
|
15047
|
+
'X-SCX-TIMESTAMP'?: string;
|
|
15048
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetOHLCVResponse, HandleError>>;
|
|
15049
|
+
/**
|
|
15050
|
+
* @description Retrieves a list of market news articles filtered using given parameters.
|
|
15051
|
+
* @tags Market Data
|
|
15052
|
+
* @name GetNewsArticles
|
|
15053
|
+
* @summary Get news articles
|
|
15054
|
+
* @request GET:/market_data/news/latest
|
|
15055
|
+
* @secure
|
|
15056
|
+
*/
|
|
15057
|
+
getNewsArticles(query?: {
|
|
15058
|
+
/** Sources (feeds) of news articles, options can be fetched from /news/feeds */
|
|
15059
|
+
news_source?: string;
|
|
15060
|
+
/** Categories of news articles, options can be fetched from /news/categories */
|
|
15061
|
+
categories?: string;
|
|
15062
|
+
/** Categories of news articles to be excluded from result, options can be fetched from /news/categories */
|
|
15063
|
+
exclude_categories?: string;
|
|
15064
|
+
/** UNIX timestamp, is used to fetch articles before the given time */
|
|
15065
|
+
lookback?: string;
|
|
15066
|
+
/** Language of articles to be fetched. Format: `EN` (English) or `PT` (Portuguese) */
|
|
15067
|
+
language?: string;
|
|
15068
|
+
/** Sorting order of news articles. Can be either `popular` or `latest` */
|
|
15069
|
+
sort_by?: string;
|
|
15070
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetLatestNewsResponse, HandleError>>;
|
|
15071
|
+
/**
|
|
15072
|
+
* @description Retrieves a list of available market data feeds, which can be used to query articles.
|
|
15073
|
+
* @tags Market Data
|
|
15074
|
+
* @name GetNewsFeeds
|
|
15075
|
+
* @summary Get news feeds
|
|
15076
|
+
* @request GET:/market_data/news/feeds
|
|
15077
|
+
* @secure
|
|
15078
|
+
*/
|
|
15079
|
+
getNewsFeeds(config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetNewsFeedsResponse, HandleError>>;
|
|
15080
|
+
/**
|
|
15081
|
+
* @description Retrieves a list of available market data categories, which can be used to query articles.
|
|
15082
|
+
* @tags Market Data
|
|
15083
|
+
* @name GetCategories
|
|
15084
|
+
* @summary Get categories
|
|
15085
|
+
* @request GET:/market_data/news/categories
|
|
15086
|
+
* @secure
|
|
15087
|
+
*/
|
|
15088
|
+
getCategories(config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetNewsCategoriesResponse, HandleError>>;
|
|
15089
|
+
}
|
|
14999
15090
|
export class ConvertAndWithdraw<HandleError extends boolean = boolean> {
|
|
15000
15091
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
15001
15092
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -15362,97 +15453,6 @@ export class Fund<HandleError extends boolean = boolean> {
|
|
|
15362
15453
|
'X-SCX-TIMESTAMP'?: string;
|
|
15363
15454
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetFundTransactionsResponse, HandleError>>;
|
|
15364
15455
|
}
|
|
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>;
|