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

package/esm/api/models/TransactionStatementDTO.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 { SourceDTOFromJSON, SourceDTOToJSON, } from './SourceDTO';
+import { TransactionStatementDTOReceiptsInnerFromJSON, TransactionStatementDTOReceiptsInnerToJSON, } from './TransactionStatementDTOReceiptsInner';
+/**
+ * Check if a given object implements the TransactionStatementDTO interface.
+ */
+export function instanceOfTransactionStatementDTO(value) {
+    if (!('height' in value) || value['height'] === undefined)
+        return false;
+    if (!('source' in value) || value['source'] === undefined)
+        return false;
+    if (!('receipts' in value) || value['receipts'] === undefined)
+        return false;
+    return true;
+}
+export function TransactionStatementDTOFromJSON(json) {
+    return TransactionStatementDTOFromJSONTyped(json, false);
+}
+export function TransactionStatementDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'height': json['height'],
+        'source': SourceDTOFromJSON(json['source']),
+        'receipts': (json['receipts'].map(TransactionStatementDTOReceiptsInnerFromJSON)),
+    };
+}
+export function TransactionStatementDTOToJSON(json) {
+    return TransactionStatementDTOToJSONTyped(json, false);
+}
+export function TransactionStatementDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'height': value['height'],
+        'source': SourceDTOToJSON(value['source']),
+        'receipts': (value['receipts'].map(TransactionStatementDTOReceiptsInnerToJSON)),
+    };
+}

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

@@ -0,0 +1,91 @@
+/**
+ * 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';
+/**
+ *
+ * @export
+ * @interface TransactionStatementDTOReceiptsInner
+ */
+export interface TransactionStatementDTOReceiptsInner {
+    /**
+     * Version of the receipt format.
+     * @type {number}
+     * @memberof TransactionStatementDTOReceiptsInner
+     */
+    version: number;
+    /**
+     *
+     * @type {ReceiptTypeEnum}
+     * @memberof TransactionStatementDTOReceiptsInner
+     */
+    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 TransactionStatementDTOReceiptsInner
+     */
+    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 TransactionStatementDTOReceiptsInner
+     */
+    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 TransactionStatementDTOReceiptsInner
+     */
+    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 TransactionStatementDTOReceiptsInner
+     */
+    recipientAddress: 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 TransactionStatementDTOReceiptsInner
+     */
+    targetAddress: string;
+    /**
+     * 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 TransactionStatementDTOReceiptsInner
+     */
+    artifactId: string;
+}
+/**
+ * Check if a given object implements the TransactionStatementDTOReceiptsInner interface.
+ */
+export declare function instanceOfTransactionStatementDTOReceiptsInner(value: Record<string, any>): value is TransactionStatementDTOReceiptsInner;
+export declare function TransactionStatementDTOReceiptsInnerFromJSON(json: any): TransactionStatementDTOReceiptsInner;
+export declare function TransactionStatementDTOReceiptsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionStatementDTOReceiptsInner;
+export declare function TransactionStatementDTOReceiptsInnerToJSON(json: any): TransactionStatementDTOReceiptsInner;
+export declare function TransactionStatementDTOReceiptsInnerToJSONTyped(value?: TransactionStatementDTOReceiptsInner | null, ignoreDiscriminator?: boolean): any;

package/esm/api/models/TransactionStatementDTOReceiptsInner.js

@@ -0,0 +1,72 @@
+/* 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 TransactionStatementDTOReceiptsInner interface.
+ */
+export function instanceOfTransactionStatementDTOReceiptsInner(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;
+    if (!('targetAddress' in value) || value['targetAddress'] === undefined)
+        return false;
+    if (!('artifactId' in value) || value['artifactId'] === undefined)
+        return false;
+    return true;
+}
+export function TransactionStatementDTOReceiptsInnerFromJSON(json) {
+    return TransactionStatementDTOReceiptsInnerFromJSONTyped(json, false);
+}
+export function TransactionStatementDTOReceiptsInnerFromJSONTyped(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'],
+        'targetAddress': json['targetAddress'],
+        'artifactId': json['artifactId'],
+    };
+}
+export function TransactionStatementDTOReceiptsInnerToJSON(json) {
+    return TransactionStatementDTOReceiptsInnerToJSONTyped(json, false);
+}
+export function TransactionStatementDTOReceiptsInnerToJSONTyped(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'],
+        'targetAddress': value['targetAddress'],
+        'artifactId': value['artifactId'],
+    };
+}

package/esm/api/models/TransactionStatementInfoDTO.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 { StatementMetaDTO } from './StatementMetaDTO';
+import type { TransactionStatementDTO } from './TransactionStatementDTO';
+/**
+ * Wrapper object containing one transaction statement and its metadata.
+ * @export
+ * @interface TransactionStatementInfoDTO
+ */
+export interface TransactionStatementInfoDTO {
+    /**
+     * 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 TransactionStatementInfoDTO
+     */
+    id: string;
+    /**
+     *
+     * @type {StatementMetaDTO}
+     * @memberof TransactionStatementInfoDTO
+     */
+    meta: StatementMetaDTO;
+    /**
+     *
+     * @type {TransactionStatementDTO}
+     * @memberof TransactionStatementInfoDTO
+     */
+    statement: TransactionStatementDTO;
+}
+/**
+ * Check if a given object implements the TransactionStatementInfoDTO interface.
+ */
+export declare function instanceOfTransactionStatementInfoDTO(value: Record<string, any>): value is TransactionStatementInfoDTO;
+export declare function TransactionStatementInfoDTOFromJSON(json: any): TransactionStatementInfoDTO;
+export declare function TransactionStatementInfoDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionStatementInfoDTO;
+export declare function TransactionStatementInfoDTOToJSON(json: any): TransactionStatementInfoDTO;
+export declare function TransactionStatementInfoDTOToJSONTyped(value?: TransactionStatementInfoDTO | null, ignoreDiscriminator?: boolean): any;

package/esm/api/models/TransactionStatementInfoDTO.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 { StatementMetaDTOFromJSON, StatementMetaDTOToJSON, } from './StatementMetaDTO';
+import { TransactionStatementDTOFromJSON, TransactionStatementDTOToJSON, } from './TransactionStatementDTO';
+/**
+ * Check if a given object implements the TransactionStatementInfoDTO interface.
+ */
+export function instanceOfTransactionStatementInfoDTO(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('meta' in value) || value['meta'] === undefined)
+        return false;
+    if (!('statement' in value) || value['statement'] === undefined)
+        return false;
+    return true;
+}
+export function TransactionStatementInfoDTOFromJSON(json) {
+    return TransactionStatementInfoDTOFromJSONTyped(json, false);
+}
+export function TransactionStatementInfoDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'meta': StatementMetaDTOFromJSON(json['meta']),
+        'statement': TransactionStatementDTOFromJSON(json['statement']),
+    };
+}
+export function TransactionStatementInfoDTOToJSON(json) {
+    return TransactionStatementInfoDTOToJSONTyped(json, false);
+}
+export function TransactionStatementInfoDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'meta': StatementMetaDTOToJSON(value['meta']),
+        'statement': TransactionStatementDTOToJSON(value['statement']),
+    };
+}

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

@@ -0,0 +1,40 @@
+/**
+ * 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 { Pagination } from './Pagination';
+import type { TransactionStatementInfoDTO } from './TransactionStatementInfoDTO';
+/**
+ * Paginated response containing transaction statements.
+ * @export
+ * @interface TransactionStatementPage
+ */
+export interface TransactionStatementPage {
+    /**
+     * Transaction statements matching the requested filters.
+     * @type {Array<TransactionStatementInfoDTO>}
+     * @memberof TransactionStatementPage
+     */
+    data: Array<TransactionStatementInfoDTO>;
+    /**
+     *
+     * @type {Pagination}
+     * @memberof TransactionStatementPage
+     */
+    pagination: Pagination;
+}
+/**
+ * Check if a given object implements the TransactionStatementPage interface.
+ */
+export declare function instanceOfTransactionStatementPage(value: Record<string, any>): value is TransactionStatementPage;
+export declare function TransactionStatementPageFromJSON(json: any): TransactionStatementPage;
+export declare function TransactionStatementPageFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionStatementPage;
+export declare function TransactionStatementPageToJSON(json: any): TransactionStatementPage;
+export declare function TransactionStatementPageToJSONTyped(value?: TransactionStatementPage | null, ignoreDiscriminator?: boolean): any;

package/esm/api/models/TransactionStatementPage.js

@@ -0,0 +1,49 @@
+/* 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 { PaginationFromJSON, PaginationToJSON, } from './Pagination';
+import { TransactionStatementInfoDTOFromJSON, TransactionStatementInfoDTOToJSON, } from './TransactionStatementInfoDTO';
+/**
+ * Check if a given object implements the TransactionStatementPage interface.
+ */
+export function instanceOfTransactionStatementPage(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if (!('pagination' in value) || value['pagination'] === undefined)
+        return false;
+    return true;
+}
+export function TransactionStatementPageFromJSON(json) {
+    return TransactionStatementPageFromJSONTyped(json, false);
+}
+export function TransactionStatementPageFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(TransactionStatementInfoDTOFromJSON)),
+        'pagination': PaginationFromJSON(json['pagination']),
+    };
+}
+export function TransactionStatementPageToJSON(json) {
+    return TransactionStatementPageToJSONTyped(json, false);
+}
+export function TransactionStatementPageToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(TransactionStatementInfoDTOToJSON)),
+        'pagination': PaginationToJSON(value['pagination']),
+    };
+}

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

@@ -0,0 +1,70 @@
+/**
+ * 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 { TransactionGroupEnum } from './TransactionGroupEnum';
+import type { TransactionStatusEnum } from './TransactionStatusEnum';
+/**
+ * Current processing status of a transaction identified by its hash.
+ * @export
+ * @interface TransactionStatusDTO
+ */
+export interface TransactionStatusDTO {
+    /**
+     *
+     * @type {TransactionGroupEnum}
+     * @memberof TransactionStatusDTO
+     */
+    group: TransactionGroupEnum;
+    /**
+     *
+     * @type {TransactionStatusEnum}
+     * @memberof TransactionStatusDTO
+     */
+    code?: TransactionStatusEnum;
+    /**
+     * 256-bit hash encoded as a 64-character hexadecimal string.
+     * @type {string}
+     * @memberof TransactionStatusDTO
+     */
+    hash: string;
+    /**
+     * Network timestamp in **milliseconds** since the creation of the nemesis (first) block.
+     * Used for block timestamps, transaction deadlines, and time synchronization.
+     *
+     * **Finding the nemesis block time:** The `epochAdjustment` field returned by the
+     * [`/network/properties`] endpoint gives the nemesis block creation time in seconds since the
+     * [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). For Symbol MAINNET this is
+     * always `1615853185` (15 March 2021, 00:06:25 UTC).
+     *
+     * **Converting to real time:** Add this timestamp (ms) to `epochAdjustment × 1000` (ms), then use standard date functions.
+     * Note: `epochAdjustment` may be returned as a string like `"1615853185s"`; use the numeric part.
+     *
+     * @type {string}
+     * @memberof TransactionStatusDTO
+     */
+    deadline: 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 TransactionStatusDTO
+     */
+    height?: string;
+}
+/**
+ * Check if a given object implements the TransactionStatusDTO interface.
+ */
+export declare function instanceOfTransactionStatusDTO(value: Record<string, any>): value is TransactionStatusDTO;
+export declare function TransactionStatusDTOFromJSON(json: any): TransactionStatusDTO;
+export declare function TransactionStatusDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionStatusDTO;
+export declare function TransactionStatusDTOToJSON(json: any): TransactionStatusDTO;
+export declare function TransactionStatusDTOToJSONTyped(value?: TransactionStatusDTO | null, ignoreDiscriminator?: boolean): any;

package/esm/api/models/TransactionStatusDTO.js

@@ -0,0 +1,57 @@
+/* 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 { TransactionGroupEnumFromJSON, TransactionGroupEnumToJSON, } from './TransactionGroupEnum';
+import { TransactionStatusEnumFromJSON, TransactionStatusEnumToJSON, } from './TransactionStatusEnum';
+/**
+ * Check if a given object implements the TransactionStatusDTO interface.
+ */
+export function instanceOfTransactionStatusDTO(value) {
+    if (!('group' in value) || value['group'] === undefined)
+        return false;
+    if (!('hash' in value) || value['hash'] === undefined)
+        return false;
+    if (!('deadline' in value) || value['deadline'] === undefined)
+        return false;
+    return true;
+}
+export function TransactionStatusDTOFromJSON(json) {
+    return TransactionStatusDTOFromJSONTyped(json, false);
+}
+export function TransactionStatusDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'group': TransactionGroupEnumFromJSON(json['group']),
+        'code': json['code'] == null ? undefined : TransactionStatusEnumFromJSON(json['code']),
+        'hash': json['hash'],
+        'deadline': json['deadline'],
+        'height': json['height'] == null ? undefined : json['height'],
+    };
+}
+export function TransactionStatusDTOToJSON(json) {
+    return TransactionStatusDTOToJSONTyped(json, false);
+}
+export function TransactionStatusDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'group': TransactionGroupEnumToJSON(value['group']),
+        'code': TransactionStatusEnumToJSON(value['code']),
+        'hash': value['hash'],
+        'deadline': value['deadline'],
+        'height': value['height'],
+    };
+}