@icure/cardinal-sdk 2.1.1 → 2.1.3

package/model/MaintenanceTask.d.mts

@@ -10,72 +10,274 @@ import { Encryptable } from './embed/Encryptable.mjs';
 import { SecurityMetadata } from './embed/SecurityMetadata.mjs';
 import { TaskStatus } from './embed/TaskStatus.mjs';
 import { Base64String } from './specializations/Base64String.mjs';
+/**
+ *
+ *  Represents a maintenance task in the iCure system. Maintenance tasks are used to track background
+ *  operations
+ *  such as key exchange requests, data migrations, or other administrative operations that require
+ *  asynchronous processing.
+ *  /
+ */
 export interface MaintenanceTask extends StoredDocument, ICureDocument<string>, HasEncryptionMetadata, Encryptable, HasEndOfLife {
+    /**
+     *
+     *  The identifiers of the maintenance task.
+     */
     identifier: Array<Identifier>;
+    /**
+     *
+     *  The type of the maintenance task.
+     */
     taskType: string | undefined;
+    /**
+     *
+     *  Extra properties for the maintenance task.
+     */
     properties: Array<PropertyStub>;
+    /**
+     *
+     *  The current status of the maintenance task (pending, ongoing, cancelled, completed).
+     */
     status: TaskStatus;
     readonly isEncrypted: boolean;
     toJSON(): object;
 }
+/**
+ *
+ *  Represents a maintenance task in the iCure system. Maintenance tasks are used to track background
+ *  operations
+ *  such as key exchange requests, data migrations, or other administrative operations that require
+ *  asynchronous processing.
+ *  /
+ */
 export declare class DecryptedMaintenanceTask {
+    /**
+     *
+     *  The unique identifier of the maintenance task.
+     */
     id: string;
+    /**
+     *
+     *  The revision of the maintenance task in the database, used for conflict management / optimistic
+     *  locking.
+     */
     rev: string | undefined;
+    /**
+     *
+     *  The identifiers of the maintenance task.
+     */
     identifier: Array<Identifier>;
+    /**
+     *
+     *  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 User that created this maintenance task.
+     */
     author: string | undefined;
+    /**
+     *
+     *  The id of the HealthcareParty that is responsible for this maintenance task.
+     */
     responsible: string | undefined;
+    /**
+     *
+     *  Tags that qualify the maintenance task as being member of a certain class.
+     */
     tags: Array<CodeStub>;
+    /**
+     *
+     *  Codes that identify or qualify this particular maintenance task.
+     */
     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;
+    /**
+     *
+     *  The type of the maintenance task.
+     */
     taskType: string | undefined;
+    /**
+     *
+     *  Extra properties for the maintenance task.
+     */
     properties: Array<DecryptedPropertyStub>;
+    /**
+     *
+     *  The current status of the maintenance task (pending, ongoing, cancelled, completed).
+     */
     status: TaskStatus;
+    /**
+     *
+     *  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;
+    /**
+     *
+     *  The security metadata of the entity.
+     */
     securityMetadata: SecurityMetadata | undefined;
     readonly isEncrypted: false;
     constructor(partial: Partial<DecryptedMaintenanceTask>);
     toJSON(): object;
     static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): DecryptedMaintenanceTask;
 }
+/**
+ *
+ *  Represents a maintenance task in the iCure system. Maintenance tasks are used to track background
+ *  operations
+ *  such as key exchange requests, data migrations, or other administrative operations that require
+ *  asynchronous processing.
+ *  /
+ */
 export declare class EncryptedMaintenanceTask {
+    /**
+     *
+     *  The unique identifier of the maintenance task.
+     */
     id: string;
+    /**
+     *
+     *  The revision of the maintenance task in the database, used for conflict management / optimistic
+     *  locking.
+     */
     rev: string | undefined;
+    /**
+     *
+     *  The identifiers of the maintenance task.
+     */
     identifier: Array<Identifier>;
+    /**
+     *
+     *  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 User that created this maintenance task.
+     */
     author: string | undefined;
+    /**
+     *
+     *  The id of the HealthcareParty that is responsible for this maintenance task.
+     */
     responsible: string | undefined;
+    /**
+     *
+     *  Tags that qualify the maintenance task as being member of a certain class.
+     */
     tags: Array<CodeStub>;
+    /**
+     *
+     *  Codes that identify or qualify this particular maintenance task.
+     */
     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;
+    /**
+     *
+     *  The type of the maintenance task.
+     */
     taskType: string | undefined;
+    /**
+     *
+     *  Extra properties for the maintenance task.
+     */
     properties: Array<EncryptedPropertyStub>;
+    /**
+     *
+     *  The current status of the maintenance task (pending, ongoing, cancelled, completed).
+     */
     status: TaskStatus;
+    /**
+     *
+     *  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;
+    /**
+     *
+     *  The security metadata of the entity.
+     */
     securityMetadata: SecurityMetadata | undefined;
     readonly isEncrypted: true;
     constructor(partial: Partial<EncryptedMaintenanceTask>);

package/model/MaintenanceTask.mjs

@@ -7,27 +7,112 @@ import { Identifier } from './base/Identifier.mjs';
 import { Delegation } from './embed/Delegation.mjs';
 import { SecurityMetadata } from './embed/SecurityMetadata.mjs';
 import { TaskStatus } from './embed/TaskStatus.mjs';
+/**
+ *
+ *  Represents a maintenance task in the iCure system. Maintenance tasks are used to track background
+ *  operations
+ *  such as key exchange requests, data migrations, or other administrative operations that require
+ *  asynchronous processing.
+ *  /
+ */
 export class DecryptedMaintenanceTask {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the maintenance task in the database, used for conflict management / optimistic
+         *  locking.
+         */
         this.rev = undefined;
+        /**
+         *
+         *  The identifiers of the maintenance task.
+         */
         this.identifier = [];
+        /**
+         *
+         *  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 maintenance task.
+         */
         this.author = undefined;
+        /**
+         *
+         *  The id of the HealthcareParty that is responsible for this maintenance task.
+         */
         this.responsible = undefined;
+        /**
+         *
+         *  Tags that qualify the maintenance task as being member of a certain class.
+         */
         this.tags = [];
+        /**
+         *
+         *  Codes that identify or qualify this particular maintenance task.
+         */
         this.codes = [];
+        /**
+         *
+         *  Soft delete (unix epoch in ms) timestamp of the object.
+         */
         this.endOfLife = undefined;
+        /**
+         *
+         *  Hard delete (unix epoch in ms) timestamp of the object.
+         */
         this.deletionDate = undefined;
+        /**
+         *
+         *  The type of the maintenance task.
+         */
         this.taskType = undefined;
+        /**
+         *
+         *  Extra properties for the maintenance task.
+         */
         this.properties = [];
+        /**
+         *
+         *  The current status of the maintenance task (pending, ongoing, cancelled, completed).
+         */
         this.status = TaskStatus.Pending;
+        /**
+         *
+         *  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)
@@ -143,27 +228,112 @@ export class DecryptedMaintenanceTask {
         return res;
     }
 }
+/**
+ *
+ *  Represents a maintenance task in the iCure system. Maintenance tasks are used to track background
+ *  operations
+ *  such as key exchange requests, data migrations, or other administrative operations that require
+ *  asynchronous processing.
+ *  /
+ */
 export class EncryptedMaintenanceTask {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the maintenance task in the database, used for conflict management / optimistic
+         *  locking.
+         */
         this.rev = undefined;
+        /**
+         *
+         *  The identifiers of the maintenance task.
+         */
         this.identifier = [];
+        /**
+         *
+         *  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 maintenance task.
+         */
         this.author = undefined;
+        /**
+         *
+         *  The id of the HealthcareParty that is responsible for this maintenance task.
+         */
         this.responsible = undefined;
+        /**
+         *
+         *  Tags that qualify the maintenance task as being member of a certain class.
+         */
         this.tags = [];
+        /**
+         *
+         *  Codes that identify or qualify this particular maintenance task.
+         */
         this.codes = [];
+        /**
+         *
+         *  Soft delete (unix epoch in ms) timestamp of the object.
+         */
         this.endOfLife = undefined;
+        /**
+         *
+         *  Hard delete (unix epoch in ms) timestamp of the object.
+         */
         this.deletionDate = undefined;
+        /**
+         *
+         *  The type of the maintenance task.
+         */
         this.taskType = undefined;
+        /**
+         *
+         *  Extra properties for the maintenance task.
+         */
         this.properties = [];
+        /**
+         *
+         *  The current status of the maintenance task (pending, ongoing, cancelled, completed).
+         */
         this.status = TaskStatus.Pending;
+        /**
+         *
+         *  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)