@icure/cardinal-sdk 2.1.1 → 2.1.3

package/model/Place.d.mts

@@ -1,11 +1,36 @@
 import { Named } from './base/Named.mjs';
 import { StoredDocument } from './base/StoredDocument.mjs';
 import { DecryptedAddress } from './embed/Address.mjs';
+/**
+ *
+ *  DTO representing a physical place or location, such as a clinic or office.
+ *  /
+ */
 export declare class Place implements StoredDocument, Named {
+    /**
+     *
+     *  The unique identifier of the place.
+     */
     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 the place.
+     */
     name: string | undefined;
+    /**
+     *
+     *  The address of the place.
+     */
     address: DecryptedAddress | undefined;
     constructor(partial: Partial<Place>);
     toJSON(): object;

package/model/Place.mjs

@@ -2,12 +2,33 @@
 import { expectNumber, expectObject, expectString, extractEntry } from '../internal/JsonDecodeUtils.mjs';
 import { randomUuid } from '../utils/Id.mjs';
 import { DecryptedAddress } from './embed/Address.mjs';
+/**
+ *
+ *  DTO representing a physical place or location, such as a clinic or office.
+ *  /
+ */
 export class Place {
     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 the place.
+         */
         this.name = undefined;
+        /**
+         *
+         *  The address of the place.
+         */
         this.address = undefined;
         this.id = (_a = partial.id) !== null && _a !== void 0 ? _a : randomUuid();
         if ('rev' in partial)

package/model/PropertyStub.d.mts

@@ -2,27 +2,86 @@ import { PropertyTypeStub } from './PropertyTypeStub.mjs';
 import { Encryptable } from './embed/Encryptable.mjs';
 import { DecryptedTypedValue, EncryptedTypedValue, TypedValue } from './embed/TypedValue.mjs';
 import { Base64String } from './specializations/Base64String.mjs';
+/**
+ *
+ *  Lightweight stub representation of a property, used when the full stored property is not needed.
+ *  /
+ */
 export interface PropertyStub extends Encryptable {
+    /**
+     *
+     *  The unique identifier of the property stub.
+     */
     id: string | undefined;
+    /**
+     *
+     *  The type stub definition of this property.
+     */
     type: PropertyTypeStub | undefined;
+    /**
+     *
+     *  The typed value held by this property.
+     */
     typedValue: TypedValue | undefined;
     readonly isEncrypted: boolean;
     toJSON(): object;
 }
+/**
+ *
+ *  Lightweight stub representation of a property, used when the full stored property is not needed.
+ *  /
+ */
 export declare class DecryptedPropertyStub {
+    /**
+     *
+     *  The unique identifier of the property stub.
+     */
     id: string | undefined;
+    /**
+     *
+     *  The type stub definition of this property.
+     */
     type: PropertyTypeStub | undefined;
+    /**
+     *
+     *  The typed value held by this property.
+     */
     typedValue: DecryptedTypedValue | undefined;
+    /**
+     *
+     *  The encrypted content of this property, encoded as a Base64 string.
+     */
     encryptedSelf: Base64String | undefined;
     readonly isEncrypted: false;
     constructor(partial: Partial<DecryptedPropertyStub>);
     toJSON(): object;
     static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): DecryptedPropertyStub;
 }
+/**
+ *
+ *  Lightweight stub representation of a property, used when the full stored property is not needed.
+ *  /
+ */
 export declare class EncryptedPropertyStub {
+    /**
+     *
+     *  The unique identifier of the property stub.
+     */
     id: string | undefined;
+    /**
+     *
+     *  The type stub definition of this property.
+     */
     type: PropertyTypeStub | undefined;
+    /**
+     *
+     *  The typed value held by this property.
+     */
     typedValue: EncryptedTypedValue | undefined;
+    /**
+     *
+     *  The encrypted content of this property, encoded as a Base64 string.
+     */
     encryptedSelf: Base64String | undefined;
     readonly isEncrypted: true;
     constructor(partial: Partial<EncryptedPropertyStub>);

package/model/PropertyStub.mjs

@@ -2,11 +2,32 @@
 import { expectObject, expectString, extractEntry } from '../internal/JsonDecodeUtils.mjs';
 import { PropertyTypeStub } from './PropertyTypeStub.mjs';
 import { DecryptedTypedValue, EncryptedTypedValue } from './embed/TypedValue.mjs';
+/**
+ *
+ *  Lightweight stub representation of a property, used when the full stored property is not needed.
+ *  /
+ */
 export class DecryptedPropertyStub {
     constructor(partial) {
+        /**
+         *
+         *  The unique identifier of the property stub.
+         */
         this.id = undefined;
+        /**
+         *
+         *  The type stub definition of this property.
+         */
         this.type = undefined;
+        /**
+         *
+         *  The typed value held by this property.
+         */
         this.typedValue = undefined;
+        /**
+         *
+         *  The encrypted content of this property, encoded as a Base64 string.
+         */
         this.encryptedSelf = undefined;
         this.isEncrypted = false;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== false)
@@ -53,11 +74,32 @@ export class DecryptedPropertyStub {
         return res;
     }
 }
+/**
+ *
+ *  Lightweight stub representation of a property, used when the full stored property is not needed.
+ *  /
+ */
 export class EncryptedPropertyStub {
     constructor(partial) {
+        /**
+         *
+         *  The unique identifier of the property stub.
+         */
         this.id = undefined;
+        /**
+         *
+         *  The type stub definition of this property.
+         */
         this.type = undefined;
+        /**
+         *
+         *  The typed value held by this property.
+         */
         this.typedValue = undefined;
+        /**
+         *
+         *  The encrypted content of this property, encoded as a Base64 string.
+         */
         this.encryptedSelf = undefined;
         this.isEncrypted = true;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== true)

package/model/PropertyTypeStub.d.mts

@@ -1,6 +1,20 @@
 import { TypedValuesType } from './embed/TypedValuesType.mjs';
+/**
+ *
+ *  Lightweight stub representation of a property type, containing only the identifier and value
+ *  type.
+ *  /
+ */
 export declare class PropertyTypeStub {
+    /**
+     *
+     *  The human-readable identifier of this property type.
+     */
     identifier: string | undefined;
+    /**
+     *
+     *  The value type of this property type.
+     */
     type: TypedValuesType | undefined;
     constructor(partial: Partial<PropertyTypeStub>);
     toJSON(): object;

package/model/PropertyTypeStub.mjs

@@ -1,9 +1,23 @@
 // auto-generated file
 import { expectString, expectStringEnum, extractEntry } from '../internal/JsonDecodeUtils.mjs';
 import { TypedValuesType } from './embed/TypedValuesType.mjs';
+/**
+ *
+ *  Lightweight stub representation of a property type, containing only the identifier and value
+ *  type.
+ *  /
+ */
 export class PropertyTypeStub {
     constructor(partial) {
+        /**
+         *
+         *  The human-readable identifier of this property type.
+         */
         this.identifier = undefined;
+        /**
+         *
+         *  The value type of this property type.
+         */
         this.type = undefined;
         if ('identifier' in partial)
             this.identifier = partial.identifier;

package/model/PublicAgendasAndCalendarItemTypes.d.mts

@@ -1,9 +1,23 @@
 import { Agenda } from './Agenda.mjs';
 import { CalendarItemType } from './CalendarItemType.mjs';
+/**
+ *
+ *
+ *   DTO containing publicly accessible agendas and their associated calendar item types,
+ *   used for public appointment booking.
+ */
 export declare class PublicAgendasAndCalendarItemTypes {
+    /**
+     *
+     *  The list of publicly available agendas.
+     */
     agendas: Array<Agenda>;
+    /**
+     *
+     *  The list of calendar item types associated with the public agendas.
+     */
     calendarItemTypes: Array<CalendarItemType>;
-    constructor(partial: Partial<PublicAgendasAndCalendarItemTypes> & Pick<PublicAgendasAndCalendarItemTypes, "agendas" | "calendarItemTypes">);
+    constructor(partial: Partial<PublicAgendasAndCalendarItemTypes>);
     toJSON(): object;
     static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): PublicAgendasAndCalendarItemTypes;
 }

package/model/PublicAgendasAndCalendarItemTypes.mjs

@@ -2,10 +2,28 @@
 import { expectArray, expectObject, extractEntry } from '../internal/JsonDecodeUtils.mjs';
 import { Agenda } from './Agenda.mjs';
 import { CalendarItemType } from './CalendarItemType.mjs';
+/**
+ *
+ *
+ *   DTO containing publicly accessible agendas and their associated calendar item types,
+ *   used for public appointment booking.
+ */
 export class PublicAgendasAndCalendarItemTypes {
     constructor(partial) {
-        this.agendas = partial.agendas;
-        this.calendarItemTypes = partial.calendarItemTypes;
+        /**
+         *
+         *  The list of publicly available agendas.
+         */
+        this.agendas = [];
+        /**
+         *
+         *  The list of calendar item types associated with the public agendas.
+         */
+        this.calendarItemTypes = [];
+        if ('agendas' in partial && partial.agendas !== undefined)
+            this.agendas = partial.agendas;
+        if ('calendarItemTypes' in partial && partial.calendarItemTypes !== undefined)
+            this.calendarItemTypes = partial.calendarItemTypes;
     }
     toJSON() {
         const res = {};
@@ -18,8 +36,8 @@ export class PublicAgendasAndCalendarItemTypes {
             throw new Error(`Expected json object at path ${path.join("")}`);
         const jCpy = Object.assign({}, json);
         const res = new PublicAgendasAndCalendarItemTypes({
-            agendas: expectArray(extractEntry(jCpy, 'agendas', true, path), false, [...path, ".agendas"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, Agenda.fromJSON)),
-            calendarItemTypes: expectArray(extractEntry(jCpy, 'calendarItemTypes', true, path), false, [...path, ".calendarItemTypes"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, CalendarItemType.fromJSON)),
+            agendas: expectArray(extractEntry(jCpy, 'agendas', false, path), false, [...path, ".agendas"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, Agenda.fromJSON)),
+            calendarItemTypes: expectArray(extractEntry(jCpy, 'calendarItemTypes', false, path), false, [...path, ".calendarItemTypes"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, CalendarItemType.fromJSON)),
         });
         if (!ignoreUnknownKeys) {
             const unused = Object.keys(jCpy);

package/model/PublicKey.d.mts

@@ -1,5 +1,18 @@
+/**
+ *
+ *  DTO representing the public key of a healthcare party, used for end-to-end encryption.
+ *  /
+ */
 export declare class PublicKey {
+    /**
+     *
+     *  The identifier of the healthcare party that owns this public key.
+     */
     hcPartyId: string | undefined;
+    /**
+     *
+     *  The public key encoded as a hexadecimal string.
+     */
     hexString: string | undefined;
     constructor(partial: Partial<PublicKey>);
     toJSON(): object;

package/model/PublicKey.mjs

@@ -1,8 +1,21 @@
 // auto-generated file
 import { expectString, extractEntry } from '../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  DTO representing the public key of a healthcare party, used for end-to-end encryption.
+ *  /
+ */
 export class PublicKey {
     constructor(partial) {
+        /**
+         *
+         *  The identifier of the healthcare party that owns this public key.
+         */
         this.hcPartyId = undefined;
+        /**
+         *
+         *  The public key encoded as a hexadecimal string.
+         */
         this.hexString = undefined;
         if ('hcPartyId' in partial)
             this.hcPartyId = partial.hcPartyId;

package/model/Receipt.d.mts

@@ -6,70 +6,265 @@ 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 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 interface Receipt extends StoredDocument, ICureDocument<string>, HasEncryptionMetadata, Encryptable {
+    /**
+     *
+     *  List of references (e.g., nipReference, errorCode, errorPath, tarification, invoice UUID).
+     */
     references: Array<string>;
+    /**
+     *
+     *  The id of the document (InvoiceDto, ContactDto, ...) this receipt is linked to.
+     */
     documentId: string | undefined;
+    /**
+     *
+     *  The category of the receipt.
+     */
     category: string | undefined;
+    /**
+     *
+     *  The sub-category of the receipt.
+     */
     subCategory: string | undefined;
     readonly isEncrypted: boolean;
     toJSON(): object;
 }
+/**
+ *
+ *  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 declare class DecryptedReceipt {
+    /**
+     *
+     *  The unique identifier of the receipt.
+     */
     id: string;
+    /**
+     *
+     *  The revision of the receipt 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 User that created this receipt.
+     */
     author: string | undefined;
+    /**
+     *
+     *  The id of the HealthcareParty that is responsible for this receipt.
+     */
     responsible: string | undefined;
+    /**
+     *
+     *  Tags that qualify the receipt as being member of a certain class.
+     */
     tags: Array<CodeStub>;
+    /**
+     *
+     *  Codes that identify or qualify this particular receipt.
+     */
     codes: Array<CodeStub>;
+    /**
+     *
+     *  Hard delete (unix epoch in ms) timestamp of the object.
+     */
     deletionDate: number | undefined;
+    /**
+     *
+     *  List of references (e.g., nipReference, errorCode, errorPath, tarification, invoice UUID).
+     */
     references: Array<string>;
+    /**
+     *
+     *  The id of the document (InvoiceDto, ContactDto, ...) this receipt is linked to.
+     */
     documentId: string | undefined;
+    /**
+     *
+     *  The category of the receipt.
+     */
     category: string | undefined;
+    /**
+     *
+     *  The sub-category of the receipt.
+     */
     subCategory: string | 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;
+    /**
+     *
+     *  The security metadata of the entity.
+     */
     securityMetadata: SecurityMetadata | undefined;
     readonly isEncrypted: false;
     constructor(partial: Partial<DecryptedReceipt>);
     toJSON(): object;
     static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): DecryptedReceipt;
 }
+/**
+ *
+ *  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 declare class EncryptedReceipt {
+    /**
+     *
+     *  The unique identifier of the receipt.
+     */
     id: string;
+    /**
+     *
+     *  The revision of the receipt 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 User that created this receipt.
+     */
     author: string | undefined;
+    /**
+     *
+     *  The id of the HealthcareParty that is responsible for this receipt.
+     */
     responsible: string | undefined;
+    /**
+     *
+     *  Tags that qualify the receipt as being member of a certain class.
+     */
     tags: Array<CodeStub>;
+    /**
+     *
+     *  Codes that identify or qualify this particular receipt.
+     */
     codes: Array<CodeStub>;
+    /**
+     *
+     *  Hard delete (unix epoch in ms) timestamp of the object.
+     */
     deletionDate: number | undefined;
+    /**
+     *
+     *  List of references (e.g., nipReference, errorCode, errorPath, tarification, invoice UUID).
+     */
     references: Array<string>;
+    /**
+     *
+     *  The id of the document (InvoiceDto, ContactDto, ...) this receipt is linked to.
+     */
     documentId: string | undefined;
+    /**
+     *
+     *  The category of the receipt.
+     */
     category: string | undefined;
+    /**
+     *
+     *  The sub-category of the receipt.
+     */
     subCategory: string | 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;
+    /**
+     *
+     *  The security metadata of the entity.
+     */
     securityMetadata: SecurityMetadata | undefined;
     readonly isEncrypted: true;
     constructor(partial: Partial<EncryptedReceipt>);