@icure/cardinal-sdk 3.0.0-PREVIEW-4 → 3.0.0-PREVIEW.6

package/model/PaginatedDocumentKeyIdPair.d.mts

@@ -11,8 +11,7 @@ export declare class PaginatedDocumentKeyIdPair {
     startKey: any | undefined;
     /**
      *
-     *  The document identifier to start the next page from, used to disambiguate when multiple
-     *  documents share the same key.
+     *  The document identifier to start the next page from, used to disambiguate when multiple documents share the same key.
      */
     startKeyDocId: string | undefined;
     constructor(partial: Partial<PaginatedDocumentKeyIdPair>);

package/model/PaginatedDocumentKeyIdPair.mjs

@@ -14,8 +14,7 @@ export class PaginatedDocumentKeyIdPair {
         this.startKey = undefined;
         /**
          *
-         *  The document identifier to start the next page from, used to disambiguate when multiple
-         *  documents share the same key.
+         *  The document identifier to start the next page from, used to disambiguate when multiple documents share the same key.
          */
         this.startKeyDocId = undefined;
         if ('startKey' in partial)

package/model/PaginatedList.d.mts

@@ -16,15 +16,13 @@ export declare class PaginatedList<T> {
     rows: Array<T>;
     /**
      *
-     *  The key-document ID pair to use for fetching the next page of results, or null if this is the
-     *  last page.
+     *  The key-document ID pair to use for fetching the next page of results, or null if this is the last page.
      */
     nextKeyPair: PaginatedDocumentKeyIdPair | undefined;
     /**
      *
      *
-     *   If not null the page was aborted by this error after some rows were already returned: [rows] is
-     *  valid but
+     *   If not null the page was aborted by this error after some rows were already returned: [rows] is valid but
      *   incomplete, and there is no [nextKeyPair] to resume from.
      */
     error: PaginationError | undefined;

package/model/PaginatedList.mjs

@@ -15,15 +15,13 @@ export class PaginatedList {
         this.rows = [];
         /**
          *
-         *  The key-document ID pair to use for fetching the next page of results, or null if this is the
-         *  last page.
+         *  The key-document ID pair to use for fetching the next page of results, or null if this is the last page.
          */
         this.nextKeyPair = undefined;
         /**
          *
          *
-         *   If not null the page was aborted by this error after some rows were already returned: [rows] is
-         *  valid but
+         *   If not null the page was aborted by this error after some rows were already returned: [rows] is valid but
          *   incomplete, and there is no [nextKeyPair] to resume from.
          */
         this.error = undefined;

package/model/PaginationError.d.mts

@@ -1,14 +1,12 @@
 /**
  *
- *  The error that aborted a page of results, reported in the body of an otherwise successful
- *  response.
+ *  The error that aborted a page of results, reported in the body of an otherwise successful response.
  *  /
  */
 export declare class PaginationError {
     /**
      *
-     *  The status code the request would have failed with, had the error been found before returning
-     *  any result.
+     *  The status code the request would have failed with, had the error been found before returning any result.
      */
     statusCode: number;
     /**

package/model/PaginationError.mjs

@@ -2,8 +2,7 @@
 import { expectNumber, expectString, extractEntry } from '../internal/JsonDecodeUtils.mjs';
 /**
  *
- *  The error that aborted a page of results, reported in the body of an otherwise successful
- *  response.
+ *  The error that aborted a page of results, reported in the body of an otherwise successful response.
  *  /
  */
 export class PaginationError {

package/model/Patient.d.mts

@@ -26,10 +26,8 @@ import { HexString } from './specializations/HexString.mjs';
 import { SpkiHexString } from './specializations/SpkiHexString.mjs';
 /**
  *
- *  Represents a patient in the iCure platform. A patient is a person who receives healthcare
- *  services.
- *  This entity stores personal, administrative, and medical information about the patient, and
- *  supports
+ *  Represents a patient in the iCure platform. A patient is a person who receives healthcare services.
+ *  This entity stores personal, administrative, and medical information about the patient, and supports
  *  end-to-end encryption of sensitive data.
  *  /
  */
@@ -222,10 +220,8 @@ export interface Patient extends StoredDocument, ICureDocument<string>, HasMedic
 }
 /**
  *
- *  Represents a patient in the iCure platform. A patient is a person who receives healthcare
- *  services.
- *  This entity stores personal, administrative, and medical information about the patient, and
- *  supports
+ *  Represents a patient in the iCure platform. A patient is a person who receives healthcare services.
+ *  This entity stores personal, administrative, and medical information about the patient, and supports
  *  end-to-end encryption of sensitive data.
  *  /
  */
@@ -591,10 +587,8 @@ export declare class DecryptedPatient {
 }
 /**
  *
- *  Represents a patient in the iCure platform. A patient is a person who receives healthcare
- *  services.
- *  This entity stores personal, administrative, and medical information about the patient, and
- *  supports
+ *  Represents a patient in the iCure platform. A patient is a person who receives healthcare services.
+ *  This entity stores personal, administrative, and medical information about the patient, and supports
  *  end-to-end encryption of sensitive data.
  *  /
  */

package/model/Patient.mjs

@@ -18,10 +18,8 @@ import { PersonalStatus } from './embed/PersonalStatus.mjs';
 import { SecurityMetadata } from './embed/SecurityMetadata.mjs';
 /**
  *
- *  Represents a patient in the iCure platform. A patient is a person who receives healthcare
- *  services.
- *  This entity stores personal, administrative, and medical information about the patient, and
- *  supports
+ *  Represents a patient in the iCure platform. A patient is a person who receives healthcare services.
+ *  This entity stores personal, administrative, and medical information about the patient, and supports
  *  end-to-end encryption of sensitive data.
  *  /
  */
@@ -689,10 +687,8 @@ export class DecryptedPatient {
 }
 /**
  *
- *  Represents a patient in the iCure platform. A patient is a person who receives healthcare
- *  services.
- *  This entity stores personal, administrative, and medical information about the patient, and
- *  supports
+ *  Represents a patient in the iCure platform. A patient is a person who receives healthcare services.
+ *  This entity stores personal, administrative, and medical information about the patient, and supports
  *  end-to-end encryption of sensitive data.
  *  /
  */

package/model/PropertyTypeStub.d.mts

@@ -1,8 +1,7 @@
 import { TypedValuesType } from './embed/TypedValuesType.mjs';
 /**
  *
- *  Lightweight stub representation of a property type, containing only the identifier and value
- *  type.
+ *  Lightweight stub representation of a property type, containing only the identifier and value type.
  *  /
  */
 export declare class PropertyTypeStub {

package/model/PropertyTypeStub.mjs

@@ -3,8 +3,7 @@ import { expectString, expectStringEnum, extractEntry } from '../internal/JsonDe
 import { TypedValuesType } from './embed/TypedValuesType.mjs';
 /**
  *
- *  Lightweight stub representation of a property type, containing only the identifier and value
- *  type.
+ *  Lightweight stub representation of a property type, containing only the identifier and value type.
  *  /
  */
 export class PropertyTypeStub {

package/model/Receipt.d.mts

@@ -12,10 +12,8 @@ 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
+ *  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.
  *  /
  */
@@ -64,10 +62,8 @@ export interface Receipt extends StoredDocument, ICureDocument<string>, HasMedic
 }
 /**
  *
- *  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
+ *  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.
  *  /
  */
@@ -199,10 +195,8 @@ export declare class 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
+ *  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.
  *  /
  */

package/model/Receipt.mjs

@@ -9,10 +9,8 @@ import { ReceiptBlobType } from './embed/ReceiptBlobType.mjs';
 import { SecurityMetadata } from './embed/SecurityMetadata.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
+ *  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.
  *  /
  */
@@ -249,10 +247,8 @@ export class 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
+ *  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.
  *  /
  */

package/model/RelatedPerson.d.mts

@@ -17,11 +17,9 @@ import { Base64String } from './specializations/Base64String.mjs';
 /**
  *
  *
- *   A person related to one or more patients, that is neither a patient nor a healthcare party:
- *  typically a contact
+ *   A person related to one or more patients, that is neither a patient nor a healthcare party: typically a contact
  *   person (parent of a child patient, caregiver, ...), referenced from a patient's partnership with
- *   partnerType = relatedPerson. It is a standalone encryptable entity but NOT a crypto actor nor a
- *  data owner.
+ *   partnerType = relatedPerson. It is a standalone encryptable entity but NOT a crypto actor nor a data owner.
  */
 export interface RelatedPerson extends StoredDocument, ICureDocument<string>, Person, HasEncryptionMetadata, Encryptable, HasIdentifier, HasEndOfLife {
     /**
@@ -35,11 +33,9 @@ export interface RelatedPerson extends StoredDocument, ICureDocument<string>, Pe
 /**
  *
  *
- *   A person related to one or more patients, that is neither a patient nor a healthcare party:
- *  typically a contact
+ *   A person related to one or more patients, that is neither a patient nor a healthcare party: typically a contact
  *   person (parent of a child patient, caregiver, ...), referenced from a patient's partnership with
- *   partnerType = relatedPerson. It is a standalone encryptable entity but NOT a crypto actor nor a
- *  data owner.
+ *   partnerType = relatedPerson. It is a standalone encryptable entity but NOT a crypto actor nor a data owner.
  */
 export declare class DecryptedRelatedPerson {
     /**
@@ -49,8 +45,7 @@ export declare class DecryptedRelatedPerson {
     id: string;
     /**
      *
-     *  The revision of the related person in the database, used for conflict management / optimistic
-     *  locking.
+     *  The revision of the related person in the database, used for conflict management / optimistic locking.
      */
     rev: string | undefined;
     /**
@@ -111,7 +106,6 @@ export declare class DecryptedRelatedPerson {
     /**
      *
      *  The list of all names of the related person, also containing the official full name information.
-     *
      */
     names: Array<PersonName>;
     /**
@@ -188,11 +182,9 @@ export declare class DecryptedRelatedPerson {
 /**
  *
  *
- *   A person related to one or more patients, that is neither a patient nor a healthcare party:
- *  typically a contact
+ *   A person related to one or more patients, that is neither a patient nor a healthcare party: typically a contact
  *   person (parent of a child patient, caregiver, ...), referenced from a patient's partnership with
- *   partnerType = relatedPerson. It is a standalone encryptable entity but NOT a crypto actor nor a
- *  data owner.
+ *   partnerType = relatedPerson. It is a standalone encryptable entity but NOT a crypto actor nor a data owner.
  */
 export declare class EncryptedRelatedPerson {
     /**
@@ -202,8 +194,7 @@ export declare class EncryptedRelatedPerson {
     id: string;
     /**
      *
-     *  The revision of the related person in the database, used for conflict management / optimistic
-     *  locking.
+     *  The revision of the related person in the database, used for conflict management / optimistic locking.
      */
     rev: string | undefined;
     /**
@@ -264,7 +255,6 @@ export declare class EncryptedRelatedPerson {
     /**
      *
      *  The list of all names of the related person, also containing the official full name information.
-     *
      */
     names: Array<PersonName>;
     /**

package/model/RelatedPerson.mjs

@@ -12,19 +12,16 @@ import { SecurityMetadata } from './embed/SecurityMetadata.mjs';
 /**
  *
  *
- *   A person related to one or more patients, that is neither a patient nor a healthcare party:
- *  typically a contact
+ *   A person related to one or more patients, that is neither a patient nor a healthcare party: typically a contact
  *   person (parent of a child patient, caregiver, ...), referenced from a patient's partnership with
- *   partnerType = relatedPerson. It is a standalone encryptable entity but NOT a crypto actor nor a
- *  data owner.
+ *   partnerType = relatedPerson. It is a standalone encryptable entity but NOT a crypto actor nor a data owner.
  */
 export class DecryptedRelatedPerson {
     constructor(partial) {
         var _a;
         /**
          *
-         *  The revision of the related person in the database, used for conflict management / optimistic
-         *  locking.
+         *  The revision of the related person in the database, used for conflict management / optimistic locking.
          */
         this.rev = undefined;
         /**
@@ -85,7 +82,6 @@ export class DecryptedRelatedPerson {
         /**
          *
          *  The list of all names of the related person, also containing the official full name information.
-         *
          */
         this.names = [];
         /**
@@ -293,19 +289,16 @@ export class DecryptedRelatedPerson {
 /**
  *
  *
- *   A person related to one or more patients, that is neither a patient nor a healthcare party:
- *  typically a contact
+ *   A person related to one or more patients, that is neither a patient nor a healthcare party: typically a contact
  *   person (parent of a child patient, caregiver, ...), referenced from a patient's partnership with
- *   partnerType = relatedPerson. It is a standalone encryptable entity but NOT a crypto actor nor a
- *  data owner.
+ *   partnerType = relatedPerson. It is a standalone encryptable entity but NOT a crypto actor nor a data owner.
  */
 export class EncryptedRelatedPerson {
     constructor(partial) {
         var _a;
         /**
          *
-         *  The revision of the related person in the database, used for conflict management / optimistic
-         *  locking.
+         *  The revision of the related person in the database, used for conflict management / optimistic locking.
          */
         this.rev = undefined;
         /**
@@ -366,7 +359,6 @@ export class EncryptedRelatedPerson {
         /**
          *
          *  The list of all names of the related person, also containing the official full name information.
-         *
          */
         this.names = [];
         /**

package/model/Role.d.mts

@@ -2,10 +2,8 @@ import { StoredDocument } from './base/StoredDocument.mjs';
 /**
  *
  *
- *   The RoleDto class represents a role in the system, which can have permissions and can be
- *  inheritable up to a certain level by users in child Groups.$
- *   down the group hierarchy this role can be inherited by users in child groups. A value of 0 means
- *  it cannot be inherited, while a value of -1 means it can be inherited indefinitely.
+ *   The RoleDto class represents a role in the system, which can have permissions and can be inheritable up to a certain level by users in child Groups.$
+ *   down the group hierarchy this role can be inherited by users in child groups. A value of 0 means it cannot be inherited, while a value of -1 means it can be inherited indefinitely.
  */
 export declare class Role implements StoredDocument {
     /**
@@ -25,8 +23,7 @@ export declare class Role implements StoredDocument {
     deletionDate: number | undefined;
     /**
      *
-     *  The name of the role. It can only contain uppercase letters, numbers, and underscores for a max
-     *  length of 40 characters.
+     *  The name of the role. It can only contain uppercase letters, numbers, and underscores for a max length of 40 characters.
      */
     name: string | undefined;
     /**
@@ -45,8 +42,7 @@ export declare class Role implements StoredDocument {
     inheritableUpTo: number | undefined;
     /**
      *
-     *  A set of permissions associated with this role, defining what actions users with this role can
-     *  perform.
+     *  A set of permissions associated with this role, defining what actions users with this role can perform.
      */
     permissions: Array<string>;
     constructor(partial: Partial<Role>);

package/model/Role.mjs

@@ -4,10 +4,8 @@ import { randomUuid } from '../utils/Id.mjs';
 /**
  *
  *
- *   The RoleDto class represents a role in the system, which can have permissions and can be
- *  inheritable up to a certain level by users in child Groups.$
- *   down the group hierarchy this role can be inherited by users in child groups. A value of 0 means
- *  it cannot be inherited, while a value of -1 means it can be inherited indefinitely.
+ *   The RoleDto class represents a role in the system, which can have permissions and can be inheritable up to a certain level by users in child Groups.$
+ *   down the group hierarchy this role can be inherited by users in child groups. A value of 0 means it cannot be inherited, while a value of -1 means it can be inherited indefinitely.
  */
 export class Role {
     constructor(partial) {
@@ -24,8 +22,7 @@ export class Role {
         this.deletionDate = undefined;
         /**
          *
-         *  The name of the role. It can only contain uppercase letters, numbers, and underscores for a max
-         *  length of 40 characters.
+         *  The name of the role. It can only contain uppercase letters, numbers, and underscores for a max length of 40 characters.
          */
         this.name = undefined;
         /**
@@ -44,8 +41,7 @@ export class Role {
         this.inheritableUpTo = undefined;
         /**
          *
-         *  A set of permissions associated with this role, defining what actions users with this role can
-         *  perform.
+         *  A set of permissions associated with this role, defining what actions users with this role can perform.
          */
         this.permissions = [];
         this.id = (_a = partial.id) !== null && _a !== void 0 ? _a : randomUuid();

package/model/Topic.d.mts

@@ -10,8 +10,7 @@ import { SecurityMetadata } from './embed/SecurityMetadata.mjs';
 import { Base64String } from './specializations/Base64String.mjs';
 /**
  *
- *  Represents a topic for secure messaging between healthcare parties. A topic groups messages in a
- *  conversation
+ *  Represents a topic for secure messaging between healthcare parties. A topic groups messages in a conversation
  *  and can be linked to health elements and services for medical context.
  *  /
  */
@@ -53,8 +52,7 @@ export interface Topic extends StoredDocument, ICureDocument<string>, HasMedical
 }
 /**
  *
- *  Represents a topic for secure messaging between healthcare parties. A topic groups messages in a
- *  conversation
+ *  Represents a topic for secure messaging between healthcare parties. A topic groups messages in a conversation
  *  and can be linked to health elements and services for medical context.
  *  /
  */
@@ -179,8 +177,7 @@ export declare class DecryptedTopic {
 }
 /**
  *
- *  Represents a topic for secure messaging between healthcare parties. A topic groups messages in a
- *  conversation
+ *  Represents a topic for secure messaging between healthcare parties. A topic groups messages in a conversation
  *  and can be linked to health elements and services for medical context.
  *  /
  */

package/model/Topic.mjs

@@ -7,8 +7,7 @@ import { Delegation } from './embed/Delegation.mjs';
 import { SecurityMetadata } from './embed/SecurityMetadata.mjs';
 /**
  *
- *  Represents a topic for secure messaging between healthcare parties. A topic groups messages in a
- *  conversation
+ *  Represents a topic for secure messaging between healthcare parties. A topic groups messages in a conversation
  *  and can be linked to health elements and services for medical context.
  *  /
  */
@@ -236,8 +235,7 @@ export class DecryptedTopic {
 }
 /**
  *
- *  Represents a topic for secure messaging between healthcare parties. A topic groups messages in a
- *  conversation
+ *  Represents a topic for secure messaging between healthcare parties. A topic groups messages in a conversation
  *  and can be linked to health elements and services for medical context.
  *  /
  */

package/model/User.d.mts

@@ -10,8 +10,7 @@ import { Permission } from './security/Permission.mjs';
 /**
  *
  *
- *   Represents a user that can log in to the iCure platform. A user can be linked to a healthcare
- *  party,
+ *   Represents a user that can log in to the iCure platform. A user can be linked to a healthcare party,
  *   a patient, or a device, and holds authentication credentials, roles, and permissions.
  */
 export declare class User implements StoredDocument, HasIdentifier {
@@ -97,8 +96,7 @@ export declare class User implements StoredDocument, HasIdentifier {
     deviceId: string | undefined;
     /**
      *
-     *  Delegations that are automatically generated client side when a new database object is created
-     *  by this user.
+     *  Delegations that are automatically generated client side when a new database object is created by this user.
      */
     autoDelegations: {
         [key in DelegationTag]?: Array<string>;

package/model/User.mjs

@@ -11,8 +11,7 @@ import { Permission } from './security/Permission.mjs';
 /**
  *
  *
- *   Represents a user that can log in to the iCure platform. A user can be linked to a healthcare
- *  party,
+ *   Represents a user that can log in to the iCure platform. A user can be linked to a healthcare party,
  *   a patient, or a device, and holds authentication credentials, roles, and permissions.
  */
 export class User {
@@ -95,8 +94,7 @@ export class User {
         this.deviceId = undefined;
         /**
          *
-         *  Delegations that are automatically generated client side when a new database object is created
-         *  by this user.
+         *  Delegations that are automatically generated client side when a new database object is created by this user.
          */
         this.autoDelegations = {};
         /**

package/model/base/CodeStub.d.mts

@@ -2,8 +2,7 @@ import { CodeIdentification } from './CodeIdentification.mjs';
 /**
  *
  *
- *   A lightweight reference to a code from a codification system, used as a stub in entities that
- *  reference codes
+ *   A lightweight reference to a code from a codification system, used as a stub in entities that reference codes
  *   without embedding the full code definition. The id is typically formatted as type|code|version.
  */
 export declare class CodeStub implements CodeIdentification<string | undefined> {

package/model/base/CodeStub.mjs

@@ -3,8 +3,7 @@ import { expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
 /**
  *
  *
- *   A lightweight reference to a code from a codification system, used as a stub in entities that
- *  reference codes
+ *   A lightweight reference to a code from a codification system, used as a stub in entities that reference codes
  *   without embedding the full code definition. The id is typically formatted as type|code|version.
  */
 export class CodeStub {