@icure/cardinal-sdk 2.1.0 → 2.1.2

package/model/Message.mjs

@@ -6,37 +6,160 @@ import { CodeStub } from './base/CodeStub.mjs';
 import { Delegation } from './embed/Delegation.mjs';
 import { MessageReadStatus } from './embed/MessageReadStatus.mjs';
 import { SecurityMetadata } from './embed/SecurityMetadata.mjs';
+/**
+ *
+ *  Represents a message exchanged between healthcare parties. Messages can be used for internal
+ *  communication,
+ *  eHealth box messages, eFact batches, and other types of healthcare-related communications.
+ *  /
+ */
 export class DecryptedMessage {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the message in the database, used for conflict management / optimistic locking.
+         */
         this.rev = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of creation.
+         */
         this.created = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of the latest modification.
+         */
         this.modified = undefined;
+        /**
+         *
+         *  The id of the User that created this message.
+         */
         this.author = undefined;
+        /**
+         *
+         *  The id of the HealthcareParty that is responsible for this message.
+         */
         this.responsible = undefined;
+        /**
+         *
+         *  Tags that qualify the message as being member of a certain class.
+         */
         this.tags = [];
+        /**
+         *
+         *  Codes that identify or qualify this particular message.
+         */
         this.codes = [];
+        /**
+         *
+         *  Hard delete (unix epoch in ms) timestamp of the object.
+         */
         this.deletionDate = undefined;
+        /**
+         *
+         *  Address of the sender of the message.
+         */
         this.fromAddress = undefined;
+        /**
+         *
+         *  ID of the healthcare party sending the message.
+         */
         this.fromHealthcarePartyId = undefined;
+        /**
+         *
+         *  List of IDs of healthcare parties to whom the message is addressed.
+         */
         this.recipients = [];
+        /**
+         *
+         *  The addresses of the recipients of the message.
+         */
         this.toAddresses = [];
+        /**
+         *
+         *  The timestamp (unix epoch in ms) when the message was received.
+         */
         this.received = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) when the message was sent.
+         */
         this.sent = undefined;
+        /**
+         *
+         *  Additional metadata for the message.
+         */
         this.metas = {};
+        /**
+         *
+         *  Status showing whether the message is read or not and the time of reading.
+         */
         this.readStatus = {};
+        /**
+         *
+         *  Transport-level identifier for the message, format depends on the transport type.
+         */
         this.transportGuid = undefined;
+        /**
+         *
+         *  An additional remark on the message.
+         */
         this.remark = undefined;
+        /**
+         *
+         *  The guid of the conversation this message belongs to.
+         */
         this.conversationGuid = undefined;
+        /**
+         *
+         *  Subject for the message.
+         */
         this.subject = undefined;
+        /**
+         *
+         *  Set of IDs for invoices in the message.
+         */
         this.invoiceIds = [];
+        /**
+         *
+         *  ID of a parent in a message conversation.
+         */
         this.parentId = undefined;
+        /**
+         *
+         *  Extra properties for the message.
+         */
         this.properties = [];
+        /**
+         *
+         *  The secret patient key, encrypted in the patient's own AES key.
+         */
         this.secretForeignKeys = [];
+        /**
+         *
+         *  The patient id encrypted in the delegates' AES keys.
+         */
         this.cryptedForeignKeys = {};
+        /**
+         *
+         *  The delegations giving access to connected healthcare information.
+         */
         this.delegations = {};
+        /**
+         *
+         *  The keys used to encrypt this entity when stored encrypted.
+         */
         this.encryptionKeys = {};
+        /**
+         *
+         *  The base64-encoded encrypted fields of this entity.
+         */
         this.encryptedSelf = undefined;
+        /**
+         *
+         *  The security metadata of the entity.
+         */
         this.securityMetadata = undefined;
         this.isEncrypted = false;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== false)
@@ -199,37 +322,160 @@ export class DecryptedMessage {
         return res;
     }
 }
+/**
+ *
+ *  Represents a message exchanged between healthcare parties. Messages can be used for internal
+ *  communication,
+ *  eHealth box messages, eFact batches, and other types of healthcare-related communications.
+ *  /
+ */
 export class EncryptedMessage {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the message in the database, used for conflict management / optimistic locking.
+         */
         this.rev = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of creation.
+         */
         this.created = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of the latest modification.
+         */
         this.modified = undefined;
+        /**
+         *
+         *  The id of the User that created this message.
+         */
         this.author = undefined;
+        /**
+         *
+         *  The id of the HealthcareParty that is responsible for this message.
+         */
         this.responsible = undefined;
+        /**
+         *
+         *  Tags that qualify the message as being member of a certain class.
+         */
         this.tags = [];
+        /**
+         *
+         *  Codes that identify or qualify this particular message.
+         */
         this.codes = [];
+        /**
+         *
+         *  Hard delete (unix epoch in ms) timestamp of the object.
+         */
         this.deletionDate = undefined;
+        /**
+         *
+         *  Address of the sender of the message.
+         */
         this.fromAddress = undefined;
+        /**
+         *
+         *  ID of the healthcare party sending the message.
+         */
         this.fromHealthcarePartyId = undefined;
+        /**
+         *
+         *  List of IDs of healthcare parties to whom the message is addressed.
+         */
         this.recipients = [];
+        /**
+         *
+         *  The addresses of the recipients of the message.
+         */
         this.toAddresses = [];
+        /**
+         *
+         *  The timestamp (unix epoch in ms) when the message was received.
+         */
         this.received = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) when the message was sent.
+         */
         this.sent = undefined;
+        /**
+         *
+         *  Additional metadata for the message.
+         */
         this.metas = {};
+        /**
+         *
+         *  Status showing whether the message is read or not and the time of reading.
+         */
         this.readStatus = {};
+        /**
+         *
+         *  Transport-level identifier for the message, format depends on the transport type.
+         */
         this.transportGuid = undefined;
+        /**
+         *
+         *  An additional remark on the message.
+         */
         this.remark = undefined;
+        /**
+         *
+         *  The guid of the conversation this message belongs to.
+         */
         this.conversationGuid = undefined;
+        /**
+         *
+         *  Subject for the message.
+         */
         this.subject = undefined;
+        /**
+         *
+         *  Set of IDs for invoices in the message.
+         */
         this.invoiceIds = [];
+        /**
+         *
+         *  ID of a parent in a message conversation.
+         */
         this.parentId = undefined;
+        /**
+         *
+         *  Extra properties for the message.
+         */
         this.properties = [];
+        /**
+         *
+         *  The secret patient key, encrypted in the patient's own AES key.
+         */
         this.secretForeignKeys = [];
+        /**
+         *
+         *  The patient id encrypted in the delegates' AES keys.
+         */
         this.cryptedForeignKeys = {};
+        /**
+         *
+         *  The delegations giving access to connected healthcare information.
+         */
         this.delegations = {};
+        /**
+         *
+         *  The keys used to encrypt this entity when stored encrypted.
+         */
         this.encryptionKeys = {};
+        /**
+         *
+         *  The base64-encoded encrypted fields of this entity.
+         */
         this.encryptedSelf = undefined;
+        /**
+         *
+         *  The security metadata of the entity.
+         */
         this.securityMetadata = undefined;
         this.isEncrypted = true;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== true)

package/model/PaginatedDocumentKeyIdPair.d.mts

@@ -1,5 +1,19 @@
+/**
+ *
+ *  DTO representing a key-document ID pair used for cursor-based pagination in CouchDB views.
+ *  /
+ */
 export declare class PaginatedDocumentKeyIdPair {
+    /**
+     *
+     *  The view key to start the next page from.
+     */
     startKey: any | undefined;
+    /**
+     *
+     *  The document identifier to start the next page from, used to disambiguate when multiple
+     *  documents share the same key.
+     */
     startKeyDocId: string | undefined;
     constructor(partial: Partial<PaginatedDocumentKeyIdPair>);
     toJSON(): object;

package/model/PaginatedDocumentKeyIdPair.mjs

@@ -1,8 +1,22 @@
 // auto-generated file
 import { expectString, extractEntry } from '../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  DTO representing a key-document ID pair used for cursor-based pagination in CouchDB views.
+ *  /
+ */
 export class PaginatedDocumentKeyIdPair {
     constructor(partial) {
+        /**
+         *
+         *  The view key to start the next page from.
+         */
         this.startKey = undefined;
+        /**
+         *
+         *  The document identifier to start the next page from, used to disambiguate when multiple
+         *  documents share the same key.
+         */
         this.startKeyDocId = undefined;
         if ('startKey' in partial)
             this.startKey = partial.startKey;

package/model/PaginatedList.d.mts

@@ -1,6 +1,23 @@
 import { PaginatedDocumentKeyIdPair } from './PaginatedDocumentKeyIdPair.mjs';
+/**
+ *
+ *  Generic DTO representing a paginated list of results. Contains the current page of rows
+ *  and a key pair for fetching the next page.
+ *
+ *  @param T The type of elements in the paginated list.
+ *  /
+ */
 export declare class PaginatedList<T> {
+    /**
+     *
+     *  The list of results for the current page.
+     */
     rows: Array<T>;
+    /**
+     *
+     *  The key-document ID pair to use for fetching the next page of results, or null if this is the
+     *  last page.
+     */
     nextKeyPair: PaginatedDocumentKeyIdPair | undefined;
     constructor(partial: Partial<PaginatedList<T>>);
 }

package/model/PaginatedList.mjs

@@ -1,6 +1,23 @@
+/**
+ *
+ *  Generic DTO representing a paginated list of results. Contains the current page of rows
+ *  and a key pair for fetching the next page.
+ *
+ *  @param T The type of elements in the paginated list.
+ *  /
+ */
 export class PaginatedList {
     constructor(partial) {
+        /**
+         *
+         *  The list of results for the current page.
+         */
         this.rows = [];
+        /**
+         *
+         *  The key-document ID pair to use for fetching the next page of results, or null if this is the
+         *  last page.
+         */
         this.nextKeyPair = undefined;
         if ('rows' in partial && partial.rows !== undefined)
             this.rows = partial.rows;