@icure/cardinal-sdk 2.1.1 → 2.1.3

package/model/Device.d.mts

@@ -8,27 +8,110 @@ import { Named } from './base/Named.mjs';
 import { StoredDocument } from './base/StoredDocument.mjs';
 import { HexString } from './specializations/HexString.mjs';
 import { SpkiHexString } from './specializations/SpkiHexString.mjs';
+/**
+ *
+ *  Represents a device that sends medical data. This is a root-level entity stored in the
+ *  icure-device CouchDB database.
+ *  A device can act as a data owner and crypto actor for secure data exchange.
+ *  /
+ */
 export declare class Device implements StoredDocument, ICureDocument<string>, Named, CryptoActor, DataOwner {
+    /**
+     *
+     *  The Id of the device. We encourage using either a v4 UUID or a HL7 Id.
+     */
     id: string;
+    /**
+     *
+     *  The revision of the device 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 device's identifiers used for client-side identification.
+     */
     identifiers: Array<Identifier>;
+    /**
+     *
+     *  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 device.
+     */
     author: string | undefined;
+    /**
+     *
+     *  The id of the data owner that is responsible for this device.
+     */
     responsible: string | undefined;
+    /**
+     *
+     *  Tags that qualify the device as being member of a certain class.
+     */
     tags: Array<CodeStub>;
+    /**
+     *
+     *  Codes that identify or qualify this particular device.
+     */
     codes: Array<CodeStub>;
+    /**
+     *
+     *  The name of the device.
+     */
     name: string | undefined;
+    /**
+     *
+     *  The type of the device (e.g., smartphone, medical device sort).
+     */
     type: string | undefined;
+    /**
+     *
+     *  The brand of the device (e.g., Samsung, Apple, Philips).
+     */
     brand: string | undefined;
+    /**
+     *
+     *  The model of the device (e.g., Galaxy S10).
+     */
     model: string | undefined;
+    /**
+     *
+     *  The serial number of the device.
+     */
     serialNumber: string | undefined;
+    /**
+     *
+     *  The id of the parent of the user representing the device.
+     */
     parentId: string | undefined;
+    /**
+     *
+     *  Typed properties related to the device (e.g., version, specific device information).
+     */
     properties: Array<DecryptedPropertyStub>;
+    /**
+     *
+     *  The exchange keys with other healthcare parties, encrypted using public keys.
+     */
     hcPartyKeys: {
         [key: string]: Array<HexString>;
     };
+    /**
+     *
+     *  Extra AES exchange keys, usually keys that were lost access to at some point.
+     */
     aesExchangeKeys: {
         [key: string]: {
             [key: string]: {
@@ -36,16 +119,36 @@ export declare class Device implements StoredDocument, ICureDocument<string>, Na
             };
         };
     };
+    /**
+     *
+     *  Private keys encrypted with public keys for key transfer.
+     */
     transferKeys: {
         [key: string]: {
             [key: string]: HexString;
         };
     };
+    /**
+     *
+     *  Shamir partitions of this device's RSA private keys, encrypted with notary public keys.
+     */
     privateKeyShamirPartitions: {
         [key: string]: HexString;
     };
+    /**
+     *
+     *  The public RSA key of this device.
+     */
     publicKey: SpkiHexString | undefined;
+    /**
+     *
+     *  The public keys of this device generated using OAEP with SHA-256.
+     */
     publicKeysForOaepWithSha256: Array<SpkiHexString>;
+    /**
+     *
+     *  Properties specific to the crypto actor role of this device.
+     */
     cryptoActorProperties: Array<DecryptedPropertyStub>;
     readonly $ktClass: 'com.icure.cardinal.sdk.model.Device';
     constructor(partial: Partial<Device>);

package/model/Device.mjs

@@ -4,31 +4,130 @@ import { randomUuid } from '../utils/Id.mjs';
 import { DecryptedPropertyStub } from './PropertyStub.mjs';
 import { CodeStub } from './base/CodeStub.mjs';
 import { Identifier } from './base/Identifier.mjs';
+/**
+ *
+ *  Represents a device that sends medical data. This is a root-level entity stored in the
+ *  icure-device CouchDB database.
+ *  A device can act as a data owner and crypto actor for secure data exchange.
+ *  /
+ */
 export class Device {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the device in the database, used for conflict management / optimistic locking.
+         */
         this.rev = undefined;
+        /**
+         *
+         *  Hard delete (unix epoch in ms) timestamp of the object.
+         */
         this.deletionDate = undefined;
+        /**
+         *
+         *  The device's identifiers used for client-side identification.
+         */
         this.identifiers = [];
+        /**
+         *
+         *  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 device.
+         */
         this.author = undefined;
+        /**
+         *
+         *  The id of the data owner that is responsible for this device.
+         */
         this.responsible = undefined;
+        /**
+         *
+         *  Tags that qualify the device as being member of a certain class.
+         */
         this.tags = [];
+        /**
+         *
+         *  Codes that identify or qualify this particular device.
+         */
         this.codes = [];
+        /**
+         *
+         *  The name of the device.
+         */
         this.name = undefined;
+        /**
+         *
+         *  The type of the device (e.g., smartphone, medical device sort).
+         */
         this.type = undefined;
+        /**
+         *
+         *  The brand of the device (e.g., Samsung, Apple, Philips).
+         */
         this.brand = undefined;
+        /**
+         *
+         *  The model of the device (e.g., Galaxy S10).
+         */
         this.model = undefined;
+        /**
+         *
+         *  The serial number of the device.
+         */
         this.serialNumber = undefined;
+        /**
+         *
+         *  The id of the parent of the user representing the device.
+         */
         this.parentId = undefined;
+        /**
+         *
+         *  Typed properties related to the device (e.g., version, specific device information).
+         */
         this.properties = [];
+        /**
+         *
+         *  The exchange keys with other healthcare parties, encrypted using public keys.
+         */
         this.hcPartyKeys = {};
+        /**
+         *
+         *  Extra AES exchange keys, usually keys that were lost access to at some point.
+         */
         this.aesExchangeKeys = {};
+        /**
+         *
+         *  Private keys encrypted with public keys for key transfer.
+         */
         this.transferKeys = {};
+        /**
+         *
+         *  Shamir partitions of this device's RSA private keys, encrypted with notary public keys.
+         */
         this.privateKeyShamirPartitions = {};
+        /**
+         *
+         *  The public RSA key of this device.
+         */
         this.publicKey = undefined;
+        /**
+         *
+         *  The public keys of this device generated using OAEP with SHA-256.
+         */
         this.publicKeysForOaepWithSha256 = [];
+        /**
+         *
+         *  Properties specific to the crypto actor role of this device.
+         */
         this.cryptoActorProperties = [];
         this.$ktClass = 'com.icure.cardinal.sdk.model.Device';
         this.id = (_a = partial.id) !== null && _a !== void 0 ? _a : randomUuid();

package/model/Document.d.mts

@@ -10,106 +10,415 @@ import { DocumentType } from './embed/DocumentType.mjs';
 import { Encryptable } from './embed/Encryptable.mjs';
 import { SecurityMetadata } from './embed/SecurityMetadata.mjs';
 import { Base64String } from './specializations/Base64String.mjs';
+/**
+ *
+ *  Represents a document entity stored in CouchDB. Documents can have main and secondary data
+ *  attachments,
+ *  and support various storage backends (CouchDB attachments, object storage).
+ *  /
+ */
 export interface Document extends StoredDocument, ICureDocument<string>, HasEncryptionMetadata, Encryptable {
+    /**
+     *
+     *  The type of document (e.g., admission, clinical path, document report, invoice).
+     */
     documentType: DocumentType | undefined;
+    /**
+     *
+     *  The status of the document development (e.g., Draft, finalized, reviewed, signed).
+     */
     documentStatus: DocumentStatus | undefined;
+    /**
+     *
+     *  When the document is stored externally, the URI of the document in that repository.
+     */
     externalUri: string | undefined;
+    /**
+     *
+     *  The name of the document.
+     */
     name: string | undefined;
+    /**
+     *
+     *  The document version.
+     */
     version: string | undefined;
+    /**
+     *
+     *  The size of the document file.
+     */
     size: number | undefined;
+    /**
+     *
+     *  The hashed version of the document.
+     */
     hash: string | undefined;
+    /**
+     *
+     *  The id of the contact during which the document was created.
+     */
     openingContactId: string | undefined;
+    /**
+     *
+     *  The id of the main attachment stored as a CouchDB attachment.
+     */
     attachmentId: string | undefined;
+    /**
+     *
+     *  The id of the main attachment in the object storage service.
+     */
     objectStoreReference: string | undefined;
+    /**
+     *
+     *  The main Uniform Type Identifier of the main attachment.
+     */
     mainUti: string | undefined;
+    /**
+     *
+     *  Extra Uniform Type Identifiers for the main attachment.
+     */
     otherUtis: Array<string>;
+    /**
+     *
+     *  Secondary attachments for this document.
+     */
     secondaryAttachments: {
         [key: string]: DataAttachment;
     };
+    /**
+     *
+     *  Information on past attachments for this document.
+     */
     deletedAttachments: Array<DeletedAttachment>;
     readonly isEncrypted: boolean;
     toJSON(): object;
 }
+/**
+ *
+ *  Represents a document entity stored in CouchDB. Documents can have main and secondary data
+ *  attachments,
+ *  and support various storage backends (CouchDB attachments, object storage).
+ *  /
+ */
 export declare class DecryptedDocument {
+    /**
+     *
+     *  The Id of the document. We encourage using either a v4 UUID or a HL7 Id.
+     */
     id: string;
+    /**
+     *
+     *  The revision of the document 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 document.
+     */
     author: string | undefined;
+    /**
+     *
+     *  The id of the data owner that is responsible for this document.
+     */
     responsible: string | undefined;
+    /**
+     *
+     *  Tags that qualify the document as being member of a certain class.
+     */
     tags: Array<CodeStub>;
+    /**
+     *
+     *  Codes that identify or qualify this particular document.
+     */
     codes: Array<CodeStub>;
+    /**
+     *
+     *  Hard delete (unix epoch in ms) timestamp of the object.
+     */
     deletionDate: number | undefined;
+    /**
+     *
+     *  The type of document (e.g., admission, clinical path, document report, invoice).
+     */
     documentType: DocumentType | undefined;
+    /**
+     *
+     *  The status of the document development (e.g., Draft, finalized, reviewed, signed).
+     */
     documentStatus: DocumentStatus | undefined;
+    /**
+     *
+     *  When the document is stored externally, the URI of the document in that repository.
+     */
     externalUri: string | undefined;
+    /**
+     *
+     *  The name of the document.
+     */
     name: string | undefined;
+    /**
+     *
+     *  The document version.
+     */
     version: string | undefined;
+    /**
+     *
+     *  The size of the document file.
+     */
     size: number | undefined;
+    /**
+     *
+     *  The hashed version of the document.
+     */
     hash: string | undefined;
+    /**
+     *
+     *  The id of the contact during which the document was created.
+     */
     openingContactId: string | undefined;
+    /**
+     *
+     *  The id of the main attachment stored as a CouchDB attachment.
+     */
     attachmentId: string | undefined;
+    /**
+     *
+     *  The id of the main attachment in the object storage service.
+     */
     objectStoreReference: string | undefined;
+    /**
+     *
+     *  The main Uniform Type Identifier of the main attachment.
+     */
     mainUti: string | undefined;
+    /**
+     *
+     *  Extra Uniform Type Identifiers for the main attachment.
+     */
     otherUtis: Array<string>;
+    /**
+     *
+     *  Secondary attachments for this document.
+     */
     secondaryAttachments: {
         [key: string]: DataAttachment;
     };
+    /**
+     *
+     *  Information on past attachments for this document.
+     */
     deletedAttachments: Array<DeletedAttachment>;
+    /**
+     *
+     *  The secret foreign keys, used for secure linking to patients.
+     */
     secretForeignKeys: Array<string>;
+    /**
+     *
+     *  The encrypted foreign keys.
+     */
     cryptedForeignKeys: {
         [key: string]: Array<Delegation>;
     };
+    /**
+     *
+     *  The delegations giving access to connected healthcare information.
+     */
     delegations: {
         [key: string]: Array<Delegation>;
     };
+    /**
+     *
+     *  The encryption keys used to encrypt secured properties, encrypted for separate Crypto Actors.
+     */
     encryptionKeys: {
         [key: string]: Array<Delegation>;
     };
+    /**
+     *
+     *  The base64-encoded encrypted fields of this document.
+     */
     encryptedSelf: Base64String | undefined;
+    /**
+     *
+     *  The security metadata of this entity, for access control.
+     */
     securityMetadata: SecurityMetadata | undefined;
     readonly isEncrypted: false;
     constructor(partial: Partial<DecryptedDocument>);
     toJSON(): object;
     static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): DecryptedDocument;
 }
+/**
+ *
+ *  Represents a document entity stored in CouchDB. Documents can have main and secondary data
+ *  attachments,
+ *  and support various storage backends (CouchDB attachments, object storage).
+ *  /
+ */
 export declare class EncryptedDocument {
+    /**
+     *
+     *  The Id of the document. We encourage using either a v4 UUID or a HL7 Id.
+     */
     id: string;
+    /**
+     *
+     *  The revision of the document 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 document.
+     */
     author: string | undefined;
+    /**
+     *
+     *  The id of the data owner that is responsible for this document.
+     */
     responsible: string | undefined;
+    /**
+     *
+     *  Tags that qualify the document as being member of a certain class.
+     */
     tags: Array<CodeStub>;
+    /**
+     *
+     *  Codes that identify or qualify this particular document.
+     */
     codes: Array<CodeStub>;
+    /**
+     *
+     *  Hard delete (unix epoch in ms) timestamp of the object.
+     */
     deletionDate: number | undefined;
+    /**
+     *
+     *  The type of document (e.g., admission, clinical path, document report, invoice).
+     */
     documentType: DocumentType | undefined;
+    /**
+     *
+     *  The status of the document development (e.g., Draft, finalized, reviewed, signed).
+     */
     documentStatus: DocumentStatus | undefined;
+    /**
+     *
+     *  When the document is stored externally, the URI of the document in that repository.
+     */
     externalUri: string | undefined;
+    /**
+     *
+     *  The name of the document.
+     */
     name: string | undefined;
+    /**
+     *
+     *  The document version.
+     */
     version: string | undefined;
+    /**
+     *
+     *  The size of the document file.
+     */
     size: number | undefined;
+    /**
+     *
+     *  The hashed version of the document.
+     */
     hash: string | undefined;
+    /**
+     *
+     *  The id of the contact during which the document was created.
+     */
     openingContactId: string | undefined;
+    /**
+     *
+     *  The id of the main attachment stored as a CouchDB attachment.
+     */
     attachmentId: string | undefined;
+    /**
+     *
+     *  The id of the main attachment in the object storage service.
+     */
     objectStoreReference: string | undefined;
+    /**
+     *
+     *  The main Uniform Type Identifier of the main attachment.
+     */
     mainUti: string | undefined;
+    /**
+     *
+     *  Extra Uniform Type Identifiers for the main attachment.
+     */
     otherUtis: Array<string>;
+    /**
+     *
+     *  Secondary attachments for this document.
+     */
     secondaryAttachments: {
         [key: string]: DataAttachment;
     };
+    /**
+     *
+     *  Information on past attachments for this document.
+     */
     deletedAttachments: Array<DeletedAttachment>;
+    /**
+     *
+     *  The secret foreign keys, used for secure linking to patients.
+     */
     secretForeignKeys: Array<string>;
+    /**
+     *
+     *  The encrypted foreign keys.
+     */
     cryptedForeignKeys: {
         [key: string]: Array<Delegation>;
     };
+    /**
+     *
+     *  The delegations giving access to connected healthcare information.
+     */
     delegations: {
         [key: string]: Array<Delegation>;
     };
+    /**
+     *
+     *  The encryption keys used to encrypt secured properties, encrypted for separate Crypto Actors.
+     */
     encryptionKeys: {
         [key: string]: Array<Delegation>;
     };
+    /**
+     *
+     *  The base64-encoded encrypted fields of this document.
+     */
     encryptedSelf: Base64String | undefined;
+    /**
+     *
+     *  The security metadata of this entity, for access control.
+     */
     securityMetadata: SecurityMetadata | undefined;
     readonly isEncrypted: true;
     constructor(partial: Partial<EncryptedDocument>);