@orbis-systems/orbis-api-clients 0.7.9 → 0.7.10

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 +38 -29
  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 +521 -521
  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 +392 -385
  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 +34 -34
  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 +994 -994
  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 +274 -274
  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 +150 -150
  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
@@ -400,26 +400,6 @@ declare class TransfersInstantAccountVerification<HandleError extends boolean =
400
400
  remoteDevice?: any;
401
401
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
402
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
403
  declare class TransfersAcats<HandleError extends boolean = boolean> {
424
404
  protected readonly apiClient: JwtClient<HandleError>;
425
405
  constructor(apiClient: JwtClient<HandleError>);
@@ -553,6 +533,26 @@ declare class TransfersAcats<HandleError extends boolean = boolean> {
553
533
  type?: string;
554
534
  }[], config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
555
535
  }
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
556
  declare class TransfersWires<HandleError extends boolean = boolean> {
557
557
  protected readonly apiClient: JwtClient<HandleError>;
558
558
  constructor(apiClient: JwtClient<HandleError>);
@@ -14996,97 +14996,6 @@ export class Payments<HandleError extends boolean = boolean> {
14996
14996
  'X-SCX-TIMESTAMP'?: string;
14997
14997
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostPaymentsExecutePaymentResponse, HandleError>>;
14998
14998
  }
14999
- export class MarketData<HandleError extends boolean = boolean> {
15000
- protected readonly apiClient: JwtClient<HandleError>;
15001
- constructor(apiClient: JwtClient<HandleError>);
15002
- /**
15003
- * @description Retrieves a list of symbols and their market data.
15004
- * @tags Market Data
15005
- * @name GetSymbolData
15006
- * @summary Get symbol data
15007
- * @request GET:/market_data/symbol_data
15008
- * @secure
15009
- */
15010
- getSymbolData(query?: {
15011
- /** Filter for underlying asset */
15012
- underlying?: string;
15013
- /** Filter for quoted_currency */
15014
- quoted_currency?: string;
15015
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetSymbolDataResponse, HandleError>>;
15016
- /**
15017
- * @description Retrieves an list of historical data of open, high, low, close, underlying_volume and quoted_volume.
15018
- * @tags Market Data
15019
- * @name GetOhlcvData
15020
- * @summary Get OHLCV data
15021
- * @request GET:/market_data/ohlcv
15022
- * @secure
15023
- */
15024
- getOhlcvData(query: {
15025
- /** Filter for underlying asset */
15026
- underlying: string;
15027
- /** Filter for quoted asset */
15028
- quoted_currency: string;
15029
- /** Filter for maximum number of data points to be returned */
15030
- limit?: string;
15031
- /** Filter for objects before given timestamp */
15032
- data_end_date?: string;
15033
- /** Filter for all data(daily `time_frame`) */
15034
- all_data?: boolean;
15035
- /** Filter for time_frame */
15036
- time_frame: ZeroHashGetOhlcvDataParamsTimeFrameEnum;
15037
- }, headers?: {
15038
- /**
15039
- * Signature for your request.
15040
- * @default "[WEB] auto-generated on fly"
15041
- */
15042
- 'X-SCX-SIGNED'?: string;
15043
- /**
15044
- * UNIX timestamp.
15045
- * @default "[WEB] auto-generated on fly"
15046
- */
15047
- 'X-SCX-TIMESTAMP'?: string;
15048
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetOHLCVResponse, HandleError>>;
15049
- /**
15050
- * @description Retrieves a list of market news articles filtered using given parameters.
15051
- * @tags Market Data
15052
- * @name GetNewsArticles
15053
- * @summary Get news articles
15054
- * @request GET:/market_data/news/latest
15055
- * @secure
15056
- */
15057
- getNewsArticles(query?: {
15058
- /** Sources (feeds) of news articles, options can be fetched from /news/feeds */
15059
- news_source?: string;
15060
- /** Categories of news articles, options can be fetched from /news/categories */
15061
- categories?: string;
15062
- /** Categories of news articles to be excluded from result, options can be fetched from /news/categories */
15063
- exclude_categories?: string;
15064
- /** UNIX timestamp, is used to fetch articles before the given time */
15065
- lookback?: string;
15066
- /** Language of articles to be fetched. Format: `EN` (English) or `PT` (Portuguese) */
15067
- language?: string;
15068
- /** Sorting order of news articles. Can be either `popular` or `latest` */
15069
- sort_by?: string;
15070
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetLatestNewsResponse, HandleError>>;
15071
- /**
15072
- * @description Retrieves a list of available market data feeds, which can be used to query articles.
15073
- * @tags Market Data
15074
- * @name GetNewsFeeds
15075
- * @summary Get news feeds
15076
- * @request GET:/market_data/news/feeds
15077
- * @secure
15078
- */
15079
- getNewsFeeds(config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetNewsFeedsResponse, HandleError>>;
15080
- /**
15081
- * @description Retrieves a list of available market data categories, which can be used to query articles.
15082
- * @tags Market Data
15083
- * @name GetCategories
15084
- * @summary Get categories
15085
- * @request GET:/market_data/news/categories
15086
- * @secure
15087
- */
15088
- getCategories(config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetNewsCategoriesResponse, HandleError>>;
15089
- }
15090
14999
  export class ConvertAndWithdraw<HandleError extends boolean = boolean> {
15091
15000
  protected readonly apiClient: JwtClient<HandleError>;
15092
15001
  constructor(apiClient: JwtClient<HandleError>);
@@ -15181,52 +15090,44 @@ export class ConvertAndWithdraw<HandleError extends boolean = boolean> {
15181
15090
  'X-SCX-TIMESTAMP'?: string;
15182
15091
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostCWExecuteQuoteResponse, HandleError>>;
15183
15092
  }
15184
- export class Fund<HandleError extends boolean = boolean> {
15093
+ export class MarketData<HandleError extends boolean = boolean> {
15185
15094
  protected readonly apiClient: JwtClient<HandleError>;
15186
15095
  constructor(apiClient: JwtClient<HandleError>);
15187
15096
  /**
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
15097
+ * @description Retrieves a list of symbols and their market data.
15098
+ * @tags Market Data
15099
+ * @name GetSymbolData
15100
+ * @summary Get symbol data
15101
+ * @request GET:/market_data/symbol_data
15193
15102
  * @secure
15194
15103
  */
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>>;
15104
+ getSymbolData(query?: {
15105
+ /** Filter for underlying asset */
15106
+ underlying?: string;
15107
+ /** Filter for quoted_currency */
15108
+ quoted_currency?: string;
15109
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetSymbolDataResponse, HandleError>>;
15207
15110
  /**
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
15111
+ * @description Retrieves an list of historical data of open, high, low, close, underlying_volume and quoted_volume.
15112
+ * @tags Market Data
15113
+ * @name GetOhlcvData
15114
+ * @summary Get OHLCV data
15115
+ * @request GET:/market_data/ohlcv
15213
15116
  * @secure
15214
15117
  */
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;
15118
+ getOhlcvData(query: {
15119
+ /** Filter for underlying asset */
15120
+ underlying: string;
15121
+ /** Filter for quoted asset */
15122
+ quoted_currency: string;
15123
+ /** Filter for maximum number of data points to be returned */
15124
+ limit?: string;
15125
+ /** Filter for objects before given timestamp */
15126
+ data_end_date?: string;
15127
+ /** Filter for all data(daily `time_frame`) */
15128
+ all_data?: boolean;
15129
+ /** Filter for time_frame */
15130
+ time_frame: ZeroHashGetOhlcvDataParamsTimeFrameEnum;
15230
15131
  }, headers?: {
15231
15132
  /**
15232
15133
  * Signature for your request.
@@ -15238,7 +15139,47 @@ export class Fund<HandleError extends boolean = boolean> {
15238
15139
  * @default "[WEB] auto-generated on fly"
15239
15140
  */
15240
15141
  'X-SCX-TIMESTAMP'?: string;
15241
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetFundTransactionsResponse, HandleError>>;
15142
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetOHLCVResponse, HandleError>>;
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>>;
15242
15183
  }
15243
15184
  export class Clob<HandleError extends boolean = boolean> {
15244
15185
  protected readonly apiClient: JwtClient<HandleError>;
@@ -15453,6 +15394,65 @@ export class Clob<HandleError extends boolean = boolean> {
15453
15394
  'X-SCX-TIMESTAMP'?: string;
15454
15395
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostTradeStatsResponse, HandleError>>;
15455
15396
  }
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>;