@nemtus/symbol-rest-api-client-fetch 1.0.1 → 1.0.2

package/cjs/api/apis/NetworkRoutesApi.js

@@ -57,26 +57,39 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NetworkRoutesApi = void 0;
 const runtime = __importStar(require("../runtime"));
-const index_1 = require("../models/index");
+const NetworkConfigurationDTO_1 = require("../models/NetworkConfigurationDTO");
+const NetworkInflationDTO_1 = require("../models/NetworkInflationDTO");
+const NetworkTypeDTO_1 = require("../models/NetworkTypeDTO");
+const RentalFeesDTO_1 = require("../models/RentalFeesDTO");
+const TransactionFeesDTO_1 = require("../models/TransactionFeesDTO");
 /**
  *
  */
 class NetworkRoutesApi extends runtime.BaseAPI {
     /**
-     * Returns the current circulating supply of the network currency mosaic.  Circulating supply represents the portion of total on-chain supply that is not held in designated uncirculating or reserved accounts (e.g. nemesis or treasury accounts).  Data sources:   - Mosaic supply and divisibility from blockchain state   - Nemesis signer public key from network properties file   - Uncirculating account public keys defined in rest.json (`uncirculatingAccountPublicKeys`)
-     * Returns circulating currency supply
+     * Creates request options for getCirculatingCurrencySupply without sending the request
      */
-    getCirculatingCurrencySupplyRaw(initOverrides) {
+    getCirculatingCurrencySupplyRequestOpts() {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
             const headerParameters = {};
             let urlPath = `/network/currency/supply/circulating`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Returns the current circulating supply of the network currency mosaic.  Circulating supply represents the portion of total on-chain supply that is not held in designated uncirculating or reserved accounts (e.g. nemesis or treasury accounts).  Data sources:   - Mosaic supply and divisibility from blockchain state   - Nemesis signer public key from network properties file   - Uncirculating account public keys defined in rest.json (`uncirculatingAccountPublicKeys`)
+     * Returns circulating currency supply
+     */
+    getCirculatingCurrencySupplyRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getCirculatingCurrencySupplyRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
             if (this.isJsonMime(response.headers.get('content-type'))) {
                 return new runtime.JSONApiResponse(response);
             }
@@ -96,20 +109,29 @@ class NetworkRoutesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Returns the maximum possible supply of the network currency mosaic.  Data sources:   - Maximum supply (`chain.maxMosaicAtomicUnits`) defined in the network properties file   - Network currency divisibility from blockchain state  This represents the protocol-level supply cap configured for the network currency.
-     * Returns max currency supply
+     * Creates request options for getMaxCurrencySupply without sending the request
      */
-    getMaxCurrencySupplyRaw(initOverrides) {
+    getMaxCurrencySupplyRequestOpts() {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
             const headerParameters = {};
             let urlPath = `/network/currency/supply/max`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Returns the maximum possible supply of the network currency mosaic.  Data sources:   - Maximum supply (`chain.maxMosaicAtomicUnits`) defined in the network properties file   - Network currency divisibility from blockchain state  This represents the protocol-level supply cap configured for the network currency.
+     * Returns max currency supply
+     */
+    getMaxCurrencySupplyRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getMaxCurrencySupplyRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
             if (this.isJsonMime(response.headers.get('content-type'))) {
                 return new runtime.JSONApiResponse(response);
             }
@@ -129,21 +151,30 @@ class NetworkRoutesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Retrieves the network inflation table, where each entry specifies a starting block height and the reward amount applied from that height onward.
-     * Returns the inflation distribution schedule
+     * Creates request options for getNetworkInflation without sending the request
      */
-    getNetworkInflationRaw(initOverrides) {
+    getNetworkInflationRequestOpts() {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
             const headerParameters = {};
             let urlPath = `/network/inflation`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.NetworkInflationDTOFromJSON));
+            };
+        });
+    }
+    /**
+     * Retrieves the network inflation table, where each entry specifies a starting block height and the reward amount applied from that height onward.
+     * Returns the inflation distribution schedule
+     */
+    getNetworkInflationRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getNetworkInflationRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(NetworkInflationDTO_1.NetworkInflationDTOFromJSON));
         });
     }
     /**
@@ -157,10 +188,9 @@ class NetworkRoutesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Retrieves network inflation parameters at a given block height.
-     * Returns the inflation distribution data at a specific height
+     * Creates request options for getNetworkInflationAtHeight without sending the request
      */
-    getNetworkInflationAtHeightRaw(requestParameters, initOverrides) {
+    getNetworkInflationAtHeightRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['height'] == null) {
                 throw new runtime.RequiredError('height', 'Required parameter "height" was null or undefined when calling getNetworkInflationAtHeight().');
@@ -168,14 +198,24 @@ class NetworkRoutesApi extends runtime.BaseAPI {
             const queryParameters = {};
             const headerParameters = {};
             let urlPath = `/network/inflation/at/{height}`;
-            urlPath = urlPath.replace(`{${"height"}}`, encodeURIComponent(String(requestParameters['height'])));
-            const response = yield this.request({
+            urlPath = urlPath.replace('{height}', encodeURIComponent(String(requestParameters['height'])));
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.NetworkInflationDTOFromJSON)(jsonValue));
+            };
+        });
+    }
+    /**
+     * Retrieves network inflation parameters at a given block height.
+     * Returns the inflation distribution data at a specific height
+     */
+    getNetworkInflationAtHeightRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getNetworkInflationAtHeightRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, NetworkInflationDTO_1.NetworkInflationDTOFromJSON)(jsonValue));
         });
     }
     /**
@@ -189,21 +229,30 @@ class NetworkRoutesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Returns the content from a catapult-server network configuration file (e.g. `config-network.properties`). To enable this feature, the REST setting `apiNode.networkPropertyFilePath` in the config file (e.g. `rest.json`) must define where the file is located.
-     * Get the network properties
+     * Creates request options for getNetworkProperties without sending the request
      */
-    getNetworkPropertiesRaw(initOverrides) {
+    getNetworkPropertiesRequestOpts() {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
             const headerParameters = {};
             let urlPath = `/network/properties`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.NetworkConfigurationDTOFromJSON)(jsonValue));
+            };
+        });
+    }
+    /**
+     * Returns the content from a catapult-server network configuration file (e.g. `config-network.properties`). To enable this feature, the REST setting `apiNode.networkPropertyFilePath` in the config file (e.g. `rest.json`) must define where the file is located.
+     * Get the network properties
+     */
+    getNetworkPropertiesRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getNetworkPropertiesRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, NetworkConfigurationDTO_1.NetworkConfigurationDTOFromJSON)(jsonValue));
         });
     }
     /**
@@ -217,21 +266,30 @@ class NetworkRoutesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Returns the current network type.
-     * Get the current network type of the chain
+     * Creates request options for getNetworkType without sending the request
      */
-    getNetworkTypeRaw(initOverrides) {
+    getNetworkTypeRequestOpts() {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
             const headerParameters = {};
             let urlPath = `/network`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.NetworkTypeDTOFromJSON)(jsonValue));
+            };
+        });
+    }
+    /**
+     * Returns the current network type.
+     * Get the current network type of the chain
+     */
+    getNetworkTypeRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getNetworkTypeRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, NetworkTypeDTO_1.NetworkTypeDTOFromJSON)(jsonValue));
         });
     }
     /**
@@ -245,21 +303,30 @@ class NetworkRoutesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Returns the estimated effective rental fees for namespaces and mosaics. This endpoint is only available if the REST instance has access to catapult-server `resources/config-network.properties` file. To activate this feature, add the setting `network.propertiesFilePath` in the configuration file (`rest/resources/rest.json`).
-     * Get rental fees information
+     * Creates request options for getRentalFees without sending the request
      */
-    getRentalFeesRaw(initOverrides) {
+    getRentalFeesRequestOpts() {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
             const headerParameters = {};
             let urlPath = `/network/fees/rental`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.RentalFeesDTOFromJSON)(jsonValue));
+            };
+        });
+    }
+    /**
+     * Returns the estimated effective rental fees for namespaces and mosaics. This endpoint is only available if the REST instance has access to catapult-server `resources/config-network.properties` file. To activate this feature, add the setting `network.propertiesFilePath` in the configuration file (`rest/resources/rest.json`).
+     * Get rental fees information
+     */
+    getRentalFeesRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getRentalFeesRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, RentalFeesDTO_1.RentalFeesDTOFromJSON)(jsonValue));
         });
     }
     /**
@@ -273,20 +340,29 @@ class NetworkRoutesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Returns the total current on-chain supply of the network currency mosaic.  Data sources:   - Mosaic supply and divisibility from blockchain state  This value includes both circulating and uncirculating balances and represents the full issued supply currently recorded on-chain.
-     * Returns total currency supply
+     * Creates request options for getTotalCurrencySupply without sending the request
      */
-    getTotalCurrencySupplyRaw(initOverrides) {
+    getTotalCurrencySupplyRequestOpts() {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
             const headerParameters = {};
             let urlPath = `/network/currency/supply/total`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Returns the total current on-chain supply of the network currency mosaic.  Data sources:   - Mosaic supply and divisibility from blockchain state  This value includes both circulating and uncirculating balances and represents the full issued supply currently recorded on-chain.
+     * Returns total currency supply
+     */
+    getTotalCurrencySupplyRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getTotalCurrencySupplyRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
             if (this.isJsonMime(response.headers.get('content-type'))) {
                 return new runtime.JSONApiResponse(response);
             }
@@ -306,21 +382,30 @@ class NetworkRoutesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Returns the average, median, highest, and lowest fee multiplier over the last `numBlocksTransactionFeeStats` blocks. The setting `numBlocksTransactionFeeStats` is adjustable in the REST configuration file (`rest.json`) per REST instance.
-     * Get transaction fees information
+     * Creates request options for getTransactionFees without sending the request
      */
-    getTransactionFeesRaw(initOverrides) {
+    getTransactionFeesRequestOpts() {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
             const headerParameters = {};
             let urlPath = `/network/fees/transaction`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.TransactionFeesDTOFromJSON)(jsonValue));
+            };
+        });
+    }
+    /**
+     * Returns the average, median, highest, and lowest fee multiplier over the last `numBlocksTransactionFeeStats` blocks. The setting `numBlocksTransactionFeeStats` is adjustable in the REST configuration file (`rest.json`) per REST instance.
+     * Get transaction fees information
+     */
+    getTransactionFeesRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getTransactionFeesRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, TransactionFeesDTO_1.TransactionFeesDTOFromJSON)(jsonValue));
         });
     }
     /**

package/cjs/api/apis/NodeRoutesApi.d.ts

@@ -10,11 +10,20 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { NodeHealthInfoDTO, NodeInfoDTO, NodeTimeDTO, ServerInfoDTO, StorageInfoDTO, UnlockedAccountDTO } from '../models/index';
+import { type NodeHealthInfoDTO } from '../models/NodeHealthInfoDTO';
+import { type NodeInfoDTO } from '../models/NodeInfoDTO';
+import { type NodeTimeDTO } from '../models/NodeTimeDTO';
+import { type ServerInfoDTO } from '../models/ServerInfoDTO';
+import { type StorageInfoDTO } from '../models/StorageInfoDTO';
+import { type UnlockedAccountDTO } from '../models/UnlockedAccountDTO';
 /**
  *
  */
 export declare class NodeRoutesApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for getNodeHealth without sending the request
+     */
+    getNodeHealthRequestOpts(): Promise<runtime.RequestOpts>;
     /**
      * Supplies information regarding the connection and services status.
      * Get the node health information
@@ -25,6 +34,10 @@ export declare class NodeRoutesApi extends runtime.BaseAPI {
      * Get the node health information
      */
     getNodeHealth(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NodeHealthInfoDTO>;
+    /**
+     * Creates request options for getNodeInfo without sending the request
+     */
+    getNodeInfoRequestOpts(): Promise<runtime.RequestOpts>;
     /**
      * Supplies additional information about the application running on a node.
      * Get the node information
@@ -35,6 +48,10 @@ export declare class NodeRoutesApi extends runtime.BaseAPI {
      * Get the node information
      */
     getNodeInfo(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NodeInfoDTO>;
+    /**
+     * Creates request options for getNodeMetadata without sending the request
+     */
+    getNodeMetadataRequestOpts(): Promise<runtime.RequestOpts>;
     /**
      * Gets the node metadata information that has been set by the node operator.  **How to set:** Add a top-level `nodeMetadata` object in the REST server JSON configuration file. Example:  ```json {   \"nodeMetadata\": {     \"deploymentTool\": \"symbol-shoestring\",     \"version\": \"1.0.0\",     \"customLabel\": \"my-node\"   } } ```  The entire `nodeMetadata` object is served as-is; add any key-value pairs to personalize your node.
      * Retrieve node metadata
@@ -49,6 +66,10 @@ export declare class NodeRoutesApi extends runtime.BaseAPI {
     getNodeMetadata(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
         [key: string]: string;
     }>;
+    /**
+     * Creates request options for getNodePeers without sending the request
+     */
+    getNodePeersRequestOpts(): Promise<runtime.RequestOpts>;
     /**
      * Gets the list of peers visible by the node.
      * Get peers information
@@ -59,6 +80,10 @@ export declare class NodeRoutesApi extends runtime.BaseAPI {
      * Get peers information
      */
     getNodePeers(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<NodeInfoDTO>>;
+    /**
+     * Creates request options for getNodeStorage without sending the request
+     */
+    getNodeStorageRequestOpts(): Promise<runtime.RequestOpts>;
     /**
      * Returns estimated counts of blocks, transactions, and accounts in the REST server\'s MongoDB database, along with database size statistics (`db.stats()`).
      * Get the storage information of the node
@@ -69,6 +94,10 @@ export declare class NodeRoutesApi extends runtime.BaseAPI {
      * Get the storage information of the node
      */
     getNodeStorage(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StorageInfoDTO>;
+    /**
+     * Creates request options for getNodeTime without sending the request
+     */
+    getNodeTimeRequestOpts(): Promise<runtime.RequestOpts>;
     /**
      * Gets the node time at the moment the reply was sent and received.
      * Get the node time
@@ -79,6 +108,10 @@ export declare class NodeRoutesApi extends runtime.BaseAPI {
      * Get the node time
      */
     getNodeTime(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NodeTimeDTO>;
+    /**
+     * Creates request options for getServerInfo without sending the request
+     */
+    getServerInfoRequestOpts(): Promise<runtime.RequestOpts>;
     /**
      * Returns the version of the running catapult-rest component.
      * Get the version of the running REST component
@@ -89,6 +122,10 @@ export declare class NodeRoutesApi extends runtime.BaseAPI {
      * Get the version of the running REST component
      */
     getServerInfo(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ServerInfoDTO>;
+    /**
+     * Creates request options for getUnlockedAccount without sending the request
+     */
+    getUnlockedAccountRequestOpts(): Promise<runtime.RequestOpts>;
     /**
      * Returns array of unlocked account public keys.
      * Get the unlocked harvesting account public keys