@simplito/privmx-webendpoint 2.2.9 → 2.5.1

package/service/EndpointFactory.js

@@ -12,16 +12,22 @@ limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EndpointFactory = void 0;
 const Api_1 = require("../api/Api");
+const ApiStatic_1 = require("../api/ApiStatic");
 const ConnectionNative_1 = require("../api/ConnectionNative");
 const CryptoApiNative_1 = require("../api/CryptoApiNative");
+const EventApiNative_1 = require("../api/EventApiNative");
 const EventQueueNative_1 = require("../api/EventQueueNative");
 const InboxApiNative_1 = require("../api/InboxApiNative");
+const KvdbApiNative_1 = require("../api/KvdbApiNative");
 const StoreApiNative_1 = require("../api/StoreApiNative");
 const ThreadApiNative_1 = require("../api/ThreadApiNative");
+const FinalizationHelper_1 = require("../FinalizationHelper");
 const Connection_1 = require("./Connection");
 const CryptoApi_1 = require("./CryptoApi");
+const EventApi_1 = require("./EventApi");
 const EventQueue_1 = require("./EventQueue");
 const InboxApi_1 = require("./InboxApi");
+const KvdbApi_1 = require("./KvdbApi");
 const StoreApi_1 = require("./StoreApi");
 const ThreadApi_1 = require("./ThreadApi");
 /**
@@ -61,6 +67,8 @@ class EndpointFactory {
      */
     static init(lib) {
         this.api = new Api_1.Api(lib);
+        ApiStatic_1.ApiStatic.init(this.api);
+        FinalizationHelper_1.FinalizationHelper.init(lib);
     }
     /**
      * Gets the EventQueue instance.
@@ -75,18 +83,25 @@ class EndpointFactory {
         }
         return this.eventQueueInstance;
     }
+    static generateDefaultPKIVerificationOptions() {
+        return {
+            bridgeInstanceId: undefined,
+            bridgePubKey: undefined
+        };
+    }
     /**
      * Connects to the platform backend.
      *
      * @param {string} userPrivKey user's private key
      * @param {string} solutionId ID of the Solution
      * @param {string} bridgeUrl the Bridge Server URL
+     * @param {PKIVerificationOptions} [verificationOptions] PrivMX Bridge server instance verification options using a PKI server
      * @returns {Connection} instance of Connection
      */
-    static async connect(userPrivKey, solutionId, bridgeUrl) {
+    static async connect(userPrivKey, solutionId, bridgeUrl, verificationOptions) {
         const nativeApi = new ConnectionNative_1.ConnectionNative(this.api);
         const ptr = await nativeApi.newConnection();
-        await nativeApi.connect(ptr, [userPrivKey, solutionId, bridgeUrl]);
+        await nativeApi.connect(ptr, [userPrivKey, solutionId, bridgeUrl, verificationOptions || this.generateDefaultPKIVerificationOptions()]);
         return new Connection_1.Connection(nativeApi, ptr);
     }
     /**
@@ -94,13 +109,13 @@ class EndpointFactory {
      *
      * @param {string} solutionId ID of the Solution
      * @param {string} bridgeUrl the Bridge Server URL
-     *
+     * @param {PKIVerificationOptions} [verificationOptions] PrivMX Bridge server instance verification options using a PKI server
      * @returns {Connection} instance of Connection
      */
-    static async connectPublic(solutionId, bridgeUrl) {
+    static async connectPublic(solutionId, bridgeUrl, verificationOptions) {
         const nativeApi = new ConnectionNative_1.ConnectionNative(this.api);
         const ptr = await nativeApi.newConnection();
-        await nativeApi.connectPublic(ptr, [solutionId, bridgeUrl]);
+        await nativeApi.connectPublic(ptr, [solutionId, bridgeUrl, verificationOptions || this.generateDefaultPKIVerificationOptions()]);
         return new Connection_1.Connection(nativeApi, ptr);
     }
     /**
@@ -158,6 +173,24 @@ class EndpointFactory {
         await nativeApi.create(ptr, []);
         return new InboxApi_1.InboxApi(nativeApi, ptr);
     }
+    /**
+     * Creates an instance of the Kvdb API.
+     *
+     * @param {Connection} connection instance of Connection
+     *
+     * @returns {KvdbApi} instance of KvdbApi
+     */
+    static async createKvdbApi(connection) {
+        if ("kvdbs" in connection.apisRefs) {
+            throw new Error("KvdbApi already registered for given connection.");
+        }
+        const nativeApi = new KvdbApiNative_1.KvdbApiNative(this.api);
+        const ptr = await nativeApi.newApi(connection.servicePtr);
+        await nativeApi.create(ptr, []);
+        connection.apisRefs["kvdbs"] = { _apiServicePtr: ptr };
+        connection.nativeApisDeps["kvdbs"] = nativeApi;
+        return new KvdbApi_1.KvdbApi(nativeApi, ptr);
+    }
     /**
      * Creates an instance of the Crypto API.
      *
@@ -169,5 +202,23 @@ class EndpointFactory {
         await nativeApi.create(ptr, []);
         return new CryptoApi_1.CryptoApi(nativeApi, ptr);
     }
+    /**
+     * Creates an instance of 'EventApi'.
+     *
+     * @param connection instance of 'Connection'
+     *
+     * @returns {EventApi} instance of EventApi
+     */
+    static async createEventApi(connection) {
+        if ("events" in connection.apisRefs) {
+            throw new Error("EventApi already registered for given connection.");
+        }
+        const nativeApi = new EventApiNative_1.EventApiNative(this.api);
+        const ptr = await nativeApi.newApi(connection.servicePtr);
+        connection.apisRefs["events"] = { _apiServicePtr: ptr };
+        connection.nativeApisDeps["events"] = nativeApi;
+        await nativeApi.create(ptr, []);
+        return new EventApi_1.EventApi(nativeApi, ptr);
+    }
 }
 exports.EndpointFactory = EndpointFactory;

package/service/EventApi.d.ts

@@ -0,0 +1,40 @@
+/*!
+PrivMX Web Endpoint.
+Copyright © 2024 Simplito sp. z o.o.
+
+This file is part of the PrivMX Platform (https://privmx.dev).
+This software is Licensed under the PrivMX Free License.
+
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+import { BaseApi } from "./BaseApi";
+import { EventApiNative } from "../api/EventApiNative";
+import { UserWithPubKey } from "../Types";
+export declare class EventApi extends BaseApi {
+    private native;
+    constructor(native: EventApiNative, ptr: number);
+    /**
+     * Emits the custom event on the given Context and channel.
+     *
+     * @param {string} contextId ID of the Context
+     * @param {string} channelName name of the Channel
+     * @param {Uint8Array} eventData event's data
+     * @param {UserWithPubKey[]} users list of UserWithPubKey objects which defines the recipients of the event
+     */
+    emitEvent(contextId: string, channelName: string, eventData: Uint8Array, users: UserWithPubKey[]): Promise<void>;
+    /**
+     * Subscribe for the custom events on the given channel.
+     *
+     * @param {string} contextId ID of the Context
+     * @param {string} channelName name of the Channel
+     */
+    subscribeForCustomEvents(contextId: string, channelName: string): Promise<void>;
+    /**
+     * Unsubscribe from the custom events on the given channel.
+     *
+     * @param {string} contextId ID of the Context
+     * @param {string} channelName name of the Channel
+     */
+    unsubscribeFromCustomEvents(contextId: string, channelName: string): Promise<void>;
+}

package/service/EventApi.js

@@ -0,0 +1,60 @@
+"use strict";
+/*!
+PrivMX Web Endpoint.
+Copyright © 2024 Simplito sp. z o.o.
+
+This file is part of the PrivMX Platform (https://privmx.dev).
+This software is Licensed under the PrivMX Free License.
+
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventApi = void 0;
+const BaseApi_1 = require("./BaseApi");
+class EventApi extends BaseApi_1.BaseApi {
+    native;
+    constructor(native, ptr) {
+        super(ptr);
+        this.native = native;
+    }
+    // /**
+    //  * Creates an instance of 'EventApi'.
+    //  * 
+    //  * @param connection instance of 'Connection'
+    //  * 
+    //  * @return EventApi object
+    //  */
+    // static EventApi create(core::Connection& connection);
+    // EventApi() = default;
+    /**
+     * Emits the custom event on the given Context and channel.
+     *
+     * @param {string} contextId ID of the Context
+     * @param {string} channelName name of the Channel
+     * @param {Uint8Array} eventData event's data
+     * @param {UserWithPubKey[]} users list of UserWithPubKey objects which defines the recipients of the event
+     */
+    async emitEvent(contextId, channelName, eventData, users) {
+        return this.native.emitEvent(this.servicePtr, [contextId, channelName, eventData, users]);
+    }
+    /**
+     * Subscribe for the custom events on the given channel.
+     *
+     * @param {string} contextId ID of the Context
+     * @param {string} channelName name of the Channel
+     */
+    async subscribeForCustomEvents(contextId, channelName) {
+        return this.native.subscribeForCustomEvents(this.servicePtr, [contextId, channelName]);
+    }
+    /**
+     * Unsubscribe from the custom events on the given channel.
+     *
+     * @param {string} contextId ID of the Context
+     * @param {string} channelName name of the Channel
+     */
+    async unsubscribeFromCustomEvents(contextId, channelName) {
+        return this.native.unsubscribeFromCustomEvents(this.servicePtr, [contextId, channelName]);
+    }
+}
+exports.EventApi = EventApi;

package/service/ExtKey.d.ts

@@ -0,0 +1,103 @@
+import { ExtKeyNativePtr } from "../api/ExtKeyNative";
+import { BaseApi } from "./BaseApi";
+export declare class ExtKey extends BaseApi {
+    private native;
+    ptr: ExtKeyNativePtr;
+    private static freeExtKey;
+    /**
+     * Creates ExtKey from given seed.
+     * @param {Uint8Array} seed the seed used to generate Key
+     * @returns {ExtKey} object
+    */
+    static fromSeed(seed: Uint8Array): Promise<ExtKey>;
+    /**
+     * Decodes ExtKey from Base58 format.
+     *
+     * @param {string} base58 the ExtKey in Base58
+     * @returns {ExtKey} object
+    */
+    static fromBase58(base58: string): Promise<ExtKey>;
+    /**
+     * Generates a new ExtKey.
+     *
+     * @returns {ExtKey} object
+    */
+    static generateRandom(): Promise<ExtKey>;
+    /**
+     * //doc-gen:ignore
+     */
+    private constructor();
+    static fromPtr(ptr: ExtKeyNativePtr): ExtKey;
+    /**
+     * Generates child ExtKey from a current ExtKey using BIP32.
+     *
+     * @param {number} index number from 0 to 2^31-1
+
+     * @returns {ExtKey} object
+     */
+    derive(index: number): Promise<ExtKey>;
+    /**
+     * Generates hardened child ExtKey from a current ExtKey using BIP32.
+     *
+     * @param {number} index number from 0 to 2^31-1
+
+     * @returns {ExtKey} object
+     */
+    deriveHardened(index: number): Promise<ExtKey>;
+    /**
+     * Converts ExtKey to Base58 string.
+     *
+     * @returns {string} ExtKey in Base58 format
+    */
+    getPrivatePartAsBase58(): Promise<string>;
+    /**
+     * Converts the public part of ExtKey to Base58 string.
+     *
+     * @returns {string} ExtKey in Base58 format
+    */
+    getPublicPartAsBase58(): Promise<string>;
+    /**
+     * Extracts ECC PrivateKey.
+     *
+     * @returns {string} ECC key in WIF format
+    */
+    getPrivateKey(): Promise<string>;
+    /**
+     * Extracts ECC PublicKey.
+     *
+     * @returns {string} ECC key in BASE58DER format
+    */
+    getPublicKey(): Promise<string>;
+    /**
+     * Extracts raw ECC PrivateKey.
+     *
+     * @returns {Uint8Array} ECC PrivateKey
+    */
+    getPrivateEncKey(): Promise<Uint8Array>;
+    /**
+     * Extracts ECC PublicKey Address.
+     *
+     * @returns {string} ECC Address in BASE58 format
+    */
+    getPublicKeyAsBase58Address(): Promise<string>;
+    /**
+     * Gets the chain code of Extended Key.
+     *
+     * @returns {Uint8Array} Raw chain code
+     */
+    getChainCode(): Promise<Uint8Array>;
+    /**
+     * Validates a signature of a message.
+     *
+     * @param {Uint8Array} message data used on validation
+     * @param {Uint8Array} signature signature of data to verify
+     * @returns {boolean} message validation result
+     */
+    verifyCompactSignatureWithHash(message: Uint8Array, signature: Uint8Array): Promise<boolean>;
+    /**
+     * Checks if ExtKey is Private.
+     *
+     * @returns {boolean} true if ExtKey is private
+    */
+    isPrivate(): Promise<boolean>;
+}

package/service/ExtKey.js

@@ -0,0 +1,167 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtKey = void 0;
+const ApiStatic_1 = require("../api/ApiStatic");
+const ExtKeyNative_1 = require("../api/ExtKeyNative");
+const FinalizationHelper_1 = require("../FinalizationHelper");
+const BaseApi_1 = require("./BaseApi");
+class ExtKey extends BaseApi_1.BaseApi {
+    native;
+    ptr;
+    static async freeExtKey(ptr) {
+        const nativeApi = new ExtKeyNative_1.ExtKeyNative(ApiStatic_1.ApiStatic.getInstance());
+        await nativeApi.deleteExtKey(ptr);
+    }
+    /**
+     * Creates ExtKey from given seed.
+     * @param {Uint8Array} seed the seed used to generate Key
+     * @returns {ExtKey} object
+    */
+    static async fromSeed(seed) {
+        const ptr = await ExtKeyNative_1.ExtKeyNative.fromSeed([seed]);
+        const native = new ExtKeyNative_1.ExtKeyNative(ApiStatic_1.ApiStatic.getInstance());
+        const extKey = new ExtKey(native, ptr);
+        const fh = FinalizationHelper_1.FinalizationHelper.getInstance();
+        fh.register(extKey, { ptr: ptr, onFree: () => this.freeExtKey(ptr) });
+        return extKey;
+    }
+    /**
+     * Decodes ExtKey from Base58 format.
+     *
+     * @param {string} base58 the ExtKey in Base58
+     * @returns {ExtKey} object
+    */
+    static async fromBase58(base58) {
+        const ptr = await ExtKeyNative_1.ExtKeyNative.fromBase58([base58]);
+        const native = new ExtKeyNative_1.ExtKeyNative(ApiStatic_1.ApiStatic.getInstance());
+        const extKey = new ExtKey(native, ptr);
+        const fh = FinalizationHelper_1.FinalizationHelper.getInstance();
+        fh.register(extKey, { ptr: ptr, onFree: () => this.freeExtKey(ptr) });
+        return extKey;
+    }
+    /**
+     * Generates a new ExtKey.
+     *
+     * @returns {ExtKey} object
+    */
+    static async generateRandom() {
+        const ptr = await ExtKeyNative_1.ExtKeyNative.generateRandom([]);
+        const native = new ExtKeyNative_1.ExtKeyNative(ApiStatic_1.ApiStatic.getInstance());
+        const extKey = new ExtKey(native, ptr);
+        const fh = FinalizationHelper_1.FinalizationHelper.getInstance();
+        fh.register(extKey, { ptr: ptr, onFree: () => this.freeExtKey(ptr) });
+        return extKey;
+    }
+    /**
+     * //doc-gen:ignore
+     */
+    constructor(native, ptr) {
+        super(ptr);
+        this.native = native;
+        this.ptr = ptr;
+    }
+    static fromPtr(ptr) {
+        const native = new ExtKeyNative_1.ExtKeyNative(ApiStatic_1.ApiStatic.getInstance());
+        return new ExtKey(native, ptr);
+    }
+    /**
+     * Generates child ExtKey from a current ExtKey using BIP32.
+     *
+     * @param {number} index number from 0 to 2^31-1
+
+     * @returns {ExtKey} object
+     */
+    async derive(index) {
+        const ptr = await this.native.derive(this.servicePtr, [index]);
+        const extKey = new ExtKey(this.native, ptr);
+        const fh = FinalizationHelper_1.FinalizationHelper.getInstance();
+        fh.register(extKey, { ptr: ptr, onFree: () => ExtKey.freeExtKey(ptr) });
+        return extKey;
+    }
+    /**
+     * Generates hardened child ExtKey from a current ExtKey using BIP32.
+     *
+     * @param {number} index number from 0 to 2^31-1
+
+     * @returns {ExtKey} object
+     */
+    async deriveHardened(index) {
+        const extKeyPtr = await this.native.deriveHardened(this.servicePtr, [index]);
+        return new ExtKey(this.native, extKeyPtr);
+    }
+    /**
+     * Converts ExtKey to Base58 string.
+     *
+     * @returns {string} ExtKey in Base58 format
+    */
+    async getPrivatePartAsBase58() {
+        return this.native.getPrivatePartAsBase58(this.servicePtr, []);
+    }
+    /**
+     * Converts the public part of ExtKey to Base58 string.
+     *
+     * @returns {string} ExtKey in Base58 format
+    */
+    async getPublicPartAsBase58() {
+        return this.native.getPublicPartAsBase58(this.servicePtr, []);
+    }
+    /**
+     * Extracts ECC PrivateKey.
+     *
+     * @returns {string} ECC key in WIF format
+    */
+    async getPrivateKey() {
+        return this.native.getPrivateKey(this.servicePtr, []);
+    }
+    /**
+     * Extracts ECC PublicKey.
+     *
+     * @returns {string} ECC key in BASE58DER format
+    */
+    async getPublicKey() {
+        return this.native.getPublicKey(this.servicePtr, []);
+    }
+    /**
+     * Extracts raw ECC PrivateKey.
+     *
+     * @returns {Uint8Array} ECC PrivateKey
+    */
+    async getPrivateEncKey() {
+        return this.native.getPrivateEncKey(this.servicePtr, []);
+    }
+    /**
+     * Extracts ECC PublicKey Address.
+     *
+     * @returns {string} ECC Address in BASE58 format
+    */
+    async getPublicKeyAsBase58Address() {
+        return this.native.getPublicKeyAsBase58Address(this.servicePtr, []);
+    }
+    /**
+     * Gets the chain code of Extended Key.
+     *
+     * @returns {Uint8Array} Raw chain code
+     */
+    async getChainCode() {
+        return this.native.getChainCode(this.servicePtr, []);
+    }
+    /**
+     * Validates a signature of a message.
+     *
+     * @param {Uint8Array} message data used on validation
+     * @param {Uint8Array} signature signature of data to verify
+     * @returns {boolean} message validation result
+     */
+    async verifyCompactSignatureWithHash(message, signature) {
+        return this.native.verifyCompactSignatureWithHash(this.servicePtr, [message, signature]);
+    }
+    /**
+     * Checks if ExtKey is Private.
+     *
+     * @returns {boolean} true if ExtKey is private
+    */
+    async isPrivate() {
+        return this.native.isPrivate(this.servicePtr, []);
+    }
+}
+exports.ExtKey = ExtKey;

package/service/InboxApi.d.ts

@@ -23,7 +23,7 @@ export declare class InboxApi extends BaseApi {
      * the created Inbox
      * @param {Uint8Array} publicMeta public (unencrypted) metadata
      * @param {Uint8Array} privateMeta private (encrypted) metadata
-     * @param {FilesConfig} filesConfig struct to override default file configuration
+     * @param {FilesConfig} filesConfig to override default file configuration
      * @param {ContainerWithoutItemPolicy} policies Inbox policies
      * @returns {string} ID of the created Inbox
      */
@@ -37,7 +37,7 @@ export declare class InboxApi extends BaseApi {
      * the created Inbox
      * @param {Uint8Array} publicMeta public (unencrypted) metadata
      * @param {Uint8Array} privateMeta private (encrypted) metadata
-     * @param {FilesConfig} filesConfig struct to override default files configuration
+     * @param {FilesConfig} filesConfig  to override default files configuration
      * @param {number} version current version of the updated Inbox
      * @param {boolean} force force update (without checking version)
      * @param {boolean} forceGenerateNewKey force to regenerate a key for the Inbox
@@ -48,15 +48,15 @@ export declare class InboxApi extends BaseApi {
      * Gets a single Inbox by given Inbox ID.
      *
      * @param {string} inboxId ID of the Inbox to get
-     * @returns {Inbox} struct containing information about the Inbox
+     * @returns {Inbox} containing information about the Inbox
      */
     getInbox(inboxId: string): Promise<Inbox>;
     /**
      * Gets s list of Inboxes in given Context.
      *
      * @param {string} contextId ID of the Context to get Inboxes from
-     * @param {PagingQuery} pagingQuery struct with list query parameters
-     * @returns {PagingList<Inbox>} struct containing list of Inboxes
+     * @param {PagingQuery} pagingQuery  with list query parameters
+     * @returns {PagingList<Inbox>} containing list of Inboxes
      */
     listInboxes(contextId: string, pagingQuery: PagingQuery): Promise<PagingList<Inbox>>;
     /**
@@ -64,7 +64,7 @@ export declare class InboxApi extends BaseApi {
      * You do not have to be logged in to call this function.
      *
      * @param {string} inboxId ID of the Inbox to get
-     * @returns {InboxPublicView} struct containing public accessible information about the Inbox
+     * @returns {InboxPublicView} containing public accessible information about the Inbox
      */
     getInboxPublicView(inboxId: string): Promise<InboxPublicView>;
     /**
@@ -95,15 +95,15 @@ export declare class InboxApi extends BaseApi {
      * Gets an entry from an Inbox.
      *
      * @param {string} inboxEntryId ID of an entry to read from the Inbox
-     * @returns {InboxEntry} struct containing data of the selected entry stored in the Inbox
+     * @returns {InboxEntry} containing data of the selected entry stored in the Inbox
      */
     readEntry(inboxEntryId: string): Promise<InboxEntry>;
     /**
      * Gets list of entries in given Inbox.
      *
      * @param {string} inboxId ID of the Inbox
-     * @param {PagingQuery} pagingQuery struct with list query parameters
-     * @returns {PagingList<InboxEntry>} struct containing list of entries
+     * @param {PagingQuery} pagingQuery with list query parameters
+     * @returns {PagingList<InboxEntry>} containing list of entries
      */
     listEntries(inboxId: string, pagingQuery: PagingQuery): Promise<PagingList<InboxEntry>>;
     /**

package/service/InboxApi.js

@@ -27,7 +27,7 @@ class InboxApi extends BaseApi_1.BaseApi {
      * the created Inbox
      * @param {Uint8Array} publicMeta public (unencrypted) metadata
      * @param {Uint8Array} privateMeta private (encrypted) metadata
-     * @param {FilesConfig} filesConfig struct to override default file configuration
+     * @param {FilesConfig} filesConfig to override default file configuration
      * @param {ContainerWithoutItemPolicy} policies Inbox policies
      * @returns {string} ID of the created Inbox
      */
@@ -51,7 +51,7 @@ class InboxApi extends BaseApi_1.BaseApi {
      * the created Inbox
      * @param {Uint8Array} publicMeta public (unencrypted) metadata
      * @param {Uint8Array} privateMeta private (encrypted) metadata
-     * @param {FilesConfig} filesConfig struct to override default files configuration
+     * @param {FilesConfig} filesConfig  to override default files configuration
      * @param {number} version current version of the updated Inbox
      * @param {boolean} force force update (without checking version)
      * @param {boolean} forceGenerateNewKey force to regenerate a key for the Inbox
@@ -75,7 +75,7 @@ class InboxApi extends BaseApi_1.BaseApi {
      * Gets a single Inbox by given Inbox ID.
      *
      * @param {string} inboxId ID of the Inbox to get
-     * @returns {Inbox} struct containing information about the Inbox
+     * @returns {Inbox} containing information about the Inbox
      */
     async getInbox(inboxId) {
         return this.native.getInbox(this.servicePtr, [inboxId]);
@@ -84,8 +84,8 @@ class InboxApi extends BaseApi_1.BaseApi {
      * Gets s list of Inboxes in given Context.
      *
      * @param {string} contextId ID of the Context to get Inboxes from
-     * @param {PagingQuery} pagingQuery struct with list query parameters
-     * @returns {PagingList<Inbox>} struct containing list of Inboxes
+     * @param {PagingQuery} pagingQuery  with list query parameters
+     * @returns {PagingList<Inbox>} containing list of Inboxes
      */
     async listInboxes(contextId, pagingQuery) {
         return this.native.listInboxes(this.servicePtr, [contextId, pagingQuery]);
@@ -95,7 +95,7 @@ class InboxApi extends BaseApi_1.BaseApi {
      * You do not have to be logged in to call this function.
      *
      * @param {string} inboxId ID of the Inbox to get
-     * @returns {InboxPublicView} struct containing public accessible information about the Inbox
+     * @returns {InboxPublicView} containing public accessible information about the Inbox
      */
     async getInboxPublicView(inboxId) {
         return this.native.getInboxPublicView(this.servicePtr, [inboxId]);
@@ -139,7 +139,7 @@ class InboxApi extends BaseApi_1.BaseApi {
      * Gets an entry from an Inbox.
      *
      * @param {string} inboxEntryId ID of an entry to read from the Inbox
-     * @returns {InboxEntry} struct containing data of the selected entry stored in the Inbox
+     * @returns {InboxEntry} containing data of the selected entry stored in the Inbox
      */
     async readEntry(inboxEntryId) {
         return this.native.readEntry(this.servicePtr, [inboxEntryId]);
@@ -148,8 +148,8 @@ class InboxApi extends BaseApi_1.BaseApi {
      * Gets list of entries in given Inbox.
      *
      * @param {string} inboxId ID of the Inbox
-     * @param {PagingQuery} pagingQuery struct with list query parameters
-     * @returns {PagingList<InboxEntry>} struct containing list of entries
+     * @param {PagingQuery} pagingQuery with list query parameters
+     * @returns {PagingList<InboxEntry>} containing list of entries
      */
     async listEntries(inboxId, pagingQuery) {
         return this.native.listEntries(this.servicePtr, [inboxId, pagingQuery]);