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

package/dist/zerohash/index.d.ts

@@ -420,81 +420,6 @@ declare class TransfersAch<HandleError extends boolean = boolean> {
      */
     withdraw(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
 }
-declare class TransfersWires<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @tags Transfers Wires
-     * @name Outgoing
-     * @summary Outgoing
-     * @request POST:/transfer/wire/outgoing
-     * @secure
-     */
-    outgoing(data: {
-        /** @example "TRACCOUNT" */
-        account?: any;
-        /** @example 200 */
-        amount?: any;
-        beneficiary?: {
-            /** @example "AAA012345" */
-            account?: string;
-            /** @example "CHECKING|SAVINGS" */
-            accountType?: 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 "John Smith" */
-            name?: string;
-            /** @example false */
-            thirdParty?: boolean;
-        };
-        /** @example "Partial|Full" */
-        disbursementType?: any;
-        /** @example 1234 */
-        entryId?: any;
-        /** @example false */
-        international?: any;
-        iraDetails?: {
-            /** @example "" */
-            contributionType?: string;
-            /** @example 2020 */
-            contributionYear?: number;
-        };
-        recipientBank?: {
-            /** @example "" */
-            additionalInformation?: string;
-            /** @example "" */
-            city?: string;
-            /** @example "" */
-            country?: string;
-            identifier?: {
-                /** @example "021202162" */
-                id?: string;
-                /** @example "ABA|BIC" */
-                type?: string;
-            };
-            /** @example "" */
-            name?: string;
-            /** @example "" */
-            postalCode?: string;
-            /** @example "" */
-            stateProvince?: string;
-        };
-        /** @example "0.0.0.0" */
-        remoteAddr?: any;
-        /** @example "ultra fast browser 1.1" */
-        remoteDevice?: any;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
-}
 declare class TransfersAcats<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -628,6 +553,81 @@ declare class TransfersAcats<HandleError extends boolean = boolean> {
         type?: string;
     }[], config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
 }
+declare class TransfersWires<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @tags Transfers Wires
+     * @name Outgoing
+     * @summary Outgoing
+     * @request POST:/transfer/wire/outgoing
+     * @secure
+     */
+    outgoing(data: {
+        /** @example "TRACCOUNT" */
+        account?: any;
+        /** @example 200 */
+        amount?: any;
+        beneficiary?: {
+            /** @example "AAA012345" */
+            account?: string;
+            /** @example "CHECKING|SAVINGS" */
+            accountType?: 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 "John Smith" */
+            name?: string;
+            /** @example false */
+            thirdParty?: boolean;
+        };
+        /** @example "Partial|Full" */
+        disbursementType?: any;
+        /** @example 1234 */
+        entryId?: any;
+        /** @example false */
+        international?: any;
+        iraDetails?: {
+            /** @example "" */
+            contributionType?: string;
+            /** @example 2020 */
+            contributionYear?: number;
+        };
+        recipientBank?: {
+            /** @example "" */
+            additionalInformation?: string;
+            /** @example "" */
+            city?: string;
+            /** @example "" */
+            country?: string;
+            identifier?: {
+                /** @example "021202162" */
+                id?: string;
+                /** @example "ABA|BIC" */
+                type?: string;
+            };
+            /** @example "" */
+            name?: string;
+            /** @example "" */
+            postalCode?: string;
+            /** @example "" */
+            stateProvince?: string;
+        };
+        /** @example "0.0.0.0" */
+        remoteAddr?: any;
+        /** @example "ultra fast browser 1.1" */
+        remoteDevice?: any;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
+}
 declare class TransfersJournals<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -749,18 +749,6 @@ declare class TransfersBank<HandleError extends boolean = boolean> {
      */
     fundTransfer(direction: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
 }
-declare class TransfersCheques<HandleError extends boolean = boolean> {
-    protected readonly apiClient: JwtClient<HandleError>;
-    constructor(apiClient: JwtClient<HandleError>);
-    /**
-     * @tags Transfers Cheques
-     * @name Withdrawal
-     * @summary Withdrawal
-     * @request POST:/transfer/check/outgoing
-     * @secure
-     */
-    withdrawal(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
-}
 declare class TransfersInstantCashTransfers<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -866,6 +854,18 @@ declare class TransfersInstantCashTransfers<HandleError extends boolean = boolea
      */
     listReports(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
 }
+declare class TransfersCheques<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @tags Transfers Cheques
+     * @name Withdrawal
+     * @summary Withdrawal
+     * @request POST:/transfer/check/outgoing
+     * @secure
+     */
+    withdrawal(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
+}
 declare class _Transfers1<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     relationships: TransfersRelationships<HandleError>;
@@ -14662,6 +14662,100 @@ export class Awards<HandleError extends boolean = boolean> {
         'X-SCX-TIMESTAMP'?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostAwardsDistributeResponse, HandleError>>;
 }
+export class ConvertAndWithdraw<HandleError extends boolean = boolean> {
+    protected readonly apiClient: JwtClient<HandleError>;
+    constructor(apiClient: JwtClient<HandleError>);
+    /**
+     * @description Retrieves a quote for the purchase of an asset and the network fees associated with an eminent and automatic withdrawal of the asset.
+     * @tags Convert and Withdraw
+     * @name GetQuote
+     * @summary Get quote
+     * @request GET:/convert_withdraw/rfq
+     * @secure
+     */
+    getQuote(query: {
+        /** Allows platforms to specify the side of the quote */
+        side: ZeroHashGetQuoteParams2SideEnum;
+        /** Allows platforms to specify the underlying asset */
+        underlying: ZeroHashUnderlyingCurrency;
+        /** Allows platforms to specify the quoted asset */
+        quoted_currency: ZeroHashQuotedCurrency;
+        /** The `quantity` of the `underlying` asset requested in the quote */
+        quantity?: string;
+        /** The `total` of the `quoted_currency` asset requested in the quote */
+        total?: string;
+        /** The participant requesting a quote to buy or sell an asset */
+        participant_code?: string;
+        /** The account_label that's used to fund the trade */
+        account_label?: string;
+        /** The on-chain address where the withdrawal should be sent */
+        withdrawal_address: string;
+        /**
+         * Allows platforms to specify if fees are inclusive
+         * This parameter is only applicable for requests made by `total`
+         */
+        fee_inclusive?: boolean;
+        /** Allows the platform to define the quote spread in basis points */
+        spread?: string;
+        /** 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 */
+        destination_tag?: string;
+        /** 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 */
+        no_destination_tag?: 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<ZeroHashGetRequestForCWQuoteResponse, HandleError>>;
+    /**
+     * @description Retrieves a quote for the purchase of an asset and the network fees associated with an eminent and automatic withdrawal of the asset.
+     * @tags Convert and Withdraw
+     * @name GetQuote2
+     * @summary Get quote
+     * @request POST:/convert_withdraw/rfq
+     * @originalName getQuote
+     * @duplicate
+     * @secure
+     */
+    getQuote2(data: ZeroHashPostCWRequestForQuoteBody, 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<ZeroHashGetRequestForCWQuoteResponse, HandleError>>;
+    /**
+     * @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.
+     * @tags Convert and Withdraw
+     * @name ExecuteQuote
+     * @summary Execute quote
+     * @request POST:/convert_withdraw/execute
+     * @secure
+     */
+    executeQuote(data: ZeroHashPostCWExecuteQuoteBody, 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<ZeroHashPostCWExecuteQuoteResponse, HandleError>>;
+}
 export class Payments<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
@@ -15087,68 +15181,18 @@ export class MarketData<HandleError extends boolean = boolean> {
      */
     getCategories(config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetNewsCategoriesResponse, HandleError>>;
 }
-export class ConvertAndWithdraw<HandleError extends boolean = boolean> {
+export class Fund<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
     constructor(apiClient: JwtClient<HandleError>);
     /**
-     * @description Retrieves a quote for the purchase of an asset and the network fees associated with an eminent and automatic withdrawal of the asset.
-     * @tags Convert and Withdraw
+     * @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 GET:/convert_withdraw/rfq
-     * @secure
-     */
-    getQuote(query: {
-        /** Allows platforms to specify the side of the quote */
-        side: ZeroHashGetQuoteParams2SideEnum;
-        /** Allows platforms to specify the underlying asset */
-        underlying: ZeroHashUnderlyingCurrency;
-        /** Allows platforms to specify the quoted asset */
-        quoted_currency: ZeroHashQuotedCurrency;
-        /** The `quantity` of the `underlying` asset requested in the quote */
-        quantity?: string;
-        /** The `total` of the `quoted_currency` asset requested in the quote */
-        total?: string;
-        /** The participant requesting a quote to buy or sell an asset */
-        participant_code?: string;
-        /** The account_label that's used to fund the trade */
-        account_label?: string;
-        /** The on-chain address where the withdrawal should be sent */
-        withdrawal_address: string;
-        /**
-         * Allows platforms to specify if fees are inclusive
-         * This parameter is only applicable for requests made by `total`
-         */
-        fee_inclusive?: boolean;
-        /** Allows the platform to define the quote spread in basis points */
-        spread?: string;
-        /** 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 */
-        destination_tag?: string;
-        /** 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 */
-        no_destination_tag?: 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<ZeroHashGetRequestForCWQuoteResponse, HandleError>>;
-    /**
-     * @description Retrieves a quote for the purchase of an asset and the network fees associated with an eminent and automatic withdrawal of the asset.
-     * @tags Convert and Withdraw
-     * @name GetQuote2
-     * @summary Get quote
-     * @request POST:/convert_withdraw/rfq
-     * @originalName getQuote
-     * @duplicate
+     * @request POST:/fund/rfq
      * @secure
      */
-    getQuote2(data: ZeroHashPostCWRequestForQuoteBody, headers?: {
+    getQuote(data: ZeroHashPostFundRfqBody, headers?: {
         /**
          * Signature for your request.
          * @default "[WEB] auto-generated on fly"
@@ -15159,16 +15203,31 @@ export class ConvertAndWithdraw<HandleError extends boolean = boolean> {
          * @default "[WEB] auto-generated on fly"
          */
         'X-SCX-TIMESTAMP'?: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetRequestForCWQuoteResponse, HandleError>>;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostFundRfqResponse, HandleError>>;
     /**
-     * @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.
-     * @tags Convert and Withdraw
-     * @name ExecuteQuote
-     * @summary Execute quote
-     * @request POST:/convert_withdraw/execute
+     * @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
      */
-    executeQuote(data: ZeroHashPostCWExecuteQuoteBody, headers?: {
+    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"
@@ -15179,7 +15238,7 @@ export class ConvertAndWithdraw<HandleError extends boolean = boolean> {
          * @default "[WEB] auto-generated on fly"
          */
         'X-SCX-TIMESTAMP'?: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostCWExecuteQuoteResponse, HandleError>>;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashGetFundTransactionsResponse, HandleError>>;
 }
 export class Clob<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
@@ -15394,65 +15453,6 @@ export class Clob<HandleError extends boolean = boolean> {
         'X-SCX-TIMESTAMP'?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<ZeroHashPostTradeStatsResponse, 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>;