@nemtus/symbol-rest-api-client-fetch 1.0.1 → 1.0.3

package/cjs/api/apis/SecretLockRoutesApi.d.ts

@@ -10,36 +10,151 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CompositeHashes, MerkleStateInfoDTO, Order, SecretLockInfoDTO, SecretLockPage } from '../models/index';
+import { type CompositeHashes } from '../models/CompositeHashes';
+import { type MerkleStateInfoDTO } from '../models/MerkleStateInfoDTO';
+import { type Order } from '../models/Order';
+import { type SecretLockInfoDTO } from '../models/SecretLockInfoDTO';
+import { type SecretLockPage } from '../models/SecretLockPage';
 export interface GetSecretLockRequest {
+    /**
+     * Composite hash encoded as a 64-character hexadecimal string.
+     */
     compositeHash: string;
 }
 export interface GetSecretLockMerkleRequest {
+    /**
+     * Composite hash encoded as a 64-character hexadecimal string.
+     */
     compositeHash: string;
 }
 export interface GetSecretLocksRequest {
+    /**
+     *
+     */
     compositeHashes: CompositeHashes;
 }
 export interface SearchAccountSecretLocksRequest {
+    /**
+     * Account address in Base32-encoded format.
+     */
     address: string;
+    /**
+     * Filter by the 256-bit hashed secret associated with the secret lock (include).
+     */
     secret?: string;
+    /**
+     * Select the number of entries to return per page.
+     * Values outside the allowed range are clamped to the schema minimum or maximum.
+     *
+     */
     pageSize?: number;
+    /**
+     * Page number for numbered pagination (1-based).
+     *
+     * Numbered and cursor pagination can be combined, but this is not recommended because the semantics
+     * are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by
+     * updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by
+     * incrementing `pageNumber`.
+     *
+     */
     pageNumber?: number;
+    /**
+     * Cursor for pagination. Provide the value of the sort field (`orderBy`) from the
+     * last entry of the previous page. **The offset type must match `orderBy`:**
+     * - `orderBy=id`: use the entry's `id` (ObjectId, 24-char hex).
+     * - `orderBy=height`: use the block height (string, e.g. `"17592"`).
+     * - `orderBy=balance`: use the mosaic balance amount (string, e.g. `"1000000"`).
+     *
+     * Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default.
+     *
+     * Set `offset` to the sort-field value of the last entry from the previous page. Across pages,
+     * this value decreases with `order=desc` and increases with `order=asc`.
+     *
+     * Numbered and cursor pagination can be combined, but this is not recommended because the semantics
+     * are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by
+     * updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by
+     * incrementing `pageNumber`.
+     *
+     */
     offset?: string;
+    /**
+     * Sort responses in ascending or descending order based on the collection property set on the param `orderBy`.
+     * If the request does not specify `orderBy`, REST returns the collection ordered by id.
+     * The default sort direction depends on the endpoint implementation.
+     *
+     */
     order?: Order;
 }
 export interface SearchSecretLockRequest {
+    /**
+     * Filter by address (include), in Base32 format.
+     *
+     * The exact meaning depends on the endpoint:
+     * - transaction search: returns transactions where the address appears as the sender, recipient, or cosigner
+     * - account search: matches the account address
+     * - account restriction search: matches the restricted account address
+     * - hash lock and secret lock search: matches the lock owner address
+     *
+     * On transaction search endpoints, this filter cannot be combined with `recipientAddress` and
+     * `signerPublicKey`.
+     *
+     */
     address?: string;
+    /**
+     * Filter by the 256-bit hashed secret associated with the secret lock (include).
+     */
     secret?: string;
+    /**
+     * Select the number of entries to return per page.
+     * Values outside the allowed range are clamped to the schema minimum or maximum.
+     *
+     */
     pageSize?: number;
+    /**
+     * Page number for numbered pagination (1-based).
+     *
+     * Numbered and cursor pagination can be combined, but this is not recommended because the semantics
+     * are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by
+     * updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by
+     * incrementing `pageNumber`.
+     *
+     */
     pageNumber?: number;
+    /**
+     * Cursor for pagination. Provide the value of the sort field (`orderBy`) from the
+     * last entry of the previous page. **The offset type must match `orderBy`:**
+     * - `orderBy=id`: use the entry's `id` (ObjectId, 24-char hex).
+     * - `orderBy=height`: use the block height (string, e.g. `"17592"`).
+     * - `orderBy=balance`: use the mosaic balance amount (string, e.g. `"1000000"`).
+     *
+     * Allowed `orderBy` values depend on the endpoint. If `orderBy` is omitted, `id` is used by default.
+     *
+     * Set `offset` to the sort-field value of the last entry from the previous page. Across pages,
+     * this value decreases with `order=desc` and increases with `order=asc`.
+     *
+     * Numbered and cursor pagination can be combined, but this is not recommended because the semantics
+     * are harder to reason about. For cursor-style flows, keep `pageNumber=1` and advance pages by
+     * updating only `offset`. For numbered pagination flows, omit `offset` and advance pages by
+     * incrementing `pageNumber`.
+     *
+     */
     offset?: string;
+    /**
+     * Sort responses in ascending or descending order based on the collection property set on the param `orderBy`.
+     * If the request does not specify `orderBy`, REST returns the collection ordered by id.
+     * The default sort direction depends on the endpoint implementation.
+     *
+     */
     order?: Order;
 }
 /**
  *
  */
 export declare class SecretLockRoutesApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for getSecretLock without sending the request
+     */
+    getSecretLockRequestOpts(requestParameters: GetSecretLockRequest): Promise<runtime.RequestOpts>;
     /**
      * Returns the secret lock entry associated with the given composite hash.
      * Get secret lock information
@@ -50,6 +165,10 @@ export declare class SecretLockRoutesApi extends runtime.BaseAPI {
      * Get secret lock information
      */
     getSecretLock(requestParameters: GetSecretLockRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecretLockInfoDTO>;
+    /**
+     * Creates request options for getSecretLockMerkle without sending the request
+     */
+    getSecretLockMerkleRequestOpts(requestParameters: GetSecretLockMerkleRequest): Promise<runtime.RequestOpts>;
     /**
      * Returns the state Merkle proof for the secret lock entry associated with the given composite hash.
      * Get secret lock Merkle information
@@ -60,6 +179,10 @@ export declare class SecretLockRoutesApi extends runtime.BaseAPI {
      * Get secret lock Merkle information
      */
     getSecretLockMerkle(requestParameters: GetSecretLockMerkleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MerkleStateInfoDTO>;
+    /**
+     * Creates request options for getSecretLocks without sending the request
+     */
+    getSecretLocksRequestOpts(requestParameters: GetSecretLocksRequest): Promise<runtime.RequestOpts>;
     /**
      * Returns secret lock entries associated with the given composite hashes.
      * Get secret lock information for an array of composite hashes
@@ -70,6 +193,10 @@ export declare class SecretLockRoutesApi extends runtime.BaseAPI {
      * Get secret lock information for an array of composite hashes
      */
     getSecretLocks(requestParameters: GetSecretLocksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SecretLockInfoDTO>>;
+    /**
+     * Creates request options for searchAccountSecretLocks without sending the request
+     */
+    searchAccountSecretLocksRequestOpts(requestParameters: SearchAccountSecretLocksRequest): Promise<runtime.RequestOpts>;
     /**
      * Returns a paginated list of secret lock entries owned by the given account address, optionally filtered by secret.
      * Search secret lock entries by account
@@ -80,6 +207,10 @@ export declare class SecretLockRoutesApi extends runtime.BaseAPI {
      * Search secret lock entries by account
      */
     searchAccountSecretLocks(requestParameters: SearchAccountSecretLocksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SecretLockPage>;
+    /**
+     * Creates request options for searchSecretLock without sending the request
+     */
+    searchSecretLockRequestOpts(requestParameters: SearchSecretLockRequest): Promise<runtime.RequestOpts>;
     /**
      * Returns a paginated list of secret lock entries, optionally filtered by owner address and secret.
      * Search secret lock entries

package/cjs/api/apis/SecretLockRoutesApi.js

@@ -57,16 +57,18 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SecretLockRoutesApi = void 0;
 const runtime = __importStar(require("../runtime"));
-const index_1 = require("../models/index");
+const CompositeHashes_1 = require("../models/CompositeHashes");
+const MerkleStateInfoDTO_1 = require("../models/MerkleStateInfoDTO");
+const SecretLockInfoDTO_1 = require("../models/SecretLockInfoDTO");
+const SecretLockPage_1 = require("../models/SecretLockPage");
 /**
  *
  */
 class SecretLockRoutesApi extends runtime.BaseAPI {
     /**
-     * Returns the secret lock entry associated with the given composite hash.
-     * Get secret lock information
+     * Creates request options for getSecretLock without sending the request
      */
-    getSecretLockRaw(requestParameters, initOverrides) {
+    getSecretLockRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['compositeHash'] == null) {
                 throw new runtime.RequiredError('compositeHash', 'Required parameter "compositeHash" was null or undefined when calling getSecretLock().');
@@ -74,14 +76,24 @@ class SecretLockRoutesApi extends runtime.BaseAPI {
             const queryParameters = {};
             const headerParameters = {};
             let urlPath = `/lock/secret/{compositeHash}`;
-            urlPath = urlPath.replace(`{${"compositeHash"}}`, encodeURIComponent(String(requestParameters['compositeHash'])));
-            const response = yield this.request({
+            urlPath = urlPath.replace('{compositeHash}', encodeURIComponent(String(requestParameters['compositeHash'])));
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SecretLockInfoDTOFromJSON)(jsonValue));
+            };
+        });
+    }
+    /**
+     * Returns the secret lock entry associated with the given composite hash.
+     * Get secret lock information
+     */
+    getSecretLockRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getSecretLockRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, SecretLockInfoDTO_1.SecretLockInfoDTOFromJSON)(jsonValue));
         });
     }
     /**
@@ -95,10 +107,9 @@ class SecretLockRoutesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Returns the state Merkle proof for the secret lock entry associated with the given composite hash.
-     * Get secret lock Merkle information
+     * Creates request options for getSecretLockMerkle without sending the request
      */
-    getSecretLockMerkleRaw(requestParameters, initOverrides) {
+    getSecretLockMerkleRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['compositeHash'] == null) {
                 throw new runtime.RequiredError('compositeHash', 'Required parameter "compositeHash" was null or undefined when calling getSecretLockMerkle().');
@@ -106,14 +117,24 @@ class SecretLockRoutesApi extends runtime.BaseAPI {
             const queryParameters = {};
             const headerParameters = {};
             let urlPath = `/lock/secret/{compositeHash}/merkle`;
-            urlPath = urlPath.replace(`{${"compositeHash"}}`, encodeURIComponent(String(requestParameters['compositeHash'])));
-            const response = yield this.request({
+            urlPath = urlPath.replace('{compositeHash}', encodeURIComponent(String(requestParameters['compositeHash'])));
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.MerkleStateInfoDTOFromJSON)(jsonValue));
+            };
+        });
+    }
+    /**
+     * Returns the state Merkle proof for the secret lock entry associated with the given composite hash.
+     * Get secret lock Merkle information
+     */
+    getSecretLockMerkleRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getSecretLockMerkleRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, MerkleStateInfoDTO_1.MerkleStateInfoDTOFromJSON)(jsonValue));
         });
     }
     /**
@@ -127,10 +148,9 @@ class SecretLockRoutesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Returns secret lock entries associated with the given composite hashes.
-     * Get secret lock information for an array of composite hashes
+     * Creates request options for getSecretLocks without sending the request
      */
-    getSecretLocksRaw(requestParameters, initOverrides) {
+    getSecretLocksRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['compositeHashes'] == null) {
                 throw new runtime.RequiredError('compositeHashes', 'Required parameter "compositeHashes" was null or undefined when calling getSecretLocks().');
@@ -139,14 +159,24 @@ class SecretLockRoutesApi extends runtime.BaseAPI {
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
             let urlPath = `/lock/secret`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
-                body: (0, index_1.CompositeHashesToJSON)(requestParameters['compositeHashes']),
-            }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.SecretLockInfoDTOFromJSON));
+                body: (0, CompositeHashes_1.CompositeHashesToJSON)(requestParameters['compositeHashes']),
+            };
+        });
+    }
+    /**
+     * Returns secret lock entries associated with the given composite hashes.
+     * Get secret lock information for an array of composite hashes
+     */
+    getSecretLocksRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getSecretLocksRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(SecretLockInfoDTO_1.SecretLockInfoDTOFromJSON));
         });
     }
     /**
@@ -160,10 +190,9 @@ class SecretLockRoutesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Returns a paginated list of secret lock entries owned by the given account address, optionally filtered by secret.
-     * Search secret lock entries by account
+     * Creates request options for searchAccountSecretLocks without sending the request
      */
-    searchAccountSecretLocksRaw(requestParameters, initOverrides) {
+    searchAccountSecretLocksRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['address'] == null) {
                 throw new runtime.RequiredError('address', 'Required parameter "address" was null or undefined when calling searchAccountSecretLocks().');
@@ -186,14 +215,24 @@ class SecretLockRoutesApi extends runtime.BaseAPI {
             }
             const headerParameters = {};
             let urlPath = `/account/{address}/lock/secret`;
-            urlPath = urlPath.replace(`{${"address"}}`, encodeURIComponent(String(requestParameters['address'])));
-            const response = yield this.request({
+            urlPath = urlPath.replace('{address}', encodeURIComponent(String(requestParameters['address'])));
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SecretLockPageFromJSON)(jsonValue));
+            };
+        });
+    }
+    /**
+     * Returns a paginated list of secret lock entries owned by the given account address, optionally filtered by secret.
+     * Search secret lock entries by account
+     */
+    searchAccountSecretLocksRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.searchAccountSecretLocksRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, SecretLockPage_1.SecretLockPageFromJSON)(jsonValue));
         });
     }
     /**
@@ -207,10 +246,9 @@ class SecretLockRoutesApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Returns a paginated list of secret lock entries, optionally filtered by owner address and secret.
-     * Search secret lock entries
+     * Creates request options for searchSecretLock without sending the request
      */
-    searchSecretLockRaw(requestParameters, initOverrides) {
+    searchSecretLockRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
             if (requestParameters['address'] != null) {
@@ -233,13 +271,23 @@ class SecretLockRoutesApi extends runtime.BaseAPI {
             }
             const headerParameters = {};
             let urlPath = `/lock/secret`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SecretLockPageFromJSON)(jsonValue));
+            };
+        });
+    }
+    /**
+     * Returns a paginated list of secret lock entries, optionally filtered by owner address and secret.
+     * Search secret lock entries
+     */
+    searchSecretLockRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.searchSecretLockRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, SecretLockPage_1.SecretLockPageFromJSON)(jsonValue));
         });
     }
     /**