/** * 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 { AccountsNamesDTO, Addresses, AliasTypeEnum, MerkleStateInfoDTO, MosaicIds, MosaicsNamesDTO, NamespaceIds, NamespaceInfoDTO, NamespaceNameDTO, NamespacePage, NamespaceRegistrationTypeEnum, Order } from '../models/index'; export interface GetAccountsNamesRequest { addresses: Addresses; } export interface GetMosaicsNamesRequest { mosaicIds: MosaicIds; } export interface GetNamespaceRequest { namespaceId: string; } export interface GetNamespaceMerkleRequest { namespaceId: string; } export interface GetNamespacesNamesRequest { namespaceIds: NamespaceIds; } export interface SearchNamespacesRequest { ownerAddress?: string; registrationType?: NamespaceRegistrationTypeEnum; level0?: string; aliasType?: AliasTypeEnum; pageSize?: number; pageNumber?: number; offset?: string; order?: Order; } /** * */ export declare 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: GetAccountsNamesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * 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: GetAccountsNamesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * 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: GetMosaicsNamesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * 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: GetMosaicsNamesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Retrieves the current on-chain state for a namespace. * Get namespace information */ getNamespaceRaw(requestParameters: GetNamespaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieves the current on-chain state for a namespace. * Get namespace information */ getNamespace(requestParameters: GetNamespaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * 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: GetNamespaceMerkleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * 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: GetNamespaceMerkleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * 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: GetNamespacesNamesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** * 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: GetNamespacesNamesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a paginated list of namespaces matching the given criteria. * Search namespaces */ searchNamespacesRaw(requestParameters: SearchNamespacesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a paginated list of namespaces matching the given criteria. * Search namespaces */ searchNamespaces(requestParameters?: SearchNamespacesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }