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

package/cjs/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/cjs/api/models/NamespaceExpiryReceiptDTO.js

@@ -0,0 +1,59 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfNamespaceExpiryReceiptDTO = instanceOfNamespaceExpiryReceiptDTO;
+exports.NamespaceExpiryReceiptDTOFromJSON = NamespaceExpiryReceiptDTOFromJSON;
+exports.NamespaceExpiryReceiptDTOFromJSONTyped = NamespaceExpiryReceiptDTOFromJSONTyped;
+exports.NamespaceExpiryReceiptDTOToJSON = NamespaceExpiryReceiptDTOToJSON;
+exports.NamespaceExpiryReceiptDTOToJSONTyped = NamespaceExpiryReceiptDTOToJSONTyped;
+const ReceiptTypeEnum_1 = require("./ReceiptTypeEnum");
+/**
+ * Check if a given object implements the NamespaceExpiryReceiptDTO interface.
+ */
+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;
+}
+function NamespaceExpiryReceiptDTOFromJSON(json) {
+    return NamespaceExpiryReceiptDTOFromJSONTyped(json, false);
+}
+function NamespaceExpiryReceiptDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'version': json['version'],
+        'type': (0, ReceiptTypeEnum_1.ReceiptTypeEnumFromJSON)(json['type']),
+        'artifactId': json['artifactId'],
+    };
+}
+function NamespaceExpiryReceiptDTOToJSON(json) {
+    return NamespaceExpiryReceiptDTOToJSONTyped(json, false);
+}
+function NamespaceExpiryReceiptDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'version': value['version'],
+        'type': (0, ReceiptTypeEnum_1.ReceiptTypeEnumToJSON)(value['type']),
+        'artifactId': value['artifactId'],
+    };
+}

package/cjs/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/cjs/api/models/NamespaceIds.js

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

package/cjs/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/cjs/api/models/NamespaceInfoDTO.js

@@ -0,0 +1,60 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfNamespaceInfoDTO = instanceOfNamespaceInfoDTO;
+exports.NamespaceInfoDTOFromJSON = NamespaceInfoDTOFromJSON;
+exports.NamespaceInfoDTOFromJSONTyped = NamespaceInfoDTOFromJSONTyped;
+exports.NamespaceInfoDTOToJSON = NamespaceInfoDTOToJSON;
+exports.NamespaceInfoDTOToJSONTyped = NamespaceInfoDTOToJSONTyped;
+const NamespaceDTO_1 = require("./NamespaceDTO");
+const NamespaceMetaDTO_1 = require("./NamespaceMetaDTO");
+/**
+ * Check if a given object implements the NamespaceInfoDTO interface.
+ */
+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;
+}
+function NamespaceInfoDTOFromJSON(json) {
+    return NamespaceInfoDTOFromJSONTyped(json, false);
+}
+function NamespaceInfoDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'meta': (0, NamespaceMetaDTO_1.NamespaceMetaDTOFromJSON)(json['meta']),
+        'namespace': (0, NamespaceDTO_1.NamespaceDTOFromJSON)(json['namespace']),
+    };
+}
+function NamespaceInfoDTOToJSON(json) {
+    return NamespaceInfoDTOToJSONTyped(json, false);
+}
+function NamespaceInfoDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'meta': (0, NamespaceMetaDTO_1.NamespaceMetaDTOToJSON)(value['meta']),
+        'namespace': (0, NamespaceDTO_1.NamespaceDTOToJSON)(value['namespace']),
+    };
+}

package/cjs/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/cjs/api/models/NamespaceMetaDTO.js

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

package/cjs/api/models/NamespaceMetadataTransactionBodyDTO.d.ts

@@ -0,0 +1,80 @@
+/**
+ * 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.
+ */
+/**
+ * Namespace metadata transaction body with the target namespace, metadata key, and metadata value
+ * update.
+ *
+ * @export
+ * @interface NamespaceMetadataTransactionBodyDTO
+ */
+export interface NamespaceMetadataTransactionBodyDTO {
+    /**
+     * Unresolved address encoded as a 48-character hexadecimal string (24 bytes).
+     * If bit 0 of byte 0 is not set, the value represents a regular address.
+     * Otherwise, it represents a namespace ID alias encoded as an unresolved address.
+     *
+     * @type {string}
+     * @memberof NamespaceMetadataTransactionBodyDTO
+     */
+    targetAddress: string;
+    /**
+     * 64-bit key assigned by the metadata creator to identify the metadata entry within the source and target context.
+     * @type {string}
+     * @memberof NamespaceMetadataTransactionBodyDTO
+     */
+    scopedMetadataKey: 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 NamespaceMetadataTransactionBodyDTO
+     */
+    targetNamespaceId: string;
+    /**
+     * Change in metadata value size, in bytes.
+     * Positive values increase the stored value size, negative values decrease it.
+     *
+     * @type {number}
+     * @memberof NamespaceMetadataTransactionBodyDTO
+     */
+    valueSizeDelta: number;
+    /**
+     * Size of a metadata value or metadata value update payload, in bytes.
+     * In metadata transactions, when no previous value exists, or when the value grows, this is the new
+     * value size after applying the update. When the value shrinks, this is the previous stored value size
+     * before truncation.
+     *
+     * @type {number}
+     * @memberof NamespaceMetadataTransactionBodyDTO
+     */
+    valueSize: number;
+    /**
+     * Metadata value encoded as hex.
+     * In metadata transactions, this field carries the metadata value update payload.
+     * When no previous value exists, it contains the new value.
+     * When updating existing metadata, it contains the byte-wise XOR of the previous value and the new value.
+     *
+     * @type {string}
+     * @memberof NamespaceMetadataTransactionBodyDTO
+     */
+    value: string;
+}
+/**
+ * Check if a given object implements the NamespaceMetadataTransactionBodyDTO interface.
+ */
+export declare function instanceOfNamespaceMetadataTransactionBodyDTO(value: Record<string, any>): value is NamespaceMetadataTransactionBodyDTO;
+export declare function NamespaceMetadataTransactionBodyDTOFromJSON(json: any): NamespaceMetadataTransactionBodyDTO;
+export declare function NamespaceMetadataTransactionBodyDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): NamespaceMetadataTransactionBodyDTO;
+export declare function NamespaceMetadataTransactionBodyDTOToJSON(json: any): NamespaceMetadataTransactionBodyDTO;
+export declare function NamespaceMetadataTransactionBodyDTOToJSONTyped(value?: NamespaceMetadataTransactionBodyDTO | null, ignoreDiscriminator?: boolean): any;

package/cjs/api/models/NamespaceMetadataTransactionBodyDTO.js

@@ -0,0 +1,70 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfNamespaceMetadataTransactionBodyDTO = instanceOfNamespaceMetadataTransactionBodyDTO;
+exports.NamespaceMetadataTransactionBodyDTOFromJSON = NamespaceMetadataTransactionBodyDTOFromJSON;
+exports.NamespaceMetadataTransactionBodyDTOFromJSONTyped = NamespaceMetadataTransactionBodyDTOFromJSONTyped;
+exports.NamespaceMetadataTransactionBodyDTOToJSON = NamespaceMetadataTransactionBodyDTOToJSON;
+exports.NamespaceMetadataTransactionBodyDTOToJSONTyped = NamespaceMetadataTransactionBodyDTOToJSONTyped;
+/**
+ * Check if a given object implements the NamespaceMetadataTransactionBodyDTO interface.
+ */
+function instanceOfNamespaceMetadataTransactionBodyDTO(value) {
+    if (!('targetAddress' in value) || value['targetAddress'] === undefined)
+        return false;
+    if (!('scopedMetadataKey' in value) || value['scopedMetadataKey'] === undefined)
+        return false;
+    if (!('targetNamespaceId' in value) || value['targetNamespaceId'] === undefined)
+        return false;
+    if (!('valueSizeDelta' in value) || value['valueSizeDelta'] === undefined)
+        return false;
+    if (!('valueSize' in value) || value['valueSize'] === undefined)
+        return false;
+    if (!('value' in value) || value['value'] === undefined)
+        return false;
+    return true;
+}
+function NamespaceMetadataTransactionBodyDTOFromJSON(json) {
+    return NamespaceMetadataTransactionBodyDTOFromJSONTyped(json, false);
+}
+function NamespaceMetadataTransactionBodyDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'targetAddress': json['targetAddress'],
+        'scopedMetadataKey': json['scopedMetadataKey'],
+        'targetNamespaceId': json['targetNamespaceId'],
+        'valueSizeDelta': json['valueSizeDelta'],
+        'valueSize': json['valueSize'],
+        'value': json['value'],
+    };
+}
+function NamespaceMetadataTransactionBodyDTOToJSON(json) {
+    return NamespaceMetadataTransactionBodyDTOToJSONTyped(json, false);
+}
+function NamespaceMetadataTransactionBodyDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'targetAddress': value['targetAddress'],
+        'scopedMetadataKey': value['scopedMetadataKey'],
+        'targetNamespaceId': value['targetNamespaceId'],
+        'valueSizeDelta': value['valueSizeDelta'],
+        'valueSize': value['valueSize'],
+        'value': value['value'],
+    };
+}