@orbis-systems/orbis-api-clients 0.7.10 → 0.7.12
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 +39 -39
- 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 +313 -304
- 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 +774 -521
- 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 +30 -30
- 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 +1501 -1501
- 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 +452 -452
- 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 +563 -563
- 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,250 +77,6 @@ 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
80
|
declare class TransfersInstantAccountVerification<HandleError extends boolean = boolean> {
|
|
325
81
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
326
82
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -400,18 +156,38 @@ declare class TransfersInstantAccountVerification<HandleError extends boolean =
|
|
|
400
156
|
remoteDevice?: any;
|
|
401
157
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
402
158
|
}
|
|
403
|
-
declare class
|
|
159
|
+
declare class TransfersAch<HandleError extends boolean = boolean> {
|
|
404
160
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
405
161
|
constructor(apiClient: JwtClient<HandleError>);
|
|
406
162
|
/**
|
|
407
|
-
* @tags Transfers
|
|
408
|
-
* @name
|
|
409
|
-
* @summary
|
|
410
|
-
* @request
|
|
163
|
+
* @tags Transfers Ach
|
|
164
|
+
* @name Deposit
|
|
165
|
+
* @summary Deposit
|
|
166
|
+
* @request POST:/transfer/ach/deposit
|
|
411
167
|
* @secure
|
|
412
168
|
*/
|
|
413
|
-
|
|
414
|
-
|
|
169
|
+
deposit(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
170
|
+
/**
|
|
171
|
+
* @tags Transfers Ach
|
|
172
|
+
* @name Withdraw
|
|
173
|
+
* @summary Withdraw
|
|
174
|
+
* @request POST:/transfer/ach/withdraw
|
|
175
|
+
* @secure
|
|
176
|
+
*/
|
|
177
|
+
withdraw(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
178
|
+
}
|
|
179
|
+
declare class TransfersAcats<HandleError extends boolean = boolean> {
|
|
180
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
181
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
182
|
+
/**
|
|
183
|
+
* @tags Transfers Acats
|
|
184
|
+
* @name Search
|
|
185
|
+
* @summary Search
|
|
186
|
+
* @request GET:/transfer/acat/search
|
|
187
|
+
* @secure
|
|
188
|
+
*/
|
|
189
|
+
search(query?: {
|
|
190
|
+
status?: any;
|
|
415
191
|
account?: any;
|
|
416
192
|
accountId?: any;
|
|
417
193
|
requestId?: any;
|
|
@@ -533,26 +309,6 @@ declare class TransfersAcats<HandleError extends boolean = boolean> {
|
|
|
533
309
|
type?: string;
|
|
534
310
|
}[], config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
535
311
|
}
|
|
536
|
-
declare class TransfersAch<HandleError extends boolean = boolean> {
|
|
537
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
538
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
539
|
-
/**
|
|
540
|
-
* @tags Transfers Ach
|
|
541
|
-
* @name Deposit
|
|
542
|
-
* @summary Deposit
|
|
543
|
-
* @request POST:/transfer/ach/deposit
|
|
544
|
-
* @secure
|
|
545
|
-
*/
|
|
546
|
-
deposit(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
547
|
-
/**
|
|
548
|
-
* @tags Transfers Ach
|
|
549
|
-
* @name Withdraw
|
|
550
|
-
* @summary Withdraw
|
|
551
|
-
* @request POST:/transfer/ach/withdraw
|
|
552
|
-
* @secure
|
|
553
|
-
*/
|
|
554
|
-
withdraw(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
555
|
-
}
|
|
556
312
|
declare class TransfersWires<HandleError extends boolean = boolean> {
|
|
557
313
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
558
314
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -671,188 +427,432 @@ declare class TransfersJournals<HandleError extends boolean = boolean> {
|
|
|
671
427
|
purpose?: any;
|
|
672
428
|
/** @example "" */
|
|
673
429
|
reason?: any;
|
|
674
|
-
/** @example "0.0.0.0" */
|
|
675
|
-
remoteAddr?: any;
|
|
676
|
-
/** @example "Ultra fast proxy" */
|
|
677
|
-
remoteDevice?: any;
|
|
678
|
-
/** @example "required for StockGift" */
|
|
679
|
-
symbol?: any;
|
|
430
|
+
/** @example "0.0.0.0" */
|
|
431
|
+
remoteAddr?: any;
|
|
432
|
+
/** @example "Ultra fast proxy" */
|
|
433
|
+
remoteDevice?: any;
|
|
434
|
+
/** @example "required for StockGift" */
|
|
435
|
+
symbol?: any;
|
|
436
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
437
|
+
/**
|
|
438
|
+
* @tags Transfers Journals
|
|
439
|
+
* @name Search
|
|
440
|
+
* @summary Search
|
|
441
|
+
* @request POST:/transfer/journal/search
|
|
442
|
+
* @secure
|
|
443
|
+
*/
|
|
444
|
+
search(data: {
|
|
445
|
+
account?: {
|
|
446
|
+
/** @example 0 */
|
|
447
|
+
accountId?: number;
|
|
448
|
+
/** @example "ABC123456" */
|
|
449
|
+
accountNumber?: string;
|
|
450
|
+
};
|
|
451
|
+
/** @example "PLACED|SENT|..." */
|
|
452
|
+
status?: any;
|
|
453
|
+
/** @example "AB123456" */
|
|
454
|
+
transferId?: any;
|
|
455
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
456
|
+
}
|
|
457
|
+
declare class TransfersPositions<HandleError extends boolean = boolean> {
|
|
458
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
459
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
460
|
+
/**
|
|
461
|
+
* @tags Transfers Positions
|
|
462
|
+
* @name TransferRequest
|
|
463
|
+
* @summary Transfer request
|
|
464
|
+
* @request POST:/transfer/position/request
|
|
465
|
+
* @secure
|
|
466
|
+
*/
|
|
467
|
+
transferRequest(data: {
|
|
468
|
+
deliverFrom?: {
|
|
469
|
+
/** @example 124 */
|
|
470
|
+
accountId?: number;
|
|
471
|
+
/** @example "ABC123456" */
|
|
472
|
+
accountNumber?: string;
|
|
473
|
+
};
|
|
474
|
+
deliverTo?: {
|
|
475
|
+
/** @example 456 */
|
|
476
|
+
accountId?: number;
|
|
477
|
+
/** @example "DEF123456" */
|
|
478
|
+
accountNumber?: string;
|
|
479
|
+
};
|
|
480
|
+
/** @example "NoPurpose|Gift" */
|
|
481
|
+
purpose?: any;
|
|
482
|
+
/** @example 1000 */
|
|
483
|
+
quantity?: any;
|
|
484
|
+
quote?: {
|
|
485
|
+
/** @example "IBM" */
|
|
486
|
+
symbol?: string;
|
|
487
|
+
};
|
|
488
|
+
/** @example "" */
|
|
489
|
+
reason?: any;
|
|
490
|
+
/** @example "0.0.0.0" */
|
|
491
|
+
remoteAddr?: any;
|
|
492
|
+
/** @example "Ultra fast proxy" */
|
|
493
|
+
remoteDevice?: any;
|
|
494
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
495
|
+
}
|
|
496
|
+
declare class TransfersBank<HandleError extends boolean = boolean> {
|
|
497
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
498
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
499
|
+
/**
|
|
500
|
+
* @tags Transfers Bank
|
|
501
|
+
* @name FundTransfer
|
|
502
|
+
* @summary Fund transfer
|
|
503
|
+
* @request POST:/transfer/bank/{direction}
|
|
504
|
+
* @secure
|
|
505
|
+
*/
|
|
506
|
+
fundTransfer(direction: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
507
|
+
}
|
|
508
|
+
declare class TransfersInstantCashTransfers<HandleError extends boolean = boolean> {
|
|
509
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
510
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
511
|
+
/**
|
|
512
|
+
* @tags Transfers Instant Cash Transfers
|
|
513
|
+
* @name DepositWithdrawal
|
|
514
|
+
* @summary Deposit/Withdrawal
|
|
515
|
+
* @request POST:/transfer/ict/${direction}
|
|
516
|
+
* @secure
|
|
517
|
+
*/
|
|
518
|
+
depositWithdrawal(direction: string, data: {
|
|
519
|
+
/** @example "ABC123456" */
|
|
520
|
+
account?: any;
|
|
521
|
+
/** @example 100 */
|
|
522
|
+
amount?: any;
|
|
523
|
+
/** @example "USD" */
|
|
524
|
+
currency?: any;
|
|
525
|
+
originator?: {
|
|
526
|
+
address?: {
|
|
527
|
+
/** @example "Central City" */
|
|
528
|
+
city?: string;
|
|
529
|
+
/** @example "USA" */
|
|
530
|
+
country?: string;
|
|
531
|
+
/** @example "12345" */
|
|
532
|
+
postalCode?: string;
|
|
533
|
+
/** @example "NY" */
|
|
534
|
+
stateProvince?: string;
|
|
535
|
+
/** @example ["123 Main St"] */
|
|
536
|
+
streetAddress?: string[];
|
|
537
|
+
};
|
|
538
|
+
/** @example "John" */
|
|
539
|
+
firstName?: string;
|
|
540
|
+
institution?: {
|
|
541
|
+
/** @example "123456789" */
|
|
542
|
+
accountNumber?: string;
|
|
543
|
+
/** @example "Central City Central Bank" */
|
|
544
|
+
name?: string;
|
|
545
|
+
};
|
|
546
|
+
/** @example "Smith" */
|
|
547
|
+
lastName?: string;
|
|
548
|
+
};
|
|
549
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
550
|
+
/**
|
|
551
|
+
* @tags Transfers Instant Cash Transfers
|
|
552
|
+
* @name DepositWithdrawalV2
|
|
553
|
+
* @summary Deposit/Withdrawal V2
|
|
554
|
+
* @request POST:/transfer/v2/ict/${direction}
|
|
555
|
+
* @secure
|
|
556
|
+
*/
|
|
557
|
+
depositWithdrawalV2(direction: string, data: {
|
|
558
|
+
/** @example "AB123456" */
|
|
559
|
+
account?: any;
|
|
560
|
+
/** @example 100.32 */
|
|
561
|
+
amount?: any;
|
|
562
|
+
counterparty?: {
|
|
563
|
+
address?: {
|
|
564
|
+
/** @example "Central City" */
|
|
565
|
+
city?: string;
|
|
566
|
+
/** @example "12345" */
|
|
567
|
+
postalCode?: string;
|
|
568
|
+
/** @example "CC" */
|
|
569
|
+
stateProvince?: string;
|
|
570
|
+
/** @example ["225 Baker St"] */
|
|
571
|
+
streetAddress?: string[];
|
|
572
|
+
};
|
|
573
|
+
/** @example "James" */
|
|
574
|
+
firstName?: string;
|
|
575
|
+
institution?: {
|
|
576
|
+
/** @example "123456" */
|
|
577
|
+
accountNumber?: string;
|
|
578
|
+
/** @example "Royal Central Bank" */
|
|
579
|
+
name?: string;
|
|
580
|
+
};
|
|
581
|
+
/** @example "Bond" */
|
|
582
|
+
lastName?: string;
|
|
583
|
+
};
|
|
584
|
+
/** @example "USD" */
|
|
585
|
+
currency?: any;
|
|
586
|
+
/** @example "1.1.1.1" */
|
|
587
|
+
remoteAddr?: any;
|
|
588
|
+
/** @example "Droid Phone" */
|
|
589
|
+
remoteDevice?: any;
|
|
590
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
591
|
+
/**
|
|
592
|
+
* @tags Transfers Instant Cash Transfers
|
|
593
|
+
* @name ObtainTheReport
|
|
594
|
+
* @summary Obtain the report
|
|
595
|
+
* @request POST:/transfer/reports/obtain
|
|
596
|
+
* @secure
|
|
597
|
+
*/
|
|
598
|
+
obtainTheReport(data: {
|
|
599
|
+
/** @example "MM/DD/YYYY HH:MM:SS ZZZ" */
|
|
600
|
+
date?: any;
|
|
601
|
+
/** @example "RETAIL_BANKING" */
|
|
602
|
+
reportType?: any;
|
|
603
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
604
|
+
/**
|
|
605
|
+
* @tags Transfers Instant Cash Transfers
|
|
606
|
+
* @name ListReports
|
|
607
|
+
* @summary List reports
|
|
608
|
+
* @request GET:/transfer/reports
|
|
609
|
+
* @secure
|
|
610
|
+
*/
|
|
611
|
+
listReports(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
612
|
+
}
|
|
613
|
+
declare class TransfersRelationships<HandleError extends boolean = boolean> {
|
|
614
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
615
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
616
|
+
/**
|
|
617
|
+
* @tags Transfers Relationships
|
|
618
|
+
* @name List
|
|
619
|
+
* @summary List
|
|
620
|
+
* @request GET:/transfer/relationship/list/{account}
|
|
621
|
+
* @secure
|
|
622
|
+
*/
|
|
623
|
+
list(account: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
624
|
+
/**
|
|
625
|
+
* @tags Transfers Relationships
|
|
626
|
+
* @name GetInfo
|
|
627
|
+
* @summary Get Info
|
|
628
|
+
* @request GET:/transfer/relationship/get
|
|
629
|
+
* @secure
|
|
630
|
+
*/
|
|
631
|
+
getInfo(query?: {
|
|
632
|
+
/**
|
|
633
|
+
* Account number
|
|
634
|
+
* @example "ABC123"
|
|
635
|
+
*/
|
|
636
|
+
account?: any;
|
|
637
|
+
/**
|
|
638
|
+
* Desired entry ID
|
|
639
|
+
* @example "123"
|
|
640
|
+
*/
|
|
641
|
+
entryId?: any;
|
|
642
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
643
|
+
/**
|
|
644
|
+
* @tags Transfers Relationships
|
|
645
|
+
* @name PaymentMethods
|
|
646
|
+
* @summary Payment methods
|
|
647
|
+
* @request GET:/transfer/bank/paymentMethods
|
|
648
|
+
* @secure
|
|
649
|
+
*/
|
|
650
|
+
paymentMethods(query?: {
|
|
651
|
+
/** @example "IND" */
|
|
652
|
+
country?: any;
|
|
653
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
654
|
+
/**
|
|
655
|
+
* @tags Transfers Relationships
|
|
656
|
+
* @name PaymentMethodsViaAddress
|
|
657
|
+
* @summary Payment methods (via address)
|
|
658
|
+
* @request POST:/transfer/bank/paymentMethods
|
|
659
|
+
* @secure
|
|
660
|
+
*/
|
|
661
|
+
paymentMethodsViaAddress(data: {
|
|
662
|
+
/** @example "Mumbai" */
|
|
663
|
+
city?: any;
|
|
664
|
+
/** @example "IND" */
|
|
665
|
+
country?: any;
|
|
666
|
+
/** @example "400018" */
|
|
667
|
+
postalCode?: any;
|
|
668
|
+
/** @example "Maharashtra" */
|
|
669
|
+
stateProvince?: any;
|
|
670
|
+
/** @example ["716 /a, Poonam Chem, Dr.annie Besant Road, Opp.atre Mall, Worli"] */
|
|
671
|
+
streetAddress?: any;
|
|
672
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
673
|
+
/**
|
|
674
|
+
* @tags Transfers Relationships
|
|
675
|
+
* @name BankCodes
|
|
676
|
+
* @summary Bank Codes
|
|
677
|
+
* @request GET:/transfer/bank/bankCodes
|
|
678
|
+
* @secure
|
|
679
|
+
*/
|
|
680
|
+
bankCodes(query?: {
|
|
681
|
+
/** @example "IND|MEX" */
|
|
682
|
+
country?: any;
|
|
683
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
684
|
+
/**
|
|
685
|
+
* @tags Transfers Relationships
|
|
686
|
+
* @name BankCodesViaAddress
|
|
687
|
+
* @summary Bank Codes (via address)
|
|
688
|
+
* @request POST:/transfer/bank/bankCodes
|
|
689
|
+
* @secure
|
|
690
|
+
*/
|
|
691
|
+
bankCodesViaAddress(data: {
|
|
692
|
+
/** @example "Mumbai" */
|
|
693
|
+
city?: any;
|
|
694
|
+
/** @example "IND" */
|
|
695
|
+
country?: any;
|
|
696
|
+
/** @example "400018" */
|
|
697
|
+
postalCode?: any;
|
|
698
|
+
/** @example "Maharashtra" */
|
|
699
|
+
stateProvince?: any;
|
|
700
|
+
/** @example ["716 /a, Poonam Chem, Dr.annie Besant Road, Opp.atre Mall, Worli"] */
|
|
701
|
+
streetAddress?: any;
|
|
702
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
703
|
+
/**
|
|
704
|
+
* @tags Transfers Relationships
|
|
705
|
+
* @name Create
|
|
706
|
+
* @summary Create
|
|
707
|
+
* @request POST:/transfer/relationship/create
|
|
708
|
+
* @secure
|
|
709
|
+
*/
|
|
710
|
+
create(data: {
|
|
711
|
+
/** @example "5VA0XXXX" */
|
|
712
|
+
account?: any;
|
|
713
|
+
/** @example "111111" */
|
|
714
|
+
bankAccount?: any;
|
|
715
|
+
/** @example "John Doe" */
|
|
716
|
+
bankAccountOwnerName?: any;
|
|
717
|
+
/** @example "CHECKING" */
|
|
718
|
+
bankAccountType?: any;
|
|
719
|
+
/** @example "010101010" */
|
|
720
|
+
bankRoutingNumber?: any;
|
|
721
|
+
/** @example "Test" */
|
|
722
|
+
nickname?: any;
|
|
723
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
724
|
+
/**
|
|
725
|
+
* @tags Transfers Relationships
|
|
726
|
+
* @name WireInformation
|
|
727
|
+
* @summary Wire information
|
|
728
|
+
* @request POST:/transfer/relationship/wire/create
|
|
729
|
+
* @secure
|
|
730
|
+
*/
|
|
731
|
+
wireInformation(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
732
|
+
/**
|
|
733
|
+
* @tags Transfers Relationships
|
|
734
|
+
* @name BankingRelationship
|
|
735
|
+
* @summary Banking relationship
|
|
736
|
+
* @request POST:/transfer/relationship/bank/create
|
|
737
|
+
* @secure
|
|
738
|
+
*/
|
|
739
|
+
bankingRelationship(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
740
|
+
/**
|
|
741
|
+
* @tags Transfers Relationships
|
|
742
|
+
* @name Approve
|
|
743
|
+
* @summary Approve
|
|
744
|
+
* @request POST:/transfer/relationship/approve
|
|
745
|
+
* @secure
|
|
746
|
+
*/
|
|
747
|
+
approve(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
748
|
+
/**
|
|
749
|
+
* @tags Transfers Relationships
|
|
750
|
+
* @name Cancel
|
|
751
|
+
* @summary Cancel
|
|
752
|
+
* @request POST:/transfer/relationship/cancel/{entryId}
|
|
753
|
+
* @secure
|
|
754
|
+
*/
|
|
755
|
+
cancel(entryId: string, data: {
|
|
756
|
+
/** @example "2QC05208" */
|
|
757
|
+
account?: any;
|
|
758
|
+
/** @example "USER CANCELED" */
|
|
759
|
+
reason?: any;
|
|
680
760
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
681
761
|
/**
|
|
682
|
-
* @tags Transfers
|
|
683
|
-
* @name
|
|
684
|
-
* @summary
|
|
685
|
-
* @request POST:/transfer/
|
|
762
|
+
* @tags Transfers Relationships
|
|
763
|
+
* @name Rename
|
|
764
|
+
* @summary Rename
|
|
765
|
+
* @request POST:/transfer/relationship/rename/{entryId}
|
|
686
766
|
* @secure
|
|
687
767
|
*/
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
accountId?: number;
|
|
692
|
-
/** @example "ABC123456" */
|
|
693
|
-
accountNumber?: string;
|
|
694
|
-
};
|
|
695
|
-
/** @example "PLACED|SENT|..." */
|
|
696
|
-
status?: any;
|
|
697
|
-
/** @example "AB123456" */
|
|
698
|
-
transferId?: any;
|
|
768
|
+
rename(entryId: string, data: {
|
|
769
|
+
/** @example "Citi Checking 2" */
|
|
770
|
+
nickname?: any;
|
|
699
771
|
}, 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>);
|
|
704
772
|
/**
|
|
705
|
-
* @tags Transfers
|
|
706
|
-
* @name
|
|
707
|
-
* @summary
|
|
708
|
-
* @request POST:/transfer/
|
|
773
|
+
* @tags Transfers Relationships
|
|
774
|
+
* @name AdvisorPolicyUpdate
|
|
775
|
+
* @summary Advisor Policy Update
|
|
776
|
+
* @request POST:/transfer/relationship/policy
|
|
709
777
|
* @secure
|
|
710
778
|
*/
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
/** @example
|
|
714
|
-
accountId?: number;
|
|
715
|
-
/** @example "ABC123456" */
|
|
716
|
-
accountNumber?: string;
|
|
717
|
-
};
|
|
718
|
-
deliverTo?: {
|
|
719
|
-
/** @example 456 */
|
|
779
|
+
advisorPolicyUpdate(data: {
|
|
780
|
+
account?: {
|
|
781
|
+
/** @example 0 */
|
|
720
782
|
accountId?: number;
|
|
721
|
-
/** @example "
|
|
783
|
+
/** @example "{optional}" */
|
|
722
784
|
accountNumber?: string;
|
|
723
785
|
};
|
|
724
|
-
/** @example
|
|
725
|
-
|
|
726
|
-
/** @example
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
symbol?: string;
|
|
731
|
-
};
|
|
786
|
+
/** @example 123 */
|
|
787
|
+
entryId?: any;
|
|
788
|
+
/** @example true */
|
|
789
|
+
esigned?: any;
|
|
790
|
+
/** @example "AllowWithdrawal|Disallow" */
|
|
791
|
+
policy?: any;
|
|
732
792
|
/** @example "" */
|
|
733
|
-
reason?: any;
|
|
734
|
-
/** @example "0.0.0.0" */
|
|
735
793
|
remoteAddr?: any;
|
|
736
|
-
/** @example "
|
|
794
|
+
/** @example "" */
|
|
737
795
|
remoteDevice?: any;
|
|
738
796
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
739
|
-
}
|
|
740
|
-
declare class TransfersBank<HandleError extends boolean = boolean> {
|
|
741
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
742
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
743
797
|
/**
|
|
744
|
-
* @tags Transfers
|
|
745
|
-
* @name
|
|
746
|
-
* @summary
|
|
747
|
-
* @request POST:/transfer/
|
|
798
|
+
* @tags Transfers Relationships
|
|
799
|
+
* @name DocumentUpload
|
|
800
|
+
* @summary Document upload
|
|
801
|
+
* @request POST:/transfer/relationship/wire/upload
|
|
748
802
|
* @secure
|
|
749
803
|
*/
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
|
|
804
|
+
documentUpload(data: {
|
|
805
|
+
/**
|
|
806
|
+
* Wire relationship ID
|
|
807
|
+
* @example ""
|
|
808
|
+
*/
|
|
809
|
+
entryId?: string;
|
|
810
|
+
/**
|
|
811
|
+
* Document file
|
|
812
|
+
* @format binary
|
|
813
|
+
*/
|
|
814
|
+
file?: File;
|
|
815
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
755
816
|
/**
|
|
756
|
-
* @tags Transfers
|
|
757
|
-
* @name
|
|
758
|
-
* @summary
|
|
759
|
-
* @request POST:/transfer/
|
|
817
|
+
* @tags Transfers Relationships
|
|
818
|
+
* @name MfaReInitiation
|
|
819
|
+
* @summary 2FA re-initiation
|
|
820
|
+
* @request POST:/transfer/relationship/wire/2fa/reinitiate
|
|
760
821
|
* @secure
|
|
761
822
|
*/
|
|
762
|
-
|
|
763
|
-
/** @example
|
|
764
|
-
|
|
765
|
-
/** @example 100 */
|
|
766
|
-
amount?: any;
|
|
767
|
-
/** @example "USD" */
|
|
768
|
-
currency?: any;
|
|
769
|
-
originator?: {
|
|
770
|
-
address?: {
|
|
771
|
-
/** @example "Central City" */
|
|
772
|
-
city?: string;
|
|
773
|
-
/** @example "USA" */
|
|
774
|
-
country?: string;
|
|
775
|
-
/** @example "12345" */
|
|
776
|
-
postalCode?: string;
|
|
777
|
-
/** @example "NY" */
|
|
778
|
-
stateProvince?: string;
|
|
779
|
-
/** @example ["123 Main St"] */
|
|
780
|
-
streetAddress?: string[];
|
|
781
|
-
};
|
|
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;
|
|
792
|
-
};
|
|
823
|
+
mfaReInitiation(data: {
|
|
824
|
+
/** @example 123 */
|
|
825
|
+
entryId?: any;
|
|
793
826
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
794
827
|
/**
|
|
795
|
-
* @tags Transfers
|
|
796
|
-
* @name
|
|
797
|
-
* @summary
|
|
798
|
-
* @request POST:/transfer/
|
|
828
|
+
* @tags Transfers Relationships
|
|
829
|
+
* @name SupplementWire
|
|
830
|
+
* @summary Supplement wire
|
|
831
|
+
* @request POST:/transfer/relationship/wire/supplement
|
|
799
832
|
* @secure
|
|
800
833
|
*/
|
|
801
|
-
|
|
802
|
-
/** @example
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
/** @example "
|
|
809
|
-
|
|
810
|
-
/** @example "
|
|
811
|
-
|
|
812
|
-
/** @example "CC" */
|
|
813
|
-
stateProvince?: string;
|
|
814
|
-
/** @example ["225 Baker St"] */
|
|
815
|
-
streetAddress?: string[];
|
|
816
|
-
};
|
|
817
|
-
/** @example "James" */
|
|
818
|
-
firstName?: string;
|
|
819
|
-
institution?: {
|
|
820
|
-
/** @example "123456" */
|
|
821
|
-
accountNumber?: string;
|
|
822
|
-
/** @example "Royal Central Bank" */
|
|
823
|
-
name?: string;
|
|
834
|
+
supplementWire(data: {
|
|
835
|
+
/** @example 123456 */
|
|
836
|
+
entryId?: any;
|
|
837
|
+
recipientBank?: {
|
|
838
|
+
/** @example "Capital City" */
|
|
839
|
+
city?: string;
|
|
840
|
+
identifier?: {
|
|
841
|
+
/** @example "AAA-123-2587964" */
|
|
842
|
+
id?: string;
|
|
843
|
+
/** @example "BIC" */
|
|
844
|
+
type?: string;
|
|
824
845
|
};
|
|
825
|
-
/** @example "
|
|
826
|
-
|
|
846
|
+
/** @example "ABC 123" */
|
|
847
|
+
postalCode?: string;
|
|
848
|
+
/** @example "NJ" */
|
|
849
|
+
stateProvince?: string;
|
|
850
|
+
};
|
|
851
|
+
userAccount?: {
|
|
852
|
+
/** @example "AB12345" */
|
|
853
|
+
accountNumber?: string;
|
|
827
854
|
};
|
|
828
|
-
/** @example "USD" */
|
|
829
|
-
currency?: any;
|
|
830
|
-
/** @example "1.1.1.1" */
|
|
831
|
-
remoteAddr?: any;
|
|
832
|
-
/** @example "Droid Phone" */
|
|
833
|
-
remoteDevice?: any;
|
|
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
855
|
}, 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
856
|
}
|
|
857
857
|
declare class TransfersCheques<HandleError extends boolean = boolean> {
|
|
858
858
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -14974,16 +14974,67 @@ export class Payments<HandleError extends boolean = boolean> {
|
|
|
14974
14974
|
* @default "[WEB] auto-generated on fly"
|
|
14975
14975
|
*/
|
|
14976
14976
|
'X-SCX-TIMESTAMP'?: string;
|
|
14977
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostPaymentsRequestForQuoteResponse, HandleError>>;
|
|
14977
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostPaymentsRequestForQuoteResponse, HandleError>>;
|
|
14978
|
+
/**
|
|
14979
|
+
* @description Executes the quote identified by `quote_id`.
|
|
14980
|
+
* @tags Payments
|
|
14981
|
+
* @name ExecuteQuote
|
|
14982
|
+
* @summary Execute quote
|
|
14983
|
+
* @request POST:/payments/execute
|
|
14984
|
+
* @secure
|
|
14985
|
+
*/
|
|
14986
|
+
executeQuote(data: ZeroHashPostPaymentsExecutePaymentRequest, headers?: {
|
|
14987
|
+
/**
|
|
14988
|
+
* Signature for your request.
|
|
14989
|
+
* @default "[WEB] auto-generated on fly"
|
|
14990
|
+
*/
|
|
14991
|
+
'X-SCX-SIGNED'?: string;
|
|
14992
|
+
/**
|
|
14993
|
+
* UNIX timestamp.
|
|
14994
|
+
* @default "[WEB] auto-generated on fly"
|
|
14995
|
+
*/
|
|
14996
|
+
'X-SCX-TIMESTAMP'?: string;
|
|
14997
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostPaymentsExecutePaymentResponse, HandleError>>;
|
|
14998
|
+
}
|
|
14999
|
+
export class MarketData<HandleError extends boolean = boolean> {
|
|
15000
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
15001
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
14978
15002
|
/**
|
|
14979
|
-
* @description
|
|
14980
|
-
* @tags
|
|
14981
|
-
* @name
|
|
14982
|
-
* @summary
|
|
14983
|
-
* @request
|
|
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
|
|
14984
15008
|
* @secure
|
|
14985
15009
|
*/
|
|
14986
|
-
|
|
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?: {
|
|
14987
15038
|
/**
|
|
14988
15039
|
* Signature for your request.
|
|
14989
15040
|
* @default "[WEB] auto-generated on fly"
|
|
@@ -14994,7 +15045,47 @@ export class Payments<HandleError extends boolean = boolean> {
|
|
|
14994
15045
|
* @default "[WEB] auto-generated on fly"
|
|
14995
15046
|
*/
|
|
14996
15047
|
'X-SCX-TIMESTAMP'?: string;
|
|
14997
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
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>>;
|
|
14998
15089
|
}
|
|
14999
15090
|
export class ConvertAndWithdraw<HandleError extends boolean = boolean> {
|
|
15000
15091
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -15090,44 +15181,52 @@ export class ConvertAndWithdraw<HandleError extends boolean = boolean> {
|
|
|
15090
15181
|
'X-SCX-TIMESTAMP'?: string;
|
|
15091
15182
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostCWExecuteQuoteResponse, HandleError>>;
|
|
15092
15183
|
}
|
|
15093
|
-
export class
|
|
15184
|
+
export class Fund<HandleError extends boolean = boolean> {
|
|
15094
15185
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
15095
15186
|
constructor(apiClient: JwtClient<HandleError>);
|
|
15096
15187
|
/**
|
|
15097
|
-
* @description Retrieves a
|
|
15098
|
-
* @tags
|
|
15099
|
-
* @name
|
|
15100
|
-
* @summary Get
|
|
15101
|
-
* @request
|
|
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
|
|
15191
|
+
* @summary Get quote
|
|
15192
|
+
* @request POST:/fund/rfq
|
|
15102
15193
|
* @secure
|
|
15103
15194
|
*/
|
|
15104
|
-
|
|
15105
|
-
/**
|
|
15106
|
-
|
|
15107
|
-
|
|
15108
|
-
|
|
15109
|
-
|
|
15195
|
+
getQuote(data: ZeroHashPostFundRfqBody, headers?: {
|
|
15196
|
+
/**
|
|
15197
|
+
* Signature for your request.
|
|
15198
|
+
* @default "[WEB] auto-generated on fly"
|
|
15199
|
+
*/
|
|
15200
|
+
'X-SCX-SIGNED'?: string;
|
|
15201
|
+
/**
|
|
15202
|
+
* UNIX timestamp.
|
|
15203
|
+
* @default "[WEB] auto-generated on fly"
|
|
15204
|
+
*/
|
|
15205
|
+
'X-SCX-TIMESTAMP'?: string;
|
|
15206
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostFundRfqResponse, HandleError>>;
|
|
15110
15207
|
/**
|
|
15111
|
-
* @description
|
|
15112
|
-
* @tags
|
|
15113
|
-
* @name
|
|
15114
|
-
* @summary Get
|
|
15115
|
-
* @request GET:/
|
|
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
|
|
15116
15213
|
* @secure
|
|
15117
15214
|
*/
|
|
15118
|
-
|
|
15119
|
-
/**
|
|
15120
|
-
|
|
15121
|
-
/**
|
|
15122
|
-
|
|
15123
|
-
/**
|
|
15124
|
-
|
|
15125
|
-
/**
|
|
15126
|
-
|
|
15127
|
-
/**
|
|
15128
|
-
|
|
15129
|
-
/**
|
|
15130
|
-
|
|
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;
|
|
15131
15230
|
}, headers?: {
|
|
15132
15231
|
/**
|
|
15133
15232
|
* Signature for your request.
|
|
@@ -15139,47 +15238,7 @@ export class MarketData<HandleError extends boolean = boolean> {
|
|
|
15139
15238
|
* @default "[WEB] auto-generated on fly"
|
|
15140
15239
|
*/
|
|
15141
15240
|
'X-SCX-TIMESTAMP'?: string;
|
|
15142
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
15143
|
-
/**
|
|
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>>;
|
|
15241
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetFundTransactionsResponse, HandleError>>;
|
|
15183
15242
|
}
|
|
15184
15243
|
export class Clob<HandleError extends boolean = boolean> {
|
|
15185
15244
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -15394,65 +15453,6 @@ export class Clob<HandleError extends boolean = boolean> {
|
|
|
15394
15453
|
'X-SCX-TIMESTAMP'?: string;
|
|
15395
15454
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostTradeStatsResponse, HandleError>>;
|
|
15396
15455
|
}
|
|
15397
|
-
export class Fund<HandleError extends boolean = boolean> {
|
|
15398
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
15399
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
15400
|
-
/**
|
|
15401
|
-
* @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.
|
|
15402
|
-
* @tags Fund
|
|
15403
|
-
* @name GetQuote
|
|
15404
|
-
* @summary Get quote
|
|
15405
|
-
* @request POST:/fund/rfq
|
|
15406
|
-
* @secure
|
|
15407
|
-
*/
|
|
15408
|
-
getQuote(data: ZeroHashPostFundRfqBody, headers?: {
|
|
15409
|
-
/**
|
|
15410
|
-
* Signature for your request.
|
|
15411
|
-
* @default "[WEB] auto-generated on fly"
|
|
15412
|
-
*/
|
|
15413
|
-
'X-SCX-SIGNED'?: string;
|
|
15414
|
-
/**
|
|
15415
|
-
* UNIX timestamp.
|
|
15416
|
-
* @default "[WEB] auto-generated on fly"
|
|
15417
|
-
*/
|
|
15418
|
-
'X-SCX-TIMESTAMP'?: string;
|
|
15419
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostFundRfqResponse, HandleError>>;
|
|
15420
|
-
/**
|
|
15421
|
-
* @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.
|
|
15422
|
-
* @tags Fund
|
|
15423
|
-
* @name GetTransactions
|
|
15424
|
-
* @summary Get transactions
|
|
15425
|
-
* @request GET:/fund/transactions
|
|
15426
|
-
* @secure
|
|
15427
|
-
*/
|
|
15428
|
-
getTransactions(query?: {
|
|
15429
|
-
/** Participant code of the end customer */
|
|
15430
|
-
participant_code?: string;
|
|
15431
|
-
/** The asset sent on-chain by the end customer in order to fund an account */
|
|
15432
|
-
fund_asset?: string;
|
|
15433
|
-
/** The address provided by Zero Hash that the end customer will send to */
|
|
15434
|
-
deposit_address?: string;
|
|
15435
|
-
/** The Zero Hash-generated unique identifier associated with an executed fund event */
|
|
15436
|
-
fund_id?: string;
|
|
15437
|
-
/** Filters for a specific page (pagination) */
|
|
15438
|
-
page?: string;
|
|
15439
|
-
/** The number of results returned per page, with a maximum of 50 transactions per page */
|
|
15440
|
-
page_size?: string;
|
|
15441
|
-
/** Filters transactions by successful status. This is a boolean field, please specify either `true` or `false` */
|
|
15442
|
-
success?: string;
|
|
15443
|
-
}, headers?: {
|
|
15444
|
-
/**
|
|
15445
|
-
* Signature for your request.
|
|
15446
|
-
* @default "[WEB] auto-generated on fly"
|
|
15447
|
-
*/
|
|
15448
|
-
'X-SCX-SIGNED'?: string;
|
|
15449
|
-
/**
|
|
15450
|
-
* UNIX timestamp.
|
|
15451
|
-
* @default "[WEB] auto-generated on fly"
|
|
15452
|
-
*/
|
|
15453
|
-
'X-SCX-TIMESTAMP'?: string;
|
|
15454
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetFundTransactionsResponse, 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>;
|