@icure/cardinal-sdk 2.1.0 → 2.1.2

package/model/couchdb/ReplicatorDocument.d.mts

@@ -1,22 +1,84 @@
 import { Versionable } from '../base/Versionable.mjs';
 import { Remote } from './Remote.mjs';
 import { ReplicationStats } from './ReplicationStats.mjs';
+/**
+ *
+ *  Data transfer object representing a CouchDB replicator document that tracks the state of a
+ *  replication task.
+ *  /
+ */
 export declare class ReplicatorDocument implements Versionable<string> {
+    /**
+     *
+     *  The unique identifier of this replicator document.
+     */
     id: string;
+    /**
+     *
+     *  The current revision of this document.
+     */
     rev: string | undefined;
+    /**
+     *
+     *  The source remote endpoint for the replication.
+     */
     source: Remote | undefined;
+    /**
+     *
+     *  The target remote endpoint for the replication.
+     */
     target: Remote | undefined;
+    /**
+     *
+     *  The owner of this replication task.
+     */
     owner: string | undefined;
+    /**
+     *
+     *  Whether to create the target database if it does not exist.
+     */
     create_target: boolean | undefined;
+    /**
+     *
+     *  Whether the replication runs continuously.
+     */
     continuous: boolean | undefined;
+    /**
+     *
+     *  An optional list of document ids to replicate.
+     */
     doc_ids: Array<string> | undefined;
+    /**
+     *
+     *  The current state of the replication (e.g. triggered, completed, error).
+     */
     replicationState: string | undefined;
+    /**
+     *
+     *  The time when the replication state was last updated.
+     */
     replicationStateTime: string | undefined;
+    /**
+     *
+     *  Statistics about the replication process.
+     */
     replicationStats: ReplicationStats | undefined;
+    /**
+     *
+     *  The number of errors encountered during replication.
+     */
     errorCount: number | undefined;
+    /**
+     *
+     *  Information about the document revisions.
+     */
     revsInfo: Array<{
         [key: string]: string;
     }> | undefined;
+    /**
+     *
+     *  A map of the document revision history.
+     */
     revHistory: {
         [key: string]: string;
     } | undefined;

package/model/couchdb/ReplicatorDocument.mjs

@@ -3,21 +3,79 @@ import { expectArray, expectBoolean, expectMap, expectNumber, expectObject, expe
 import { randomUuid } from '../../utils/Id.mjs';
 import { Remote } from './Remote.mjs';
 import { ReplicationStats } from './ReplicationStats.mjs';
+/**
+ *
+ *  Data transfer object representing a CouchDB replicator document that tracks the state of a
+ *  replication task.
+ *  /
+ */
 export class ReplicatorDocument {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The current revision of this document.
+         */
         this.rev = undefined;
+        /**
+         *
+         *  The source remote endpoint for the replication.
+         */
         this.source = undefined;
+        /**
+         *
+         *  The target remote endpoint for the replication.
+         */
         this.target = undefined;
+        /**
+         *
+         *  The owner of this replication task.
+         */
         this.owner = undefined;
+        /**
+         *
+         *  Whether to create the target database if it does not exist.
+         */
         this.create_target = undefined;
+        /**
+         *
+         *  Whether the replication runs continuously.
+         */
         this.continuous = undefined;
+        /**
+         *
+         *  An optional list of document ids to replicate.
+         */
         this.doc_ids = undefined;
+        /**
+         *
+         *  The current state of the replication (e.g. triggered, completed, error).
+         */
         this.replicationState = undefined;
+        /**
+         *
+         *  The time when the replication state was last updated.
+         */
         this.replicationStateTime = undefined;
+        /**
+         *
+         *  Statistics about the replication process.
+         */
         this.replicationStats = undefined;
+        /**
+         *
+         *  The number of errors encountered during replication.
+         */
         this.errorCount = undefined;
+        /**
+         *
+         *  Information about the document revisions.
+         */
         this.revsInfo = undefined;
+        /**
+         *
+         *  A map of the document revision history.
+         */
         this.revHistory = undefined;
         this.id = (_a = partial.id) !== null && _a !== void 0 ? _a : randomUuid();
         if ('rev' in partial)

package/model/couchdb/View.d.mts

@@ -1,5 +1,18 @@
+/**
+ *
+ *
+ *   Data transfer object representing a CouchDB view definition within a design document.
+ */
 export declare class View {
+    /**
+     *
+     *  The map function source code for this view.
+     */
     map: string;
+    /**
+     *
+     *  The optional reduce function source code for this view.
+     */
     reduce: string | undefined;
     constructor(partial: Partial<View> & Pick<View, "map">);
     toJSON(): object;

package/model/couchdb/View.mjs

@@ -1,7 +1,16 @@
 // auto-generated file
 import { expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *
+ *   Data transfer object representing a CouchDB view definition within a design document.
+ */
 export class View {
     constructor(partial) {
+        /**
+         *
+         *  The optional reduce function source code for this view.
+         */
         this.reduce = undefined;
         this.map = partial.map;
         if ('reduce' in partial)

package/model/data/LabelledOccurence.d.mts

@@ -1,5 +1,19 @@
+/**
+ *
+ *  Data transfer object representing a labelled occurrence count, typically used for aggregation
+ *  results.
+ *  /
+ */
 export declare class LabelledOccurence {
+    /**
+     *
+     *  The label identifying what is being counted.
+     */
     label: string;
+    /**
+     *
+     *  The number of occurrences for this label.
+     */
     occurence: number;
     constructor(partial: Partial<LabelledOccurence> & Pick<LabelledOccurence, "label" | "occurence">);
     toJSON(): object;

package/model/data/LabelledOccurence.mjs

@@ -1,5 +1,11 @@
 // auto-generated file
 import { expectNumber, expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  Data transfer object representing a labelled occurrence count, typically used for aggregation
+ *  results.
+ *  /
+ */
 export class LabelledOccurence {
     constructor(partial) {
         this.label = partial.label;

package/model/embed/AccessLevel.d.mts

@@ -1,3 +1,9 @@
+/**
+ *
+ *
+ *   Specifies whether a user has read-only permission or read-write permissions.
+ *   Used for entity-level permissions.
+ */
 export declare enum AccessLevel {
     Read = "Read",
     Write = "Write"

package/model/embed/AccessLevel.mjs

@@ -1,4 +1,10 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Specifies whether a user has read-only permission or read-write permissions.
+ *   Used for entity-level permissions.
+ */
 export var AccessLevel;
 (function (AccessLevel) {
     AccessLevel["Read"] = "Read";

package/model/embed/AddressType.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *
+ *   Created by aduchate on 21/01/13, 14:53
+ */
 export declare enum AddressType {
     Home = "Home",
     Work = "Work",

package/model/embed/AddressType.mjs

@@ -1,4 +1,9 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Created by aduchate on 21/01/13, 14:53
+ */
 export var AddressType;
 (function (AddressType) {
     AddressType["Home"] = "Home";

package/model/embed/AdministrationQuantity.d.mts

@@ -1,7 +1,25 @@
 import { CodeStub } from '../base/CodeStub.mjs';
+/**
+ *
+ *  Represents a quantity for medication administration, including the numeric amount and the unit of
+ *  administration.
+ *  /
+ */
 export declare class AdministrationQuantity {
+    /**
+     *
+     *  The numeric quantity to administer.
+     */
     quantity: number | undefined;
+    /**
+     *
+     *  The coded unit of administration (CD-ADMINISTRATIONUNIT).
+     */
     administrationUnit: CodeStub | undefined;
+    /**
+     *
+     *  A textual representation of the unit.
+     */
     unit: string | undefined;
     constructor(partial: Partial<AdministrationQuantity>);
     toJSON(): object;

package/model/embed/AdministrationQuantity.mjs

@@ -1,10 +1,28 @@
 // auto-generated file
 import { expectNumber, expectObject, expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
 import { CodeStub } from '../base/CodeStub.mjs';
+/**
+ *
+ *  Represents a quantity for medication administration, including the numeric amount and the unit of
+ *  administration.
+ *  /
+ */
 export class AdministrationQuantity {
     constructor(partial) {
+        /**
+         *
+         *  The numeric quantity to administer.
+         */
         this.quantity = undefined;
+        /**
+         *
+         *  The coded unit of administration (CD-ADMINISTRATIONUNIT).
+         */
         this.administrationUnit = undefined;
+        /**
+         *
+         *  A textual representation of the unit.
+         */
         this.unit = undefined;
         if ('quantity' in partial)
             this.quantity = partial.quantity;

package/model/embed/AgendaSlottingAlgorithm.d.mts

@@ -1,5 +1,18 @@
 export type AgendaSlottingAlgorithm = AgendaSlottingAlgorithm.FixedIntervals;
 export declare namespace AgendaSlottingAlgorithm {
+    /**
+     *
+     *
+     *   The appointments can be taken at fixed intervals of [intervalMinutes] starting from the
+     *  beginning of the
+     *   scheduled working hours for the available timetable item.
+     *   # Example
+     *   - Time table item scheduled 09:30-12:00, 12:45-14:00
+     *   - Time table item availabilities 10:03-10:50, 13:00-13:30,
+     *   - [intervalMinutes] = 10
+     *   - Calendar item type duration = 15
+     *   The returned slots for that time table item are 10:10, 10:20, 10:30, 13:05, 13:15
+     */
     class FixedIntervals {
         intervalMinutes: number;
         readonly $ktClass: 'com.icure.cardinal.sdk.model.embed.AgendaSlottingAlgorithm.FixedIntervals';

package/model/embed/AgendaSlottingAlgorithm.mjs

@@ -2,6 +2,19 @@
 import { expectNumber, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
 export var AgendaSlottingAlgorithm;
 (function (AgendaSlottingAlgorithm) {
+    /**
+     *
+     *
+     *   The appointments can be taken at fixed intervals of [intervalMinutes] starting from the
+     *  beginning of the
+     *   scheduled working hours for the available timetable item.
+     *   # Example
+     *   - Time table item scheduled 09:30-12:00, 12:45-14:00
+     *   - Time table item availabilities 10:03-10:50, 13:00-13:30,
+     *   - [intervalMinutes] = 10
+     *   - Calendar item type duration = 15
+     *   The returned slots for that time table item are 10:10, 10:20, 10:30, 13:05, 13:15
+     */
     class FixedIntervals {
         constructor(partial) {
             this.$ktClass = 'com.icure.cardinal.sdk.model.embed.AgendaSlottingAlgorithm.FixedIntervals';

package/model/embed/Annotation.d.mts

@@ -1,17 +1,65 @@
 import { CodeStub } from '../base/CodeStub.mjs';
 import { Identifiable } from '../base/Identifiable.mjs';
+/**
+ *
+ *  Text node with attribution that can be attached to a medical record. Used by healthcare parties
+ *  to add side notes,
+ *  for example to flag a faulty thermometer after taking a temperature.
+ *  /
+ */
 export declare class Annotation implements Identifiable<string> {
+    /**
+     *
+     *  The Id of the Annotation. We encourage using either a v4 UUID or a HL7 Id.
+     */
     id: string;
+    /**
+     *
+     *  The identifier of the author of this annotation.
+     */
     author: string | undefined;
+    /**
+     *
+     *  The timestamp (unix epoch in ms) of creation of this note, filled automatically if missing.
+     */
     created: number | undefined;
+    /**
+     *
+     *  The timestamp (unix epoch in ms) of the latest modification of this note, filled automatically
+     *  if missing.
+     */
     modified: number | undefined;
+    /**
+     *
+     *  Text contained in the note, written as markdown. Deprecated in favor of [markdown].
+     */
     text: string | undefined;
+    /**
+     *
+     *  Localized text contained in the note, written as markdown. Keys should respect ISO 639-1.
+     */
     markdown: {
         [key: string]: string;
     };
+    /**
+     *
+     *  Defines to which part of the corresponding information the note is related to.
+     */
     location: string | undefined;
+    /**
+     *
+     *  Whether this annotation is confidential.
+     */
     confidential: boolean | undefined;
+    /**
+     *
+     *  Tags associated with this annotation.
+     */
     tags: Array<CodeStub>;
+    /**
+     *
+     *  The encrypted content of this annotation.
+     */
     encryptedSelf: string | undefined;
     constructor(partial: Partial<Annotation>);
     toJSON(): object;

package/model/embed/Annotation.mjs

@@ -2,17 +2,61 @@
 import { expectArray, expectBoolean, expectMap, expectNumber, expectObject, expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
 import { randomUuid } from '../../utils/Id.mjs';
 import { CodeStub } from '../base/CodeStub.mjs';
+/**
+ *
+ *  Text node with attribution that can be attached to a medical record. Used by healthcare parties
+ *  to add side notes,
+ *  for example to flag a faulty thermometer after taking a temperature.
+ *  /
+ */
 export class Annotation {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The identifier of the author of this annotation.
+         */
         this.author = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of creation of this note, filled automatically if missing.
+         */
         this.created = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of the latest modification of this note, filled automatically
+         *  if missing.
+         */
         this.modified = undefined;
+        /**
+         *
+         *  Text contained in the note, written as markdown. Deprecated in favor of [markdown].
+         */
         this.text = undefined;
+        /**
+         *
+         *  Localized text contained in the note, written as markdown. Keys should respect ISO 639-1.
+         */
         this.markdown = {};
+        /**
+         *
+         *  Defines to which part of the corresponding information the note is related to.
+         */
         this.location = undefined;
+        /**
+         *
+         *  Whether this annotation is confidential.
+         */
         this.confidential = undefined;
+        /**
+         *
+         *  Tags associated with this annotation.
+         */
         this.tags = [];
+        /**
+         *
+         *  The encrypted content of this annotation.
+         */
         this.encryptedSelf = undefined;
         this.id = (_a = partial.id) !== null && _a !== void 0 ? _a : randomUuid();
         if ('author' in partial)

package/model/embed/AuthenticationClass.d.mts

@@ -1,3 +1,9 @@
+/**
+ *
+ *
+ *   Enumerates the different classes of authentication that can be used to establish a user session,
+ *   ordered from strongest to weakest authentication assurance.
+ */
 export declare enum AuthenticationClass {
     DigitalId = "DigitalId",
     TwoFactorAuthentication = "TwoFactorAuthentication",

package/model/embed/AuthenticationClass.mjs

@@ -1,4 +1,10 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Enumerates the different classes of authentication that can be used to establish a user session,
+ *   ordered from strongest to weakest authentication assurance.
+ */
 export var AuthenticationClass;
 (function (AuthenticationClass) {
     AuthenticationClass["DigitalId"] = "DigitalId";

package/model/embed/CalendarItemTag.d.mts

@@ -1,29 +1,100 @@
 import { Base64String } from '../specializations/Base64String.mjs';
 import { Encryptable } from './Encryptable.mjs';
+/**
+ *
+ *  Represents a tag associated with a calendar item, carrying metadata about who tagged it and when.
+ *  /
+ */
 export interface CalendarItemTag extends Encryptable {
+    /**
+     *
+     *  The code identifying this tag.
+     */
     code: string | undefined;
+    /**
+     *
+     *  The timestamp (unix epoch in ms) when the tag was applied.
+     */
     date: number | undefined;
+    /**
+     *
+     *  The identifier of the user who applied the tag.
+     */
     userId: string | undefined;
+    /**
+     *
+     *  The display name of the user who applied the tag.
+     */
     userName: string | undefined;
     readonly isEncrypted: boolean;
     toJSON(): object;
 }
+/**
+ *
+ *  Represents a tag associated with a calendar item, carrying metadata about who tagged it and when.
+ *  /
+ */
 export declare class DecryptedCalendarItemTag {
+    /**
+     *
+     *  The code identifying this tag.
+     */
     code: string | undefined;
+    /**
+     *
+     *  The timestamp (unix epoch in ms) when the tag was applied.
+     */
     date: number | undefined;
+    /**
+     *
+     *  The identifier of the user who applied the tag.
+     */
     userId: string | undefined;
+    /**
+     *
+     *  The display name of the user who applied the tag.
+     */
     userName: string | undefined;
+    /**
+     *
+     *  The base64-encoded encrypted content of this tag.
+     */
     encryptedSelf: Base64String | undefined;
     readonly isEncrypted: false;
     constructor(partial: Partial<DecryptedCalendarItemTag>);
     toJSON(): object;
     static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): DecryptedCalendarItemTag;
 }
+/**
+ *
+ *  Represents a tag associated with a calendar item, carrying metadata about who tagged it and when.
+ *  /
+ */
 export declare class EncryptedCalendarItemTag {
+    /**
+     *
+     *  The code identifying this tag.
+     */
     code: string | undefined;
+    /**
+     *
+     *  The timestamp (unix epoch in ms) when the tag was applied.
+     */
     date: number | undefined;
+    /**
+     *
+     *  The identifier of the user who applied the tag.
+     */
     userId: string | undefined;
+    /**
+     *
+     *  The display name of the user who applied the tag.
+     */
     userName: string | undefined;
+    /**
+     *
+     *  The base64-encoded encrypted content of this tag.
+     */
     encryptedSelf: Base64String | undefined;
     readonly isEncrypted: true;
     constructor(partial: Partial<EncryptedCalendarItemTag>);