@icure/cardinal-sdk 2.1.1 → 2.1.3

package/model/CalendarItem.mjs

@@ -8,46 +8,206 @@ import { DecryptedAddress, EncryptedAddress } from './embed/Address.mjs';
 import { DecryptedCalendarItemTag, EncryptedCalendarItemTag } from './embed/CalendarItemTag.mjs';
 import { Delegation } from './embed/Delegation.mjs';
 import { SecurityMetadata } from './embed/SecurityMetadata.mjs';
+/**
+ *
+ *  Represents an appointment or event in a calendar. Calendar items are linked to an agenda and can
+ *  block
+ *  availabilities for scheduling purposes.
+ *  /
+ */
 export class DecryptedCalendarItem {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the calendar item 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 calendar item.
+         */
         this.author = undefined;
+        /**
+         *
+         *  The id of the data owner that is responsible for this calendar item.
+         */
         this.responsible = undefined;
+        /**
+         *
+         *  Tags that qualify the calendar item as being member of a certain class.
+         */
         this.tags = [];
+        /**
+         *
+         *  Codes that identify or qualify this particular calendar item.
+         */
         this.codes = [];
+        /**
+         *
+         *  Hard delete (unix epoch in ms) timestamp of the object.
+         */
         this.deletionDate = undefined;
+        /**
+         *
+         *  The title of the calendar item.
+         */
         this.title = undefined;
+        /**
+         *
+         *  The id of the calendar item type associated with this item.
+         */
         this.calendarItemTypeId = undefined;
+        /**
+         *
+         *  The id of the master calendar item if this is a recurring instance.
+         */
         this.masterCalendarItemId = undefined;
+        /**
+         *
+         *  Whether this calendar item is marked as important.
+         */
         this.important = undefined;
+        /**
+         *
+         *  Whether this calendar item represents a home visit.
+         */
         this.homeVisit = undefined;
+        /**
+         *
+         *  A phone number associated with this calendar item.
+         */
         this.phoneNumber = undefined;
+        /**
+         *
+         *  The id of the place where the appointment takes place.
+         */
         this.placeId = undefined;
+        /**
+         *
+         *  The address where the appointment takes place.
+         */
         this.address = undefined;
+        /**
+         *
+         *  The textual representation of the address.
+         */
         this.addressText = undefined;
+        /**
+         *
+         *  The start time of the calendar item in YYYYMMDDHHMMSS format.
+         */
         this.startTime = undefined;
+        /**
+         *
+         *  The end time of the calendar item in YYYYMMDDHHMMSS format.
+         */
         this.endTime = undefined;
+        /**
+         *
+         *  The time of confirmation in YYYYMMDDHHMMSS format.
+         */
         this.confirmationTime = undefined;
+        /**
+         *
+         *  The timestamp of cancellation.
+         */
         this.cancellationTimestamp = undefined;
+        /**
+         *
+         *  An id associated with the confirmation.
+         */
         this.confirmationId = undefined;
+        /**
+         *
+         *  The duration of the appointment.
+         */
         this.duration = undefined;
+        /**
+         *
+         *  Whether this calendar item spans the entire day.
+         */
         this.allDay = undefined;
+        /**
+         *
+         *  Additional details about the calendar item.
+         */
         this.details = undefined;
+        /**
+         *
+         *  Whether this calendar item was migrated from another system.
+         */
         this.wasMigrated = undefined;
+        /**
+         *
+         *  The id of the agenda linked to this calendar item.
+         */
         this.agendaId = undefined;
+        /**
+         *
+         *  The resource group of the agenda that will handle this calendar item.
+         */
         this.resourceGroup = undefined;
+        /**
+         *
+         *  How this calendar item is considered by the availabilities algorithm.
+         */
         this.availabilitiesAssignmentStrategy = undefined;
+        /**
+         *
+         *  An id for linking recurring calendar items.
+         */
         this.recurrenceId = undefined;
+        /**
+         *
+         *  Tags for the meeting associated with this calendar item.
+         */
         this.meetingTags = [];
+        /**
+         *
+         *  Custom properties of this calendar item.
+         */
         this.properties = [];
+        /**
+         *
+         *  The secret foreign keys, used for secure linking to patients.
+         */
         this.secretForeignKeys = [];
+        /**
+         *
+         *  The encrypted foreign keys.
+         */
         this.cryptedForeignKeys = {};
+        /**
+         *
+         *  The delegations giving access to connected healthcare information.
+         */
         this.delegations = {};
+        /**
+         *
+         *  The encryption keys used to encrypt secured properties, encrypted for separate Crypto Actors.
+         */
         this.encryptionKeys = {};
+        /**
+         *
+         *  The base64-encoded encrypted fields of this calendar item.
+         */
         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)
@@ -259,46 +419,206 @@ export class DecryptedCalendarItem {
         return res;
     }
 }
+/**
+ *
+ *  Represents an appointment or event in a calendar. Calendar items are linked to an agenda and can
+ *  block
+ *  availabilities for scheduling purposes.
+ *  /
+ */
 export class EncryptedCalendarItem {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the calendar item 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 calendar item.
+         */
         this.author = undefined;
+        /**
+         *
+         *  The id of the data owner that is responsible for this calendar item.
+         */
         this.responsible = undefined;
+        /**
+         *
+         *  Tags that qualify the calendar item as being member of a certain class.
+         */
         this.tags = [];
+        /**
+         *
+         *  Codes that identify or qualify this particular calendar item.
+         */
         this.codes = [];
+        /**
+         *
+         *  Hard delete (unix epoch in ms) timestamp of the object.
+         */
         this.deletionDate = undefined;
+        /**
+         *
+         *  The title of the calendar item.
+         */
         this.title = undefined;
+        /**
+         *
+         *  The id of the calendar item type associated with this item.
+         */
         this.calendarItemTypeId = undefined;
+        /**
+         *
+         *  The id of the master calendar item if this is a recurring instance.
+         */
         this.masterCalendarItemId = undefined;
+        /**
+         *
+         *  Whether this calendar item is marked as important.
+         */
         this.important = undefined;
+        /**
+         *
+         *  Whether this calendar item represents a home visit.
+         */
         this.homeVisit = undefined;
+        /**
+         *
+         *  A phone number associated with this calendar item.
+         */
         this.phoneNumber = undefined;
+        /**
+         *
+         *  The id of the place where the appointment takes place.
+         */
         this.placeId = undefined;
+        /**
+         *
+         *  The address where the appointment takes place.
+         */
         this.address = undefined;
+        /**
+         *
+         *  The textual representation of the address.
+         */
         this.addressText = undefined;
+        /**
+         *
+         *  The start time of the calendar item in YYYYMMDDHHMMSS format.
+         */
         this.startTime = undefined;
+        /**
+         *
+         *  The end time of the calendar item in YYYYMMDDHHMMSS format.
+         */
         this.endTime = undefined;
+        /**
+         *
+         *  The time of confirmation in YYYYMMDDHHMMSS format.
+         */
         this.confirmationTime = undefined;
+        /**
+         *
+         *  The timestamp of cancellation.
+         */
         this.cancellationTimestamp = undefined;
+        /**
+         *
+         *  An id associated with the confirmation.
+         */
         this.confirmationId = undefined;
+        /**
+         *
+         *  The duration of the appointment.
+         */
         this.duration = undefined;
+        /**
+         *
+         *  Whether this calendar item spans the entire day.
+         */
         this.allDay = undefined;
+        /**
+         *
+         *  Additional details about the calendar item.
+         */
         this.details = undefined;
+        /**
+         *
+         *  Whether this calendar item was migrated from another system.
+         */
         this.wasMigrated = undefined;
+        /**
+         *
+         *  The id of the agenda linked to this calendar item.
+         */
         this.agendaId = undefined;
+        /**
+         *
+         *  The resource group of the agenda that will handle this calendar item.
+         */
         this.resourceGroup = undefined;
+        /**
+         *
+         *  How this calendar item is considered by the availabilities algorithm.
+         */
         this.availabilitiesAssignmentStrategy = undefined;
+        /**
+         *
+         *  An id for linking recurring calendar items.
+         */
         this.recurrenceId = undefined;
+        /**
+         *
+         *  Tags for the meeting associated with this calendar item.
+         */
         this.meetingTags = [];
+        /**
+         *
+         *  Custom properties of this calendar item.
+         */
         this.properties = [];
+        /**
+         *
+         *  The secret foreign keys, used for secure linking to patients.
+         */
         this.secretForeignKeys = [];
+        /**
+         *
+         *  The encrypted foreign keys.
+         */
         this.cryptedForeignKeys = {};
+        /**
+         *
+         *  The delegations giving access to connected healthcare information.
+         */
         this.delegations = {};
+        /**
+         *
+         *  The encryption keys used to encrypt secured properties, encrypted for separate Crypto Actors.
+         */
         this.encryptionKeys = {};
+        /**
+         *
+         *  The base64-encoded encrypted fields of this calendar item.
+         */
         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/CalendarItemType.d.mts

@@ -1,25 +1,97 @@
 import { DecryptedPropertyStub } from './PropertyStub.mjs';
 import { StoredDocument } from './base/StoredDocument.mjs';
+/**
+ *
+ *  Represents a type of calendar item, defining properties like duration, color, and name for
+ *  appointments.
+ *  Calendar item types are used to categorize calendar items within an agenda.
+ *  /
+ */
 export declare class CalendarItemType implements StoredDocument {
+    /**
+     *
+     *  The Id of the calendar item type.
+     */
     id: string;
+    /**
+     *
+     *  The revision of the calendar item type 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 id of the healthcare party associated with this type.
+     */
     healthcarePartyId: string | undefined;
+    /**
+     *
+     *  The id of the agenda this type belongs to.
+     */
     agendaId: string | undefined;
+    /**
+     *
+     *  Whether this is the default calendar item type for its agenda.
+     */
     defaultCalendarItemType: boolean;
+    /**
+     *
+     *  The display name of this calendar item type.
+     */
     name: string | undefined;
+    /**
+     *
+     *  The color associated with this type, in hex format (e.g. "#123456").
+     */
     color: string | undefined;
+    /**
+     *
+     *  The default duration in minutes for calendar items of this type.
+     */
     duration: number;
+    /**
+     *
+     *  Optional configuration for additional allowed durations.
+     */
     extraDurationsConfig: CalendarItemType.DurationConfig | undefined;
+    /**
+     *
+     *  An external reference identifier.
+     */
     externalRef: string | undefined;
+    /**
+     *
+     *  An external Mikrono identifier.
+     */
     mikronoId: string | undefined;
+    /**
+     *
+     *  A set of document ids associated with this type.
+     */
     docIds: Array<string>;
+    /**
+     *
+     *  Additional information stored as key-value pairs.
+     */
     otherInfos: {
         [key: string]: string;
     };
+    /**
+     *
+     *  Subject text for this calendar item type, by language.
+     */
     subjectByLanguage: {
         [key: string]: string;
     };
+    /**
+     *
+     *  Public properties exposed to anonymous endpoints for public calendar items.
+     */
     publicProperties: Array<DecryptedPropertyStub> | undefined;
     constructor(partial: Partial<CalendarItemType>);
     toJSON(): object;

package/model/CalendarItemType.mjs

@@ -2,23 +2,91 @@
 import { expectArray, expectBoolean, expectMap, expectNumber, expectObject, expectString, extractEntry } from '../internal/JsonDecodeUtils.mjs';
 import { randomUuid } from '../utils/Id.mjs';
 import { DecryptedPropertyStub } from './PropertyStub.mjs';
+/**
+ *
+ *  Represents a type of calendar item, defining properties like duration, color, and name for
+ *  appointments.
+ *  Calendar item types are used to categorize calendar items within an agenda.
+ *  /
+ */
 export class CalendarItemType {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the calendar item type 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 id of the healthcare party associated with this type.
+         */
         this.healthcarePartyId = undefined;
+        /**
+         *
+         *  The id of the agenda this type belongs to.
+         */
         this.agendaId = undefined;
+        /**
+         *
+         *  Whether this is the default calendar item type for its agenda.
+         */
         this.defaultCalendarItemType = false;
+        /**
+         *
+         *  The display name of this calendar item type.
+         */
         this.name = undefined;
+        /**
+         *
+         *  The color associated with this type, in hex format (e.g. "#123456").
+         */
         this.color = undefined;
+        /**
+         *
+         *  The default duration in minutes for calendar items of this type.
+         */
         this.duration = 0;
+        /**
+         *
+         *  Optional configuration for additional allowed durations.
+         */
         this.extraDurationsConfig = undefined;
+        /**
+         *
+         *  An external reference identifier.
+         */
         this.externalRef = undefined;
+        /**
+         *
+         *  An external Mikrono identifier.
+         */
         this.mikronoId = undefined;
+        /**
+         *
+         *  A set of document ids associated with this type.
+         */
         this.docIds = [];
+        /**
+         *
+         *  Additional information stored as key-value pairs.
+         */
         this.otherInfos = {};
+        /**
+         *
+         *  Subject text for this calendar item type, by language.
+         */
         this.subjectByLanguage = {};
+        /**
+         *
+         *  Public properties exposed to anonymous endpoints for public calendar items.
+         */
         this.publicProperties = undefined;
         this.id = (_a = partial.id) !== null && _a !== void 0 ? _a : randomUuid();
         if ('rev' in partial)