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

package/esm/api/models/MultisigNetworkPropertiesDTO.js

@@ -0,0 +1,45 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the MultisigNetworkPropertiesDTO interface.
+ */
+export function instanceOfMultisigNetworkPropertiesDTO(value) {
+    return true;
+}
+export function MultisigNetworkPropertiesDTOFromJSON(json) {
+    return MultisigNetworkPropertiesDTOFromJSONTyped(json, false);
+}
+export function MultisigNetworkPropertiesDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'maxMultisigDepth': json['maxMultisigDepth'] == null ? undefined : json['maxMultisigDepth'],
+        'maxCosignatoriesPerAccount': json['maxCosignatoriesPerAccount'] == null ? undefined : json['maxCosignatoriesPerAccount'],
+        'maxCosignedAccountsPerAccount': json['maxCosignedAccountsPerAccount'] == null ? undefined : json['maxCosignedAccountsPerAccount'],
+    };
+}
+export function MultisigNetworkPropertiesDTOToJSON(json) {
+    return MultisigNetworkPropertiesDTOToJSONTyped(json, false);
+}
+export function MultisigNetworkPropertiesDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'maxMultisigDepth': value['maxMultisigDepth'],
+        'maxCosignatoriesPerAccount': value['maxCosignatoriesPerAccount'],
+        'maxCosignedAccountsPerAccount': value['maxCosignedAccountsPerAccount'],
+    };
+}

package/esm/api/models/NamespaceDTO.d.ts

@@ -0,0 +1,117 @@
+/**
+ * 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 type { AliasDTO } from './AliasDTO';
+import type { NamespaceRegistrationTypeEnum } from './NamespaceRegistrationTypeEnum';
+/**
+ * State information describing a namespace and its alias configuration.
+ * @export
+ * @interface NamespaceDTO
+ */
+export interface NamespaceDTO {
+    /**
+     * Version of the on-chain state serialization format. Incremented when the storage
+     * schema of the entity changes (e.g. new fields are added), allowing the node to
+     * deserialize entries written under earlier formats.
+     *
+     * @type {number}
+     * @memberof NamespaceDTO
+     */
+    version: number;
+    /**
+     *
+     * @type {NamespaceRegistrationTypeEnum}
+     * @memberof NamespaceDTO
+     */
+    registrationType: NamespaceRegistrationTypeEnum;
+    /**
+     * Number of levels present in the namespace path.
+     * This matches how many namespace IDs are defined across `level0`, `level1`, and `level2`.
+     *
+     * @type {number}
+     * @memberof NamespaceDTO
+     */
+    depth: number;
+    /**
+     * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier.
+     * A 64-bit unsigned integer derived from the namespace name and its parent namespace ID,
+     * encoded as a 16-character hexadecimal string.
+     *
+     * @type {string}
+     * @memberof NamespaceDTO
+     */
+    level0: string;
+    /**
+     * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier.
+     * A 64-bit unsigned integer derived from the namespace name and its parent namespace ID,
+     * encoded as a 16-character hexadecimal string.
+     *
+     * @type {string}
+     * @memberof NamespaceDTO
+     */
+    level1?: string;
+    /**
+     * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier.
+     * A 64-bit unsigned integer derived from the namespace name and its parent namespace ID,
+     * encoded as a 16-character hexadecimal string.
+     *
+     * @type {string}
+     * @memberof NamespaceDTO
+     */
+    level2?: string;
+    /**
+     *
+     * @type {AliasDTO}
+     * @memberof NamespaceDTO
+     */
+    alias: AliasDTO;
+    /**
+     * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier.
+     * A 64-bit unsigned integer derived from the namespace name and its parent namespace ID,
+     * encoded as a 16-character hexadecimal string.
+     *
+     * @type {string}
+     * @memberof NamespaceDTO
+     */
+    parentId: string;
+    /**
+     * Address encoded as a 48-character hexadecimal string (24 bytes).
+     * The REST API returns addresses in this format. For Base32-encoded addresses (39 chars) see `Address`.
+     *
+     * @type {string}
+     * @memberof NamespaceDTO
+     */
+    ownerAddress: string;
+    /**
+     * Height of a block in the blockchain. Starts at 1 and increments by one per block.
+     * Represented as a string to preserve precision, since the value is an unsigned 64-bit integer.
+     *
+     * @type {string}
+     * @memberof NamespaceDTO
+     */
+    startHeight: string;
+    /**
+     * Height of a block in the blockchain. Starts at 1 and increments by one per block.
+     * Represented as a string to preserve precision, since the value is an unsigned 64-bit integer.
+     *
+     * @type {string}
+     * @memberof NamespaceDTO
+     */
+    endHeight: string;
+}
+/**
+ * Check if a given object implements the NamespaceDTO interface.
+ */
+export declare function instanceOfNamespaceDTO(value: Record<string, any>): value is NamespaceDTO;
+export declare function NamespaceDTOFromJSON(json: any): NamespaceDTO;
+export declare function NamespaceDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): NamespaceDTO;
+export declare function NamespaceDTOToJSON(json: any): NamespaceDTO;
+export declare function NamespaceDTOToJSONTyped(value?: NamespaceDTO | null, ignoreDiscriminator?: boolean): any;

package/esm/api/models/NamespaceDTO.js

@@ -0,0 +1,81 @@
+/* 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.
+ */
+import { AliasDTOFromJSON, AliasDTOToJSON, } from './AliasDTO';
+import { NamespaceRegistrationTypeEnumFromJSON, NamespaceRegistrationTypeEnumToJSON, } from './NamespaceRegistrationTypeEnum';
+/**
+ * Check if a given object implements the NamespaceDTO interface.
+ */
+export function instanceOfNamespaceDTO(value) {
+    if (!('version' in value) || value['version'] === undefined)
+        return false;
+    if (!('registrationType' in value) || value['registrationType'] === undefined)
+        return false;
+    if (!('depth' in value) || value['depth'] === undefined)
+        return false;
+    if (!('level0' in value) || value['level0'] === undefined)
+        return false;
+    if (!('alias' in value) || value['alias'] === undefined)
+        return false;
+    if (!('parentId' in value) || value['parentId'] === undefined)
+        return false;
+    if (!('ownerAddress' in value) || value['ownerAddress'] === undefined)
+        return false;
+    if (!('startHeight' in value) || value['startHeight'] === undefined)
+        return false;
+    if (!('endHeight' in value) || value['endHeight'] === undefined)
+        return false;
+    return true;
+}
+export function NamespaceDTOFromJSON(json) {
+    return NamespaceDTOFromJSONTyped(json, false);
+}
+export function NamespaceDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'version': json['version'],
+        'registrationType': NamespaceRegistrationTypeEnumFromJSON(json['registrationType']),
+        'depth': json['depth'],
+        'level0': json['level0'],
+        'level1': json['level1'] == null ? undefined : json['level1'],
+        'level2': json['level2'] == null ? undefined : json['level2'],
+        'alias': AliasDTOFromJSON(json['alias']),
+        'parentId': json['parentId'],
+        'ownerAddress': json['ownerAddress'],
+        'startHeight': json['startHeight'],
+        'endHeight': json['endHeight'],
+    };
+}
+export function NamespaceDTOToJSON(json) {
+    return NamespaceDTOToJSONTyped(json, false);
+}
+export function NamespaceDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'version': value['version'],
+        'registrationType': NamespaceRegistrationTypeEnumToJSON(value['registrationType']),
+        'depth': value['depth'],
+        'level0': value['level0'],
+        'level1': value['level1'],
+        'level2': value['level2'],
+        'alias': AliasDTOToJSON(value['alias']),
+        'parentId': value['parentId'],
+        'ownerAddress': value['ownerAddress'],
+        'startHeight': value['startHeight'],
+        'endHeight': value['endHeight'],
+    };
+}

package/esm/api/models/NamespaceExpiryReceiptDTO.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 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 type { ReceiptTypeEnum } from './ReceiptTypeEnum';
+/**
+ * Receipt emitted when a namespace reaches the end of its lifetime and expires.
+ * @export
+ * @interface NamespaceExpiryReceiptDTO
+ */
+export interface NamespaceExpiryReceiptDTO {
+    /**
+     * Version of the receipt format.
+     * @type {number}
+     * @memberof NamespaceExpiryReceiptDTO
+     */
+    version: number;
+    /**
+     *
+     * @type {ReceiptTypeEnum}
+     * @memberof NamespaceExpiryReceiptDTO
+     */
+    type: ReceiptTypeEnum;
+    /**
+     * Unique [namespace](https://docs.symbol.dev/concepts/namespaces.html) identifier.
+     * A 64-bit unsigned integer derived from the namespace name and its parent namespace ID,
+     * encoded as a 16-character hexadecimal string.
+     *
+     * @type {string}
+     * @memberof NamespaceExpiryReceiptDTO
+     */
+    artifactId: string;
+}
+/**
+ * Check if a given object implements the NamespaceExpiryReceiptDTO interface.
+ */
+export declare function instanceOfNamespaceExpiryReceiptDTO(value: Record<string, any>): value is NamespaceExpiryReceiptDTO;
+export declare function NamespaceExpiryReceiptDTOFromJSON(json: any): NamespaceExpiryReceiptDTO;
+export declare function NamespaceExpiryReceiptDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): NamespaceExpiryReceiptDTO;
+export declare function NamespaceExpiryReceiptDTOToJSON(json: any): NamespaceExpiryReceiptDTO;
+export declare function NamespaceExpiryReceiptDTOToJSONTyped(value?: NamespaceExpiryReceiptDTO | null, ignoreDiscriminator?: boolean): any;

package/esm/api/models/NamespaceExpiryReceiptDTO.js

@@ -0,0 +1,52 @@
+/* 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.
+ */
+import { ReceiptTypeEnumFromJSON, ReceiptTypeEnumToJSON, } from './ReceiptTypeEnum';
+/**
+ * Check if a given object implements the NamespaceExpiryReceiptDTO interface.
+ */
+export function instanceOfNamespaceExpiryReceiptDTO(value) {
+    if (!('version' in value) || value['version'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('artifactId' in value) || value['artifactId'] === undefined)
+        return false;
+    return true;
+}
+export function NamespaceExpiryReceiptDTOFromJSON(json) {
+    return NamespaceExpiryReceiptDTOFromJSONTyped(json, false);
+}
+export function NamespaceExpiryReceiptDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'version': json['version'],
+        'type': ReceiptTypeEnumFromJSON(json['type']),
+        'artifactId': json['artifactId'],
+    };
+}
+export function NamespaceExpiryReceiptDTOToJSON(json) {
+    return NamespaceExpiryReceiptDTOToJSONTyped(json, false);
+}
+export function NamespaceExpiryReceiptDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'version': value['version'],
+        'type': ReceiptTypeEnumToJSON(value['type']),
+        'artifactId': value['artifactId'],
+    };
+}

package/esm/api/models/NamespaceIds.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+/**
+ * Array payload used to submit namespace identifiers.
+ * @export
+ * @interface NamespaceIds
+ */
+export interface NamespaceIds {
+    /**
+     * Array of namespace identifiers.
+     * @type {Array<string>}
+     * @memberof NamespaceIds
+     */
+    namespaceIds?: Array<string>;
+}
+/**
+ * Check if a given object implements the NamespaceIds interface.
+ */
+export declare function instanceOfNamespaceIds(value: Record<string, any>): value is NamespaceIds;
+export declare function NamespaceIdsFromJSON(json: any): NamespaceIds;
+export declare function NamespaceIdsFromJSONTyped(json: any, ignoreDiscriminator: boolean): NamespaceIds;
+export declare function NamespaceIdsToJSON(json: any): NamespaceIds;
+export declare function NamespaceIdsToJSONTyped(value?: NamespaceIds | null, ignoreDiscriminator?: boolean): any;

package/esm/api/models/NamespaceIds.js

@@ -0,0 +1,41 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the NamespaceIds interface.
+ */
+export function instanceOfNamespaceIds(value) {
+    return true;
+}
+export function NamespaceIdsFromJSON(json) {
+    return NamespaceIdsFromJSONTyped(json, false);
+}
+export function NamespaceIdsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'namespaceIds': json['namespaceIds'] == null ? undefined : json['namespaceIds'],
+    };
+}
+export function NamespaceIdsToJSON(json) {
+    return NamespaceIdsToJSONTyped(json, false);
+}
+export function NamespaceIdsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'namespaceIds': value['namespaceIds'],
+    };
+}

package/esm/api/models/NamespaceInfoDTO.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 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 type { NamespaceDTO } from './NamespaceDTO';
+import type { NamespaceMetaDTO } from './NamespaceMetaDTO';
+/**
+ * Namespace information including an internal resource identifier, metadata, and the full namespace state.
+ * @export
+ * @interface NamespaceInfoDTO
+ */
+export interface NamespaceInfoDTO {
+    /**
+     * Unique identifier of the object in the node's database (MongoDB ObjectId).
+     * Used as the `offset` parameter value for cursor-based pagination.
+     *
+     * @type {string}
+     * @memberof NamespaceInfoDTO
+     */
+    id: string;
+    /**
+     *
+     * @type {NamespaceMetaDTO}
+     * @memberof NamespaceInfoDTO
+     */
+    meta: NamespaceMetaDTO;
+    /**
+     *
+     * @type {NamespaceDTO}
+     * @memberof NamespaceInfoDTO
+     */
+    namespace: NamespaceDTO;
+}
+/**
+ * Check if a given object implements the NamespaceInfoDTO interface.
+ */
+export declare function instanceOfNamespaceInfoDTO(value: Record<string, any>): value is NamespaceInfoDTO;
+export declare function NamespaceInfoDTOFromJSON(json: any): NamespaceInfoDTO;
+export declare function NamespaceInfoDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): NamespaceInfoDTO;
+export declare function NamespaceInfoDTOToJSON(json: any): NamespaceInfoDTO;
+export declare function NamespaceInfoDTOToJSONTyped(value?: NamespaceInfoDTO | null, ignoreDiscriminator?: boolean): any;

package/esm/api/models/NamespaceInfoDTO.js

@@ -0,0 +1,53 @@
+/* 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.
+ */
+import { NamespaceDTOFromJSON, NamespaceDTOToJSON, } from './NamespaceDTO';
+import { NamespaceMetaDTOFromJSON, NamespaceMetaDTOToJSON, } from './NamespaceMetaDTO';
+/**
+ * Check if a given object implements the NamespaceInfoDTO interface.
+ */
+export function instanceOfNamespaceInfoDTO(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('meta' in value) || value['meta'] === undefined)
+        return false;
+    if (!('namespace' in value) || value['namespace'] === undefined)
+        return false;
+    return true;
+}
+export function NamespaceInfoDTOFromJSON(json) {
+    return NamespaceInfoDTOFromJSONTyped(json, false);
+}
+export function NamespaceInfoDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'meta': NamespaceMetaDTOFromJSON(json['meta']),
+        'namespace': NamespaceDTOFromJSON(json['namespace']),
+    };
+}
+export function NamespaceInfoDTOToJSON(json) {
+    return NamespaceInfoDTOToJSONTyped(json, false);
+}
+export function NamespaceInfoDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'meta': NamespaceMetaDTOToJSON(value['meta']),
+        'namespace': NamespaceDTOToJSON(value['namespace']),
+    };
+}

package/esm/api/models/NamespaceMetaDTO.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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.
+ */
+/**
+ * Metadata about the namespace entry.
+ * Includes whether the namespace is currently active and its internal ordering index.
+ *
+ * @export
+ * @interface NamespaceMetaDTO
+ */
+export interface NamespaceMetaDTO {
+    /**
+     * Indicates whether the namespace is currently active at the chain height used to serve the request.
+     * @type {boolean}
+     * @memberof NamespaceMetaDTO
+     */
+    active: boolean;
+    /**
+     * Internal namespace index used by the backend and Mongo storage to identify and order historical
+     * namespace entries. This value is returned for informational purposes only.
+     * API clients should not use it as a pagination cursor; use the standard pagination query parameters (`pageSize`,
+     * `pageNumber`, `offset`, `order`) instead.
+     *
+     * @type {number}
+     * @memberof NamespaceMetaDTO
+     */
+    index: number;
+}
+/**
+ * Check if a given object implements the NamespaceMetaDTO interface.
+ */
+export declare function instanceOfNamespaceMetaDTO(value: Record<string, any>): value is NamespaceMetaDTO;
+export declare function NamespaceMetaDTOFromJSON(json: any): NamespaceMetaDTO;
+export declare function NamespaceMetaDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): NamespaceMetaDTO;
+export declare function NamespaceMetaDTOToJSON(json: any): NamespaceMetaDTO;
+export declare function NamespaceMetaDTOToJSONTyped(value?: NamespaceMetaDTO | null, ignoreDiscriminator?: boolean): any;

package/esm/api/models/NamespaceMetaDTO.js

@@ -0,0 +1,47 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the NamespaceMetaDTO interface.
+ */
+export function instanceOfNamespaceMetaDTO(value) {
+    if (!('active' in value) || value['active'] === undefined)
+        return false;
+    if (!('index' in value) || value['index'] === undefined)
+        return false;
+    return true;
+}
+export function NamespaceMetaDTOFromJSON(json) {
+    return NamespaceMetaDTOFromJSONTyped(json, false);
+}
+export function NamespaceMetaDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'active': json['active'],
+        'index': json['index'],
+    };
+}
+export function NamespaceMetaDTOToJSON(json) {
+    return NamespaceMetaDTOToJSONTyped(json, false);
+}
+export function NamespaceMetaDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'active': value['active'],
+        'index': value['index'],
+    };
+}