@orbis-systems/orbis-api-clients 0.7.13 → 0.7.15

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.
Files changed (43) hide show
  1. package/dist/aesmidas/index.d.ts +297 -163
  2. package/dist/aesmidas/index.d.ts.map +1 -1
  3. package/dist/aesmidas/index.esm.js +1 -1
  4. package/dist/aesmidas/index.esm.js.map +1 -1
  5. package/dist/aesmidas/index.js +1 -1
  6. package/dist/aesmidas/index.js.map +1 -1
  7. package/dist/bridgewise/index.d.ts +1034 -882
  8. package/dist/bridgewise/index.d.ts.map +1 -1
  9. package/dist/bridgewise/index.esm.js +1 -1
  10. package/dist/bridgewise/index.esm.js.map +1 -1
  11. package/dist/bridgewise/index.js +1 -1
  12. package/dist/bridgewise/index.js.map +1 -1
  13. package/dist/insight/index.d.ts +1535 -1265
  14. package/dist/insight/index.d.ts.map +1 -1
  15. package/dist/insight/index.esm.js +1 -1
  16. package/dist/insight/index.esm.js.map +1 -1
  17. package/dist/insight/index.js +1 -1
  18. package/dist/insight/index.js.map +1 -1
  19. package/dist/middleware/index.d.ts +141 -72
  20. package/dist/middleware/index.d.ts.map +1 -1
  21. package/dist/middleware/index.esm.js +1 -1
  22. package/dist/middleware/index.esm.js.map +1 -1
  23. package/dist/middleware/index.js +1 -1
  24. package/dist/middleware/index.js.map +1 -1
  25. package/dist/orbis/index.d.ts +3907 -4063
  26. package/dist/orbis/index.d.ts.map +1 -1
  27. package/dist/orbis/index.esm.js +1 -1
  28. package/dist/orbis/index.esm.js.map +1 -1
  29. package/dist/orbis/index.js +1 -1
  30. package/dist/orbis/index.js.map +1 -1
  31. package/dist/uma/index.d.ts +917 -1221
  32. package/dist/uma/index.d.ts.map +1 -1
  33. package/dist/uma/index.esm.js +1 -1
  34. package/dist/uma/index.esm.js.map +1 -1
  35. package/dist/uma/index.js +1 -1
  36. package/dist/uma/index.js.map +1 -1
  37. package/dist/zerohash/index.d.ts +607 -589
  38. package/dist/zerohash/index.d.ts.map +1 -1
  39. package/dist/zerohash/index.esm.js +1 -1
  40. package/dist/zerohash/index.esm.js.map +1 -1
  41. package/dist/zerohash/index.js +1 -1
  42. package/dist/zerohash/index.js.map +1 -1
  43. package/package.json +1 -1
@@ -77,476 +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 TransfersAcats<HandleError extends boolean = boolean> {
81
- protected readonly apiClient: JwtClient<HandleError>;
82
- constructor(apiClient: JwtClient<HandleError>);
83
- /**
84
- * @tags Transfers Acats
85
- * @name Search
86
- * @summary Search
87
- * @request GET:/transfer/acat/search
88
- * @secure
89
- */
90
- search(query?: {
91
- status?: any;
92
- account?: any;
93
- accountId?: any;
94
- requestId?: any;
95
- batchId?: any;
96
- loadAccounts?: any;
97
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
98
- /**
99
- * @tags Transfers Acats
100
- * @name Cancel
101
- * @summary Cancel
102
- * @request POST:/transfer/acat/cancel
103
- * @secure
104
- */
105
- cancel(data: {
106
- /** @example "AC123" */
107
- account?: any;
108
- /** @example 0 */
109
- accountId?: any;
110
- /** @example "{batchId}" */
111
- batchId?: any;
112
- /** @example "something for the record" */
113
- comment?: any;
114
- /** @example "{optional}" */
115
- remoteDevice?: any;
116
- /** @example "{optional}" */
117
- remoteIp?: any;
118
- /** @example "{requestId}" */
119
- requestId?: any;
120
- /** @example "{optional}|Cancelled|Disgarded" */
121
- status?: any;
122
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
123
- /**
124
- * @tags Transfers Acats
125
- * @name InitiateSchedule
126
- * @summary Initiate/Schedule
127
- * @request POST:/transfer/acat/initiate
128
- * @secure
129
- */
130
- initiateSchedule(data: {
131
- account?: {
132
- /** @example 0 */
133
- accountId?: number;
134
- /** @example "AC123" */
135
- accountNumber?: string;
136
- };
137
- /** @example [{"isShort":0,"optionFlag":1,"quantity":1000,"quote":{"cusip":"0A1B2C","symbol":""},"symbol":"ZVZZT","type":"Security | Cash"}] */
138
- assets?: any;
139
- /** @example "{batchId}" */
140
- batchId?: any;
141
- /** @example "something for the record" */
142
- comment?: any;
143
- /** @example "" */
144
- contraAccount?: any;
145
- /** @example "COLLEGE_TAX_ADVANTAGE_529|PENSION_PLAN_401K|TAX_SHELTERED_ANNUITY_403B|AGENCY|BANK_CUSTODY|BENEFICIARY|BENEFICIARY_ROTH_IRA|CORPORATE|CO_TRUSTEE|CUSTODIAN_UGMA|DIRECT_ROLLOVER|COVERDELL_IRA|ESTATE|HEALTH_SAVINGS_ACCOUNT|IRA|JOINT|MEDICAL_SAVINGS_ACCOUNT|OTHER|QUALIFIED_PROFIT_SHARING_PENSION|ROTH_IRA|SIMPLE_IRA|SARSEP|SINGLE|TRUST" */
146
- contraAccountType?: any;
147
- /** @example "" */
148
- contraNumber?: any;
149
- /** @example "" */
150
- contraTitle?: any;
151
- /** @example "" */
152
- participantNumber?: any;
153
- /** @example "" */
154
- primaryTaxId?: any;
155
- /** @example "{optional}" */
156
- remoteDevice?: any;
157
- /** @example "{optional}" */
158
- remoteIp?: any;
159
- /** @example "" */
160
- secondaryTaxId?: any;
161
- /** @example "{optional}|RequestPlaced|Scheduled" */
162
- status?: any;
163
- /** @example "Full|Partial" */
164
- type?: any;
165
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
166
- /**
167
- * @tags Transfers Acats
168
- * @name BulkSchedule
169
- * @summary Bulk schedule
170
- * @request POST:/transfer/acat/schedule
171
- * @secure
172
- */
173
- bulkSchedule(data: {
174
- account?: {
175
- /** @example 0 */
176
- accountId?: number;
177
- /** @example "AC123" */
178
- accountNumber?: string;
179
- };
180
- /** @example [{"quantity":1000,"symbol":"ZVZZT"}] */
181
- assets?: {
182
- /** @example 1000 */
183
- quantity?: number;
184
- /** @example "ZVZZT" */
185
- symbol?: string;
186
- }[];
187
- /** @example "{batchId}" */
188
- batchId?: string;
189
- /** @example "something for the record" */
190
- comment?: string;
191
- /** @example "" */
192
- contraAccount?: string;
193
- /** @example "" */
194
- contraAccountType?: string;
195
- /** @example "" */
196
- contraNumber?: string;
197
- /** @example "" */
198
- contraTitle?: string;
199
- /** @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>>;
440
- }
441
- declare class TransfersJournals<HandleError extends boolean = boolean> {
442
- protected readonly apiClient: JwtClient<HandleError>;
443
- constructor(apiClient: JwtClient<HandleError>);
444
- /**
445
- * @tags Transfers Journals
446
- * @name JournalRequest
447
- * @summary Journal request
448
- * @request POST:/transfer/journal/request
449
- * @secure
450
- */
451
- journalRequest(data: {
452
- /** @example 1000 */
453
- amount?: any;
454
- deliverFrom?: {
455
- /** @example 124 */
456
- accountId?: number;
457
- /** @example "ABC123456" */
458
- accountNumber?: string;
459
- };
460
- deliverTo?: {
461
- /** @example 456 */
462
- accountId?: number;
463
- /** @example "DEF123456" */
464
- accountNumber?: string;
465
- };
466
- /** @example "MM/dd/yyyy HH:mm:ss z" */
467
- deliveryDate?: any;
468
- loa?: {
469
- /** @example "" */
470
- fullName?: string;
471
- /** @example "" */
472
- remoteAddr?: string;
473
- /** @example "" */
474
- remoteDevice?: string;
475
- /** @example "" */
476
- signature?: string;
477
- /** @example "MM/dd/yyyy HH:mm:ss z" */
478
- timestamp?: string;
479
- };
480
- /** @example "NoPurpose|Gift|StockGift" */
481
- purpose?: any;
482
- /** @example "" */
483
- reason?: any;
484
- /** @example "0.0.0.0" */
485
- remoteAddr?: any;
486
- /** @example "Ultra fast proxy" */
487
- remoteDevice?: any;
488
- /** @example "required for StockGift" */
489
- symbol?: any;
490
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
491
- /**
492
- * @tags Transfers Journals
493
- * @name Search
494
- * @summary Search
495
- * @request POST:/transfer/journal/search
496
- * @secure
497
- */
498
- search(data: {
499
- account?: {
500
- /** @example 0 */
501
- accountId?: number;
502
- /** @example "ABC123456" */
503
- accountNumber?: string;
504
- };
505
- /** @example "PLACED|SENT|..." */
506
- status?: any;
507
- /** @example "AB123456" */
508
- transferId?: any;
509
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
510
- }
511
- declare class TransfersPositions<HandleError extends boolean = boolean> {
512
- protected readonly apiClient: JwtClient<HandleError>;
513
- constructor(apiClient: JwtClient<HandleError>);
514
- /**
515
- * @tags Transfers Positions
516
- * @name TransferRequest
517
- * @summary Transfer request
518
- * @request POST:/transfer/position/request
519
- * @secure
520
- */
521
- transferRequest(data: {
522
- deliverFrom?: {
523
- /** @example 124 */
524
- accountId?: number;
525
- /** @example "ABC123456" */
526
- accountNumber?: string;
527
- };
528
- deliverTo?: {
529
- /** @example 456 */
530
- accountId?: number;
531
- /** @example "DEF123456" */
532
- accountNumber?: string;
533
- };
534
- /** @example "NoPurpose|Gift" */
535
- purpose?: any;
536
- /** @example 1000 */
537
- quantity?: any;
538
- quote?: {
539
- /** @example "IBM" */
540
- symbol?: string;
541
- };
542
- /** @example "" */
543
- reason?: any;
544
- /** @example "0.0.0.0" */
545
- remoteAddr?: any;
546
- /** @example "Ultra fast proxy" */
547
- remoteDevice?: any;
548
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
549
- }
550
80
  declare class TransfersRelationships<HandleError extends boolean = boolean> {
551
81
  protected readonly apiClient: JwtClient<HandleError>;
552
82
  constructor(apiClient: JwtClient<HandleError>);
@@ -768,28 +298,260 @@ declare class TransfersRelationships<HandleError extends boolean = boolean> {
768
298
  * @request POST:/transfer/relationship/wire/supplement
769
299
  * @secure
770
300
  */
771
- supplementWire(data: {
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" */
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 TransfersAcats<HandleError extends boolean = boolean> {
424
+ protected readonly apiClient: JwtClient<HandleError>;
425
+ constructor(apiClient: JwtClient<HandleError>);
426
+ /**
427
+ * @tags Transfers Acats
428
+ * @name Search
429
+ * @summary Search
430
+ * @request GET:/transfer/acat/search
431
+ * @secure
432
+ */
433
+ search(query?: {
434
+ status?: any;
435
+ account?: any;
436
+ accountId?: any;
437
+ requestId?: any;
438
+ batchId?: any;
439
+ loadAccounts?: any;
440
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
441
+ /**
442
+ * @tags Transfers Acats
443
+ * @name Cancel
444
+ * @summary Cancel
445
+ * @request POST:/transfer/acat/cancel
446
+ * @secure
447
+ */
448
+ cancel(data: {
449
+ /** @example "AC123" */
450
+ account?: any;
451
+ /** @example 0 */
452
+ accountId?: any;
453
+ /** @example "{batchId}" */
454
+ batchId?: any;
455
+ /** @example "something for the record" */
456
+ comment?: any;
457
+ /** @example "{optional}" */
458
+ remoteDevice?: any;
459
+ /** @example "{optional}" */
460
+ remoteIp?: any;
461
+ /** @example "{requestId}" */
462
+ requestId?: any;
463
+ /** @example "{optional}|Cancelled|Disgarded" */
464
+ status?: any;
465
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
466
+ /**
467
+ * @tags Transfers Acats
468
+ * @name InitiateSchedule
469
+ * @summary Initiate/Schedule
470
+ * @request POST:/transfer/acat/initiate
471
+ * @secure
472
+ */
473
+ initiateSchedule(data: {
474
+ account?: {
475
+ /** @example 0 */
476
+ accountId?: number;
477
+ /** @example "AC123" */
478
+ accountNumber?: string;
479
+ };
480
+ /** @example [{"isShort":0,"optionFlag":1,"quantity":1000,"quote":{"cusip":"0A1B2C","symbol":""},"symbol":"ZVZZT","type":"Security | Cash"}] */
481
+ assets?: any;
482
+ /** @example "{batchId}" */
483
+ batchId?: any;
484
+ /** @example "something for the record" */
485
+ comment?: any;
486
+ /** @example "" */
487
+ contraAccount?: any;
488
+ /** @example "COLLEGE_TAX_ADVANTAGE_529|PENSION_PLAN_401K|TAX_SHELTERED_ANNUITY_403B|AGENCY|BANK_CUSTODY|BENEFICIARY|BENEFICIARY_ROTH_IRA|CORPORATE|CO_TRUSTEE|CUSTODIAN_UGMA|DIRECT_ROLLOVER|COVERDELL_IRA|ESTATE|HEALTH_SAVINGS_ACCOUNT|IRA|JOINT|MEDICAL_SAVINGS_ACCOUNT|OTHER|QUALIFIED_PROFIT_SHARING_PENSION|ROTH_IRA|SIMPLE_IRA|SARSEP|SINGLE|TRUST" */
489
+ contraAccountType?: any;
490
+ /** @example "" */
491
+ contraNumber?: any;
492
+ /** @example "" */
493
+ contraTitle?: any;
494
+ /** @example "" */
495
+ participantNumber?: any;
496
+ /** @example "" */
497
+ primaryTaxId?: any;
498
+ /** @example "{optional}" */
499
+ remoteDevice?: any;
500
+ /** @example "{optional}" */
501
+ remoteIp?: any;
502
+ /** @example "" */
503
+ secondaryTaxId?: any;
504
+ /** @example "{optional}|RequestPlaced|Scheduled" */
505
+ status?: any;
506
+ /** @example "Full|Partial" */
507
+ type?: any;
508
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
509
+ /**
510
+ * @tags Transfers Acats
511
+ * @name BulkSchedule
512
+ * @summary Bulk schedule
513
+ * @request POST:/transfer/acat/schedule
514
+ * @secure
515
+ */
516
+ bulkSchedule(data: {
517
+ account?: {
518
+ /** @example 0 */
519
+ accountId?: number;
520
+ /** @example "AC123" */
790
521
  accountNumber?: string;
791
522
  };
792
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
523
+ /** @example [{"quantity":1000,"symbol":"ZVZZT"}] */
524
+ assets?: {
525
+ /** @example 1000 */
526
+ quantity?: number;
527
+ /** @example "ZVZZT" */
528
+ symbol?: string;
529
+ }[];
530
+ /** @example "{batchId}" */
531
+ batchId?: string;
532
+ /** @example "something for the record" */
533
+ comment?: string;
534
+ /** @example "" */
535
+ contraAccount?: string;
536
+ /** @example "" */
537
+ contraAccountType?: string;
538
+ /** @example "" */
539
+ contraNumber?: string;
540
+ /** @example "" */
541
+ contraTitle?: string;
542
+ /** @example "" */
543
+ participantNumber?: string;
544
+ /** @example "" */
545
+ primaryTaxId?: string;
546
+ /** @example "{optional}" */
547
+ remoteDevice?: string;
548
+ /** @example "{optional}" */
549
+ remoteIp?: string;
550
+ /** @example "" */
551
+ secondaryTaxId?: string;
552
+ /** @example "Full|Partial" */
553
+ type?: string;
554
+ }[], config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
793
555
  }
794
556
  declare class TransfersWires<HandleError extends boolean = boolean> {
795
557
  protected readonly apiClient: JwtClient<HandleError>;
@@ -832,6 +594,24 @@ declare class TransfersWires<HandleError extends boolean = boolean> {
832
594
  disbursementType?: any;
833
595
  /** @example 1234 */
834
596
  entryId?: any;
597
+ intermediary?: {
598
+ /** @example "{account number}" */
599
+ account?: string;
600
+ address?: {
601
+ /** @example "Central City" */
602
+ city?: string;
603
+ /** @example "USA" */
604
+ country?: string;
605
+ /** @example "11235" */
606
+ postalCode?: string;
607
+ /** @example "ST" */
608
+ stateProvince?: string;
609
+ /** @example ["123 Main St"] */
610
+ streetAddress?: string[];
611
+ };
612
+ /** @example "{name on account}" */
613
+ name?: string;
614
+ };
835
615
  /** @example false */
836
616
  international?: any;
837
617
  iraDetails?: {
@@ -853,18 +633,256 @@ declare class TransfersWires<HandleError extends boolean = boolean> {
853
633
  /** @example "ABA|BIC" */
854
634
  type?: string;
855
635
  };
856
- /** @example "" */
857
- name?: string;
858
- /** @example "" */
859
- postalCode?: string;
860
- /** @example "" */
861
- stateProvince?: string;
636
+ /** @example "" */
637
+ name?: string;
638
+ /** @example "" */
639
+ postalCode?: string;
640
+ /** @example "" */
641
+ stateProvince?: string;
642
+ };
643
+ /** @example "0.0.0.0" */
644
+ remoteAddr?: any;
645
+ /** @example "ultra fast browser 1.1" */
646
+ remoteDevice?: any;
647
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
648
+ }
649
+ declare class TransfersJournals<HandleError extends boolean = boolean> {
650
+ protected readonly apiClient: JwtClient<HandleError>;
651
+ constructor(apiClient: JwtClient<HandleError>);
652
+ /**
653
+ * @tags Transfers Journals
654
+ * @name JournalRequest
655
+ * @summary Journal request
656
+ * @request POST:/transfer/journal/request
657
+ * @secure
658
+ */
659
+ journalRequest(data: {
660
+ /** @example 1000 */
661
+ amount?: any;
662
+ deliverFrom?: {
663
+ /** @example 124 */
664
+ accountId?: number;
665
+ /** @example "ABC123456" */
666
+ accountNumber?: string;
667
+ };
668
+ deliverTo?: {
669
+ /** @example 456 */
670
+ accountId?: number;
671
+ /** @example "DEF123456" */
672
+ accountNumber?: string;
673
+ };
674
+ /** @example "MM/dd/yyyy HH:mm:ss z" */
675
+ deliveryDate?: any;
676
+ loa?: {
677
+ /** @example "" */
678
+ fullName?: string;
679
+ /** @example "" */
680
+ remoteAddr?: string;
681
+ /** @example "" */
682
+ remoteDevice?: string;
683
+ /** @example "" */
684
+ signature?: string;
685
+ /** @example "MM/dd/yyyy HH:mm:ss z" */
686
+ timestamp?: string;
687
+ };
688
+ /** @example "NoPurpose|Gift|StockGift" */
689
+ purpose?: any;
690
+ /** @example "" */
691
+ reason?: any;
692
+ /** @example "0.0.0.0" */
693
+ remoteAddr?: any;
694
+ /** @example "Ultra fast proxy" */
695
+ remoteDevice?: any;
696
+ /** @example "required for StockGift" */
697
+ symbol?: any;
698
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
699
+ /**
700
+ * @tags Transfers Journals
701
+ * @name Search
702
+ * @summary Search
703
+ * @request POST:/transfer/journal/search
704
+ * @secure
705
+ */
706
+ search(data: {
707
+ account?: {
708
+ /** @example 0 */
709
+ accountId?: number;
710
+ /** @example "ABC123456" */
711
+ accountNumber?: string;
712
+ };
713
+ /** @example "PLACED|SENT|..." */
714
+ status?: any;
715
+ /** @example "AB123456" */
716
+ transferId?: any;
717
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
718
+ }
719
+ declare class TransfersPositions<HandleError extends boolean = boolean> {
720
+ protected readonly apiClient: JwtClient<HandleError>;
721
+ constructor(apiClient: JwtClient<HandleError>);
722
+ /**
723
+ * @tags Transfers Positions
724
+ * @name TransferRequest
725
+ * @summary Transfer request
726
+ * @request POST:/transfer/position/request
727
+ * @secure
728
+ */
729
+ transferRequest(data: {
730
+ deliverFrom?: {
731
+ /** @example 124 */
732
+ accountId?: number;
733
+ /** @example "ABC123456" */
734
+ accountNumber?: string;
735
+ };
736
+ deliverTo?: {
737
+ /** @example 456 */
738
+ accountId?: number;
739
+ /** @example "DEF123456" */
740
+ accountNumber?: string;
741
+ };
742
+ /** @example "NoPurpose|Gift" */
743
+ purpose?: any;
744
+ /** @example 1000 */
745
+ quantity?: any;
746
+ quote?: {
747
+ /** @example "IBM" */
748
+ symbol?: string;
749
+ };
750
+ /** @example "" */
751
+ reason?: any;
752
+ /** @example "0.0.0.0" */
753
+ remoteAddr?: any;
754
+ /** @example "Ultra fast proxy" */
755
+ remoteDevice?: any;
756
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
757
+ }
758
+ declare class TransfersBank<HandleError extends boolean = boolean> {
759
+ protected readonly apiClient: JwtClient<HandleError>;
760
+ constructor(apiClient: JwtClient<HandleError>);
761
+ /**
762
+ * @tags Transfers Bank
763
+ * @name FundTransfer
764
+ * @summary Fund transfer
765
+ * @request POST:/transfer/bank/{direction}
766
+ * @secure
767
+ */
768
+ fundTransfer(direction: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
769
+ }
770
+ declare class TransfersInstantCashTransfers<HandleError extends boolean = boolean> {
771
+ protected readonly apiClient: JwtClient<HandleError>;
772
+ constructor(apiClient: JwtClient<HandleError>);
773
+ /**
774
+ * @tags Transfers Instant Cash Transfers
775
+ * @name DepositWithdrawal
776
+ * @summary Deposit/Withdrawal
777
+ * @request POST:/transfer/ict/${direction}
778
+ * @secure
779
+ */
780
+ depositWithdrawal(direction: string, data: {
781
+ /** @example "ABC123456" */
782
+ account?: any;
783
+ /** @example 100 */
784
+ amount?: any;
785
+ /** @example "USD" */
786
+ currency?: any;
787
+ originator?: {
788
+ address?: {
789
+ /** @example "Central City" */
790
+ city?: string;
791
+ /** @example "USA" */
792
+ country?: string;
793
+ /** @example "12345" */
794
+ postalCode?: string;
795
+ /** @example "NY" */
796
+ stateProvince?: string;
797
+ /** @example ["123 Main St"] */
798
+ streetAddress?: string[];
799
+ };
800
+ /** @example "John" */
801
+ firstName?: string;
802
+ institution?: {
803
+ /** @example "123456789" */
804
+ accountNumber?: string;
805
+ /** @example "Central City Central Bank" */
806
+ name?: string;
807
+ };
808
+ /** @example "Smith" */
809
+ lastName?: string;
810
+ };
811
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
812
+ /**
813
+ * @tags Transfers Instant Cash Transfers
814
+ * @name DepositWithdrawalV2
815
+ * @summary Deposit/Withdrawal V2
816
+ * @request POST:/transfer/v2/ict/${direction}
817
+ * @secure
818
+ */
819
+ depositWithdrawalV2(direction: string, data: {
820
+ /** @example "AB123456" */
821
+ account?: any;
822
+ /** @example 100.32 */
823
+ amount?: any;
824
+ counterparty?: {
825
+ address?: {
826
+ /** @example "Central City" */
827
+ city?: string;
828
+ /** @example "12345" */
829
+ postalCode?: string;
830
+ /** @example "CC" */
831
+ stateProvince?: string;
832
+ /** @example ["225 Baker St"] */
833
+ streetAddress?: string[];
834
+ };
835
+ /** @example "James" */
836
+ firstName?: string;
837
+ institution?: {
838
+ /** @example "123456" */
839
+ accountNumber?: string;
840
+ /** @example "Royal Central Bank" */
841
+ name?: string;
842
+ };
843
+ /** @example "Bond" */
844
+ lastName?: string;
862
845
  };
863
- /** @example "0.0.0.0" */
846
+ /** @example "USD" */
847
+ currency?: any;
848
+ /** @example "1.1.1.1" */
864
849
  remoteAddr?: any;
865
- /** @example "ultra fast browser 1.1" */
850
+ /** @example "Droid Phone" */
866
851
  remoteDevice?: any;
867
852
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
853
+ /**
854
+ * @tags Transfers Instant Cash Transfers
855
+ * @name ObtainTheReport
856
+ * @summary Obtain the report
857
+ * @request POST:/transfer/reports/obtain
858
+ * @secure
859
+ */
860
+ obtainTheReport(data: {
861
+ /** @example "MM/DD/YYYY HH:MM:SS ZZZ" */
862
+ date?: any;
863
+ /** @example "RETAIL_BANKING" */
864
+ reportType?: any;
865
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
866
+ /**
867
+ * @tags Transfers Instant Cash Transfers
868
+ * @name ListReports
869
+ * @summary List reports
870
+ * @request GET:/transfer/reports
871
+ * @secure
872
+ */
873
+ listReports(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
874
+ }
875
+ declare class TransfersCheques<HandleError extends boolean = boolean> {
876
+ protected readonly apiClient: JwtClient<HandleError>;
877
+ constructor(apiClient: JwtClient<HandleError>);
878
+ /**
879
+ * @tags Transfers Cheques
880
+ * @name Withdrawal
881
+ * @summary Withdrawal
882
+ * @request POST:/transfer/check/outgoing
883
+ * @secure
884
+ */
885
+ withdrawal(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
868
886
  }
869
887
  declare class _Transfers1<HandleError extends boolean = boolean> {
870
888
  protected readonly apiClient: JwtClient<HandleError>;
@@ -14996,97 +15014,6 @@ export class Payments<HandleError extends boolean = boolean> {
14996
15014
  'X-SCX-TIMESTAMP'?: string;
14997
15015
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostPaymentsExecutePaymentResponse, HandleError>>;
14998
15016
  }
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
- }
15090
15017
  export class ConvertAndWithdraw<HandleError extends boolean = boolean> {
15091
15018
  protected readonly apiClient: JwtClient<HandleError>;
15092
15019
  constructor(apiClient: JwtClient<HandleError>);
@@ -15181,6 +15108,97 @@ export class ConvertAndWithdraw<HandleError extends boolean = boolean> {
15181
15108
  'X-SCX-TIMESTAMP'?: string;
15182
15109
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostCWExecuteQuoteResponse, HandleError>>;
15183
15110
  }
15111
+ export class MarketData<HandleError extends boolean = boolean> {
15112
+ protected readonly apiClient: JwtClient<HandleError>;
15113
+ constructor(apiClient: JwtClient<HandleError>);
15114
+ /**
15115
+ * @description Retrieves a list of symbols and their market data.
15116
+ * @tags Market Data
15117
+ * @name GetSymbolData
15118
+ * @summary Get symbol data
15119
+ * @request GET:/market_data/symbol_data
15120
+ * @secure
15121
+ */
15122
+ getSymbolData(query?: {
15123
+ /** Filter for underlying asset */
15124
+ underlying?: string;
15125
+ /** Filter for quoted_currency */
15126
+ quoted_currency?: string;
15127
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetSymbolDataResponse, HandleError>>;
15128
+ /**
15129
+ * @description Retrieves an list of historical data of open, high, low, close, underlying_volume and quoted_volume.
15130
+ * @tags Market Data
15131
+ * @name GetOhlcvData
15132
+ * @summary Get OHLCV data
15133
+ * @request GET:/market_data/ohlcv
15134
+ * @secure
15135
+ */
15136
+ getOhlcvData(query: {
15137
+ /** Filter for underlying asset */
15138
+ underlying: string;
15139
+ /** Filter for quoted asset */
15140
+ quoted_currency: string;
15141
+ /** Filter for maximum number of data points to be returned */
15142
+ limit?: string;
15143
+ /** Filter for objects before given timestamp */
15144
+ data_end_date?: string;
15145
+ /** Filter for all data(daily `time_frame`) */
15146
+ all_data?: boolean;
15147
+ /** Filter for time_frame */
15148
+ time_frame: ZeroHashGetOhlcvDataParamsTimeFrameEnum;
15149
+ }, headers?: {
15150
+ /**
15151
+ * Signature for your request.
15152
+ * @default "[WEB] auto-generated on fly"
15153
+ */
15154
+ 'X-SCX-SIGNED'?: string;
15155
+ /**
15156
+ * UNIX timestamp.
15157
+ * @default "[WEB] auto-generated on fly"
15158
+ */
15159
+ 'X-SCX-TIMESTAMP'?: string;
15160
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetOHLCVResponse, HandleError>>;
15161
+ /**
15162
+ * @description Retrieves a list of market news articles filtered using given parameters.
15163
+ * @tags Market Data
15164
+ * @name GetNewsArticles
15165
+ * @summary Get news articles
15166
+ * @request GET:/market_data/news/latest
15167
+ * @secure
15168
+ */
15169
+ getNewsArticles(query?: {
15170
+ /** Sources (feeds) of news articles, options can be fetched from /news/feeds */
15171
+ news_source?: string;
15172
+ /** Categories of news articles, options can be fetched from /news/categories */
15173
+ categories?: string;
15174
+ /** Categories of news articles to be excluded from result, options can be fetched from /news/categories */
15175
+ exclude_categories?: string;
15176
+ /** UNIX timestamp, is used to fetch articles before the given time */
15177
+ lookback?: string;
15178
+ /** Language of articles to be fetched. Format: `EN` (English) or `PT` (Portuguese) */
15179
+ language?: string;
15180
+ /** Sorting order of news articles. Can be either `popular` or `latest` */
15181
+ sort_by?: string;
15182
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetLatestNewsResponse, HandleError>>;
15183
+ /**
15184
+ * @description Retrieves a list of available market data feeds, which can be used to query articles.
15185
+ * @tags Market Data
15186
+ * @name GetNewsFeeds
15187
+ * @summary Get news feeds
15188
+ * @request GET:/market_data/news/feeds
15189
+ * @secure
15190
+ */
15191
+ getNewsFeeds(config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetNewsFeedsResponse, HandleError>>;
15192
+ /**
15193
+ * @description Retrieves a list of available market data categories, which can be used to query articles.
15194
+ * @tags Market Data
15195
+ * @name GetCategories
15196
+ * @summary Get categories
15197
+ * @request GET:/market_data/news/categories
15198
+ * @secure
15199
+ */
15200
+ getCategories(config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetNewsCategoriesResponse, HandleError>>;
15201
+ }
15184
15202
  export class Fund<HandleError extends boolean = boolean> {
15185
15203
  protected readonly apiClient: JwtClient<HandleError>;
15186
15204
  constructor(apiClient: JwtClient<HandleError>);