@icure/cardinal-sdk 2.1.1 → 2.1.2

package/model/Receipt.mjs

@@ -4,26 +4,107 @@ import { randomUuid } from '../utils/Id.mjs';
 import { CodeStub } from './base/CodeStub.mjs';
 import { Delegation } from './embed/Delegation.mjs';
 import { SecurityMetadata } from './embed/SecurityMetadata.mjs';
+/**
+ *
+ *  Represents a receipt for a healthcare transaction. Receipts are used to store acknowledgements
+ *  and responses
+ *  from external systems such as eFact, eAttest, or other healthcare messaging platforms. They can
+ *  be linked
+ *  to invoices or other documents.
+ *  /
+ */
 export class DecryptedReceipt {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the receipt 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 receipt.
+         */
         this.author = undefined;
+        /**
+         *
+         *  The id of the HealthcareParty that is responsible for this receipt.
+         */
         this.responsible = undefined;
+        /**
+         *
+         *  Tags that qualify the receipt as being member of a certain class.
+         */
         this.tags = [];
+        /**
+         *
+         *  Codes that identify or qualify this particular receipt.
+         */
         this.codes = [];
+        /**
+         *
+         *  Hard delete (unix epoch in ms) timestamp of the object.
+         */
         this.deletionDate = undefined;
+        /**
+         *
+         *  List of references (e.g., nipReference, errorCode, errorPath, tarification, invoice UUID).
+         */
         this.references = [];
+        /**
+         *
+         *  The id of the document (InvoiceDto, ContactDto, ...) this receipt is linked to.
+         */
         this.documentId = undefined;
+        /**
+         *
+         *  The category of the receipt.
+         */
         this.category = undefined;
+        /**
+         *
+         *  The sub-category of the receipt.
+         */
         this.subCategory = 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;
+        /**
+         *
+         *  The security metadata of the entity.
+         */
         this.securityMetadata = undefined;
         this.isEncrypted = false;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== false)
@@ -136,26 +217,107 @@ export class DecryptedReceipt {
         return res;
     }
 }
+/**
+ *
+ *  Represents a receipt for a healthcare transaction. Receipts are used to store acknowledgements
+ *  and responses
+ *  from external systems such as eFact, eAttest, or other healthcare messaging platforms. They can
+ *  be linked
+ *  to invoices or other documents.
+ *  /
+ */
 export class EncryptedReceipt {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the receipt 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 receipt.
+         */
         this.author = undefined;
+        /**
+         *
+         *  The id of the HealthcareParty that is responsible for this receipt.
+         */
         this.responsible = undefined;
+        /**
+         *
+         *  Tags that qualify the receipt as being member of a certain class.
+         */
         this.tags = [];
+        /**
+         *
+         *  Codes that identify or qualify this particular receipt.
+         */
         this.codes = [];
+        /**
+         *
+         *  Hard delete (unix epoch in ms) timestamp of the object.
+         */
         this.deletionDate = undefined;
+        /**
+         *
+         *  List of references (e.g., nipReference, errorCode, errorPath, tarification, invoice UUID).
+         */
         this.references = [];
+        /**
+         *
+         *  The id of the document (InvoiceDto, ContactDto, ...) this receipt is linked to.
+         */
         this.documentId = undefined;
+        /**
+         *
+         *  The category of the receipt.
+         */
         this.category = undefined;
+        /**
+         *
+         *  The sub-category of the receipt.
+         */
         this.subCategory = 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;
+        /**
+         *
+         *  The security metadata of the entity.
+         */
         this.securityMetadata = undefined;
         this.isEncrypted = true;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== true)

package/model/RegistrationInformation.d.mts

@@ -1,12 +1,53 @@
+/**
+ *
+ *  DTO containing the information required to register a new user and group in the iCure platform.
+ *  /
+ */
 export declare class RegistrationInformation {
+    /**
+     *
+     *  The identifier of the application or project for this registration.
+     */
     projectId: string | undefined;
+    /**
+     *
+     *  The first name of the person registering.
+     */
     firstName: string | undefined;
+    /**
+     *
+     *  The last name of the person registering.
+     */
     lastName: string | undefined;
+    /**
+     *
+     *  The name of the company or organization.
+     */
     companyName: string | undefined;
+    /**
+     *
+     *  The email address of the person registering.
+     */
     emailAddress: string;
+    /**
+     *
+     *  Additional user options serialized as a string.
+     */
     userOptions: string | undefined;
+    /**
+     *
+     *  The set of roles to assign to the newly created user.
+     */
     userRoles: Array<string>;
+    /**
+     *
+     *  The minimum required Kraken version for this registration.
+     */
     minimumKrakenVersion: string | undefined;
+    /**
+     *
+     *  The target cluster for the registration.
+     */
     cluster: string | undefined;
     constructor(partial: Partial<RegistrationInformation> & Pick<RegistrationInformation, "emailAddress">);
     toJSON(): object;

package/model/RegistrationInformation.mjs

@@ -1,14 +1,51 @@
 // auto-generated file
 import { expectArray, expectString, extractEntry } from '../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  DTO containing the information required to register a new user and group in the iCure platform.
+ *  /
+ */
 export class RegistrationInformation {
     constructor(partial) {
+        /**
+         *
+         *  The identifier of the application or project for this registration.
+         */
         this.projectId = undefined;
+        /**
+         *
+         *  The first name of the person registering.
+         */
         this.firstName = undefined;
+        /**
+         *
+         *  The last name of the person registering.
+         */
         this.lastName = undefined;
+        /**
+         *
+         *  The name of the company or organization.
+         */
         this.companyName = undefined;
+        /**
+         *
+         *  Additional user options serialized as a string.
+         */
         this.userOptions = undefined;
+        /**
+         *
+         *  The set of roles to assign to the newly created user.
+         */
         this.userRoles = [];
+        /**
+         *
+         *  The minimum required Kraken version for this registration.
+         */
         this.minimumKrakenVersion = undefined;
+        /**
+         *
+         *  The target cluster for the registration.
+         */
         this.cluster = undefined;
         if ('projectId' in partial)
             this.projectId = partial.projectId;

package/model/RegistrationSuccess.d.mts

@@ -1,6 +1,24 @@
+/**
+ *
+ *  DTO returned upon successful user and group registration, containing the identifiers and
+ *  initial authentication token needed to access the newly created environment.
+ *  /
+ */
 export declare class RegistrationSuccess {
+    /**
+     *
+     *  The identifier of the newly created group.
+     */
     groupId: string;
+    /**
+     *
+     *  The identifier of the newly created user.
+     */
     userId: string;
+    /**
+     *
+     *  The initial authentication token for the newly registered user.
+     */
     token: string;
     constructor(partial: Partial<RegistrationSuccess> & Pick<RegistrationSuccess, "groupId" | "userId" | "token">);
     toJSON(): object;

package/model/RegistrationSuccess.mjs

@@ -1,5 +1,11 @@
 // auto-generated file
 import { expectString, extractEntry } from '../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  DTO returned upon successful user and group registration, containing the identifiers and
+ *  initial authentication token needed to access the newly created environment.
+ *  /
+ */
 export class RegistrationSuccess {
     constructor(partial) {
         this.groupId = partial.groupId;

package/model/Replication.d.mts

@@ -2,12 +2,42 @@ import { Identifiable } from './base/Identifiable.mjs';
 import { Named } from './base/Named.mjs';
 import { StoredDocument } from './base/StoredDocument.mjs';
 import { DatabaseSynchronization } from './embed/DatabaseSynchronization.mjs';
+/**
+ *
+ *  DTO representing a replication configuration, defining how databases are synchronized between
+ *  CouchDB instances.
+ *  /
+ */
 export declare class Replication implements StoredDocument, Identifiable<string>, Named {
+    /**
+     *
+     *  The unique identifier of the replication.
+     */
     id: string;
+    /**
+     *
+     *  The revision identifier for optimistic locking.
+     */
     rev: string | undefined;
+    /**
+     *
+     *  The soft-delete timestamp in epoch milliseconds.
+     */
     deletionDate: number | undefined;
+    /**
+     *
+     *  The display name of this replication configuration.
+     */
     name: string | undefined;
+    /**
+     *
+     *  The context or environment for this replication.
+     */
     context: string | undefined;
+    /**
+     *
+     *  The list of database synchronization rules defined in this replication.
+     */
     databaseSynchronizations: Array<DatabaseSynchronization>;
     constructor(partial: Partial<Replication>);
     toJSON(): object;

package/model/Replication.mjs

@@ -2,13 +2,39 @@
 import { expectArray, expectNumber, expectObject, expectString, extractEntry } from '../internal/JsonDecodeUtils.mjs';
 import { randomUuid } from '../utils/Id.mjs';
 import { DatabaseSynchronization } from './embed/DatabaseSynchronization.mjs';
+/**
+ *
+ *  DTO representing a replication configuration, defining how databases are synchronized between
+ *  CouchDB instances.
+ *  /
+ */
 export class Replication {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision identifier for optimistic locking.
+         */
         this.rev = undefined;
+        /**
+         *
+         *  The soft-delete timestamp in epoch milliseconds.
+         */
         this.deletionDate = undefined;
+        /**
+         *
+         *  The display name of this replication configuration.
+         */
         this.name = undefined;
+        /**
+         *
+         *  The context or environment for this replication.
+         */
         this.context = undefined;
+        /**
+         *
+         *  The list of database synchronization rules defined in this replication.
+         */
         this.databaseSynchronizations = [];
         this.id = (_a = partial.id) !== null && _a !== void 0 ? _a : randomUuid();
         if ('rev' in partial)

package/model/ReplicationInfo.d.mts

@@ -1,7 +1,28 @@
+/**
+ *
+ *  DTO providing status information about an ongoing or configured database replication.
+ *  /
+ */
 export declare class ReplicationInfo {
+    /**
+     *
+     *  Whether the replication is currently active.
+     */
     active: boolean;
+    /**
+     *
+     *  Whether the replication process is currently running.
+     */
     running: boolean;
+    /**
+     *
+     *  The number of pending changes to replicate from the source.
+     */
     pendingFrom: number | undefined;
+    /**
+     *
+     *  The number of pending changes to replicate to the target.
+     */
     pendingTo: number | undefined;
     constructor(partial: Partial<ReplicationInfo>);
     toJSON(): object;

package/model/ReplicationInfo.mjs

@@ -1,10 +1,31 @@
 // auto-generated file
 import { expectBoolean, expectNumber, extractEntry } from '../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  DTO providing status information about an ongoing or configured database replication.
+ *  /
+ */
 export class ReplicationInfo {
     constructor(partial) {
+        /**
+         *
+         *  Whether the replication is currently active.
+         */
         this.active = false;
+        /**
+         *
+         *  Whether the replication process is currently running.
+         */
         this.running = false;
+        /**
+         *
+         *  The number of pending changes to replicate from the source.
+         */
         this.pendingFrom = undefined;
+        /**
+         *
+         *  The number of pending changes to replicate to the target.
+         */
         this.pendingTo = undefined;
         if ('active' in partial && partial.active !== undefined)
             this.active = partial.active;

package/model/Role.d.mts

@@ -1,10 +1,43 @@
 import { StoredDocument } from './base/StoredDocument.mjs';
+/**
+ *
+ *  The RoleDto class represents a role in the system, which can have permissions and can be
+ *  inheritable up to a certain level by users in child Groups.$
+ *  down the group hierarchy this role can be inherited by users in child groups. A value of 0 means
+ *  it cannot be inherited, while a value of -1 means it can be inherited indefinitely.
+ *  /
+ */
 export declare class Role implements StoredDocument {
+    /**
+     *
+     *  The unique identifier of the role.
+     */
     id: string;
+    /**
+     *
+     *  The revision identifier of the role, used for optimistic locking.
+     */
     rev: string | undefined;
+    /**
+     *
+     *  The timestamp of when the role was deleted, if applicable.
+     */
     deletionDate: number | undefined;
+    /**
+     *
+     *  The name of the role.
+     */
     name: string | undefined;
+    /**
+     *
+     *  The maximum level of inheritance for this role, indicating how far
+     */
     inheritableUpTo: number | undefined;
+    /**
+     *
+     *  A set of permissions associated with this role, defining what actions users with this role can
+     *  perform.
+     */
     permissions: Array<string>;
     constructor(partial: Partial<Role>);
     toJSON(): object;

package/model/Role.mjs

@@ -1,13 +1,42 @@
 // auto-generated file
 import { expectArray, expectNumber, expectString, extractEntry } from '../internal/JsonDecodeUtils.mjs';
 import { randomUuid } from '../utils/Id.mjs';
+/**
+ *
+ *  The RoleDto class represents a role in the system, which can have permissions and can be
+ *  inheritable up to a certain level by users in child Groups.$
+ *  down the group hierarchy this role can be inherited by users in child groups. A value of 0 means
+ *  it cannot be inherited, while a value of -1 means it can be inherited indefinitely.
+ *  /
+ */
 export class Role {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision identifier of the role, used for optimistic locking.
+         */
         this.rev = undefined;
+        /**
+         *
+         *  The timestamp of when the role was deleted, if applicable.
+         */
         this.deletionDate = undefined;
+        /**
+         *
+         *  The name of the role.
+         */
         this.name = undefined;
+        /**
+         *
+         *  The maximum level of inheritance for this role, indicating how far
+         */
         this.inheritableUpTo = undefined;
+        /**
+         *
+         *  A set of permissions associated with this role, defining what actions users with this role can
+         *  perform.
+         */
         this.permissions = [];
         this.id = (_a = partial.id) !== null && _a !== void 0 ? _a : randomUuid();
         if ('rev' in partial)

package/model/StoredDocumentIdentifier.d.mts

@@ -1,4 +1,8 @@
 import { Identifiable } from './base/Identifiable.mjs';
+/**
+ *
+ *  Identifier for a document stored in iCure, includes revision.
+ */
 export declare class StoredDocumentIdentifier implements Identifiable<string> {
     id: string;
     rev: string;

package/model/StoredDocumentIdentifier.mjs

@@ -1,6 +1,10 @@
 // auto-generated file
 import { expectString, extractEntry } from '../internal/JsonDecodeUtils.mjs';
 import { randomUuid } from '../utils/Id.mjs';
+/**
+ *
+ *  Identifier for a document stored in iCure, includes revision.
+ */
 export class StoredDocumentIdentifier {
     constructor(partial) {
         var _a;