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

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 +157 -33
  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 +118 -118
  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 +92 -89
  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 +809 -809
  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 +365 -365
  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 +107 -107
  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
@@ -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>);