@orbis-systems/orbis-api-clients 0.7.14 → 0.7.16

package/dist/zerohash/index.d.ts

@@ -553,6 +553,45 @@ declare class TransfersAcats<HandleError extends boolean = boolean> {
         type?: string;
     }[], config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
 }
+declare class TransfersPositions<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @tags Transfers Positions
+     * @name TransferRequest
+     * @summary Transfer request
+     * @request POST:/transfer/position/request
+     * @secure
+     */
+    transferRequest(data: {
+        deliverFrom?: {
+            /** @example 124 */
+            accountId?: number;
+            /** @example "ABC123456" */
+            accountNumber?: string;
+        };
+        deliverTo?: {
+            /** @example 456 */
+            accountId?: number;
+            /** @example "DEF123456" */
+            accountNumber?: string;
+        };
+        /** @example "NoPurpose|Gift" */
+        purpose?: any;
+        /** @example 1000 */
+        quantity?: any;
+        quote?: {
+            /** @example "IBM" */
+            symbol?: string;
+        };
+        /** @example "" */
+        reason?: any;
+        /** @example "0.0.0.0" */
+        remoteAddr?: any;
+        /** @example "Ultra fast proxy" */
+        remoteDevice?: any;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
+}
 declare class TransfersWires<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -594,6 +633,24 @@ declare class TransfersWires<HandleError extends boolean = boolean> {
         disbursementType?: any;
         /** @example 1234 */
         entryId?: any;
+        intermediary?: {
+            /** @example "{account number}" */
+            account?: string;
+            address?: {
+                /** @example "Central City" */
+                city?: string;
+                /** @example "USA" */
+                country?: string;
+                /** @example "11235" */
+                postalCode?: string;
+                /** @example "ST" */
+                stateProvince?: string;
+                /** @example ["123 Main St"] */
+                streetAddress?: string[];
+            };
+            /** @example "{name on account}" */
+            name?: string;
+        };
         /** @example false */
         international?: any;
         iraDetails?: {
@@ -698,45 +755,6 @@ declare class TransfersJournals<HandleError extends boolean = boolean> {
         transferId?: any;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
 }
-declare class TransfersPositions<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @tags Transfers Positions
-     * @name TransferRequest
-     * @summary Transfer request
-     * @request POST:/transfer/position/request
-     * @secure
-     */
-    transferRequest(data: {
-        deliverFrom?: {
-            /** @example 124 */
-            accountId?: number;
-            /** @example "ABC123456" */
-            accountNumber?: string;
-        };
-        deliverTo?: {
-            /** @example 456 */
-            accountId?: number;
-            /** @example "DEF123456" */
-            accountNumber?: string;
-        };
-        /** @example "NoPurpose|Gift" */
-        purpose?: any;
-        /** @example 1000 */
-        quantity?: any;
-        quote?: {
-            /** @example "IBM" */
-            symbol?: string;
-        };
-        /** @example "" */
-        reason?: any;
-        /** @example "0.0.0.0" */
-        remoteAddr?: any;
-        /** @example "Ultra fast proxy" */
-        remoteDevice?: any;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
-}
 declare class TransfersBank<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -12859,19 +12877,6 @@ export enum ZeroHashGetOhlcvDataParamsTimeFrameEnum {
     Hourly = "hourly",
     Daily = "daily"
 }
-export class Public<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @description Provides the current server time in seconds using Unix timestamp format.
-     * @tags Public
-     * @name GetServerTime
-     * @summary Get server time
-     * @request GET:/time
-     * @secure
-     */
-    getServerTime(config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetTimeResponse, HandleError>>;
-}
 export class Index<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -12901,6 +12906,19 @@ export class Index<HandleError extends boolean = boolean> {
         'X-SCX-TIMESTAMP'?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetIndexResponse, HandleError>>;
 }
+export class Public<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @description Provides the current server time in seconds using Unix timestamp format.
+     * @tags Public
+     * @name GetServerTime
+     * @summary Get server time
+     * @request GET:/time
+     * @secure
+     */
+    getServerTime(config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetTimeResponse, HandleError>>;
+}
 export class Assets<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -13244,6 +13262,49 @@ export class Accounts<HandleError extends boolean = boolean> {
         'X-SCX-TIMESTAMP'?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetRunHistoryResponse, HandleError>>;
 }
+export class Movements<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @description Retrieves the history of each itemized movement that has been applied to all account(s) that the requesting platform has access to. Results are limited to the last 2 months
+     * @tags Movements
+     * @name GetMovements
+     * @summary Get movements
+     * @request GET:/movements
+     * @secure
+     */
+    getMovements(query?: {
+        /** Filters for a specific page (pagination) */
+        page?: string;
+        /** The number of results returned per page, with a maximum of 50 transactions per page */
+        page_size?: string;
+        /** Filters for movements that are tagged with a specific parent_link_id */
+        parent_link_id?: string;
+        /**
+         * The type of movement
+         * @example "final_settlement"
+         */
+        movement_type?: ZeroHashGetMovementsParamsMovementTypeEnum;
+        /**
+         * Transfer type
+         * @example "credit"
+         */
+        transfer_type?: ZeroHashGetMovementsParamsTransferTypeEnum;
+        /** This parameter enables the filtering of movements based on the associated account_id. */
+        account_id?: string;
+    }, headers?: {
+        /**
+         * Signature for your request.
+         * @default "[WEB] auto-generated on fly"
+         */
+        'X-SCX-SIGNED'?: string;
+        /**
+         * UNIX timestamp.
+         * @default "[WEB] auto-generated on fly"
+         */
+        'X-SCX-TIMESTAMP'?: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetMovementsResponse, HandleError>>;
+}
 export class Deposits<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -13522,49 +13583,6 @@ export class Deposits<HandleError extends boolean = boolean> {
         'X-SCX-TIMESTAMP'?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
 }
-export class Movements<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @description Retrieves the history of each itemized movement that has been applied to all account(s) that the requesting platform has access to. Results are limited to the last 2 months
-     * @tags Movements
-     * @name GetMovements
-     * @summary Get movements
-     * @request GET:/movements
-     * @secure
-     */
-    getMovements(query?: {
-        /** Filters for a specific page (pagination) */
-        page?: string;
-        /** The number of results returned per page, with a maximum of 50 transactions per page */
-        page_size?: string;
-        /** Filters for movements that are tagged with a specific parent_link_id */
-        parent_link_id?: string;
-        /**
-         * The type of movement
-         * @example "final_settlement"
-         */
-        movement_type?: ZeroHashGetMovementsParamsMovementTypeEnum;
-        /**
-         * Transfer type
-         * @example "credit"
-         */
-        transfer_type?: ZeroHashGetMovementsParamsTransferTypeEnum;
-        /** This parameter enables the filtering of movements based on the associated account_id. */
-        account_id?: string;
-    }, headers?: {
-        /**
-         * Signature for your request.
-         * @default "[WEB] auto-generated on fly"
-         */
-        'X-SCX-SIGNED'?: string;
-        /**
-         * UNIX timestamp.
-         * @default "[WEB] auto-generated on fly"
-         */
-        'X-SCX-TIMESTAMP'?: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetMovementsResponse, HandleError>>;
-}
 export class Withdrawals<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -15090,6 +15108,156 @@ export class ConvertAndWithdraw<HandleError extends boolean = boolean> {
         'X-SCX-TIMESTAMP'?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostCWExecuteQuoteResponse, HandleError>>;
 }
+export class MarketData<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @description Retrieves a list of symbols and their market data.
+     * @tags Market Data
+     * @name GetSymbolData
+     * @summary Get symbol data
+     * @request GET:/market_data/symbol_data
+     * @secure
+     */
+    getSymbolData(query?: {
+        /** Filter for underlying asset */
+        underlying?: string;
+        /** Filter for quoted_currency */
+        quoted_currency?: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetSymbolDataResponse, HandleError>>;
+    /**
+     * @description Retrieves an list of historical data of open, high, low, close, underlying_volume and quoted_volume.
+     * @tags Market Data
+     * @name GetOhlcvData
+     * @summary Get OHLCV data
+     * @request GET:/market_data/ohlcv
+     * @secure
+     */
+    getOhlcvData(query: {
+        /** Filter for underlying asset */
+        underlying: string;
+        /** Filter for quoted asset */
+        quoted_currency: string;
+        /** Filter for maximum number of data points to be returned */
+        limit?: string;
+        /** Filter for objects before given timestamp */
+        data_end_date?: string;
+        /** Filter for all data(daily `time_frame`) */
+        all_data?: boolean;
+        /** Filter for time_frame */
+        time_frame: ZeroHashGetOhlcvDataParamsTimeFrameEnum;
+    }, headers?: {
+        /**
+         * Signature for your request.
+         * @default "[WEB] auto-generated on fly"
+         */
+        'X-SCX-SIGNED'?: string;
+        /**
+         * UNIX timestamp.
+         * @default "[WEB] auto-generated on fly"
+         */
+        'X-SCX-TIMESTAMP'?: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetOHLCVResponse, HandleError>>;
+    /**
+     * @description Retrieves a list of market news articles filtered using given parameters.
+     * @tags Market Data
+     * @name GetNewsArticles
+     * @summary Get news articles
+     * @request GET:/market_data/news/latest
+     * @secure
+     */
+    getNewsArticles(query?: {
+        /** Sources (feeds) of news articles, options can be fetched from /news/feeds */
+        news_source?: string;
+        /** Categories of news articles, options can be fetched from /news/categories */
+        categories?: string;
+        /** Categories of news articles to be excluded from result, options can be fetched from /news/categories */
+        exclude_categories?: string;
+        /** UNIX timestamp, is used to fetch articles before the given time */
+        lookback?: string;
+        /** Language of articles to be fetched. Format: `EN` (English) or `PT` (Portuguese) */
+        language?: string;
+        /** Sorting order of news articles. Can be either `popular` or `latest` */
+        sort_by?: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetLatestNewsResponse, HandleError>>;
+    /**
+     * @description Retrieves a list of available market data feeds, which can be used to query articles.
+     * @tags Market Data
+     * @name GetNewsFeeds
+     * @summary Get news feeds
+     * @request GET:/market_data/news/feeds
+     * @secure
+     */
+    getNewsFeeds(config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetNewsFeedsResponse, HandleError>>;
+    /**
+     * @description Retrieves a list of available market data categories, which can be used to query articles.
+     * @tags Market Data
+     * @name GetCategories
+     * @summary Get categories
+     * @request GET:/market_data/news/categories
+     * @secure
+     */
+    getCategories(config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetNewsCategoriesResponse, HandleError>>;
+}
+export class Fund<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @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.
+     * @tags Fund
+     * @name GetQuote
+     * @summary Get quote
+     * @request POST:/fund/rfq
+     * @secure
+     */
+    getQuote(data: ZeroHashPostFundRfqBody, headers?: {
+        /**
+         * Signature for your request.
+         * @default "[WEB] auto-generated on fly"
+         */
+        'X-SCX-SIGNED'?: string;
+        /**
+         * UNIX timestamp.
+         * @default "[WEB] auto-generated on fly"
+         */
+        'X-SCX-TIMESTAMP'?: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostFundRfqResponse, HandleError>>;
+    /**
+     * @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.
+     * @tags Fund
+     * @name GetTransactions
+     * @summary Get transactions
+     * @request GET:/fund/transactions
+     * @secure
+     */
+    getTransactions(query?: {
+        /** Participant code of the end customer */
+        participant_code?: string;
+        /** The asset sent on-chain by the end customer in order to fund an account */
+        fund_asset?: string;
+        /** The address provided by Zero Hash that the end customer will send to */
+        deposit_address?: string;
+        /** The Zero Hash-generated unique identifier associated with an executed fund event */
+        fund_id?: string;
+        /** Filters for a specific page (pagination) */
+        page?: string;
+        /** The number of results returned per page, with a maximum of 50 transactions per page */
+        page_size?: string;
+        /** Filters transactions by successful status. This is a boolean field, please specify either `true` or `false` */
+        success?: string;
+    }, headers?: {
+        /**
+         * Signature for your request.
+         * @default "[WEB] auto-generated on fly"
+         */
+        'X-SCX-SIGNED'?: string;
+        /**
+         * UNIX timestamp.
+         * @default "[WEB] auto-generated on fly"
+         */
+        'X-SCX-TIMESTAMP'?: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetFundTransactionsResponse, HandleError>>;
+}
 export class Clob<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -15303,156 +15471,6 @@ export class Clob<HandleError extends boolean = boolean> {
         'X-SCX-TIMESTAMP'?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostTradeStatsResponse, HandleError>>;
 }
-export class MarketData<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @description Retrieves a list of symbols and their market data.
-     * @tags Market Data
-     * @name GetSymbolData
-     * @summary Get symbol data
-     * @request GET:/market_data/symbol_data
-     * @secure
-     */
-    getSymbolData(query?: {
-        /** Filter for underlying asset */
-        underlying?: string;
-        /** Filter for quoted_currency */
-        quoted_currency?: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetSymbolDataResponse, HandleError>>;
-    /**
-     * @description Retrieves an list of historical data of open, high, low, close, underlying_volume and quoted_volume.
-     * @tags Market Data
-     * @name GetOhlcvData
-     * @summary Get OHLCV data
-     * @request GET:/market_data/ohlcv
-     * @secure
-     */
-    getOhlcvData(query: {
-        /** Filter for underlying asset */
-        underlying: string;
-        /** Filter for quoted asset */
-        quoted_currency: string;
-        /** Filter for maximum number of data points to be returned */
-        limit?: string;
-        /** Filter for objects before given timestamp */
-        data_end_date?: string;
-        /** Filter for all data(daily `time_frame`) */
-        all_data?: boolean;
-        /** Filter for time_frame */
-        time_frame: ZeroHashGetOhlcvDataParamsTimeFrameEnum;
-    }, headers?: {
-        /**
-         * Signature for your request.
-         * @default "[WEB] auto-generated on fly"
-         */
-        'X-SCX-SIGNED'?: string;
-        /**
-         * UNIX timestamp.
-         * @default "[WEB] auto-generated on fly"
-         */
-        'X-SCX-TIMESTAMP'?: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetOHLCVResponse, HandleError>>;
-    /**
-     * @description Retrieves a list of market news articles filtered using given parameters.
-     * @tags Market Data
-     * @name GetNewsArticles
-     * @summary Get news articles
-     * @request GET:/market_data/news/latest
-     * @secure
-     */
-    getNewsArticles(query?: {
-        /** Sources (feeds) of news articles, options can be fetched from /news/feeds */
-        news_source?: string;
-        /** Categories of news articles, options can be fetched from /news/categories */
-        categories?: string;
-        /** Categories of news articles to be excluded from result, options can be fetched from /news/categories */
-        exclude_categories?: string;
-        /** UNIX timestamp, is used to fetch articles before the given time */
-        lookback?: string;
-        /** Language of articles to be fetched. Format: `EN` (English) or `PT` (Portuguese) */
-        language?: string;
-        /** Sorting order of news articles. Can be either `popular` or `latest` */
-        sort_by?: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetLatestNewsResponse, HandleError>>;
-    /**
-     * @description Retrieves a list of available market data feeds, which can be used to query articles.
-     * @tags Market Data
-     * @name GetNewsFeeds
-     * @summary Get news feeds
-     * @request GET:/market_data/news/feeds
-     * @secure
-     */
-    getNewsFeeds(config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetNewsFeedsResponse, HandleError>>;
-    /**
-     * @description Retrieves a list of available market data categories, which can be used to query articles.
-     * @tags Market Data
-     * @name GetCategories
-     * @summary Get categories
-     * @request GET:/market_data/news/categories
-     * @secure
-     */
-    getCategories(config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetNewsCategoriesResponse, HandleError>>;
-}
-export class Fund<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @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.
-     * @tags Fund
-     * @name GetQuote
-     * @summary Get quote
-     * @request POST:/fund/rfq
-     * @secure
-     */
-    getQuote(data: ZeroHashPostFundRfqBody, headers?: {
-        /**
-         * Signature for your request.
-         * @default "[WEB] auto-generated on fly"
-         */
-        'X-SCX-SIGNED'?: string;
-        /**
-         * UNIX timestamp.
-         * @default "[WEB] auto-generated on fly"
-         */
-        'X-SCX-TIMESTAMP'?: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostFundRfqResponse, HandleError>>;
-    /**
-     * @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.
-     * @tags Fund
-     * @name GetTransactions
-     * @summary Get transactions
-     * @request GET:/fund/transactions
-     * @secure
-     */
-    getTransactions(query?: {
-        /** Participant code of the end customer */
-        participant_code?: string;
-        /** The asset sent on-chain by the end customer in order to fund an account */
-        fund_asset?: string;
-        /** The address provided by Zero Hash that the end customer will send to */
-        deposit_address?: string;
-        /** The Zero Hash-generated unique identifier associated with an executed fund event */
-        fund_id?: string;
-        /** Filters for a specific page (pagination) */
-        page?: string;
-        /** The number of results returned per page, with a maximum of 50 transactions per page */
-        page_size?: string;
-        /** Filters transactions by successful status. This is a boolean field, please specify either `true` or `false` */
-        success?: string;
-    }, headers?: {
-        /**
-         * Signature for your request.
-         * @default "[WEB] auto-generated on fly"
-         */
-        'X-SCX-SIGNED'?: string;
-        /**
-         * UNIX timestamp.
-         * @default "[WEB] auto-generated on fly"
-         */
-        'X-SCX-TIMESTAMP'?: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetFundTransactionsResponse, HandleError>>;
-}
 export class ZeroHashApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
     readonly config: JwtClientConfig<HandleError>;
     accounts: Accounts<HandleError>;