@nemtus/symbol-rest-api-client-fetch 1.0.0

package/cjs/api/apis/NamespaceRoutesApi.js

@@ -0,0 +1,281 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Catapult REST Endpoints
+ * OpenAPI Specification of catapult-rest
+ *
+ * The version of the OpenAPI document: 1.0.5
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NamespaceRoutesApi = void 0;
+const runtime = __importStar(require("../runtime"));
+const index_1 = require("../models/index");
+/**
+ *
+ */
+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
+     */
+    getAccountsNamesRaw(requestParameters, initOverrides) {
+        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().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/namespaces/account/names`;
+            const response = yield this.request({
+                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));
+        });
+    }
+    /**
+     * 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
+     */
+    getAccountsNames(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getAccountsNamesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * 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* () {
+            if (requestParameters['mosaicIds'] == null) {
+                throw new runtime.RequiredError('mosaicIds', 'Required parameter "mosaicIds" was null or undefined when calling getMosaicsNames().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/namespaces/mosaic/names`;
+            const response = yield this.request({
+                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));
+        });
+    }
+    /**
+     * 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
+     */
+    getMosaicsNames(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getMosaicsNamesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Retrieves the current on-chain state for a namespace.
+     * Get namespace information
+     */
+    getNamespaceRaw(requestParameters, initOverrides) {
+        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().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/namespaces/{namespaceId}`;
+            urlPath = urlPath.replace(`{${"namespaceId"}}`, encodeURIComponent(String(requestParameters['namespaceId'])));
+            const response = yield this.request({
+                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
+     */
+    getNamespace(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getNamespaceRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * 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* () {
+            if (requestParameters['namespaceId'] == null) {
+                throw new runtime.RequiredError('namespaceId', 'Required parameter "namespaceId" was null or undefined when calling getNamespaceMerkle().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/namespaces/{namespaceId}/merkle`;
+            urlPath = urlPath.replace(`{${"namespaceId"}}`, encodeURIComponent(String(requestParameters['namespaceId'])));
+            const response = yield this.request({
+                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
+     */
+    getNamespaceMerkle(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getNamespaceMerkleRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * 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* () {
+            if (requestParameters['namespaceIds'] == null) {
+                throw new runtime.RequiredError('namespaceIds', 'Required parameter "namespaceIds" was null or undefined when calling getNamespacesNames().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/namespaces/names`;
+            const response = yield this.request({
+                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));
+        });
+    }
+    /**
+     * 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
+     */
+    getNamespacesNames(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getNamespacesNamesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns a paginated list of namespaces matching the given criteria.
+     * Search namespaces
+     */
+    searchNamespacesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['ownerAddress'] != null) {
+                queryParameters['ownerAddress'] = requestParameters['ownerAddress'];
+            }
+            if (requestParameters['registrationType'] != null) {
+                queryParameters['registrationType'] = requestParameters['registrationType'];
+            }
+            if (requestParameters['level0'] != null) {
+                queryParameters['level0'] = requestParameters['level0'];
+            }
+            if (requestParameters['aliasType'] != null) {
+                queryParameters['aliasType'] = requestParameters['aliasType'];
+            }
+            if (requestParameters['pageSize'] != null) {
+                queryParameters['pageSize'] = requestParameters['pageSize'];
+            }
+            if (requestParameters['pageNumber'] != null) {
+                queryParameters['pageNumber'] = requestParameters['pageNumber'];
+            }
+            if (requestParameters['offset'] != null) {
+                queryParameters['offset'] = requestParameters['offset'];
+            }
+            if (requestParameters['order'] != null) {
+                queryParameters['order'] = requestParameters['order'];
+            }
+            const headerParameters = {};
+            let urlPath = `/namespaces`;
+            const response = yield this.request({
+                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
+     */
+    searchNamespaces() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.searchNamespacesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.NamespaceRoutesApi = NamespaceRoutesApi;

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

@@ -0,0 +1,111 @@
+/**
+ * Catapult REST Endpoints
+ * OpenAPI Specification of catapult-rest
+ *
+ * The version of the OpenAPI document: 1.0.5
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { NetworkConfigurationDTO, NetworkInflationDTO, NetworkTypeDTO, RentalFeesDTO, TransactionFeesDTO } from '../models/index';
+export interface GetNetworkInflationAtHeightRequest {
+    height: string;
+}
+/**
+ *
+ */
+export declare 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
+     */
+    getCirculatingCurrencySupplyRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * 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
+     */
+    getCirculatingCurrencySupply(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * 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?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * 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
+     */
+    getMaxCurrencySupply(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * 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?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<NetworkInflationDTO>>>;
+    /**
+     * 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
+     */
+    getNetworkInflation(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<NetworkInflationDTO>>;
+    /**
+     * Retrieves network inflation parameters at a given block height.
+     * Returns the inflation distribution data at a specific height
+     */
+    getNetworkInflationAtHeightRaw(requestParameters: GetNetworkInflationAtHeightRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NetworkInflationDTO>>;
+    /**
+     * Retrieves network inflation parameters at a given block height.
+     * Returns the inflation distribution data at a specific height
+     */
+    getNetworkInflationAtHeight(requestParameters: GetNetworkInflationAtHeightRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NetworkInflationDTO>;
+    /**
+     * 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?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NetworkConfigurationDTO>>;
+    /**
+     * 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
+     */
+    getNetworkProperties(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NetworkConfigurationDTO>;
+    /**
+     * Returns the current network type.
+     * Get the current network type of the chain
+     */
+    getNetworkTypeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<NetworkTypeDTO>>;
+    /**
+     * Returns the current network type.
+     * Get the current network type of the chain
+     */
+    getNetworkType(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<NetworkTypeDTO>;
+    /**
+     * 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?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RentalFeesDTO>>;
+    /**
+     * 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
+     */
+    getRentalFees(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RentalFeesDTO>;
+    /**
+     * 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?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * 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
+     */
+    getTotalCurrencySupply(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * 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?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TransactionFeesDTO>>;
+    /**
+     * 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
+     */
+    getTransactionFees(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionFeesDTO>;
+}