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

package/esm/api/models/AliasDTO.js

@@ -0,0 +1,48 @@
+/* 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 { AliasTypeEnumFromJSON, AliasTypeEnumToJSON, } from './AliasTypeEnum';
+/**
+ * Check if a given object implements the AliasDTO interface.
+ */
+export function instanceOfAliasDTO(value) {
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    return true;
+}
+export function AliasDTOFromJSON(json) {
+    return AliasDTOFromJSONTyped(json, false);
+}
+export function AliasDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'type': AliasTypeEnumFromJSON(json['type']),
+        'mosaicId': json['mosaicId'] == null ? undefined : json['mosaicId'],
+        'address': json['address'] == null ? undefined : json['address'],
+    };
+}
+export function AliasDTOToJSON(json) {
+    return AliasDTOToJSONTyped(json, false);
+}
+export function AliasDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'type': AliasTypeEnumToJSON(value['type']),
+        'mosaicId': value['mosaicId'],
+        'address': value['address'],
+    };
+}

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

@@ -0,0 +1,33 @@
+/**
+ * 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.
+ */
+/**
+ * Type of alias currently linked to the namespace.
+ * A namespace can either have no alias assigned, point to a mosaic ID, or point to
+ * an account address.
+ *
+ * - 0: No alias is linked to the namespace.
+ * - 1: The namespace is linked to a mosaic ID and can be used as a mosaic alias.
+ * - 2: The namespace is linked to an account address and can be used as an address alias.
+ *
+ * @export
+ */
+export declare const AliasTypeEnum: {
+    readonly NUMBER_0: 0;
+    readonly NUMBER_1: 1;
+    readonly NUMBER_2: 2;
+};
+export type AliasTypeEnum = typeof AliasTypeEnum[keyof typeof AliasTypeEnum];
+export declare function instanceOfAliasTypeEnum(value: any): boolean;
+export declare function AliasTypeEnumFromJSON(json: any): AliasTypeEnum;
+export declare function AliasTypeEnumFromJSONTyped(json: any, ignoreDiscriminator: boolean): AliasTypeEnum;
+export declare function AliasTypeEnumToJSON(value?: AliasTypeEnum | null): any;
+export declare function AliasTypeEnumToJSONTyped(value: any, ignoreDiscriminator: boolean): AliasTypeEnum;

package/esm/api/models/AliasTypeEnum.js

@@ -0,0 +1,51 @@
+/* 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.
+ */
+/**
+ * Type of alias currently linked to the namespace.
+ * A namespace can either have no alias assigned, point to a mosaic ID, or point to
+ * an account address.
+ *
+ * - 0: No alias is linked to the namespace.
+ * - 1: The namespace is linked to a mosaic ID and can be used as a mosaic alias.
+ * - 2: The namespace is linked to an account address and can be used as an address alias.
+ *
+ * @export
+ */
+export const AliasTypeEnum = {
+    NUMBER_0: 0,
+    NUMBER_1: 1,
+    NUMBER_2: 2
+};
+export function instanceOfAliasTypeEnum(value) {
+    for (const key in AliasTypeEnum) {
+        if (Object.prototype.hasOwnProperty.call(AliasTypeEnum, key)) {
+            if (AliasTypeEnum[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function AliasTypeEnumFromJSON(json) {
+    return AliasTypeEnumFromJSONTyped(json, false);
+}
+export function AliasTypeEnumFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function AliasTypeEnumToJSON(value) {
+    return value;
+}
+export function AliasTypeEnumToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/esm/api/models/AnnounceTransactionInfoDTO.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.
+ */
+/**
+ * Informational response returned after a transaction announce request is accepted.
+ *
+ * This object does not contain the announced transaction payload or its final execution result. It
+ * only carries the node message associated with the announce request.
+ *
+ * Acceptance by a node does not mean the transaction is already part of the blockchain. The
+ * transaction still needs to be validated and confirmed by the network.
+ *
+ * To verify the final result, query `GET /transactionStatus/{hash}` on the same node that received
+ * the announce request. If that node drops the transaction before propagation, other nodes may not
+ * know the transaction at all and can return `404` for the same hash.
+ *
+ * In some cases the transaction can be dropped without any failure status being returned. Common causes include using
+ * a fee below the minimum accepted by that node or using a generation hash seed that does not match the target network.
+ * Transaction status availability is not guaranteed indefinitely: failed statuses are stored in a capped collection
+ * and may be evicted as new entries arrive.
+ *
+ * @export
+ * @interface AnnounceTransactionInfoDTO
+ */
+export interface AnnounceTransactionInfoDTO {
+    /**
+     * Human-readable message returned by the node for the announce request.
+     * @type {string}
+     * @memberof AnnounceTransactionInfoDTO
+     */
+    message: string;
+}
+/**
+ * Check if a given object implements the AnnounceTransactionInfoDTO interface.
+ */
+export declare function instanceOfAnnounceTransactionInfoDTO(value: Record<string, any>): value is AnnounceTransactionInfoDTO;
+export declare function AnnounceTransactionInfoDTOFromJSON(json: any): AnnounceTransactionInfoDTO;
+export declare function AnnounceTransactionInfoDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): AnnounceTransactionInfoDTO;
+export declare function AnnounceTransactionInfoDTOToJSON(json: any): AnnounceTransactionInfoDTO;
+export declare function AnnounceTransactionInfoDTOToJSONTyped(value?: AnnounceTransactionInfoDTO | null, ignoreDiscriminator?: boolean): any;

package/esm/api/models/AnnounceTransactionInfoDTO.js

@@ -0,0 +1,43 @@
+/* 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 AnnounceTransactionInfoDTO interface.
+ */
+export function instanceOfAnnounceTransactionInfoDTO(value) {
+    if (!('message' in value) || value['message'] === undefined)
+        return false;
+    return true;
+}
+export function AnnounceTransactionInfoDTOFromJSON(json) {
+    return AnnounceTransactionInfoDTOFromJSONTyped(json, false);
+}
+export function AnnounceTransactionInfoDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'message': json['message'],
+    };
+}
+export function AnnounceTransactionInfoDTOToJSON(json) {
+    return AnnounceTransactionInfoDTOToJSONTyped(json, false);
+}
+export function AnnounceTransactionInfoDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'message': value['message'],
+    };
+}

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

@@ -0,0 +1,69 @@
+/**
+ * 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 transaction execution changes an account mosaic balance.
+ * For example, this receipt is emitted when harvesting rewards are credited to the harvester or
+ * beneficiary account.
+ *
+ * @export
+ * @interface BalanceChangeReceiptDTO
+ */
+export interface BalanceChangeReceiptDTO {
+    /**
+     * Version of the receipt format.
+     * @type {number}
+     * @memberof BalanceChangeReceiptDTO
+     */
+    version: number;
+    /**
+     *
+     * @type {ReceiptTypeEnum}
+     * @memberof BalanceChangeReceiptDTO
+     */
+    type: ReceiptTypeEnum;
+    /**
+     * Unique [mosaic](https://docs.symbol.dev/concepts/mosaic.html) identifier.
+     * A 64-bit unsigned integer derived from the creator's address and a registration nonce,
+     * encoded as a 16-character hexadecimal string.
+     *
+     * @type {string}
+     * @memberof BalanceChangeReceiptDTO
+     */
+    mosaicId: string;
+    /**
+     * Absolute amount expressed in the mosaic's smallest (atomic) unit, with no decimal point.
+     * For example, an amount of `123456789` for a mosaic with divisibility 6 represents
+     * `123.456789` whole units. Encoded as a string to preserve precision, since the value
+     * is an unsigned 64-bit integer.
+     *
+     * @type {string}
+     * @memberof BalanceChangeReceiptDTO
+     */
+    amount: 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 BalanceChangeReceiptDTO
+     */
+    targetAddress: string;
+}
+/**
+ * Check if a given object implements the BalanceChangeReceiptDTO interface.
+ */
+export declare function instanceOfBalanceChangeReceiptDTO(value: Record<string, any>): value is BalanceChangeReceiptDTO;
+export declare function BalanceChangeReceiptDTOFromJSON(json: any): BalanceChangeReceiptDTO;
+export declare function BalanceChangeReceiptDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): BalanceChangeReceiptDTO;
+export declare function BalanceChangeReceiptDTOToJSON(json: any): BalanceChangeReceiptDTO;
+export declare function BalanceChangeReceiptDTOToJSONTyped(value?: BalanceChangeReceiptDTO | null, ignoreDiscriminator?: boolean): any;

package/esm/api/models/BalanceChangeReceiptDTO.js

@@ -0,0 +1,60 @@
+/* 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 BalanceChangeReceiptDTO interface.
+ */
+export function instanceOfBalanceChangeReceiptDTO(value) {
+    if (!('version' in value) || value['version'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('mosaicId' in value) || value['mosaicId'] === undefined)
+        return false;
+    if (!('amount' in value) || value['amount'] === undefined)
+        return false;
+    if (!('targetAddress' in value) || value['targetAddress'] === undefined)
+        return false;
+    return true;
+}
+export function BalanceChangeReceiptDTOFromJSON(json) {
+    return BalanceChangeReceiptDTOFromJSONTyped(json, false);
+}
+export function BalanceChangeReceiptDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'version': json['version'],
+        'type': ReceiptTypeEnumFromJSON(json['type']),
+        'mosaicId': json['mosaicId'],
+        'amount': json['amount'],
+        'targetAddress': json['targetAddress'],
+    };
+}
+export function BalanceChangeReceiptDTOToJSON(json) {
+    return BalanceChangeReceiptDTOToJSONTyped(json, false);
+}
+export function BalanceChangeReceiptDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'version': value['version'],
+        'type': ReceiptTypeEnumToJSON(value['type']),
+        'mosaicId': value['mosaicId'],
+        'amount': value['amount'],
+        'targetAddress': value['targetAddress'],
+    };
+}

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

@@ -0,0 +1,78 @@
+/**
+ * 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 transaction execution transfers a mosaic balance between accounts.
+ * For example, this receipt is emitted when mosaic or namespace rental fees are paid.
+ * In that case, the sender address is the account registering the mosaic or namespace, and the
+ * recipient address is the configured rental fee sink address.
+ *
+ * @export
+ * @interface BalanceTransferReceiptDTO
+ */
+export interface BalanceTransferReceiptDTO {
+    /**
+     * Version of the receipt format.
+     * @type {number}
+     * @memberof BalanceTransferReceiptDTO
+     */
+    version: number;
+    /**
+     *
+     * @type {ReceiptTypeEnum}
+     * @memberof BalanceTransferReceiptDTO
+     */
+    type: ReceiptTypeEnum;
+    /**
+     * Unique [mosaic](https://docs.symbol.dev/concepts/mosaic.html) identifier.
+     * A 64-bit unsigned integer derived from the creator's address and a registration nonce,
+     * encoded as a 16-character hexadecimal string.
+     *
+     * @type {string}
+     * @memberof BalanceTransferReceiptDTO
+     */
+    mosaicId: string;
+    /**
+     * Absolute amount expressed in the mosaic's smallest (atomic) unit, with no decimal point.
+     * For example, an amount of `123456789` for a mosaic with divisibility 6 represents
+     * `123.456789` whole units. Encoded as a string to preserve precision, since the value
+     * is an unsigned 64-bit integer.
+     *
+     * @type {string}
+     * @memberof BalanceTransferReceiptDTO
+     */
+    amount: 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 BalanceTransferReceiptDTO
+     */
+    senderAddress: 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 BalanceTransferReceiptDTO
+     */
+    recipientAddress: string;
+}
+/**
+ * Check if a given object implements the BalanceTransferReceiptDTO interface.
+ */
+export declare function instanceOfBalanceTransferReceiptDTO(value: Record<string, any>): value is BalanceTransferReceiptDTO;
+export declare function BalanceTransferReceiptDTOFromJSON(json: any): BalanceTransferReceiptDTO;
+export declare function BalanceTransferReceiptDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): BalanceTransferReceiptDTO;
+export declare function BalanceTransferReceiptDTOToJSON(json: any): BalanceTransferReceiptDTO;
+export declare function BalanceTransferReceiptDTOToJSONTyped(value?: BalanceTransferReceiptDTO | null, ignoreDiscriminator?: boolean): any;

package/esm/api/models/BalanceTransferReceiptDTO.js

@@ -0,0 +1,64 @@
+/* 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 BalanceTransferReceiptDTO interface.
+ */
+export function instanceOfBalanceTransferReceiptDTO(value) {
+    if (!('version' in value) || value['version'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('mosaicId' in value) || value['mosaicId'] === undefined)
+        return false;
+    if (!('amount' in value) || value['amount'] === undefined)
+        return false;
+    if (!('senderAddress' in value) || value['senderAddress'] === undefined)
+        return false;
+    if (!('recipientAddress' in value) || value['recipientAddress'] === undefined)
+        return false;
+    return true;
+}
+export function BalanceTransferReceiptDTOFromJSON(json) {
+    return BalanceTransferReceiptDTOFromJSONTyped(json, false);
+}
+export function BalanceTransferReceiptDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'version': json['version'],
+        'type': ReceiptTypeEnumFromJSON(json['type']),
+        'mosaicId': json['mosaicId'],
+        'amount': json['amount'],
+        'senderAddress': json['senderAddress'],
+        'recipientAddress': json['recipientAddress'],
+    };
+}
+export function BalanceTransferReceiptDTOToJSON(json) {
+    return BalanceTransferReceiptDTOToJSONTyped(json, false);
+}
+export function BalanceTransferReceiptDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'version': value['version'],
+        'type': ReceiptTypeEnumToJSON(value['type']),
+        'mosaicId': value['mosaicId'],
+        'amount': value['amount'],
+        'senderAddress': value['senderAddress'],
+        'recipientAddress': value['recipientAddress'],
+    };
+}