@icure/cardinal-sdk 2.1.0 → 2.1.2

package/model/AccessLog.d.mts

@@ -6,73 +6,275 @@ 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 an access log entry that records access to medical data or resources within the
+ *  system.
+ *  /
+ */
 export interface AccessLog extends StoredDocument, ICureDocument<string>, HasEncryptionMetadata, Encryptable {
+    /**
+     *
+     *  Id of the object that is being requested.
+     */
     objectId: string | undefined;
+    /**
+     *
+     *  The type of access.
+     */
     accessType: string | undefined;
+    /**
+     *
+     *  Id of the user making the requests.
+     */
     user: string | undefined;
+    /**
+     *
+     *  Further details about the access.
+     */
     detail: string | undefined;
+    /**
+     *
+     *  The date of logging, filled instantaneously.
+     */
     date: number | undefined;
     readonly isEncrypted: boolean;
     toJSON(): object;
 }
+/**
+ *
+ *  Represents an access log entry that records access to medical data or resources within the
+ *  system.
+ *  /
+ */
 export declare class DecryptedAccessLog {
+    /**
+     *
+     *  The Id of the access log. We encourage using either a v4 UUID or a HL7 Id.
+     */
     id: string;
+    /**
+     *
+     *  The revision of the access log in the database, used for conflict management / optimistic
+     *  locking.
+     */
     rev: string | undefined;
+    /**
+     *
+     *  The timestamp (unix epoch in ms) of creation of this entity.
+     */
     created: number | undefined;
+    /**
+     *
+     *  The timestamp (unix epoch in ms) of the latest modification of this entity.
+     */
     modified: number | undefined;
+    /**
+     *
+     *  The id of the User that created this access log.
+     */
     author: string | undefined;
+    /**
+     *
+     *  The id of the data owner that is responsible for this access log.
+     */
     responsible: string | undefined;
+    /**
+     *
+     *  Tags that qualify the access log as being member of a certain class.
+     */
     tags: Array<CodeStub>;
+    /**
+     *
+     *  Codes that identify or qualify this particular access log.
+     */
     codes: Array<CodeStub>;
+    /**
+     *
+     *  Hard delete (unix epoch in ms) timestamp of the object.
+     */
     deletionDate: number | undefined;
+    /**
+     *
+     *  Id of the object that is being requested.
+     */
     objectId: string | undefined;
+    /**
+     *
+     *  The type of access.
+     */
     accessType: string | undefined;
+    /**
+     *
+     *  Id of the user making the requests.
+     */
     user: string | undefined;
+    /**
+     *
+     *  Further details about the access.
+     */
     detail: string | undefined;
+    /**
+     *
+     *  The date of logging, filled instantaneously.
+     */
     date: number | undefined;
+    /**
+     *
+     *  The secret foreign keys of the access log, used for secure linking to patients.
+     */
     secretForeignKeys: Array<string>;
+    /**
+     *
+     *  The encrypted foreign keys, mapping owner data owner id to encrypted patient ids.
+     */
     cryptedForeignKeys: {
         [key: string]: Array<Delegation>;
     };
+    /**
+     *
+     *  The delegations giving access to all connected healthcare information.
+     */
     delegations: {
         [key: string]: Array<Delegation>;
     };
+    /**
+     *
+     *  The encryption keys used to encrypt the secured properties, encrypted for separate Crypto
+     *  Actors.
+     */
     encryptionKeys: {
         [key: string]: Array<Delegation>;
     };
+    /**
+     *
+     *  The base64-encoded encrypted fields of this access log.
+     */
     encryptedSelf: Base64String | undefined;
+    /**
+     *
+     *  The security metadata of this entity, for access control.
+     */
     securityMetadata: SecurityMetadata | undefined;
     readonly isEncrypted: false;
     constructor(partial: Partial<DecryptedAccessLog>);
     toJSON(): object;
     static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): DecryptedAccessLog;
 }
+/**
+ *
+ *  Represents an access log entry that records access to medical data or resources within the
+ *  system.
+ *  /
+ */
 export declare class EncryptedAccessLog {
+    /**
+     *
+     *  The Id of the access log. We encourage using either a v4 UUID or a HL7 Id.
+     */
     id: string;
+    /**
+     *
+     *  The revision of the access log in the database, used for conflict management / optimistic
+     *  locking.
+     */
     rev: string | undefined;
+    /**
+     *
+     *  The timestamp (unix epoch in ms) of creation of this entity.
+     */
     created: number | undefined;
+    /**
+     *
+     *  The timestamp (unix epoch in ms) of the latest modification of this entity.
+     */
     modified: number | undefined;
+    /**
+     *
+     *  The id of the User that created this access log.
+     */
     author: string | undefined;
+    /**
+     *
+     *  The id of the data owner that is responsible for this access log.
+     */
     responsible: string | undefined;
+    /**
+     *
+     *  Tags that qualify the access log as being member of a certain class.
+     */
     tags: Array<CodeStub>;
+    /**
+     *
+     *  Codes that identify or qualify this particular access log.
+     */
     codes: Array<CodeStub>;
+    /**
+     *
+     *  Hard delete (unix epoch in ms) timestamp of the object.
+     */
     deletionDate: number | undefined;
+    /**
+     *
+     *  Id of the object that is being requested.
+     */
     objectId: string | undefined;
+    /**
+     *
+     *  The type of access.
+     */
     accessType: string | undefined;
+    /**
+     *
+     *  Id of the user making the requests.
+     */
     user: string | undefined;
+    /**
+     *
+     *  Further details about the access.
+     */
     detail: string | undefined;
+    /**
+     *
+     *  The date of logging, filled instantaneously.
+     */
     date: number | undefined;
+    /**
+     *
+     *  The secret foreign keys of the access log, used for secure linking to patients.
+     */
     secretForeignKeys: Array<string>;
+    /**
+     *
+     *  The encrypted foreign keys, mapping owner data owner id to encrypted patient ids.
+     */
     cryptedForeignKeys: {
         [key: string]: Array<Delegation>;
     };
+    /**
+     *
+     *  The delegations giving access to all connected healthcare information.
+     */
     delegations: {
         [key: string]: Array<Delegation>;
     };
+    /**
+     *
+     *  The encryption keys used to encrypt the secured properties, encrypted for separate Crypto
+     *  Actors.
+     */
     encryptionKeys: {
         [key: string]: Array<Delegation>;
     };
+    /**
+     *
+     *  The base64-encoded encrypted fields of this access log.
+     */
     encryptedSelf: Base64String | undefined;
+    /**
+     *
+     *  The security metadata of this entity, for access control.
+     */
     securityMetadata: SecurityMetadata | undefined;
     readonly isEncrypted: true;
     constructor(partial: Partial<EncryptedAccessLog>);

package/model/AccessLog.mjs

@@ -4,27 +4,111 @@ 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 an access log entry that records access to medical data or resources within the
+ *  system.
+ *  /
+ */
 export class DecryptedAccessLog {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the access log in the database, used for conflict management / optimistic
+         *  locking.
+         */
         this.rev = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of creation of this entity.
+         */
         this.created = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of the latest modification of this entity.
+         */
         this.modified = undefined;
+        /**
+         *
+         *  The id of the User that created this access log.
+         */
         this.author = undefined;
+        /**
+         *
+         *  The id of the data owner that is responsible for this access log.
+         */
         this.responsible = undefined;
+        /**
+         *
+         *  Tags that qualify the access log as being member of a certain class.
+         */
         this.tags = [];
+        /**
+         *
+         *  Codes that identify or qualify this particular access log.
+         */
         this.codes = [];
+        /**
+         *
+         *  Hard delete (unix epoch in ms) timestamp of the object.
+         */
         this.deletionDate = undefined;
+        /**
+         *
+         *  Id of the object that is being requested.
+         */
         this.objectId = undefined;
+        /**
+         *
+         *  The type of access.
+         */
         this.accessType = undefined;
+        /**
+         *
+         *  Id of the user making the requests.
+         */
         this.user = undefined;
+        /**
+         *
+         *  Further details about the access.
+         */
         this.detail = undefined;
+        /**
+         *
+         *  The date of logging, filled instantaneously.
+         */
         this.date = undefined;
+        /**
+         *
+         *  The secret foreign keys of the access log, used for secure linking to patients.
+         */
         this.secretForeignKeys = [];
+        /**
+         *
+         *  The encrypted foreign keys, mapping owner data owner id to encrypted patient ids.
+         */
         this.cryptedForeignKeys = {};
+        /**
+         *
+         *  The delegations giving access to all connected healthcare information.
+         */
         this.delegations = {};
+        /**
+         *
+         *  The encryption keys used to encrypt the secured properties, encrypted for separate Crypto
+         *  Actors.
+         */
         this.encryptionKeys = {};
+        /**
+         *
+         *  The base64-encoded encrypted fields of this access log.
+         */
         this.encryptedSelf = undefined;
+        /**
+         *
+         *  The security metadata of this entity, for access control.
+         */
         this.securityMetadata = undefined;
         this.isEncrypted = false;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== false)
@@ -143,27 +227,111 @@ export class DecryptedAccessLog {
         return res;
     }
 }
+/**
+ *
+ *  Represents an access log entry that records access to medical data or resources within the
+ *  system.
+ *  /
+ */
 export class EncryptedAccessLog {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the access log in the database, used for conflict management / optimistic
+         *  locking.
+         */
         this.rev = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of creation of this entity.
+         */
         this.created = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of the latest modification of this entity.
+         */
         this.modified = undefined;
+        /**
+         *
+         *  The id of the User that created this access log.
+         */
         this.author = undefined;
+        /**
+         *
+         *  The id of the data owner that is responsible for this access log.
+         */
         this.responsible = undefined;
+        /**
+         *
+         *  Tags that qualify the access log as being member of a certain class.
+         */
         this.tags = [];
+        /**
+         *
+         *  Codes that identify or qualify this particular access log.
+         */
         this.codes = [];
+        /**
+         *
+         *  Hard delete (unix epoch in ms) timestamp of the object.
+         */
         this.deletionDate = undefined;
+        /**
+         *
+         *  Id of the object that is being requested.
+         */
         this.objectId = undefined;
+        /**
+         *
+         *  The type of access.
+         */
         this.accessType = undefined;
+        /**
+         *
+         *  Id of the user making the requests.
+         */
         this.user = undefined;
+        /**
+         *
+         *  Further details about the access.
+         */
         this.detail = undefined;
+        /**
+         *
+         *  The date of logging, filled instantaneously.
+         */
         this.date = undefined;
+        /**
+         *
+         *  The secret foreign keys of the access log, used for secure linking to patients.
+         */
         this.secretForeignKeys = [];
+        /**
+         *
+         *  The encrypted foreign keys, mapping owner data owner id to encrypted patient ids.
+         */
         this.cryptedForeignKeys = {};
+        /**
+         *
+         *  The delegations giving access to all connected healthcare information.
+         */
         this.delegations = {};
+        /**
+         *
+         *  The encryption keys used to encrypt the secured properties, encrypted for separate Crypto
+         *  Actors.
+         */
         this.encryptionKeys = {};
+        /**
+         *
+         *  The base64-encoded encrypted fields of this access log.
+         */
         this.encryptedSelf = undefined;
+        /**
+         *
+         *  The security metadata of this entity, for access control.
+         */
         this.securityMetadata = undefined;
         this.isEncrypted = true;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== true)

package/model/Agenda.d.mts

@@ -6,28 +6,117 @@ import { StoredDocument } from './base/StoredDocument.mjs';
 import { AgendaSlottingAlgorithm } from './embed/AgendaSlottingAlgorithm.mjs';
 import { ResourceGroupAllocationSchedule } from './embed/ResourceGroupAllocationSchedule.mjs';
 import { UserAccessLevel } from './embed/UserAccessLevel.mjs';
+/**
+ *
+ *  Represents an agenda that keeps track of appointments (calendar items) for a resource or group of
+ *  resources.
+ *  An agenda can specify a schedule for its resources and allows managing availabilities for
+ *  booking.
+ *  /
+ */
 export declare class Agenda implements StoredDocument, ICureDocument<string>, HasEndOfLife {
+    /**
+     *
+     *  The Id of the agenda. We encourage using either a v4 UUID or a HL7 Id.
+     */
     id: string;
+    /**
+     *
+     *  The revision of the agenda in the database, used for conflict management / optimistic locking.
+     */
     rev: string | undefined;
+    /**
+     *
+     *  The timestamp (unix epoch in ms) of creation of this entity.
+     */
     created: number | undefined;
+    /**
+     *
+     *  The timestamp (unix epoch in ms) of the latest modification of this entity.
+     */
     modified: number | undefined;
+    /**
+     *
+     *  The id of the User that created this agenda.
+     */
     author: string | undefined;
+    /**
+     *
+     *  The id of the data owner that is responsible for this agenda.
+     */
     responsible: string | undefined;
+    /**
+     *
+     *  Tags that qualify the agenda as being member of a certain class.
+     */
     tags: Array<CodeStub>;
+    /**
+     *
+     *  Codes that identify or qualify this particular agenda.
+     */
     codes: Array<CodeStub>;
+    /**
+     *
+     *  Soft delete (unix epoch in ms) timestamp of the object.
+     */
     endOfLife: number | undefined;
+    /**
+     *
+     *  Hard delete (unix epoch in ms) timestamp of the object.
+     */
     deletionDate: number | undefined;
+    /**
+     *
+     *  A fuzzy time in HHMMSS format used to split working hours into blocks for availabilities
+     *  computation.
+     */
     daySplitHour: number | undefined;
+    /**
+     *
+     *  If true the agenda is not available for availabilities and safe booking requests.
+     */
     unpublished: boolean;
+    /**
+     *
+     *  The name of the agenda.
+     */
     name: string | undefined;
+    /**
+     *
+     *  The id of the user associated with this agenda.
+     */
     userId: string | undefined;
+    /**
+     *
+     *  An identifier for the time zone of the agenda, must be an id accepted by java's ZoneId.
+     */
     zoneId: string | undefined;
+    /**
+     *
+     *  Associates a user id to the permission that user has on the entity.
+     */
     userRights: {
         [key: string]: UserAccessLevel;
     };
+    /**
+     *
+     *  The algorithm to use for computing time slots in the agenda.
+     */
     slottingAlgorithm: AgendaSlottingAlgorithm | undefined;
+    /**
+     *
+     *  If not null, limits the amount of monthly appointments per unprivileged user for this agenda.
+     */
     publicBookingQuota: number | undefined;
+    /**
+     *
+     *  Custom properties of the agenda.
+     */
     properties: Array<DecryptedPropertyStub>;
+    /**
+     *
+     *  The resource group allocation schedules defining availability rules for this agenda.
+     */
     schedules: Array<ResourceGroupAllocationSchedule>;
     constructor(partial: Partial<Agenda>);
     toJSON(): object;