@icure/api 8.6.5 → 8.6.7

package/icc-x-api/icc-message-x-api.d.ts

@@ -27,6 +27,13 @@ export declare class IccMessageXApi extends IccMessageApi implements EncryptedEn
     constructor(host: string, headers: {
         [key: string]: string;
     }, crypto: IccCryptoXApi, dataOwnerApi: IccDataOwnerXApi, authApi: IccAuthApi, autofillAuthor: boolean, authenticationProvider?: AuthenticationProvider, encryptedKeys?: Array<string>, fetchImpl?: (input: RequestInfo, init?: RequestInit) => Promise<Response>);
+    /**
+     * Creates a new instance of message with initialised encryption metadata (not in the database).
+     * @param user the current user.
+     * @param m initialised data for the message. Metadata such as id, creation data, etc. will be automatically initialised, but you can specify
+     * other kinds of data or overwrite generated metadata with this. You can't specify encryption metadata.
+     * @return a new instance of message.
+     */
     newInstance(user: User, m: any): Promise<models.Message>;
     /**
      * Creates a new instance of message with initialised encryption metadata (not in the database).
@@ -51,10 +58,20 @@ export declare class IccMessageXApi extends IccMessageApi implements EncryptedEn
         sfkOption?: SecretIdUseOption;
         alternateRootDelegation?: string;
     }): Promise<models.Message>;
+    /**
+     * Decrypts the encrypted content of messages.
+     * @param messages the messages to decrypt.
+     * @return the decrypted messages with their encryption status.
+     */
     decrypt(messages: Array<models.Message>): Promise<{
         entity: models.Message;
         decrypted: boolean;
     }[]>;
+    /**
+     * Encrypts the content of messages.
+     * @param messages the messages to encrypt.
+     * @return the encrypted messages.
+     */
     encrypt(messages: Array<models.Message>): Promise<Array<models.Message>>;
     /**
      * @param message a message
@@ -140,18 +157,65 @@ export declare class IccMessageXApi extends IccMessageApi implements EncryptedEn
      * the 'owning entity', or in the {@link shareWith} method in order to share it with other data owners.
      */
     decryptSecretIdsOf(message: models.Message): Promise<string[]>;
+    /**
+     * Creates or updates de-anonymization metadata for the message, allowing resolution of anonymous delegations.
+     * @param entity the message.
+     * @param delegates the data owner ids of the delegates.
+     */
     createDelegationDeAnonymizationMetadata(entity: Message, delegates: string[]): Promise<void>;
+    /**
+     * Retrieves the data owners that have access to the message.
+     * @param entity the message.
+     * @return the data owners with their access levels and a flag indicating if there are unknown anonymous data owners.
+     */
     getDataOwnersWithAccessTo(entity: models.Message): Promise<{
         permissionsByDataOwnerId: {
             [p: string]: AccessLevelEnum;
         };
         hasUnknownAnonymousDataOwners: boolean;
     }>;
+    /**
+     * Retrieves the encryption keys of the message.
+     * @param entity the message.
+     * @return the encryption keys.
+     */
     getEncryptionKeysOf(entity: models.Message): Promise<string[]>;
+    /**
+     * Subscribes to message events (create, update, delete).
+     * @param eventTypes the types of events to subscribe to.
+     * @param filter optional filter to apply to the events.
+     * @param eventFired callback function to be called when an event is fired.
+     * @param options optional subscription options.
+     * @return a connection that can be used to close the subscription.
+     */
     subscribeToMessageEvents(eventTypes: ('CREATE' | 'UPDATE' | 'DELETE')[], filter: AbstractFilter<Message> | undefined, eventFired: (message: Message) => Promise<void>, options?: SubscriptionOptions): Promise<Connection>;
     private decryptPage;
+    /**
+     * Creates a message.
+     * @param user the current user (unused, for compatibility).
+     * @param body the message to create.
+     * @return the created message.
+     */
     createMessageWithUser(user: models.User | undefined, body: Message): Promise<Message>;
+    /**
+     * Finds messages with pagination.
+     * @param user the current user (unused, for compatibility).
+     * @param startKey optional start key for pagination.
+     * @param startDocumentId optional start document id for pagination.
+     * @param limit optional maximum number of results to return.
+     * @return a paginated list of messages.
+     */
     findMessagesWithUser(user: models.User | undefined, startKey?: string, startDocumentId?: string, limit?: number): Promise<PaginatedListMessage>;
+    /**
+     * Finds messages by sender address with pagination.
+     * @param user the current user (unused, for compatibility).
+     * @param fromAddress the sender address to filter by.
+     * @param startKey optional start key for pagination.
+     * @param startDocumentId optional start document id for pagination.
+     * @param limit optional maximum number of results to return.
+     * @param hcpId optional healthcare party id to filter by.
+     * @return a paginated list of messages.
+     */
     findMessagesByFromAddressWithUser(user: models.User | undefined, fromAddress?: string, startKey?: string, startDocumentId?: string, limit?: number, hcpId?: string): Promise<PaginatedListMessage>;
     /**
      * @deprecated
@@ -161,18 +225,116 @@ export declare class IccMessageXApi extends IccMessageApi implements EncryptedEn
      * @deprecated
      */
     findMessagesByHCPartyPatientForeignKeysWithUser(user: models.User | undefined, secretFKeys: string): Promise<Array<Message>>;
+    /**
+     * Finds messages by recipient address with pagination.
+     * @param user the current user (unused, for compatibility).
+     * @param toAddress the recipient address to filter by.
+     * @param startKey optional start key for pagination.
+     * @param startDocumentId optional start document id for pagination.
+     * @param limit optional maximum number of results to return.
+     * @param reverse optional flag to reverse the sort order.
+     * @param hcpId optional healthcare party id to filter by.
+     * @return a paginated list of messages.
+     */
     findMessagesByToAddressWithUser(user: models.User | undefined, toAddress?: string, startKey?: string, startDocumentId?: string, limit?: number, reverse?: boolean, hcpId?: string): Promise<PaginatedListMessage>;
+    /**
+     * Finds messages by transport GUID with pagination.
+     * @param user the current user (unused, for compatibility).
+     * @param transportGuid the transport GUID to filter by.
+     * @param received optional flag to filter by received status.
+     * @param startKey optional start key for pagination.
+     * @param startDocumentId optional start document id for pagination.
+     * @param limit optional maximum number of results to return.
+     * @param hcpId optional healthcare party id to filter by.
+     * @return a paginated list of messages.
+     */
     findMessagesByTransportGuidWithUser(user: models.User | undefined, transportGuid?: string, received?: boolean, startKey?: string, startDocumentId?: string, limit?: number, hcpId?: string): Promise<PaginatedListMessage>;
+    /**
+     * Finds messages by transport GUID and sent date range with pagination.
+     * @param user the current user (unused, for compatibility).
+     * @param transportGuid the transport GUID to filter by.
+     * @param from optional start timestamp for the date range.
+     * @param to optional end timestamp for the date range.
+     * @param startKey optional start key for pagination.
+     * @param startDocumentId optional start document id for pagination.
+     * @param limit optional maximum number of results to return.
+     * @param hcpId optional healthcare party id to filter by.
+     * @return a paginated list of messages.
+     */
     findMessagesByTransportGuidSentDateWithUser(user: models.User | undefined, transportGuid?: string, from?: number, to?: number, startKey?: string, startDocumentId?: string, limit?: number, hcpId?: string): Promise<PaginatedListMessage>;
+    /**
+     * Retrieves the children messages of a message.
+     * @param user the current user (unused, for compatibility).
+     * @param messageId the id of the parent message.
+     * @return the children messages.
+     */
     getChildrenMessagesWithUser(user: models.User | undefined, messageId: string): Promise<Array<Message>>;
+    /**
+     * Retrieves the children messages of a list of parent messages.
+     * @param user the current user (unused, for compatibility).
+     * @param body the list of parent message ids.
+     * @return the children messages.
+     */
     getChildrenMessagesOfListWithUser(user: models.User | undefined, body?: ListOfIds): Promise<Array<Message>>;
+    /**
+     * Retrieves a message by its id.
+     * @param user the current user (unused, for compatibility).
+     * @param messageId the id of the message.
+     * @return the message.
+     */
     getMessageWithUser(user: models.User | undefined, messageId: string): Promise<Message>;
+    /**
+     * Retrieves multiple messages by their ids.
+     * @param user the current user (unused, for compatibility).
+     * @param messageIds the list of message ids.
+     * @return the messages.
+     */
     getMessagesWithUser(user: models.User | undefined, messageIds: ListOfIds): Promise<Message[]>;
+    /**
+     * Lists messages by invoice ids.
+     * @param user the current user (unused, for compatibility).
+     * @param body the list of invoice ids.
+     * @return the messages associated with the invoices.
+     */
     listMessagesByInvoiceIdsWithUser(user: models.User | undefined, body?: ListOfIds): Promise<Array<Message>>;
+    /**
+     * Lists messages by transport GUIDs.
+     * @param user the current user (unused, for compatibility).
+     * @param hcpId the healthcare party id.
+     * @param body the list of transport GUIDs.
+     * @return the messages associated with the transport GUIDs.
+     */
     listMessagesByTransportGuidsWithUser(user: models.User | undefined, hcpId: string, body?: ListOfIds): Promise<Array<Message>>;
+    /**
+     * Modifies a message.
+     * @param user the current user (unused, for compatibility).
+     * @param body the message to modify.
+     * @return the modified message.
+     */
     modifyMessageWithUser(user: models.User | undefined, body: Message): Promise<Message>;
+    /**
+     * Sets the status bits of multiple messages.
+     * @param user the current user (unused, for compatibility).
+     * @param status the status bits to set.
+     * @param body the list of message ids.
+     * @return the updated messages.
+     */
     setMessagesStatusBitsWithUser(user: models.User | undefined, status: number, body?: ListOfIds): Promise<Array<Message>>;
+    /**
+     * Filters messages using a filter chain with pagination.
+     * @param user the current user (unused, for compatibility).
+     * @param body the filter chain to apply.
+     * @param startDocumentId optional start document id for pagination.
+     * @param limit optional maximum number of results to return.
+     * @return a paginated list of filtered messages.
+     */
     filterMessagesByWithUser(user: models.User | undefined, body: FilterChainMessage, startDocumentId?: string, limit?: number): Promise<PaginatedListMessage>;
+    /**
+     * Sets the read status of multiple messages.
+     * @param user the current user (unused, for compatibility).
+     * @param body the read status update information.
+     * @return the updated messages.
+     */
     setMessagesReadStatusWithUser(user: models.User | undefined, body?: MessagesReadStatusUpdate): Promise<Array<Message>>;
     createMessage(body?: Message): never;
     findMessages(startKey?: string, startDocumentId?: string, limit?: number): never;

package/icc-x-api/icc-message-x-api.js

@@ -35,6 +35,13 @@ class IccMessageXApi extends icc_api_1.IccMessageApi {
         this.encryptedFields = (0, utils_1.parseEncryptedFields)(encryptedKeys, 'Message.');
     }
     // noinspection JSUnusedGlobalSymbols
+    /**
+     * Creates a new instance of message with initialised encryption metadata (not in the database).
+     * @param user the current user.
+     * @param m initialised data for the message. Metadata such as id, creation data, etc. will be automatically initialised, but you can specify
+     * other kinds of data or overwrite generated metadata with this. You can't specify encryption metadata.
+     * @return a new instance of message.
+     */
     newInstance(user, m) {
         return this.newInstanceWithPatient(user, null, m);
     }
@@ -72,11 +79,21 @@ class IccMessageXApi extends icc_api_1.IccMessageApi {
                 .then((x) => x.updatedEntity));
         });
     }
+    /**
+     * Decrypts the encrypted content of messages.
+     * @param messages the messages to decrypt.
+     * @return the decrypted messages with their encryption status.
+     */
     decrypt(messages) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.crypto.xapi.tryDecryptEntities(messages, utils_1.EntityWithDelegationTypeName.Message, (x) => new models.Message(x));
         });
     }
+    /**
+     * Encrypts the content of messages.
+     * @param messages the messages to encrypt.
+     * @return the encrypted messages.
+     */
     encrypt(messages) {
         return this.crypto.xapi.tryEncryptEntities(messages, utils_1.EntityWithDelegationTypeName.Message, this.encryptedFields, true, false, (x) => new models.Message(x));
     }
@@ -187,15 +204,38 @@ class IccMessageXApi extends icc_api_1.IccMessageApi {
     decryptSecretIdsOf(message) {
         return this.crypto.xapi.secretIdsOf({ entity: message, type: utils_1.EntityWithDelegationTypeName.Message }, undefined);
     }
+    /**
+     * Creates or updates de-anonymization metadata for the message, allowing resolution of anonymous delegations.
+     * @param entity the message.
+     * @param delegates the data owner ids of the delegates.
+     */
     createDelegationDeAnonymizationMetadata(entity, delegates) {
         return this.crypto.delegationsDeAnonymization.createOrUpdateDeAnonymizationInfo({ entity, type: utils_1.EntityWithDelegationTypeName.Message }, delegates);
     }
+    /**
+     * Retrieves the data owners that have access to the message.
+     * @param entity the message.
+     * @return the data owners with their access levels and a flag indicating if there are unknown anonymous data owners.
+     */
     getDataOwnersWithAccessTo(entity) {
         return this.crypto.delegationsDeAnonymization.getDataOwnersWithAccessTo({ entity, type: utils_1.EntityWithDelegationTypeName.Message });
     }
+    /**
+     * Retrieves the encryption keys of the message.
+     * @param entity the message.
+     * @return the encryption keys.
+     */
     getEncryptionKeysOf(entity) {
         return this.crypto.xapi.encryptionKeysOf({ entity, type: utils_1.EntityWithDelegationTypeName.Message }, undefined);
     }
+    /**
+     * Subscribes to message events (create, update, delete).
+     * @param eventTypes the types of events to subscribe to.
+     * @param filter optional filter to apply to the events.
+     * @param eventFired callback function to be called when an event is fired.
+     * @param options optional subscription options.
+     * @return a connection that can be used to close the subscription.
+     */
     subscribeToMessageEvents(eventTypes_1, filter_1, eventFired_1) {
         return __awaiter(this, arguments, void 0, function* (eventTypes, filter, eventFired, options = {}) {
             return yield (0, utils_1.subscribeToEntityEvents)(this.host, this.authApi, utils_1.EntityWithDelegationTypeName.Message, eventTypes, filter, eventFired, options, (encrypted) => __awaiter(this, void 0, void 0, function* () { return (yield this.decrypt([encrypted]))[0].entity; })).then((rs) => new Connection_1.ConnectionImpl(rs));
@@ -207,6 +247,12 @@ class IccMessageXApi extends icc_api_1.IccMessageApi {
             return Object.assign(Object.assign({}, page), { rows: (yield this.decrypt((_a = page.rows) !== null && _a !== void 0 ? _a : [])).map((x) => x.entity) });
         });
     }
+    /**
+     * Creates a message.
+     * @param user the current user (unused, for compatibility).
+     * @param body the message to create.
+     * @return the created message.
+     */
     createMessageWithUser(user, body) {
         const _super = Object.create(null, {
             createMessage: { get: () => super.createMessage }
@@ -215,6 +261,14 @@ class IccMessageXApi extends icc_api_1.IccMessageApi {
             return (yield this.decrypt([yield _super.createMessage.call(this, (yield this.encrypt([body]))[0])]))[0].entity;
         });
     }
+    /**
+     * Finds messages with pagination.
+     * @param user the current user (unused, for compatibility).
+     * @param startKey optional start key for pagination.
+     * @param startDocumentId optional start document id for pagination.
+     * @param limit optional maximum number of results to return.
+     * @return a paginated list of messages.
+     */
     findMessagesWithUser(user, startKey, startDocumentId, limit) {
         const _super = Object.create(null, {
             findMessages: { get: () => super.findMessages }
@@ -223,6 +277,16 @@ class IccMessageXApi extends icc_api_1.IccMessageApi {
             return yield this.decryptPage(yield _super.findMessages.call(this, startKey, startDocumentId, limit));
         });
     }
+    /**
+     * Finds messages by sender address with pagination.
+     * @param user the current user (unused, for compatibility).
+     * @param fromAddress the sender address to filter by.
+     * @param startKey optional start key for pagination.
+     * @param startDocumentId optional start document id for pagination.
+     * @param limit optional maximum number of results to return.
+     * @param hcpId optional healthcare party id to filter by.
+     * @return a paginated list of messages.
+     */
     findMessagesByFromAddressWithUser(user, fromAddress, startKey, startDocumentId, limit, hcpId) {
         const _super = Object.create(null, {
             findMessagesByFromAddress: { get: () => super.findMessagesByFromAddress }
@@ -253,6 +317,17 @@ class IccMessageXApi extends icc_api_1.IccMessageApi {
             return (yield this.decrypt(yield _super.findMessagesByHCPartyPatientForeignKeys.call(this, secretFKeys))).map((x) => x.entity);
         });
     }
+    /**
+     * Finds messages by recipient address with pagination.
+     * @param user the current user (unused, for compatibility).
+     * @param toAddress the recipient address to filter by.
+     * @param startKey optional start key for pagination.
+     * @param startDocumentId optional start document id for pagination.
+     * @param limit optional maximum number of results to return.
+     * @param reverse optional flag to reverse the sort order.
+     * @param hcpId optional healthcare party id to filter by.
+     * @return a paginated list of messages.
+     */
     findMessagesByToAddressWithUser(user, toAddress, startKey, startDocumentId, limit, reverse, hcpId) {
         const _super = Object.create(null, {
             findMessagesByToAddress: { get: () => super.findMessagesByToAddress }
@@ -261,6 +336,17 @@ class IccMessageXApi extends icc_api_1.IccMessageApi {
             return yield this.decryptPage(yield _super.findMessagesByToAddress.call(this, toAddress, startKey, startDocumentId, limit, reverse, hcpId));
         });
     }
+    /**
+     * Finds messages by transport GUID with pagination.
+     * @param user the current user (unused, for compatibility).
+     * @param transportGuid the transport GUID to filter by.
+     * @param received optional flag to filter by received status.
+     * @param startKey optional start key for pagination.
+     * @param startDocumentId optional start document id for pagination.
+     * @param limit optional maximum number of results to return.
+     * @param hcpId optional healthcare party id to filter by.
+     * @return a paginated list of messages.
+     */
     findMessagesByTransportGuidWithUser(user, transportGuid, received, startKey, startDocumentId, limit, hcpId) {
         const _super = Object.create(null, {
             findMessagesByTransportGuid: { get: () => super.findMessagesByTransportGuid }
@@ -269,6 +355,18 @@ class IccMessageXApi extends icc_api_1.IccMessageApi {
             return yield this.decryptPage(yield _super.findMessagesByTransportGuid.call(this, transportGuid, received, startKey, startDocumentId, limit, hcpId));
         });
     }
+    /**
+     * Finds messages by transport GUID and sent date range with pagination.
+     * @param user the current user (unused, for compatibility).
+     * @param transportGuid the transport GUID to filter by.
+     * @param from optional start timestamp for the date range.
+     * @param to optional end timestamp for the date range.
+     * @param startKey optional start key for pagination.
+     * @param startDocumentId optional start document id for pagination.
+     * @param limit optional maximum number of results to return.
+     * @param hcpId optional healthcare party id to filter by.
+     * @return a paginated list of messages.
+     */
     findMessagesByTransportGuidSentDateWithUser(user, transportGuid, from, to, startKey, startDocumentId, limit, hcpId) {
         const _super = Object.create(null, {
             findMessagesByTransportGuidSentDate: { get: () => super.findMessagesByTransportGuidSentDate }
@@ -277,6 +375,12 @@ class IccMessageXApi extends icc_api_1.IccMessageApi {
             return yield this.decryptPage(yield _super.findMessagesByTransportGuidSentDate.call(this, transportGuid, from, to, startKey, startDocumentId, limit, hcpId));
         });
     }
+    /**
+     * Retrieves the children messages of a message.
+     * @param user the current user (unused, for compatibility).
+     * @param messageId the id of the parent message.
+     * @return the children messages.
+     */
     getChildrenMessagesWithUser(user, messageId) {
         const _super = Object.create(null, {
             getChildrenMessages: { get: () => super.getChildrenMessages }
@@ -285,6 +389,12 @@ class IccMessageXApi extends icc_api_1.IccMessageApi {
             return (yield this.decrypt(yield _super.getChildrenMessages.call(this, messageId))).map((x) => x.entity);
         });
     }
+    /**
+     * Retrieves the children messages of a list of parent messages.
+     * @param user the current user (unused, for compatibility).
+     * @param body the list of parent message ids.
+     * @return the children messages.
+     */
     getChildrenMessagesOfListWithUser(user, body) {
         const _super = Object.create(null, {
             getChildrenMessagesOfList: { get: () => super.getChildrenMessagesOfList }
@@ -293,6 +403,12 @@ class IccMessageXApi extends icc_api_1.IccMessageApi {
             return (yield this.decrypt(yield _super.getChildrenMessagesOfList.call(this, body))).map((x) => x.entity);
         });
     }
+    /**
+     * Retrieves a message by its id.
+     * @param user the current user (unused, for compatibility).
+     * @param messageId the id of the message.
+     * @return the message.
+     */
     getMessageWithUser(user, messageId) {
         const _super = Object.create(null, {
             getMessage: { get: () => super.getMessage }
@@ -301,6 +417,12 @@ class IccMessageXApi extends icc_api_1.IccMessageApi {
             return (yield this.decrypt([yield _super.getMessage.call(this, messageId)]))[0].entity;
         });
     }
+    /**
+     * Retrieves multiple messages by their ids.
+     * @param user the current user (unused, for compatibility).
+     * @param messageIds the list of message ids.
+     * @return the messages.
+     */
     getMessagesWithUser(user, messageIds) {
         const _super = Object.create(null, {
             getMessages: { get: () => super.getMessages }
@@ -309,6 +431,12 @@ class IccMessageXApi extends icc_api_1.IccMessageApi {
             return (yield this.decrypt(yield _super.getMessages.call(this, messageIds))).map((x) => x.entity);
         });
     }
+    /**
+     * Lists messages by invoice ids.
+     * @param user the current user (unused, for compatibility).
+     * @param body the list of invoice ids.
+     * @return the messages associated with the invoices.
+     */
     listMessagesByInvoiceIdsWithUser(user, body) {
         const _super = Object.create(null, {
             listMessagesByInvoiceIds: { get: () => super.listMessagesByInvoiceIds }
@@ -317,6 +445,13 @@ class IccMessageXApi extends icc_api_1.IccMessageApi {
             return (yield this.decrypt(yield _super.listMessagesByInvoiceIds.call(this, body))).map((x) => x.entity);
         });
     }
+    /**
+     * Lists messages by transport GUIDs.
+     * @param user the current user (unused, for compatibility).
+     * @param hcpId the healthcare party id.
+     * @param body the list of transport GUIDs.
+     * @return the messages associated with the transport GUIDs.
+     */
     listMessagesByTransportGuidsWithUser(user, hcpId, body) {
         const _super = Object.create(null, {
             listMessagesByTransportGuids: { get: () => super.listMessagesByTransportGuids }
@@ -325,6 +460,12 @@ class IccMessageXApi extends icc_api_1.IccMessageApi {
             return (yield this.decrypt(yield _super.listMessagesByTransportGuids.call(this, hcpId, body))).map((x) => x.entity);
         });
     }
+    /**
+     * Modifies a message.
+     * @param user the current user (unused, for compatibility).
+     * @param body the message to modify.
+     * @return the modified message.
+     */
     modifyMessageWithUser(user, body) {
         const _super = Object.create(null, {
             modifyMessage: { get: () => super.modifyMessage }
@@ -333,6 +474,13 @@ class IccMessageXApi extends icc_api_1.IccMessageApi {
             return (yield this.decrypt([yield _super.modifyMessage.call(this, (yield this.encrypt([body]))[0])]))[0].entity;
         });
     }
+    /**
+     * Sets the status bits of multiple messages.
+     * @param user the current user (unused, for compatibility).
+     * @param status the status bits to set.
+     * @param body the list of message ids.
+     * @return the updated messages.
+     */
     setMessagesStatusBitsWithUser(user, status, body) {
         const _super = Object.create(null, {
             setMessagesStatusBits: { get: () => super.setMessagesStatusBits }
@@ -341,6 +489,14 @@ class IccMessageXApi extends icc_api_1.IccMessageApi {
             return (yield this.decrypt(yield _super.setMessagesStatusBits.call(this, status, body))).map((x) => x.entity);
         });
     }
+    /**
+     * Filters messages using a filter chain with pagination.
+     * @param user the current user (unused, for compatibility).
+     * @param body the filter chain to apply.
+     * @param startDocumentId optional start document id for pagination.
+     * @param limit optional maximum number of results to return.
+     * @return a paginated list of filtered messages.
+     */
     filterMessagesByWithUser(user, body, startDocumentId, limit) {
         const _super = Object.create(null, {
             filterMessagesBy: { get: () => super.filterMessagesBy }
@@ -349,6 +505,12 @@ class IccMessageXApi extends icc_api_1.IccMessageApi {
             return yield this.decryptPage(yield _super.filterMessagesBy.call(this, body, startDocumentId, limit));
         });
     }
+    /**
+     * Sets the read status of multiple messages.
+     * @param user the current user (unused, for compatibility).
+     * @param body the read status update information.
+     * @return the updated messages.
+     */
     setMessagesReadStatusWithUser(user, body) {
         const _super = Object.create(null, {
             setMessagesReadStatus: { get: () => super.setMessagesReadStatus }