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

package/cjs/api/apis/NamespaceRoutesApi.js

@@ -57,16 +57,23 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NamespaceRoutesApi = void 0;
 const runtime = __importStar(require("../runtime"));
-const index_1 = require("../models/index");
+const AccountsNamesDTO_1 = require("../models/AccountsNamesDTO");
+const Addresses_1 = require("../models/Addresses");
+const MerkleStateInfoDTO_1 = require("../models/MerkleStateInfoDTO");
+const MosaicIds_1 = require("../models/MosaicIds");
+const MosaicsNamesDTO_1 = require("../models/MosaicsNamesDTO");
+const NamespaceIds_1 = require("../models/NamespaceIds");
+const NamespaceInfoDTO_1 = require("../models/NamespaceInfoDTO");
+const NamespaceNameDTO_1 = require("../models/NamespaceNameDTO");
+const NamespacePage_1 = require("../models/NamespacePage");
 /**
  *
  */
 class NamespaceRoutesApi extends runtime.BaseAPI {
     /**
-     * Resolves namespace names linked to account addresses.  Submit an array of addresses in the request body. For each address, the response returns the namespace names currently linked to that account.
-     * Get readable names for a set of accounts
+     * Creates request options for getAccountsNames without sending the request
      */
-    getAccountsNamesRaw(requestParameters, initOverrides) {
+    getAccountsNamesRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['addresses'] == null) {
                 throw new runtime.RequiredError('addresses', 'Required parameter "addresses" was null or undefined when calling getAccountsNames().');
@@ -75,14 +82,24 @@ class NamespaceRoutesApi extends runtime.BaseAPI {
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
             let urlPath = `/namespaces/account/names`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
-                body: (0, index_1.AddressesToJSON)(requestParameters['addresses']),
-            }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AccountsNamesDTOFromJSON)(jsonValue));
+                body: (0, Addresses_1.AddressesToJSON)(requestParameters['addresses']),
+            };
+        });
+    }
+    /**
+     * Resolves namespace names linked to account addresses.  Submit an array of addresses in the request body. For each address, the response returns the namespace names currently linked to that account.
+     * Get readable names for a set of accounts
+     */
+    getAccountsNamesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getAccountsNamesRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, AccountsNamesDTO_1.AccountsNamesDTOFromJSON)(jsonValue));
         });
     }
     /**
@@ -96,10 +113,9 @@ class NamespaceRoutesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Resolves namespace names linked to mosaic identifiers.  Submit an array of mosaic identifiers in the request body. For each requested mosaic identifier, the response returns one entry in the same order as the request. Each entry contains the namespace names currently linked to that identifier. An empty `names` array means no namespace aliases were resolved for that identifier.
-     * Get readable names for a set of mosaics
+     * Creates request options for getMosaicsNames without sending the request
      */
-    getMosaicsNamesRaw(requestParameters, initOverrides) {
+    getMosaicsNamesRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['mosaicIds'] == null) {
                 throw new runtime.RequiredError('mosaicIds', 'Required parameter "mosaicIds" was null or undefined when calling getMosaicsNames().');
@@ -108,14 +124,24 @@ class NamespaceRoutesApi extends runtime.BaseAPI {
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
             let urlPath = `/namespaces/mosaic/names`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
-                body: (0, index_1.MosaicIdsToJSON)(requestParameters['mosaicIds']),
-            }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.MosaicsNamesDTOFromJSON)(jsonValue));
+                body: (0, MosaicIds_1.MosaicIdsToJSON)(requestParameters['mosaicIds']),
+            };
+        });
+    }
+    /**
+     * Resolves namespace names linked to mosaic identifiers.  Submit an array of mosaic identifiers in the request body. For each requested mosaic identifier, the response returns one entry in the same order as the request. Each entry contains the namespace names currently linked to that identifier. An empty `names` array means no namespace aliases were resolved for that identifier.
+     * Get readable names for a set of mosaics
+     */
+    getMosaicsNamesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getMosaicsNamesRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, MosaicsNamesDTO_1.MosaicsNamesDTOFromJSON)(jsonValue));
         });
     }
     /**
@@ -129,10 +155,9 @@ class NamespaceRoutesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Retrieves the current on-chain state for a namespace.
-     * Get namespace information
+     * Creates request options for getNamespace without sending the request
      */
-    getNamespaceRaw(requestParameters, initOverrides) {
+    getNamespaceRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['namespaceId'] == null) {
                 throw new runtime.RequiredError('namespaceId', 'Required parameter "namespaceId" was null or undefined when calling getNamespace().');
@@ -140,14 +165,24 @@ class NamespaceRoutesApi extends runtime.BaseAPI {
             const queryParameters = {};
             const headerParameters = {};
             let urlPath = `/namespaces/{namespaceId}`;
-            urlPath = urlPath.replace(`{${"namespaceId"}}`, encodeURIComponent(String(requestParameters['namespaceId'])));
-            const response = yield this.request({
+            urlPath = urlPath.replace('{namespaceId}', encodeURIComponent(String(requestParameters['namespaceId'])));
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.NamespaceInfoDTOFromJSON)(jsonValue));
+            };
+        });
+    }
+    /**
+     * Retrieves the current on-chain state for a namespace.
+     * Get namespace information
+     */
+    getNamespaceRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getNamespaceRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, NamespaceInfoDTO_1.NamespaceInfoDTOFromJSON)(jsonValue));
         });
     }
     /**
@@ -161,10 +196,9 @@ class NamespaceRoutesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Returns the [Merkle proof](https://docs.symbol.dev/concepts/data-validation.html#merkle-proof) for a namespace.  Clients can use this information to verify that the namespace state is included in the node\'s state Merkle tree. If the supplied namespace ID does not exist, the endpoint still returns a Merkle proof response, but it is a negative proof showing that no namespace state entry exists for the requested namespace ID. See [Data Validation](https://docs.symbol.dev/concepts/data-validation.html) for an overview of Patricia Merkle trees and state proofs on Symbol.
-     * Get namespace Merkle information
+     * Creates request options for getNamespaceMerkle without sending the request
      */
-    getNamespaceMerkleRaw(requestParameters, initOverrides) {
+    getNamespaceMerkleRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['namespaceId'] == null) {
                 throw new runtime.RequiredError('namespaceId', 'Required parameter "namespaceId" was null or undefined when calling getNamespaceMerkle().');
@@ -172,14 +206,24 @@ class NamespaceRoutesApi extends runtime.BaseAPI {
             const queryParameters = {};
             const headerParameters = {};
             let urlPath = `/namespaces/{namespaceId}/merkle`;
-            urlPath = urlPath.replace(`{${"namespaceId"}}`, encodeURIComponent(String(requestParameters['namespaceId'])));
-            const response = yield this.request({
+            urlPath = urlPath.replace('{namespaceId}', encodeURIComponent(String(requestParameters['namespaceId'])));
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.MerkleStateInfoDTOFromJSON)(jsonValue));
+            };
+        });
+    }
+    /**
+     * Returns the [Merkle proof](https://docs.symbol.dev/concepts/data-validation.html#merkle-proof) for a namespace.  Clients can use this information to verify that the namespace state is included in the node\'s state Merkle tree. If the supplied namespace ID does not exist, the endpoint still returns a Merkle proof response, but it is a negative proof showing that no namespace state entry exists for the requested namespace ID. See [Data Validation](https://docs.symbol.dev/concepts/data-validation.html) for an overview of Patricia Merkle trees and state proofs on Symbol.
+     * Get namespace Merkle information
+     */
+    getNamespaceMerkleRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getNamespaceMerkleRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, MerkleStateInfoDTO_1.MerkleStateInfoDTOFromJSON)(jsonValue));
         });
     }
     /**
@@ -193,10 +237,9 @@ class NamespaceRoutesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Resolves human-readable namespace names for namespace identifiers.  Submit an array of namespace identifiers in the request body. For each matching identifier, the response returns the namespace name. When a matching identifier is a subnamespace, the response will also include its parent namespace entry and parent namespace identifier. Identifiers that cannot be resolved are omitted from the response.
-     * Get readable names for a set of namespaces
+     * Creates request options for getNamespacesNames without sending the request
      */
-    getNamespacesNamesRaw(requestParameters, initOverrides) {
+    getNamespacesNamesRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['namespaceIds'] == null) {
                 throw new runtime.RequiredError('namespaceIds', 'Required parameter "namespaceIds" was null or undefined when calling getNamespacesNames().');
@@ -205,14 +248,24 @@ class NamespaceRoutesApi extends runtime.BaseAPI {
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
             let urlPath = `/namespaces/names`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
-                body: (0, index_1.NamespaceIdsToJSON)(requestParameters['namespaceIds']),
-            }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.NamespaceNameDTOFromJSON));
+                body: (0, NamespaceIds_1.NamespaceIdsToJSON)(requestParameters['namespaceIds']),
+            };
+        });
+    }
+    /**
+     * Resolves human-readable namespace names for namespace identifiers.  Submit an array of namespace identifiers in the request body. For each matching identifier, the response returns the namespace name. When a matching identifier is a subnamespace, the response will also include its parent namespace entry and parent namespace identifier. Identifiers that cannot be resolved are omitted from the response.
+     * Get readable names for a set of namespaces
+     */
+    getNamespacesNamesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getNamespacesNamesRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(NamespaceNameDTO_1.NamespaceNameDTOFromJSON));
         });
     }
     /**
@@ -226,10 +279,9 @@ class NamespaceRoutesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Returns a paginated list of namespaces matching the given criteria.
-     * Search namespaces
+     * Creates request options for searchNamespaces without sending the request
      */
-    searchNamespacesRaw(requestParameters, initOverrides) {
+    searchNamespacesRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
             if (requestParameters['ownerAddress'] != null) {
@@ -258,13 +310,23 @@ class NamespaceRoutesApi extends runtime.BaseAPI {
             }
             const headerParameters = {};
             let urlPath = `/namespaces`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.NamespacePageFromJSON)(jsonValue));
+            };
+        });
+    }
+    /**
+     * Returns a paginated list of namespaces matching the given criteria.
+     * Search namespaces
+     */
+    searchNamespacesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.searchNamespacesRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, NamespacePage_1.NamespacePageFromJSON)(jsonValue));
         });
     }
     /**

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

@@ -10,14 +10,25 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { NetworkConfigurationDTO, NetworkInflationDTO, NetworkTypeDTO, RentalFeesDTO, TransactionFeesDTO } from '../models/index';
+import { type NetworkConfigurationDTO } from '../models/NetworkConfigurationDTO';
+import { type NetworkInflationDTO } from '../models/NetworkInflationDTO';
+import { type NetworkTypeDTO } from '../models/NetworkTypeDTO';
+import { type RentalFeesDTO } from '../models/RentalFeesDTO';
+import { type TransactionFeesDTO } from '../models/TransactionFeesDTO';
 export interface GetNetworkInflationAtHeightRequest {
+    /**
+     * Filter by block height (include). Sequential block position in the chain; starts at 1 and increments by one.
+     */
     height: string;
 }
 /**
  *
  */
 export declare class NetworkRoutesApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for getCirculatingCurrencySupply without sending the request
+     */
+    getCirculatingCurrencySupplyRequestOpts(): Promise<runtime.RequestOpts>;
     /**
      * 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
@@ -28,6 +39,10 @@ export declare class NetworkRoutesApi extends runtime.BaseAPI {
      * Returns circulating currency supply
      */
     getCirculatingCurrencySupply(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Creates request options for getMaxCurrencySupply without sending the request
+     */
+    getMaxCurrencySupplyRequestOpts(): Promise<runtime.RequestOpts>;
     /**
      * 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
@@ -38,6 +53,10 @@ export declare class NetworkRoutesApi extends runtime.BaseAPI {
      * Returns max currency supply
      */
     getMaxCurrencySupply(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Creates request options for getNetworkInflation without sending the request
+     */
+    getNetworkInflationRequestOpts(): Promise<runtime.RequestOpts>;
     /**
      * 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
@@ -48,6 +67,10 @@ export declare class NetworkRoutesApi extends runtime.BaseAPI {
      * Returns the inflation distribution schedule
      */
     getNetworkInflation(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<NetworkInflationDTO>>;
+    /**
+     * Creates request options for getNetworkInflationAtHeight without sending the request
+     */
+    getNetworkInflationAtHeightRequestOpts(requestParameters: GetNetworkInflationAtHeightRequest): Promise<runtime.RequestOpts>;
     /**
      * Retrieves network inflation parameters at a given block height.
      * Returns the inflation distribution data at a specific height
@@ -58,6 +81,10 @@ export declare class NetworkRoutesApi extends runtime.BaseAPI {
      * Returns the inflation distribution data at a specific height
      */
     getNetworkInflationAtHeight(requestParameters: GetNetworkInflationAtHeightRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NetworkInflationDTO>;
+    /**
+     * Creates request options for getNetworkProperties without sending the request
+     */
+    getNetworkPropertiesRequestOpts(): Promise<runtime.RequestOpts>;
     /**
      * 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
@@ -68,6 +95,10 @@ export declare class NetworkRoutesApi extends runtime.BaseAPI {
      * Get the network properties
      */
     getNetworkProperties(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NetworkConfigurationDTO>;
+    /**
+     * Creates request options for getNetworkType without sending the request
+     */
+    getNetworkTypeRequestOpts(): Promise<runtime.RequestOpts>;
     /**
      * Returns the current network type.
      * Get the current network type of the chain
@@ -78,6 +109,10 @@ export declare class NetworkRoutesApi extends runtime.BaseAPI {
      * Get the current network type of the chain
      */
     getNetworkType(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NetworkTypeDTO>;
+    /**
+     * Creates request options for getRentalFees without sending the request
+     */
+    getRentalFeesRequestOpts(): Promise<runtime.RequestOpts>;
     /**
      * 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
@@ -88,6 +123,10 @@ export declare class NetworkRoutesApi extends runtime.BaseAPI {
      * Get rental fees information
      */
     getRentalFees(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RentalFeesDTO>;
+    /**
+     * Creates request options for getTotalCurrencySupply without sending the request
+     */
+    getTotalCurrencySupplyRequestOpts(): Promise<runtime.RequestOpts>;
     /**
      * 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
@@ -98,6 +137,10 @@ export declare class NetworkRoutesApi extends runtime.BaseAPI {
      * Returns total currency supply
      */
     getTotalCurrencySupply(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Creates request options for getTransactionFees without sending the request
+     */
+    getTransactionFeesRequestOpts(): Promise<runtime.RequestOpts>;
     /**
      * 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