@icure/cardinal-sdk 2.1.0 → 2.1.2

package/model/Topic.d.mts

@@ -7,82 +7,295 @@ import { Delegation } from './embed/Delegation.mjs';
 import { Encryptable } from './embed/Encryptable.mjs';
 import { SecurityMetadata } from './embed/SecurityMetadata.mjs';
 import { Base64String } from './specializations/Base64String.mjs';
+/**
+ *
+ *  Represents a topic for secure messaging between healthcare parties. A topic groups messages in a
+ *  conversation
+ *  and can be linked to health elements and services for medical context.
+ *  /
+ */
 export interface Topic extends StoredDocument, ICureDocument<string>, HasEncryptionMetadata, Encryptable {
+    /**
+     *
+     *  The id of the health element linked to this topic.
+     */
     healthElementId: string | undefined;
+    /**
+     *
+     *  The id of the contact linked to this topic.
+     */
     contactId: string | undefined;
+    /**
+     *
+     *  A description of the topic.
+     */
     description: string | undefined;
+    /**
+     *
+     *  Map of active participants with their roles (participant, admin, or owner).
+     */
     activeParticipants: {
         [key: string]: TopicRole;
     };
+    /**
+     *
+     *  Set of ids of health elements linked to this topic.
+     */
     linkedHealthElements: Array<string>;
+    /**
+     *
+     *  Set of ids of services linked to this topic.
+     */
     linkedServices: Array<string>;
     readonly isEncrypted: boolean;
     toJSON(): object;
 }
+/**
+ *
+ *  Represents a topic for secure messaging between healthcare parties. A topic groups messages in a
+ *  conversation
+ *  and can be linked to health elements and services for medical context.
+ *  /
+ */
 export declare class DecryptedTopic {
+    /**
+     *
+     *  The unique identifier of the topic.
+     */
     id: string;
+    /**
+     *
+     *  The revision of the topic in the database, used for conflict management / optimistic locking.
+     */
     rev: string | undefined;
+    /**
+     *
+     *  The timestamp (unix epoch in ms) of creation.
+     */
     created: number | undefined;
+    /**
+     *
+     *  The timestamp (unix epoch in ms) of the latest modification.
+     */
     modified: number | undefined;
+    /**
+     *
+     *  The id of the health element linked to this topic.
+     */
     healthElementId: string | undefined;
+    /**
+     *
+     *  The id of the contact linked to this topic.
+     */
     contactId: string | undefined;
+    /**
+     *
+     *  A description of the topic.
+     */
     description: string | undefined;
+    /**
+     *
+     *  Codes that identify or qualify this particular topic.
+     */
     codes: Array<CodeStub>;
+    /**
+     *
+     *  Tags that qualify the topic as being member of a certain class.
+     */
     tags: Array<CodeStub>;
+    /**
+     *
+     *  The id of the User that created this topic.
+     */
     author: string | undefined;
+    /**
+     *
+     *  The id of the HealthcareParty that is responsible for this topic.
+     */
     responsible: string | undefined;
+    /**
+     *
+     *  Hard delete (unix epoch in ms) timestamp of the object.
+     */
     deletionDate: number | undefined;
+    /**
+     *
+     *  Map of active participants with their roles (participant, admin, or owner).
+     */
     activeParticipants: {
         [key: string]: TopicRole;
     };
+    /**
+     *
+     *  The security metadata of the entity.
+     */
     securityMetadata: SecurityMetadata | undefined;
+    /**
+     *
+     *  The secret patient key, encrypted in the patient's own AES key.
+     */
     secretForeignKeys: Array<string>;
+    /**
+     *
+     *  The patient id encrypted in the delegates' AES keys.
+     */
     cryptedForeignKeys: {
         [key: string]: Array<Delegation>;
     };
+    /**
+     *
+     *  The delegations giving access to connected healthcare information.
+     */
     delegations: {
         [key: string]: Array<Delegation>;
     };
+    /**
+     *
+     *  The keys used to encrypt this entity when stored encrypted.
+     */
     encryptionKeys: {
         [key: string]: Array<Delegation>;
     };
+    /**
+     *
+     *  The base64-encoded encrypted fields of this entity.
+     */
     encryptedSelf: Base64String | undefined;
+    /**
+     *
+     *  Set of ids of health elements linked to this topic.
+     */
     linkedHealthElements: Array<string>;
+    /**
+     *
+     *  Set of ids of services linked to this topic.
+     */
     linkedServices: Array<string>;
     readonly isEncrypted: false;
     constructor(partial: Partial<DecryptedTopic>);
     toJSON(): object;
     static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): DecryptedTopic;
 }
+/**
+ *
+ *  Represents a topic for secure messaging between healthcare parties. A topic groups messages in a
+ *  conversation
+ *  and can be linked to health elements and services for medical context.
+ *  /
+ */
 export declare class EncryptedTopic {
+    /**
+     *
+     *  The unique identifier of the topic.
+     */
     id: string;
+    /**
+     *
+     *  The revision of the topic in the database, used for conflict management / optimistic locking.
+     */
     rev: string | undefined;
+    /**
+     *
+     *  The timestamp (unix epoch in ms) of creation.
+     */
     created: number | undefined;
+    /**
+     *
+     *  The timestamp (unix epoch in ms) of the latest modification.
+     */
     modified: number | undefined;
+    /**
+     *
+     *  The id of the health element linked to this topic.
+     */
     healthElementId: string | undefined;
+    /**
+     *
+     *  The id of the contact linked to this topic.
+     */
     contactId: string | undefined;
+    /**
+     *
+     *  A description of the topic.
+     */
     description: string | undefined;
+    /**
+     *
+     *  Codes that identify or qualify this particular topic.
+     */
     codes: Array<CodeStub>;
+    /**
+     *
+     *  Tags that qualify the topic as being member of a certain class.
+     */
     tags: Array<CodeStub>;
+    /**
+     *
+     *  The id of the User that created this topic.
+     */
     author: string | undefined;
+    /**
+     *
+     *  The id of the HealthcareParty that is responsible for this topic.
+     */
     responsible: string | undefined;
+    /**
+     *
+     *  Hard delete (unix epoch in ms) timestamp of the object.
+     */
     deletionDate: number | undefined;
+    /**
+     *
+     *  Map of active participants with their roles (participant, admin, or owner).
+     */
     activeParticipants: {
         [key: string]: TopicRole;
     };
+    /**
+     *
+     *  The security metadata of the entity.
+     */
     securityMetadata: SecurityMetadata | undefined;
+    /**
+     *
+     *  The secret patient key, encrypted in the patient's own AES key.
+     */
     secretForeignKeys: Array<string>;
+    /**
+     *
+     *  The patient id encrypted in the delegates' AES keys.
+     */
     cryptedForeignKeys: {
         [key: string]: Array<Delegation>;
     };
+    /**
+     *
+     *  The delegations giving access to connected healthcare information.
+     */
     delegations: {
         [key: string]: Array<Delegation>;
     };
+    /**
+     *
+     *  The keys used to encrypt this entity when stored encrypted.
+     */
     encryptionKeys: {
         [key: string]: Array<Delegation>;
     };
+    /**
+     *
+     *  The base64-encoded encrypted fields of this entity.
+     */
     encryptedSelf: Base64String | undefined;
+    /**
+     *
+     *  Set of ids of health elements linked to this topic.
+     */
     linkedHealthElements: Array<string>;
+    /**
+     *
+     *  Set of ids of services linked to this topic.
+     */
     linkedServices: Array<string>;
     readonly isEncrypted: true;
     constructor(partial: Partial<EncryptedTopic>);

package/model/Topic.mjs

@@ -5,28 +5,115 @@ import { TopicRole } from './TopicRole.mjs';
 import { CodeStub } from './base/CodeStub.mjs';
 import { Delegation } from './embed/Delegation.mjs';
 import { SecurityMetadata } from './embed/SecurityMetadata.mjs';
+/**
+ *
+ *  Represents a topic for secure messaging between healthcare parties. A topic groups messages in a
+ *  conversation
+ *  and can be linked to health elements and services for medical context.
+ *  /
+ */
 export class DecryptedTopic {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the topic 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 health element linked to this topic.
+         */
         this.healthElementId = undefined;
+        /**
+         *
+         *  The id of the contact linked to this topic.
+         */
         this.contactId = undefined;
+        /**
+         *
+         *  A description of the topic.
+         */
         this.description = undefined;
+        /**
+         *
+         *  Codes that identify or qualify this particular topic.
+         */
         this.codes = [];
+        /**
+         *
+         *  Tags that qualify the topic as being member of a certain class.
+         */
         this.tags = [];
+        /**
+         *
+         *  The id of the User that created this topic.
+         */
         this.author = undefined;
+        /**
+         *
+         *  The id of the HealthcareParty that is responsible for this topic.
+         */
         this.responsible = undefined;
+        /**
+         *
+         *  Hard delete (unix epoch in ms) timestamp of the object.
+         */
         this.deletionDate = undefined;
+        /**
+         *
+         *  Map of active participants with their roles (participant, admin, or owner).
+         */
         this.activeParticipants = {};
+        /**
+         *
+         *  The security metadata of the entity.
+         */
         this.securityMetadata = undefined;
+        /**
+         *
+         *  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;
+        /**
+         *
+         *  Set of ids of health elements linked to this topic.
+         */
         this.linkedHealthElements = [];
+        /**
+         *
+         *  Set of ids of services linked to this topic.
+         */
         this.linkedServices = [];
         this.isEncrypted = false;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== false)
@@ -147,28 +234,115 @@ export class DecryptedTopic {
         return res;
     }
 }
+/**
+ *
+ *  Represents a topic for secure messaging between healthcare parties. A topic groups messages in a
+ *  conversation
+ *  and can be linked to health elements and services for medical context.
+ *  /
+ */
 export class EncryptedTopic {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the topic 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 health element linked to this topic.
+         */
         this.healthElementId = undefined;
+        /**
+         *
+         *  The id of the contact linked to this topic.
+         */
         this.contactId = undefined;
+        /**
+         *
+         *  A description of the topic.
+         */
         this.description = undefined;
+        /**
+         *
+         *  Codes that identify or qualify this particular topic.
+         */
         this.codes = [];
+        /**
+         *
+         *  Tags that qualify the topic as being member of a certain class.
+         */
         this.tags = [];
+        /**
+         *
+         *  The id of the User that created this topic.
+         */
         this.author = undefined;
+        /**
+         *
+         *  The id of the HealthcareParty that is responsible for this topic.
+         */
         this.responsible = undefined;
+        /**
+         *
+         *  Hard delete (unix epoch in ms) timestamp of the object.
+         */
         this.deletionDate = undefined;
+        /**
+         *
+         *  Map of active participants with their roles (participant, admin, or owner).
+         */
         this.activeParticipants = {};
+        /**
+         *
+         *  The security metadata of the entity.
+         */
         this.securityMetadata = undefined;
+        /**
+         *
+         *  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;
+        /**
+         *
+         *  Set of ids of health elements linked to this topic.
+         */
         this.linkedHealthElements = [];
+        /**
+         *
+         *  Set of ids of services linked to this topic.
+         */
         this.linkedServices = [];
         this.isEncrypted = true;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== true)

package/model/TopicRole.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *
+ *   Defines the possible roles a participant can have within a topic conversation.
+ */
 export declare enum TopicRole {
     Participant = "Participant",
     Admin = "Admin",

package/model/TopicRole.mjs

@@ -1,4 +1,9 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Defines the possible roles a participant can have within a topic conversation.
+ */
 export var TopicRole;
 (function (TopicRole) {
     TopicRole["Participant"] = "Participant";

package/model/User.d.mts

@@ -6,32 +6,128 @@ import { UsersStatus } from './enums/UsersStatus.mjs';
 import { AuthenticationToken } from './security/AuthenticationToken.mjs';
 import { LoginIdentifier } from './security/LoginIdentifier.mjs';
 import { Permission } from './security/Permission.mjs';
+/**
+ *
+ *  Represents a user that can log in to the iCure platform. A user can be linked to a healthcare
+ *  party,
+ *  a patient, or a device, and holds authentication credentials, roles, and permissions.
+ *  /
+ */
 export declare class User implements StoredDocument {
+    /**
+     *
+     *  The Id of the user. We encourage using either a v4 UUID or a HL7 Id.
+     */
     id: string;
+    /**
+     *
+     *  The revision of the user in the database, used for conflict management / optimistic locking.
+     */
     rev: string | undefined;
+    /**
+     *
+     *  Hard delete (unix epoch in ms) timestamp of the object.
+     */
     deletionDate: number | undefined;
+    /**
+     *
+     *  The timestamp (unix epoch in ms) of creation.
+     */
     created: number | undefined;
+    /**
+     *
+     *  The identifiers of the user.
+     */
     identifier: Array<Identifier>;
+    /**
+     *
+     *  Last name of the user.
+     */
     name: string | undefined;
+    /**
+     *
+     *  Extra properties for the user. Those properties are typed (see class Property).
+     */
     properties: Array<DecryptedPropertyStub>;
+    /**
+     *
+     *  Local permissions specified for the user.
+     */
     permissions: Array<Permission>;
+    /**
+     *
+     *  Local roles specified for the user.
+     */
     roles: Array<string>;
+    /**
+     *
+     *  State of user's activeness: 'Active', 'Disabled' or 'Registering'.
+     */
     status: UsersStatus | undefined;
+    /**
+     *
+     *  Username for this user. We encourage using an email address.
+     */
     login: string | undefined;
+    /**
+     *
+     *  Hashed version of the password (BCrypt is used for hashing).
+     */
     passwordHash: string | undefined;
+    /**
+     *
+     *  The id of the group (practice/hospital) the user is member of.
+     */
     groupId: string | undefined;
+    /**
+     *
+     *  Id of the healthcare party if the user is a healthcare party.
+     */
     healthcarePartyId: string | undefined;
+    /**
+     *
+     *  Id of the patient if the user is a patient.
+     */
     patientId: string | undefined;
+    /**
+     *
+     *  Id of the device if the user is a device.
+     */
     deviceId: string | undefined;
+    /**
+     *
+     *  Delegations that are automatically generated client side when a new database object is created
+     *  by this user.
+     */
     autoDelegations: {
         [key in DelegationTag]?: Array<string>;
     };
+    /**
+     *
+     *  The timestamp (unix epoch in ms) of the latest validation of the terms of use.
+     */
     termsOfUseDate: number | undefined;
+    /**
+     *
+     *  Email address of the user (used for token exchange or password recovery).
+     */
     email: string | undefined;
+    /**
+     *
+     *  Mobile phone of the user (used for token exchange or password recovery).
+     */
     mobilePhone: string | undefined;
+    /**
+     *
+     *  Encrypted and time-limited authentication tokens used for inter-applications authentication.
+     */
     authenticationTokens: {
         [key: string]: AuthenticationToken;
     };
+    /**
+     *
+     *  Metadata used to enrich the user with information from the cloud environment.
+     */
     systemMetadata: User.SystemMetadata | undefined;
     constructor(partial: Partial<User>);
     toJSON(): object;
@@ -43,6 +139,8 @@ export declare namespace User {
         isAdmin: boolean;
         inheritsRoles: boolean;
         loginIdentifiers: Array<LoginIdentifier>;
+        verifiedEmail: boolean | undefined;
+        verifiedMobilePhone: boolean | undefined;
         constructor(partial: Partial<SystemMetadata> & Pick<SystemMetadata, "roles" | "isAdmin" | "inheritsRoles">);
         toJSON(): object;
         static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): SystemMetadata;