@owneraio/finp2p-sdk-js 0.16.27 → 0.16.29

package/README.md

@@ -163,7 +163,7 @@ Usage example:
     const asset = await assetInterface.getData();
 ```
 
-#### [Get User](./classes/sdk.md#getuser)
+#### [Get User]()
 Returns Promise with [UserInterface](./interfaces/userinterface.md)
 
 Usage example:

package/lib/OwneraAPI/custody-api/index.js

@@ -12,7 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../utils");
 const index = (connector, logger) => ({
     /**
-     * @description Create new account
+     * Create new account
      *
      * @param request
      *
@@ -26,7 +26,7 @@ const index = (connector, logger) => ({
         return (0, utils_1.custodyPost)('/accounts', request, connector, logger);
     }),
     /**
-     * @description Create signature
+     * Create signature
      *
      * @param request
      *
@@ -37,7 +37,7 @@ const index = (connector, logger) => ({
         return (0, utils_1.custodyPost)('/signatures', request, connector, logger);
     }),
     /**
-     * @description Get signature
+     * Get signature
      *
      * @param r
      *

package/lib/OwneraAPI/finp2p-node-api/certificates.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../utils");
 const certificates = (connector, logger) => ({
     /**
-     * @description Create certificate
+     * Create certificate
      *
      * @param request
      * @param options
@@ -21,7 +21,7 @@ const certificates = (connector, logger) => ({
         }, connector, logger, options);
     },
     /**
-     * @description Update certificate
+     * Update certificate
      *
      * @param request
      * @param options

package/lib/OwneraAPI/finp2p-node-api/documents.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../utils");
 const documents = (connector, logger) => ({
     /**
-     * @description Create Document
+     * Create Document
      *
      * @param request
      * @param options
@@ -16,7 +16,7 @@ const documents = (connector, logger) => ({
         return (0, utils_1.docPost)(`/profiles/${profileId}/certificates/${certificateId}/docs`, files, connector, logger, options);
     },
     /**
-     * @description Get Document
+     * Get Document
      *
      * @param request
      *
@@ -27,7 +27,7 @@ const documents = (connector, logger) => ({
         return (0, utils_1.docGetFile)(`/docs/${request.uri}`, connector, logger);
     },
     /**
-     * @description Update Document
+     * Update Document
      *
      * @param request
      * @param options

package/lib/OwneraAPI/finp2p-node-api/messages.js

@@ -7,7 +7,7 @@ const utils_1 = require("../utils");
 const form_data_1 = __importDefault(require("form-data"));
 const messages = (connector, logger) => ({
     /**
-     * @description Send message
+     * Send message
      *
      * @param request
      * @param options
@@ -44,7 +44,7 @@ const messages = (connector, logger) => ({
         return (0, utils_1.apiPost)('/messages/send', formData, connector, logger, Object.assign(Object.assign({}, options), { multipart: true }));
     },
     /**
-     * @description Get attachment
+     * Get attachment
      *
      * @param request
      *

package/lib/OwneraAPI/finp2p-node-api/operations.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../utils");
 const operations = (connector, logger) => ({
     /**
-     * @description Get execution operation status
+     * Get execution operation status
      *
      * @param request
      *
@@ -14,7 +14,7 @@ const operations = (connector, logger) => ({
         return (0, utils_1.apiGet)(`/operations/status/${request.cid}`, connector, logger);
     },
     /**
-     * @description Get profile operation status
+     * Get profile operation status
      *
      * @param request
      *
@@ -25,7 +25,7 @@ const operations = (connector, logger) => ({
         return (0, utils_1.apiGet)(`/operations/status/${request.cid}`, connector, logger);
     },
     /**
-     * @description Get deposit operation status
+     * Get deposit operation status
      *
      * @param request
      *
@@ -36,7 +36,7 @@ const operations = (connector, logger) => ({
         return (0, utils_1.apiGet)(`/operations/status/${request.cid}`, connector, logger);
     },
     /**
-     * @description Get withdraw operation status
+     * Get withdraw operation status
      *
      * @param request
      *
@@ -47,7 +47,7 @@ const operations = (connector, logger) => ({
         return (0, utils_1.apiGet)(`/operations/status/${request.cid}`, connector, logger);
     },
     /**
-     * @description Wait operation completion
+     * Wait operation completion
      *
      * @param request
      *

package/lib/OwneraAPI/finp2p-node-api/organizations.js

@@ -12,14 +12,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../utils");
 const organizations = (nodeMSP, client, logger) => ({
     /**
-     * @description Get current organization Id
+     * Get current organization Id
      *
      * @returns
      *
      */
     getOrganizationId: () => __awaiter(void 0, void 0, void 0, function* () { return nodeMSP.toLowerCase().replace('msp', ''); }),
     /**
-     * @description Get organizations
+     * Get organizations
      *
      * @returns
      *

package/lib/OwneraAPI/finp2p-node-api/payments.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../utils");
 const payments = (connector, logger) => ({
     /**
-     * @description Deposit money
+     * Deposit money
      *
      * @param request
      * @param options
@@ -13,7 +13,7 @@ const payments = (connector, logger) => ({
      */
     deposit: (request, options) => (0, utils_1.apiPost)(`/payments/deposit`, request, connector, logger, options),
     /**
-     * @description Withdraw money
+     * Withdraw money
      *
      * @param request
      * @param options

package/lib/OwneraAPI/finp2p-node-api/profiles.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../utils");
 const profiles = (connector, logger) => ({
     /**
-     * @description Create asset
+     * Create asset
      *
      * @param request
      * @param options
@@ -15,7 +15,7 @@ const profiles = (connector, logger) => ({
         return (0, utils_1.apiPost)('/profiles/asset', request, connector, logger, options);
     },
     /**
-     * @description Create user
+     * Create user
      *
      * @param request
      * @param options
@@ -27,7 +27,7 @@ const profiles = (connector, logger) => ({
         return (0, utils_1.apiPost)('/profiles/owner', request, connector, logger, options);
     },
     /**
-     * @description Update asset
+     * Update asset
      *
      * @param request
      * @param options
@@ -43,7 +43,7 @@ const profiles = (connector, logger) => ({
         }, connector, logger, options);
     },
     /**
-     * @description Share profile
+     * Share profile
      *
      * @param request
      * @param options
@@ -56,7 +56,7 @@ const profiles = (connector, logger) => ({
         return (0, utils_1.apiPost)(`/profiles/${profileId}/share`, { organizations }, connector, logger, options);
     },
     /**
-     * @description Create intent
+     * Create intent
      *
      * @param r
      * @param options
@@ -77,7 +77,7 @@ const profiles = (connector, logger) => ({
         return (0, utils_1.apiPost)(`/profiles/asset/${assetId}/intent`, req, connector, logger, options);
     },
     /**
-     * @description Update intent
+     * Update intent
      *
      * @param r
      * @param options
@@ -100,7 +100,7 @@ const profiles = (connector, logger) => ({
         return (0, utils_1.apiPatch)(`/profiles/asset/${assetId}/intent/${intentId}`, req, connector, logger, options);
     },
     /**
-     * @description Enable Intent
+     * Enable Intent
      *
      * @param r
      * @param options
@@ -113,7 +113,7 @@ const profiles = (connector, logger) => ({
         return (0, utils_1.apiPut)(`/profiles/asset/${assetId}/intent/${intentId}/enable`, {}, connector, logger, options);
     },
     /**
-     * @description Disable Intent
+     * Disable Intent
      *
      * @param r
      * @param options

package/lib/OwneraAPI/finp2p-node-api/tokens.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../utils");
 const tokens = (connector, logger) => ({
     /**
-     * @description No intent transfer
+     * No intent transfer
      *
      * @param request
      * @param options
@@ -15,7 +15,7 @@ const tokens = (connector, logger) => ({
         return (0, utils_1.apiPut)(`/tokens/transfer`, request, connector, logger, options);
     },
     /**
-     * @description Redeem
+     * Redeem
      *
      * @param request
      *
@@ -26,7 +26,7 @@ const tokens = (connector, logger) => ({
         return (0, utils_1.apiPut)(`/tokens/redeem`, request, connector, logger, {});
     },
     /**
-     * @description Balance
+     * Balance
      *
      * @param request
      *
@@ -37,7 +37,7 @@ const tokens = (connector, logger) => ({
         return (0, utils_1.apiPost)(`/tokens/balance`, request, connector, logger, {});
     },
     /**
-     * @description Signature result
+     * Signature result
      *
      * @param request
      *
@@ -48,7 +48,7 @@ const tokens = (connector, logger) => ({
         return (0, utils_1.apiPost)(`/tokens/signature-result`, request, connector, logger, {});
     },
     /**
-     * @description Execute Token Intent
+     * Execute Token Intent
      *
      * @param request
      * @param options

package/lib/OwneraAPI/ledger-api/index.js

@@ -79,7 +79,7 @@ const escrowPost = (connector, url, data) => new Promise((resolve, reject) => {
 const createConnection = (baseURL) => axios_1.default.create({ baseURL, headers: utils_1.headers });
 const index = {
     /**
-     * @description Update account  balance
+     * Update account  balance
      *
      * @param request
      *
@@ -101,7 +101,7 @@ const index = {
         return escrowPost(connector, url, data);
     }),
     /**
-     * @description Get exchange rates
+     * Get exchange rates
      *
      * @param request
      *
@@ -113,7 +113,7 @@ const index = {
         return escrowGet(connector, `/exchange-rate/${request.pairs}`);
     }),
     /**
-     * @description Get payouts
+     * Get payouts
      *
      * @param request
      *
@@ -128,7 +128,7 @@ const index = {
         return escrowGet(connector, url);
     }),
     /**
-     * @description Update payout
+     * Update payout
      *
      * @param request
      *

package/lib/core/asset.d.ts

@@ -2,7 +2,7 @@ import { Logger, CoreRequestOptions } from '../types';
 import { AssetInterface, CreateAssetRequest } from '../types/Core/Asset';
 import { OwneraAPIInterface } from '../types/Core/OwneraAPI';
 /**
- * @description Get {@link AssetInterface} by asset Id
+ * Get {@link AssetInterface} by asset Id
  *
  * @param req
  *
@@ -15,7 +15,7 @@ export declare const getAsset: (req: {
     assetId: string;
 }) => AssetInterface;
 /**
- * @description Create a new asset
+ * Create a new asset
  *
  * @param req
  * @param options

package/lib/core/asset.js

@@ -15,7 +15,7 @@ const intent_1 = require("./intent");
 const validators_1 = require("../validators");
 const utils_1 = require("./utils");
 /**
- * @description Get {@link AssetInterface} by asset Id
+ * Get {@link AssetInterface} by asset Id
  *
  * @param req
  *
@@ -27,7 +27,7 @@ const getAsset = (req) => {
     return {
         id: assetId,
         /**
-         * @description Create a primary sale intent for the selected asset.
+         * Create a primary sale intent for the selected asset.
          *
          * @param data
          * @param options
@@ -37,7 +37,7 @@ const getAsset = (req) => {
          */
         createPrimarySale: (data, options) => __awaiter(void 0, void 0, void 0, function* () { return yield createPrimarySale({ owneraAPI, logger, assetId, data }, options); }),
         /**
-         * @description Get a primary sale intent for the selected asset.
+         * Get a primary sale intent for the selected asset.
          *
          * @param intentId
          *
@@ -46,7 +46,7 @@ const getAsset = (req) => {
          */
         getPrimarySale: (intentId) => (0, intent_1.getIntent)({ owneraAPI, logger, assetId, intentId }),
         /**
-         * @description Create a certificate for the selected asset.
+         * Create a certificate for the selected asset.
          *
          * @param data
          *
@@ -55,7 +55,7 @@ const getAsset = (req) => {
          */
         createCertificate: (data) => __awaiter(void 0, void 0, void 0, function* () { return yield (0, certificate_1.createCertificate)({ owneraAPI, logger, profileId: assetId, data }); }),
         /**
-         * @description Get a certificate for the selected asset.
+         * Get a certificate for the selected asset.
          *
          * @param certificateId
          *
@@ -64,28 +64,28 @@ const getAsset = (req) => {
          */
         getCertificate: (certificateId) => (0, certificate_1.getCertificate)({ owneraAPI, logger, profileId: assetId, certificateId }),
         /**
-         * @description Get asset data.
+         * Get asset data.
          *
          * @returns
          *
          */
         getData: () => __awaiter(void 0, void 0, void 0, function* () { return yield getData({ owneraAPI, logger, assetId }); }),
         /**
-         * @description Get cap table for the asset.
+         * Get cap table for the asset.
          *
          * @returns
          *
          */
         getCapTable: () => __awaiter(void 0, void 0, void 0, function* () { return yield getCapTable({ owneraAPI, logger, assetId }); }),
         /**
-         * @description Get receipts for the asset.
+         * Get receipts for the asset.
          *
          * @returns
          *
          */
         getReceipts: () => __awaiter(void 0, void 0, void 0, function* () { return yield getAssetReceipts({ owneraAPI, logger, assetId }); }),
         /**
-         * @description Share the asset with another organizations.
+         * Share the asset with another organizations.
          *
          * @param organizations
          * @param options
@@ -99,7 +99,7 @@ const getAsset = (req) => {
 };
 exports.getAsset = getAsset;
 /**
- * @description Create a new asset
+ * Create a new asset
  *
  * @param req
  * @param options
@@ -177,7 +177,7 @@ const createAsset = (req, options) => __awaiter(void 0, void 0, void 0, function
 });
 exports.createAsset = createAsset;
 /**
- * @description Create primary sale for the asset
+ * Create primary sale for the asset
  *
  * @param r
  * @param options
@@ -232,7 +232,7 @@ const createPrimarySale = (r, options) => __awaiter(void 0, void 0, void 0, func
     return (0, intent_1.getIntent)({ owneraAPI, logger, assetId, intentId: primarySale.id });
 });
 /**
- * @description Get asset data
+ * Get asset data
  *
  * @param r
  *
@@ -241,7 +241,7 @@ const createPrimarySale = (r, options) => __awaiter(void 0, void 0, void 0, func
  */
 const getData = (r) => __awaiter(void 0, void 0, void 0, function* () { return (yield r.owneraAPI.query.getAssets({ filter: { assetIds: [r.assetId] } })).data[0]; });
 /**
- * @description Get cap table for the asset
+ * Get cap table for the asset
  *
  * @param r
  *
@@ -250,7 +250,7 @@ const getData = (r) => __awaiter(void 0, void 0, void 0, function* () { return (
  */
 const getCapTable = (r) => __awaiter(void 0, void 0, void 0, function* () { return yield r.owneraAPI.query.getCapTable({ assetId: r.assetId }); });
 /**
- * @description Share the asset with another organizations
+ * Share the asset with another organizations
  *
  * @param r
  *
@@ -264,7 +264,7 @@ const share = (r, options) => __awaiter(void 0, void 0, void 0, function* () {
     });
 });
 /**
- * @description Get receipts for the asset
+ * Get receipts for the asset
  *
  * @param r
  *

package/lib/core/certificate.d.ts

@@ -4,7 +4,7 @@ import { OwneraAPIInterface } from '../types/Core/OwneraAPI';
 import { Logger } from '../types';
 import { RequestOptions } from '../types/Commons';
 /**
- * @description Get {@link CertificateInterface} by certificate Id
+ * Get {@link CertificateInterface} by certificate Id
  *
  * @param req
  *
@@ -18,7 +18,7 @@ export declare const getCertificate: (req: {
     certificateId: string;
 }) => CertificateInterface;
 /**
- * @description Create new certificate
+ * Create new certificate
  *
  * @param req
  *
@@ -32,13 +32,13 @@ export declare const createCertificate: (req: {
     data: Omit<CertificateRequest, 'subjectId'>;
 }, options?: RequestOptions) => Promise<CertificateInterface>;
 /**
- * @description A set of functions to create a payload (Certificate Request) for different kind of certificates
+ * A set of functions to create a payload (Certificate Request) for different kind of certificates
  *
  * @returns
  */
 export declare const certificateUtils: {
     /**
-     * @description A util to prepare a payload to create a KYA certificate
+     * A util to prepare a payload to create a KYA certificate
      *
      * @param r
      * @returns
@@ -46,7 +46,7 @@ export declare const certificateUtils: {
      */
     createKyaRequest: (r: KyaRequest) => Omit<CertificateRequest, 'subjectId'>;
     /**
-     * @description A util to prepare a payload to create a KYC certificate
+     * A util to prepare a payload to create a KYC certificate
      *
      * @param r
      * @returns
@@ -54,7 +54,7 @@ export declare const certificateUtils: {
      */
     createKycRequest: (r: UserStandardCertificateRequest) => Omit<CertificateRequest, 'subjectId'>;
     /**
-     * @description A util to prepare a payload to create a Accreditation certificate
+     * A util to prepare a payload to create a Accreditation certificate
      *
      * @param r
      * @returns
@@ -62,7 +62,7 @@ export declare const certificateUtils: {
      */
     createAccreditationRequest: (r: UserStandardCertificateRequest) => Omit<CertificateRequest, 'subjectId'>;
     /**
-     * @description A util to prepare a payload to create an Owner Info certificate
+     * A util to prepare a payload to create an Owner Info certificate
      *
      * @param r
      * @returns
@@ -70,7 +70,7 @@ export declare const certificateUtils: {
      */
     createOwnerInfoRequest: (r: OwnerInfoRequest) => Omit<CertificateRequest, 'subjectId'>;
     /**
-     * @description A util to prepare a payload to create an NAV certificate
+     * A util to prepare a payload to create an NAV certificate
      *
      * @param r
      * @returns

package/lib/core/certificate.js

@@ -11,7 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.certificateUtils = exports.createCertificate = exports.getCertificate = void 0;
 /**
- * @description Get {@link CertificateInterface} by certificate Id
+ * Get {@link CertificateInterface} by certificate Id
  *
  * @param req
  *
@@ -23,14 +23,14 @@ const getCertificate = (req) => {
     return {
         id: certificateId,
         /**
-         * @description Get certificate data
+         * Get certificate data
          *
          * @returns
          *
          */
         getData: () => __awaiter(void 0, void 0, void 0, function* () { return yield getCertificateData({ owneraAPI, logger, profileId, certificateId }); }),
         /**
-         * @description Update certificate data
+         * Update certificate data
          *
          * @param r
          * @param options
@@ -49,7 +49,7 @@ const getCertificate = (req) => {
             }, options);
         }),
         /**
-         * @description Update certificate data
+         * Update certificate data
          *
          * @param docs
          * @param options
@@ -67,7 +67,7 @@ const getCertificate = (req) => {
             }, options);
         }),
         /**
-         * @description Update certificate document by Id
+         * Update certificate document by Id
          *
          * @param r
          * @param options
@@ -89,7 +89,7 @@ const getCertificate = (req) => {
 };
 exports.getCertificate = getCertificate;
 /**
- * @description Create new certificate
+ * Create new certificate
  *
  * @param req
  *
@@ -115,7 +115,7 @@ const updateCertificate = (r, options) => __awaiter(void 0, void 0, void 0, func
     }, options);
 });
 /**
- * @description Add documents to the certificates
+ * Add documents to the certificates
  *
  * @param r
  * @param options
@@ -131,7 +131,7 @@ const addDocuments = (r, options) => __awaiter(void 0, void 0, void 0, function*
     }, options);
 });
 /**
- * @description Update document by Id
+ * Update document by Id
  *
  * @param r
  * @param options
@@ -149,13 +149,13 @@ const updateDocument = (r, options) => __awaiter(void 0, void 0, void 0, functio
 });
 const randomId = () => Math.random().toString(36).substring(2).toUpperCase();
 /**
- * @description A set of functions to create a payload (Certificate Request) for different kind of certificates
+ * A set of functions to create a payload (Certificate Request) for different kind of certificates
  *
  * @returns
  */
 exports.certificateUtils = {
     /**
-     * @description A util to prepare a payload to create a KYA certificate
+     * A util to prepare a payload to create a KYA certificate
      *
      * @param r
      * @returns
@@ -179,7 +179,7 @@ exports.certificateUtils = {
         };
     },
     /**
-     * @description A util to prepare a payload to create a KYC certificate
+     * A util to prepare a payload to create a KYC certificate
      *
      * @param r
      * @returns
@@ -199,7 +199,7 @@ exports.certificateUtils = {
         },
     }),
     /**
-     * @description A util to prepare a payload to create a Accreditation certificate
+     * A util to prepare a payload to create a Accreditation certificate
      *
      * @param r
      * @returns
@@ -219,7 +219,7 @@ exports.certificateUtils = {
         },
     }),
     /**
-     * @description A util to prepare a payload to create an Owner Info certificate
+     * A util to prepare a payload to create an Owner Info certificate
      *
      * @param r
      * @returns
@@ -236,7 +236,7 @@ exports.certificateUtils = {
         },
     }),
     /**
-     * @description A util to prepare a payload to create an NAV certificate
+     * A util to prepare a payload to create an NAV certificate
      *
      * @param r
      * @returns