@orbis-systems/orbis-api-clients 0.7.4 → 0.7.6

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 +253 -129
  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 +123 -123
  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 +209 -190
  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 +108 -108
  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 +2865 -2865
  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 +215 -215
  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 +282 -282
  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
@@ -420,138 +420,75 @@ declare class TransfersAch<HandleError extends boolean = boolean> {
420
420
  */
421
421
  withdraw(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
422
422
  }
423
- declare class TransfersAcats<HandleError extends boolean = boolean> {
423
+ declare class TransfersJournals<HandleError extends boolean = boolean> {
424
424
  protected readonly apiClient: JwtClient<HandleError>;
425
425
  constructor(apiClient: JwtClient<HandleError>);
426
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
427
+ * @tags Transfers Journals
428
+ * @name JournalRequest
429
+ * @summary Journal request
430
+ * @request POST:/transfer/journal/request
471
431
  * @secure
472
432
  */
473
- initiateSchedule(data: {
474
- account?: {
475
- /** @example 0 */
433
+ journalRequest(data: {
434
+ /** @example 1000 */
435
+ amount?: any;
436
+ deliverFrom?: {
437
+ /** @example 124 */
476
438
  accountId?: number;
477
- /** @example "AC123" */
439
+ /** @example "ABC123456" */
478
440
  accountNumber?: string;
479
441
  };
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;
442
+ deliverTo?: {
443
+ /** @example 456 */
444
+ accountId?: number;
445
+ /** @example "DEF123456" */
446
+ accountNumber?: string;
447
+ };
448
+ /** @example "MM/dd/yyyy HH:mm:ss z" */
449
+ deliveryDate?: any;
450
+ loa?: {
451
+ /** @example "" */
452
+ fullName?: string;
453
+ /** @example "" */
454
+ remoteAddr?: string;
455
+ /** @example "" */
456
+ remoteDevice?: string;
457
+ /** @example "" */
458
+ signature?: string;
459
+ /** @example "MM/dd/yyyy HH:mm:ss z" */
460
+ timestamp?: string;
461
+ };
462
+ /** @example "NoPurpose|Gift|StockGift" */
463
+ purpose?: any;
496
464
  /** @example "" */
497
- primaryTaxId?: any;
498
- /** @example "{optional}" */
465
+ reason?: any;
466
+ /** @example "0.0.0.0" */
467
+ remoteAddr?: any;
468
+ /** @example "Ultra fast proxy" */
499
469
  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;
470
+ /** @example "required for StockGift" */
471
+ symbol?: any;
508
472
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
509
473
  /**
510
- * @tags Transfers Acats
511
- * @name BulkSchedule
512
- * @summary Bulk schedule
513
- * @request POST:/transfer/acat/schedule
474
+ * @tags Transfers Journals
475
+ * @name Search
476
+ * @summary Search
477
+ * @request POST:/transfer/journal/search
514
478
  * @secure
515
479
  */
516
- bulkSchedule(data: {
480
+ search(data: {
517
481
  account?: {
518
482
  /** @example 0 */
519
483
  accountId?: number;
520
- /** @example "AC123" */
484
+ /** @example "ABC123456" */
521
485
  accountNumber?: string;
522
486
  };
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>>;
487
+ /** @example "PLACED|SENT|..." */
488
+ status?: any;
489
+ /** @example "AB123456" */
490
+ transferId?: any;
491
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
555
492
  }
556
493
  declare class TransfersWires<HandleError extends boolean = boolean> {
557
494
  protected readonly apiClient: JwtClient<HandleError>;
@@ -628,75 +565,150 @@ declare class TransfersWires<HandleError extends boolean = boolean> {
628
565
  remoteDevice?: any;
629
566
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
630
567
  }
631
- declare class TransfersJournals<HandleError extends boolean = boolean> {
568
+ declare class TransfersBank<HandleError extends boolean = boolean> {
632
569
  protected readonly apiClient: JwtClient<HandleError>;
633
570
  constructor(apiClient: JwtClient<HandleError>);
634
571
  /**
635
- * @tags Transfers Journals
636
- * @name JournalRequest
637
- * @summary Journal request
638
- * @request POST:/transfer/journal/request
572
+ * @tags Transfers Bank
573
+ * @name FundTransfer
574
+ * @summary Fund transfer
575
+ * @request POST:/transfer/bank/{direction}
639
576
  * @secure
640
577
  */
641
- journalRequest(data: {
642
- /** @example 1000 */
643
- amount?: any;
644
- deliverFrom?: {
645
- /** @example 124 */
646
- accountId?: number;
647
- /** @example "ABC123456" */
648
- accountNumber?: string;
649
- };
650
- deliverTo?: {
651
- /** @example 456 */
578
+ fundTransfer(direction: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
579
+ }
580
+ declare class TransfersAcats<HandleError extends boolean = boolean> {
581
+ protected readonly apiClient: JwtClient<HandleError>;
582
+ constructor(apiClient: JwtClient<HandleError>);
583
+ /**
584
+ * @tags Transfers Acats
585
+ * @name Search
586
+ * @summary Search
587
+ * @request GET:/transfer/acat/search
588
+ * @secure
589
+ */
590
+ search(query?: {
591
+ status?: any;
592
+ account?: any;
593
+ accountId?: any;
594
+ requestId?: any;
595
+ batchId?: any;
596
+ loadAccounts?: any;
597
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
598
+ /**
599
+ * @tags Transfers Acats
600
+ * @name Cancel
601
+ * @summary Cancel
602
+ * @request POST:/transfer/acat/cancel
603
+ * @secure
604
+ */
605
+ cancel(data: {
606
+ /** @example "AC123" */
607
+ account?: any;
608
+ /** @example 0 */
609
+ accountId?: any;
610
+ /** @example "{batchId}" */
611
+ batchId?: any;
612
+ /** @example "something for the record" */
613
+ comment?: any;
614
+ /** @example "{optional}" */
615
+ remoteDevice?: any;
616
+ /** @example "{optional}" */
617
+ remoteIp?: any;
618
+ /** @example "{requestId}" */
619
+ requestId?: any;
620
+ /** @example "{optional}|Cancelled|Disgarded" */
621
+ status?: any;
622
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
623
+ /**
624
+ * @tags Transfers Acats
625
+ * @name InitiateSchedule
626
+ * @summary Initiate/Schedule
627
+ * @request POST:/transfer/acat/initiate
628
+ * @secure
629
+ */
630
+ initiateSchedule(data: {
631
+ account?: {
632
+ /** @example 0 */
652
633
  accountId?: number;
653
- /** @example "DEF123456" */
634
+ /** @example "AC123" */
654
635
  accountNumber?: string;
655
636
  };
656
- /** @example "MM/dd/yyyy HH:mm:ss z" */
657
- deliveryDate?: any;
658
- loa?: {
659
- /** @example "" */
660
- fullName?: string;
661
- /** @example "" */
662
- remoteAddr?: string;
663
- /** @example "" */
664
- remoteDevice?: string;
665
- /** @example "" */
666
- signature?: string;
667
- /** @example "MM/dd/yyyy HH:mm:ss z" */
668
- timestamp?: string;
669
- };
670
- /** @example "NoPurpose|Gift|StockGift" */
671
- purpose?: any;
637
+ /** @example [{"isShort":0,"optionFlag":1,"quantity":1000,"quote":{"cusip":"0A1B2C","symbol":""},"symbol":"ZVZZT","type":"Security | Cash"}] */
638
+ assets?: any;
639
+ /** @example "{batchId}" */
640
+ batchId?: any;
641
+ /** @example "something for the record" */
642
+ comment?: any;
672
643
  /** @example "" */
673
- reason?: any;
674
- /** @example "0.0.0.0" */
675
- remoteAddr?: any;
676
- /** @example "Ultra fast proxy" */
644
+ contraAccount?: any;
645
+ /** @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" */
646
+ contraAccountType?: any;
647
+ /** @example "" */
648
+ contraNumber?: any;
649
+ /** @example "" */
650
+ contraTitle?: any;
651
+ /** @example "" */
652
+ participantNumber?: any;
653
+ /** @example "" */
654
+ primaryTaxId?: any;
655
+ /** @example "{optional}" */
677
656
  remoteDevice?: any;
678
- /** @example "required for StockGift" */
679
- symbol?: any;
657
+ /** @example "{optional}" */
658
+ remoteIp?: any;
659
+ /** @example "" */
660
+ secondaryTaxId?: any;
661
+ /** @example "{optional}|RequestPlaced|Scheduled" */
662
+ status?: any;
663
+ /** @example "Full|Partial" */
664
+ type?: any;
680
665
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
681
666
  /**
682
- * @tags Transfers Journals
683
- * @name Search
684
- * @summary Search
685
- * @request POST:/transfer/journal/search
667
+ * @tags Transfers Acats
668
+ * @name BulkSchedule
669
+ * @summary Bulk schedule
670
+ * @request POST:/transfer/acat/schedule
686
671
  * @secure
687
672
  */
688
- search(data: {
673
+ bulkSchedule(data: {
689
674
  account?: {
690
675
  /** @example 0 */
691
676
  accountId?: number;
692
- /** @example "ABC123456" */
677
+ /** @example "AC123" */
693
678
  accountNumber?: string;
694
679
  };
695
- /** @example "PLACED|SENT|..." */
696
- status?: any;
697
- /** @example "AB123456" */
698
- transferId?: any;
699
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
680
+ /** @example [{"quantity":1000,"symbol":"ZVZZT"}] */
681
+ assets?: {
682
+ /** @example 1000 */
683
+ quantity?: number;
684
+ /** @example "ZVZZT" */
685
+ symbol?: string;
686
+ }[];
687
+ /** @example "{batchId}" */
688
+ batchId?: string;
689
+ /** @example "something for the record" */
690
+ comment?: string;
691
+ /** @example "" */
692
+ contraAccount?: string;
693
+ /** @example "" */
694
+ contraAccountType?: string;
695
+ /** @example "" */
696
+ contraNumber?: string;
697
+ /** @example "" */
698
+ contraTitle?: string;
699
+ /** @example "" */
700
+ participantNumber?: string;
701
+ /** @example "" */
702
+ primaryTaxId?: string;
703
+ /** @example "{optional}" */
704
+ remoteDevice?: string;
705
+ /** @example "{optional}" */
706
+ remoteIp?: string;
707
+ /** @example "" */
708
+ secondaryTaxId?: string;
709
+ /** @example "Full|Partial" */
710
+ type?: string;
711
+ }[], config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
700
712
  }
701
713
  declare class TransfersPositions<HandleError extends boolean = boolean> {
702
714
  protected readonly apiClient: JwtClient<HandleError>;
@@ -737,18 +749,6 @@ declare class TransfersPositions<HandleError extends boolean = boolean> {
737
749
  remoteDevice?: any;
738
750
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
739
751
  }
740
- declare class TransfersBank<HandleError extends boolean = boolean> {
741
- protected readonly apiClient: JwtClient<HandleError>;
742
- constructor(apiClient: JwtClient<HandleError>);
743
- /**
744
- * @tags Transfers Bank
745
- * @name FundTransfer
746
- * @summary Fund transfer
747
- * @request POST:/transfer/bank/{direction}
748
- * @secure
749
- */
750
- fundTransfer(direction: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
751
- }
752
752
  declare class TransfersInstantCashTransfers<HandleError extends boolean = boolean> {
753
753
  protected readonly apiClient: JwtClient<HandleError>;
754
754
  constructor(apiClient: JwtClient<HandleError>);
@@ -12859,19 +12859,6 @@ export enum ZeroHashGetOhlcvDataParamsTimeFrameEnum {
12859
12859
  Hourly = "hourly",
12860
12860
  Daily = "daily"
12861
12861
  }
12862
- export class Public<HandleError extends boolean = boolean> {
12863
- protected readonly apiClient: JwtClient<HandleError>;
12864
- constructor(apiClient: JwtClient<HandleError>);
12865
- /**
12866
- * @description Provides the current server time in seconds using Unix timestamp format.
12867
- * @tags Public
12868
- * @name GetServerTime
12869
- * @summary Get server time
12870
- * @request GET:/time
12871
- * @secure
12872
- */
12873
- getServerTime(config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetTimeResponse, HandleError>>;
12874
- }
12875
12862
  export class Index<HandleError extends boolean = boolean> {
12876
12863
  protected readonly apiClient: JwtClient<HandleError>;
12877
12864
  constructor(apiClient: JwtClient<HandleError>);
@@ -12901,6 +12888,19 @@ export class Index<HandleError extends boolean = boolean> {
12901
12888
  'X-SCX-TIMESTAMP'?: string;
12902
12889
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetIndexResponse, HandleError>>;
12903
12890
  }
12891
+ export class Public<HandleError extends boolean = boolean> {
12892
+ protected readonly apiClient: JwtClient<HandleError>;
12893
+ constructor(apiClient: JwtClient<HandleError>);
12894
+ /**
12895
+ * @description Provides the current server time in seconds using Unix timestamp format.
12896
+ * @tags Public
12897
+ * @name GetServerTime
12898
+ * @summary Get server time
12899
+ * @request GET:/time
12900
+ * @secure
12901
+ */
12902
+ getServerTime(config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetTimeResponse, HandleError>>;
12903
+ }
12904
12904
  export class Assets<HandleError extends boolean = boolean> {
12905
12905
  protected readonly apiClient: JwtClient<HandleError>;
12906
12906
  constructor(apiClient: JwtClient<HandleError>);
@@ -14662,100 +14662,6 @@ export class Awards<HandleError extends boolean = boolean> {
14662
14662
  'X-SCX-TIMESTAMP'?: string;
14663
14663
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostAwardsDistributeResponse, HandleError>>;
14664
14664
  }
14665
- export class ConvertAndWithdraw<HandleError extends boolean = boolean> {
14666
- protected readonly apiClient: JwtClient<HandleError>;
14667
- constructor(apiClient: JwtClient<HandleError>);
14668
- /**
14669
- * @description Retrieves a quote for the purchase of an asset and the network fees associated with an eminent and automatic withdrawal of the asset.
14670
- * @tags Convert and Withdraw
14671
- * @name GetQuote
14672
- * @summary Get quote
14673
- * @request GET:/convert_withdraw/rfq
14674
- * @secure
14675
- */
14676
- getQuote(query: {
14677
- /** Allows platforms to specify the side of the quote */
14678
- side: ZeroHashGetQuoteParams2SideEnum;
14679
- /** Allows platforms to specify the underlying asset */
14680
- underlying: ZeroHashUnderlyingCurrency;
14681
- /** Allows platforms to specify the quoted asset */
14682
- quoted_currency: ZeroHashQuotedCurrency;
14683
- /** The `quantity` of the `underlying` asset requested in the quote */
14684
- quantity?: string;
14685
- /** The `total` of the `quoted_currency` asset requested in the quote */
14686
- total?: string;
14687
- /** The participant requesting a quote to buy or sell an asset */
14688
- participant_code?: string;
14689
- /** The account_label that's used to fund the trade */
14690
- account_label?: string;
14691
- /** The on-chain address where the withdrawal should be sent */
14692
- withdrawal_address: string;
14693
- /**
14694
- * Allows platforms to specify if fees are inclusive
14695
- * This parameter is only applicable for requests made by `total`
14696
- */
14697
- fee_inclusive?: boolean;
14698
- /** Allows the platform to define the quote spread in basis points */
14699
- spread?: string;
14700
- /** The destination tag or memo ID associated with the transaction. If the asset is EOS, XLM or XRP and no_destination_tag is false, then this is required */
14701
- destination_tag?: string;
14702
- /** Whether or not the specific withdrawal and destination address requires a destination tag. If the asset is EOS, XLM or XRP, this field is required. Note: Zero Hash requires that no_destination_tag be false for EOS */
14703
- no_destination_tag?: string;
14704
- }, headers?: {
14705
- /**
14706
- * Signature for your request.
14707
- * @default "[WEB] auto-generated on fly"
14708
- */
14709
- 'X-SCX-SIGNED'?: string;
14710
- /**
14711
- * UNIX timestamp.
14712
- * @default "[WEB] auto-generated on fly"
14713
- */
14714
- 'X-SCX-TIMESTAMP'?: string;
14715
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetRequestForCWQuoteResponse, HandleError>>;
14716
- /**
14717
- * @description Retrieves a quote for the purchase of an asset and the network fees associated with an eminent and automatic withdrawal of the asset.
14718
- * @tags Convert and Withdraw
14719
- * @name GetQuote2
14720
- * @summary Get quote
14721
- * @request POST:/convert_withdraw/rfq
14722
- * @originalName getQuote
14723
- * @duplicate
14724
- * @secure
14725
- */
14726
- getQuote2(data: ZeroHashPostCWRequestForQuoteBody, headers?: {
14727
- /**
14728
- * Signature for your request.
14729
- * @default "[WEB] auto-generated on fly"
14730
- */
14731
- 'X-SCX-SIGNED'?: string;
14732
- /**
14733
- * UNIX timestamp.
14734
- * @default "[WEB] auto-generated on fly"
14735
- */
14736
- 'X-SCX-TIMESTAMP'?: string;
14737
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetRequestForCWQuoteResponse, HandleError>>;
14738
- /**
14739
- * @description Executes a quote. The underlying asset will be purchased and automatically withdrawn. You can take the `withdrawal_request_id` from the response and then query `GET /withdrawals/requests/id` endpoint to view the status of the withdrawal.
14740
- * @tags Convert and Withdraw
14741
- * @name ExecuteQuote
14742
- * @summary Execute quote
14743
- * @request POST:/convert_withdraw/execute
14744
- * @secure
14745
- */
14746
- executeQuote(data: ZeroHashPostCWExecuteQuoteBody, headers?: {
14747
- /**
14748
- * Signature for your request.
14749
- * @default "[WEB] auto-generated on fly"
14750
- */
14751
- 'X-SCX-SIGNED'?: string;
14752
- /**
14753
- * UNIX timestamp.
14754
- * @default "[WEB] auto-generated on fly"
14755
- */
14756
- 'X-SCX-TIMESTAMP'?: string;
14757
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostCWExecuteQuoteResponse, HandleError>>;
14758
- }
14759
14665
  export class Payments<HandleError extends boolean = boolean> {
14760
14666
  protected readonly apiClient: JwtClient<HandleError>;
14761
14667
  constructor(apiClient: JwtClient<HandleError>);
@@ -15090,6 +14996,100 @@ export class Payments<HandleError extends boolean = boolean> {
15090
14996
  'X-SCX-TIMESTAMP'?: string;
15091
14997
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostPaymentsExecutePaymentResponse, HandleError>>;
15092
14998
  }
14999
+ export class ConvertAndWithdraw<HandleError extends boolean = boolean> {
15000
+ protected readonly apiClient: JwtClient<HandleError>;
15001
+ constructor(apiClient: JwtClient<HandleError>);
15002
+ /**
15003
+ * @description Retrieves a quote for the purchase of an asset and the network fees associated with an eminent and automatic withdrawal of the asset.
15004
+ * @tags Convert and Withdraw
15005
+ * @name GetQuote
15006
+ * @summary Get quote
15007
+ * @request GET:/convert_withdraw/rfq
15008
+ * @secure
15009
+ */
15010
+ getQuote(query: {
15011
+ /** Allows platforms to specify the side of the quote */
15012
+ side: ZeroHashGetQuoteParams2SideEnum;
15013
+ /** Allows platforms to specify the underlying asset */
15014
+ underlying: ZeroHashUnderlyingCurrency;
15015
+ /** Allows platforms to specify the quoted asset */
15016
+ quoted_currency: ZeroHashQuotedCurrency;
15017
+ /** The `quantity` of the `underlying` asset requested in the quote */
15018
+ quantity?: string;
15019
+ /** The `total` of the `quoted_currency` asset requested in the quote */
15020
+ total?: string;
15021
+ /** The participant requesting a quote to buy or sell an asset */
15022
+ participant_code?: string;
15023
+ /** The account_label that's used to fund the trade */
15024
+ account_label?: string;
15025
+ /** The on-chain address where the withdrawal should be sent */
15026
+ withdrawal_address: string;
15027
+ /**
15028
+ * Allows platforms to specify if fees are inclusive
15029
+ * This parameter is only applicable for requests made by `total`
15030
+ */
15031
+ fee_inclusive?: boolean;
15032
+ /** Allows the platform to define the quote spread in basis points */
15033
+ spread?: string;
15034
+ /** The destination tag or memo ID associated with the transaction. If the asset is EOS, XLM or XRP and no_destination_tag is false, then this is required */
15035
+ destination_tag?: string;
15036
+ /** Whether or not the specific withdrawal and destination address requires a destination tag. If the asset is EOS, XLM or XRP, this field is required. Note: Zero Hash requires that no_destination_tag be false for EOS */
15037
+ no_destination_tag?: string;
15038
+ }, headers?: {
15039
+ /**
15040
+ * Signature for your request.
15041
+ * @default "[WEB] auto-generated on fly"
15042
+ */
15043
+ 'X-SCX-SIGNED'?: string;
15044
+ /**
15045
+ * UNIX timestamp.
15046
+ * @default "[WEB] auto-generated on fly"
15047
+ */
15048
+ 'X-SCX-TIMESTAMP'?: string;
15049
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetRequestForCWQuoteResponse, HandleError>>;
15050
+ /**
15051
+ * @description Retrieves a quote for the purchase of an asset and the network fees associated with an eminent and automatic withdrawal of the asset.
15052
+ * @tags Convert and Withdraw
15053
+ * @name GetQuote2
15054
+ * @summary Get quote
15055
+ * @request POST:/convert_withdraw/rfq
15056
+ * @originalName getQuote
15057
+ * @duplicate
15058
+ * @secure
15059
+ */
15060
+ getQuote2(data: ZeroHashPostCWRequestForQuoteBody, headers?: {
15061
+ /**
15062
+ * Signature for your request.
15063
+ * @default "[WEB] auto-generated on fly"
15064
+ */
15065
+ 'X-SCX-SIGNED'?: string;
15066
+ /**
15067
+ * UNIX timestamp.
15068
+ * @default "[WEB] auto-generated on fly"
15069
+ */
15070
+ 'X-SCX-TIMESTAMP'?: string;
15071
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetRequestForCWQuoteResponse, HandleError>>;
15072
+ /**
15073
+ * @description Executes a quote. The underlying asset will be purchased and automatically withdrawn. You can take the `withdrawal_request_id` from the response and then query `GET /withdrawals/requests/id` endpoint to view the status of the withdrawal.
15074
+ * @tags Convert and Withdraw
15075
+ * @name ExecuteQuote
15076
+ * @summary Execute quote
15077
+ * @request POST:/convert_withdraw/execute
15078
+ * @secure
15079
+ */
15080
+ executeQuote(data: ZeroHashPostCWExecuteQuoteBody, headers?: {
15081
+ /**
15082
+ * Signature for your request.
15083
+ * @default "[WEB] auto-generated on fly"
15084
+ */
15085
+ 'X-SCX-SIGNED'?: string;
15086
+ /**
15087
+ * UNIX timestamp.
15088
+ * @default "[WEB] auto-generated on fly"
15089
+ */
15090
+ 'X-SCX-TIMESTAMP'?: string;
15091
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostCWExecuteQuoteResponse, HandleError>>;
15092
+ }
15093
15093
  export class MarketData<HandleError extends boolean = boolean> {
15094
15094
  protected readonly apiClient: JwtClient<HandleError>;
15095
15095
  constructor(apiClient: JwtClient<HandleError>);