@icure/cardinal-sdk 2.1.0 → 2.1.2

package/model/Agenda.mjs

@@ -6,27 +6,112 @@ import { CodeStub } from './base/CodeStub.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 class Agenda {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the agenda 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 agenda.
+         */
         this.author = undefined;
+        /**
+         *
+         *  The id of the data owner that is responsible for this agenda.
+         */
         this.responsible = undefined;
+        /**
+         *
+         *  Tags that qualify the agenda as being member of a certain class.
+         */
         this.tags = [];
+        /**
+         *
+         *  Codes that identify or qualify this particular agenda.
+         */
         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;
+        /**
+         *
+         *  A fuzzy time in HHMMSS format used to split working hours into blocks for availabilities
+         *  computation.
+         */
         this.daySplitHour = undefined;
+        /**
+         *
+         *  If true the agenda is not available for availabilities and safe booking requests.
+         */
         this.unpublished = false;
+        /**
+         *
+         *  The name of the agenda.
+         */
         this.name = undefined;
+        /**
+         *
+         *  The id of the user associated with this agenda.
+         */
         this.userId = undefined;
+        /**
+         *
+         *  An identifier for the time zone of the agenda, must be an id accepted by java's ZoneId.
+         */
         this.zoneId = undefined;
+        /**
+         *
+         *  Associates a user id to the permission that user has on the entity.
+         */
         this.userRights = {};
+        /**
+         *
+         *  The algorithm to use for computing time slots in the agenda.
+         */
         this.slottingAlgorithm = undefined;
+        /**
+         *
+         *  If not null, limits the amount of monthly appointments per unprivileged user for this agenda.
+         */
         this.publicBookingQuota = undefined;
+        /**
+         *
+         *  Custom properties of the agenda.
+         */
         this.properties = [];
+        /**
+         *
+         *  The resource group allocation schedules defining availability rules for this agenda.
+         */
         this.schedules = [];
         this.id = (_a = partial.id) !== null && _a !== void 0 ? _a : randomUuid();
         if ('rev' in partial)

package/model/BooleanResponse.d.mts

@@ -1,4 +1,13 @@
+/**
+ *
+ *
+ *   Simple wrapper DTO containing a single boolean response value.
+ */
 export declare class BooleanResponse {
+    /**
+     *
+     *  The boolean result of the operation.
+     */
     response: boolean;
     constructor(partial: Partial<BooleanResponse> & Pick<BooleanResponse, "response">);
     toJSON(): object;

package/model/BooleanResponse.mjs

@@ -1,5 +1,10 @@
 // auto-generated file
 import { expectBoolean, extractEntry } from '../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *
+ *   Simple wrapper DTO containing a single boolean response value.
+ */
 export class BooleanResponse {
     constructor(partial) {
         this.response = partial.response;

package/model/CalendarItem.d.mts

@@ -10,130 +10,561 @@ 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 appointment or event in a calendar. Calendar items are linked to an agenda and can
+ *  block
+ *  availabilities for scheduling purposes.
+ *  /
+ */
 export interface CalendarItem extends StoredDocument, ICureDocument<string>, HasEncryptionMetadata, Encryptable {
+    /**
+     *
+     *  The title of the calendar item.
+     */
     title: string | undefined;
+    /**
+     *
+     *  The id of the calendar item type associated with this item.
+     */
     calendarItemTypeId: string | undefined;
+    /**
+     *
+     *  The id of the master calendar item if this is a recurring instance.
+     */
     masterCalendarItemId: string | undefined;
+    /**
+     *
+     *  Whether this calendar item is marked as important.
+     */
     important: boolean | undefined;
+    /**
+     *
+     *  Whether this calendar item represents a home visit.
+     */
     homeVisit: boolean | undefined;
+    /**
+     *
+     *  A phone number associated with this calendar item.
+     */
     phoneNumber: string | undefined;
+    /**
+     *
+     *  The id of the place where the appointment takes place.
+     */
     placeId: string | undefined;
+    /**
+     *
+     *  The address where the appointment takes place.
+     */
     address: Address | undefined;
+    /**
+     *
+     *  The textual representation of the address.
+     */
     addressText: string | undefined;
+    /**
+     *
+     *  The start time of the calendar item in YYYYMMDDHHMMSS format.
+     */
     startTime: number | undefined;
+    /**
+     *
+     *  The end time of the calendar item in YYYYMMDDHHMMSS format.
+     */
     endTime: number | undefined;
+    /**
+     *
+     *  The time of confirmation in YYYYMMDDHHMMSS format.
+     */
     confirmationTime: number | undefined;
+    /**
+     *
+     *  The timestamp of cancellation.
+     */
     cancellationTimestamp: number | undefined;
+    /**
+     *
+     *  An id associated with the confirmation.
+     */
     confirmationId: string | undefined;
+    /**
+     *
+     *  The duration of the appointment.
+     */
     duration: number | undefined;
+    /**
+     *
+     *  Whether this calendar item spans the entire day.
+     */
     allDay: boolean | undefined;
+    /**
+     *
+     *  Additional details about the calendar item.
+     */
     details: string | undefined;
+    /**
+     *
+     *  Whether this calendar item was migrated from another system.
+     */
     wasMigrated: boolean | undefined;
+    /**
+     *
+     *  The id of the agenda linked to this calendar item.
+     */
     agendaId: string | undefined;
+    /**
+     *
+     *  The resource group of the agenda that will handle this calendar item.
+     */
     resourceGroup: CodeStub | undefined;
+    /**
+     *
+     *  How this calendar item is considered by the availabilities algorithm.
+     */
     availabilitiesAssignmentStrategy: CalendarItem.AvailabilitiesAssignmentStrategy | undefined;
+    /**
+     *
+     *  An id for linking recurring calendar items.
+     */
     recurrenceId: string | undefined;
+    /**
+     *
+     *  Tags for the meeting associated with this calendar item.
+     */
     meetingTags: Array<CalendarItemTag>;
+    /**
+     *
+     *  Custom properties of this calendar item.
+     */
     properties: Array<PropertyStub>;
     readonly isEncrypted: boolean;
     toJSON(): object;
 }
+/**
+ *
+ *  Represents an appointment or event in a calendar. Calendar items are linked to an agenda and can
+ *  block
+ *  availabilities for scheduling purposes.
+ *  /
+ */
 export declare class DecryptedCalendarItem {
+    /**
+     *
+     *  The Id of the calendar item. We encourage using either a v4 UUID or a HL7 Id.
+     */
     id: string;
+    /**
+     *
+     *  The revision of the calendar item 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 calendar item.
+     */
     author: string | undefined;
+    /**
+     *
+     *  The id of the data owner that is responsible for this calendar item.
+     */
     responsible: string | undefined;
+    /**
+     *
+     *  Tags that qualify the calendar item as being member of a certain class.
+     */
     tags: Array<CodeStub>;
+    /**
+     *
+     *  Codes that identify or qualify this particular calendar item.
+     */
     codes: Array<CodeStub>;
+    /**
+     *
+     *  Hard delete (unix epoch in ms) timestamp of the object.
+     */
     deletionDate: number | undefined;
+    /**
+     *
+     *  The title of the calendar item.
+     */
     title: string | undefined;
+    /**
+     *
+     *  The id of the calendar item type associated with this item.
+     */
     calendarItemTypeId: string | undefined;
+    /**
+     *
+     *  The id of the master calendar item if this is a recurring instance.
+     */
     masterCalendarItemId: string | undefined;
+    /**
+     *
+     *  Whether this calendar item is marked as important.
+     */
     important: boolean | undefined;
+    /**
+     *
+     *  Whether this calendar item represents a home visit.
+     */
     homeVisit: boolean | undefined;
+    /**
+     *
+     *  A phone number associated with this calendar item.
+     */
     phoneNumber: string | undefined;
+    /**
+     *
+     *  The id of the place where the appointment takes place.
+     */
     placeId: string | undefined;
+    /**
+     *
+     *  The address where the appointment takes place.
+     */
     address: DecryptedAddress | undefined;
+    /**
+     *
+     *  The textual representation of the address.
+     */
     addressText: string | undefined;
+    /**
+     *
+     *  The start time of the calendar item in YYYYMMDDHHMMSS format.
+     */
     startTime: number | undefined;
+    /**
+     *
+     *  The end time of the calendar item in YYYYMMDDHHMMSS format.
+     */
     endTime: number | undefined;
+    /**
+     *
+     *  The time of confirmation in YYYYMMDDHHMMSS format.
+     */
     confirmationTime: number | undefined;
+    /**
+     *
+     *  The timestamp of cancellation.
+     */
     cancellationTimestamp: number | undefined;
+    /**
+     *
+     *  An id associated with the confirmation.
+     */
     confirmationId: string | undefined;
+    /**
+     *
+     *  The duration of the appointment.
+     */
     duration: number | undefined;
+    /**
+     *
+     *  Whether this calendar item spans the entire day.
+     */
     allDay: boolean | undefined;
+    /**
+     *
+     *  Additional details about the calendar item.
+     */
     details: string | undefined;
+    /**
+     *
+     *  Whether this calendar item was migrated from another system.
+     */
     wasMigrated: boolean | undefined;
+    /**
+     *
+     *  The id of the agenda linked to this calendar item.
+     */
     agendaId: string | undefined;
+    /**
+     *
+     *  The resource group of the agenda that will handle this calendar item.
+     */
     resourceGroup: CodeStub | undefined;
+    /**
+     *
+     *  How this calendar item is considered by the availabilities algorithm.
+     */
     availabilitiesAssignmentStrategy: CalendarItem_.AvailabilitiesAssignmentStrategy | undefined;
+    /**
+     *
+     *  An id for linking recurring calendar items.
+     */
     recurrenceId: string | undefined;
+    /**
+     *
+     *  Tags for the meeting associated with this calendar item.
+     */
     meetingTags: Array<DecryptedCalendarItemTag>;
+    /**
+     *
+     *  Custom properties of this calendar item.
+     */
     properties: Array<DecryptedPropertyStub>;
+    /**
+     *
+     *  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 calendar item.
+     */
     encryptedSelf: Base64String | undefined;
+    /**
+     *
+     *  The security metadata of this entity, for access control.
+     */
     securityMetadata: SecurityMetadata | undefined;
     readonly isEncrypted: false;
     constructor(partial: Partial<DecryptedCalendarItem>);
     toJSON(): object;
     static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): DecryptedCalendarItem;
 }
+/**
+ *
+ *  Represents an appointment or event in a calendar. Calendar items are linked to an agenda and can
+ *  block
+ *  availabilities for scheduling purposes.
+ *  /
+ */
 export declare class EncryptedCalendarItem {
+    /**
+     *
+     *  The Id of the calendar item. We encourage using either a v4 UUID or a HL7 Id.
+     */
     id: string;
+    /**
+     *
+     *  The revision of the calendar item 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 calendar item.
+     */
     author: string | undefined;
+    /**
+     *
+     *  The id of the data owner that is responsible for this calendar item.
+     */
     responsible: string | undefined;
+    /**
+     *
+     *  Tags that qualify the calendar item as being member of a certain class.
+     */
     tags: Array<CodeStub>;
+    /**
+     *
+     *  Codes that identify or qualify this particular calendar item.
+     */
     codes: Array<CodeStub>;
+    /**
+     *
+     *  Hard delete (unix epoch in ms) timestamp of the object.
+     */
     deletionDate: number | undefined;
+    /**
+     *
+     *  The title of the calendar item.
+     */
     title: string | undefined;
+    /**
+     *
+     *  The id of the calendar item type associated with this item.
+     */
     calendarItemTypeId: string | undefined;
+    /**
+     *
+     *  The id of the master calendar item if this is a recurring instance.
+     */
     masterCalendarItemId: string | undefined;
+    /**
+     *
+     *  Whether this calendar item is marked as important.
+     */
     important: boolean | undefined;
+    /**
+     *
+     *  Whether this calendar item represents a home visit.
+     */
     homeVisit: boolean | undefined;
+    /**
+     *
+     *  A phone number associated with this calendar item.
+     */
     phoneNumber: string | undefined;
+    /**
+     *
+     *  The id of the place where the appointment takes place.
+     */
     placeId: string | undefined;
+    /**
+     *
+     *  The address where the appointment takes place.
+     */
     address: EncryptedAddress | undefined;
+    /**
+     *
+     *  The textual representation of the address.
+     */
     addressText: string | undefined;
+    /**
+     *
+     *  The start time of the calendar item in YYYYMMDDHHMMSS format.
+     */
     startTime: number | undefined;
+    /**
+     *
+     *  The end time of the calendar item in YYYYMMDDHHMMSS format.
+     */
     endTime: number | undefined;
+    /**
+     *
+     *  The time of confirmation in YYYYMMDDHHMMSS format.
+     */
     confirmationTime: number | undefined;
+    /**
+     *
+     *  The timestamp of cancellation.
+     */
     cancellationTimestamp: number | undefined;
+    /**
+     *
+     *  An id associated with the confirmation.
+     */
     confirmationId: string | undefined;
+    /**
+     *
+     *  The duration of the appointment.
+     */
     duration: number | undefined;
+    /**
+     *
+     *  Whether this calendar item spans the entire day.
+     */
     allDay: boolean | undefined;
+    /**
+     *
+     *  Additional details about the calendar item.
+     */
     details: string | undefined;
+    /**
+     *
+     *  Whether this calendar item was migrated from another system.
+     */
     wasMigrated: boolean | undefined;
+    /**
+     *
+     *  The id of the agenda linked to this calendar item.
+     */
     agendaId: string | undefined;
+    /**
+     *
+     *  The resource group of the agenda that will handle this calendar item.
+     */
     resourceGroup: CodeStub | undefined;
+    /**
+     *
+     *  How this calendar item is considered by the availabilities algorithm.
+     */
     availabilitiesAssignmentStrategy: CalendarItem_.AvailabilitiesAssignmentStrategy | undefined;
+    /**
+     *
+     *  An id for linking recurring calendar items.
+     */
     recurrenceId: string | undefined;
+    /**
+     *
+     *  Tags for the meeting associated with this calendar item.
+     */
     meetingTags: Array<EncryptedCalendarItemTag>;
+    /**
+     *
+     *  Custom properties of this calendar item.
+     */
     properties: Array<EncryptedPropertyStub>;
+    /**
+     *
+     *  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 calendar item.
+     */
     encryptedSelf: Base64String | undefined;
+    /**
+     *
+     *  The security metadata of this entity, for access control.
+     */
     securityMetadata: SecurityMetadata | undefined;
     readonly isEncrypted: true;
     constructor(partial: Partial<EncryptedCalendarItem>);