@icure/cardinal-sdk 2.1.1 → 2.1.3

package/model/embed/Episode.d.mts

@@ -2,31 +2,109 @@ import { Identifiable } from '../base/Identifiable.mjs';
 import { Named } from '../base/Named.mjs';
 import { Base64String } from '../specializations/Base64String.mjs';
 import { Encryptable } from './Encryptable.mjs';
+/**
+ *
+ *  Represents a medical episode, which is a time-bounded grouping of healthcare elements related to
+ *  a specific concern.
+ *  /
+ */
 export interface Episode extends Encryptable, Identifiable<string>, Named {
+    /**
+     *
+     *  A comment associated with the episode.
+     */
     comment: string | undefined;
+    /**
+     *
+     *  The start date in YYYYMMDDHHMMSS format. Unknown components are set to 00.
+     */
     startDate: number | undefined;
+    /**
+     *
+     *  The end date in YYYYMMDDHHMMSS format. Unknown components are set to 00.
+     */
     endDate: number | undefined;
     readonly isEncrypted: boolean;
     toJSON(): object;
 }
+/**
+ *
+ *  Represents a medical episode, which is a time-bounded grouping of healthcare elements related to
+ *  a specific concern.
+ *  /
+ */
 export declare class DecryptedEpisode {
+    /**
+     *
+     *  The unique identifier of this episode.
+     */
     id: string;
+    /**
+     *
+     *  The name of the episode.
+     */
     name: string | undefined;
+    /**
+     *
+     *  A comment associated with the episode.
+     */
     comment: string | undefined;
+    /**
+     *
+     *  The start date in YYYYMMDDHHMMSS format. Unknown components are set to 00.
+     */
     startDate: number | undefined;
+    /**
+     *
+     *  The end date in YYYYMMDDHHMMSS format. Unknown components are set to 00.
+     */
     endDate: number | undefined;
+    /**
+     *
+     *  The base64-encoded encrypted content of this episode.
+     */
     encryptedSelf: Base64String | undefined;
     readonly isEncrypted: false;
     constructor(partial: Partial<DecryptedEpisode>);
     toJSON(): object;
     static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): DecryptedEpisode;
 }
+/**
+ *
+ *  Represents a medical episode, which is a time-bounded grouping of healthcare elements related to
+ *  a specific concern.
+ *  /
+ */
 export declare class EncryptedEpisode {
+    /**
+     *
+     *  The unique identifier of this episode.
+     */
     id: string;
+    /**
+     *
+     *  The name of the episode.
+     */
     name: string | undefined;
+    /**
+     *
+     *  A comment associated with the episode.
+     */
     comment: string | undefined;
+    /**
+     *
+     *  The start date in YYYYMMDDHHMMSS format. Unknown components are set to 00.
+     */
     startDate: number | undefined;
+    /**
+     *
+     *  The end date in YYYYMMDDHHMMSS format. Unknown components are set to 00.
+     */
     endDate: number | undefined;
+    /**
+     *
+     *  The base64-encoded encrypted content of this episode.
+     */
     encryptedSelf: Base64String | undefined;
     readonly isEncrypted: true;
     constructor(partial: Partial<EncryptedEpisode>);

package/model/embed/Episode.mjs

@@ -1,13 +1,39 @@
 // auto-generated file
 import { expectNumber, expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
 import { randomUuid } from '../../utils/Id.mjs';
+/**
+ *
+ *  Represents a medical episode, which is a time-bounded grouping of healthcare elements related to
+ *  a specific concern.
+ *  /
+ */
 export class DecryptedEpisode {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The name of the episode.
+         */
         this.name = undefined;
+        /**
+         *
+         *  A comment associated with the episode.
+         */
         this.comment = undefined;
+        /**
+         *
+         *  The start date in YYYYMMDDHHMMSS format. Unknown components are set to 00.
+         */
         this.startDate = undefined;
+        /**
+         *
+         *  The end date in YYYYMMDDHHMMSS format. Unknown components are set to 00.
+         */
         this.endDate = undefined;
+        /**
+         *
+         *  The base64-encoded encrypted content of this episode.
+         */
         this.encryptedSelf = undefined;
         this.isEncrypted = false;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== false)
@@ -62,13 +88,39 @@ export class DecryptedEpisode {
         return res;
     }
 }
+/**
+ *
+ *  Represents a medical episode, which is a time-bounded grouping of healthcare elements related to
+ *  a specific concern.
+ *  /
+ */
 export class EncryptedEpisode {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The name of the episode.
+         */
         this.name = undefined;
+        /**
+         *
+         *  A comment associated with the episode.
+         */
         this.comment = undefined;
+        /**
+         *
+         *  The start date in YYYYMMDDHHMMSS format. Unknown components are set to 00.
+         */
         this.startDate = undefined;
+        /**
+         *
+         *  The end date in YYYYMMDDHHMMSS format. Unknown components are set to 00.
+         */
         this.endDate = undefined;
+        /**
+         *
+         *  The base64-encoded encrypted content of this episode.
+         */
         this.encryptedSelf = undefined;
         this.isEncrypted = true;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== true)

package/model/embed/FinancialInstitutionInformation.d.mts

@@ -1,38 +1,148 @@
 import { Base64String } from '../specializations/Base64String.mjs';
 import { Encryptable } from './Encryptable.mjs';
+/**
+ *
+ *  Represents information about a financial institution, including bank account details and proxy
+ *  account configuration.
+ *  /
+ */
 export interface FinancialInstitutionInformation extends Encryptable {
+    /**
+     *
+     *  The name of the financial institution.
+     */
     name: string | undefined;
+    /**
+     *
+     *  The key identifying this financial institution information entry.
+     */
     key: string | undefined;
+    /**
+     *
+     *  The bank account number (e.g., IBAN).
+     */
     bankAccount: string | undefined;
+    /**
+     *
+     *  The BIC/SWIFT code of the bank.
+     */
     bic: string | undefined;
+    /**
+     *
+     *  The proxy bank account number.
+     */
     proxyBankAccount: string | undefined;
+    /**
+     *
+     *  The BIC/SWIFT code for the proxy bank.
+     */
     proxyBic: string | undefined;
+    /**
+     *
+     *  Set of insurance or healthcare party identifiers that prefer this financial institution.
+     */
     preferredFiiForPartners: Array<string>;
     readonly isEncrypted: boolean;
     toJSON(): object;
 }
+/**
+ *
+ *  Represents information about a financial institution, including bank account details and proxy
+ *  account configuration.
+ *  /
+ */
 export declare class DecryptedFinancialInstitutionInformation {
+    /**
+     *
+     *  The name of the financial institution.
+     */
     name: string | undefined;
+    /**
+     *
+     *  The key identifying this financial institution information entry.
+     */
     key: string | undefined;
+    /**
+     *
+     *  The bank account number (e.g., IBAN).
+     */
     bankAccount: string | undefined;
+    /**
+     *
+     *  The BIC/SWIFT code of the bank.
+     */
     bic: string | undefined;
+    /**
+     *
+     *  The proxy bank account number.
+     */
     proxyBankAccount: string | undefined;
+    /**
+     *
+     *  The BIC/SWIFT code for the proxy bank.
+     */
     proxyBic: string | undefined;
+    /**
+     *
+     *  Set of insurance or healthcare party identifiers that prefer this financial institution.
+     */
     preferredFiiForPartners: Array<string>;
+    /**
+     *
+     *  The base64-encoded encrypted content.
+     */
     encryptedSelf: Base64String | undefined;
     readonly isEncrypted: false;
     constructor(partial: Partial<DecryptedFinancialInstitutionInformation>);
     toJSON(): object;
     static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): DecryptedFinancialInstitutionInformation;
 }
+/**
+ *
+ *  Represents information about a financial institution, including bank account details and proxy
+ *  account configuration.
+ *  /
+ */
 export declare class EncryptedFinancialInstitutionInformation {
+    /**
+     *
+     *  The name of the financial institution.
+     */
     name: string | undefined;
+    /**
+     *
+     *  The key identifying this financial institution information entry.
+     */
     key: string | undefined;
+    /**
+     *
+     *  The bank account number (e.g., IBAN).
+     */
     bankAccount: string | undefined;
+    /**
+     *
+     *  The BIC/SWIFT code of the bank.
+     */
     bic: string | undefined;
+    /**
+     *
+     *  The proxy bank account number.
+     */
     proxyBankAccount: string | undefined;
+    /**
+     *
+     *  The BIC/SWIFT code for the proxy bank.
+     */
     proxyBic: string | undefined;
+    /**
+     *
+     *  Set of insurance or healthcare party identifiers that prefer this financial institution.
+     */
     preferredFiiForPartners: Array<string>;
+    /**
+     *
+     *  The base64-encoded encrypted content.
+     */
     encryptedSelf: Base64String | undefined;
     readonly isEncrypted: true;
     constructor(partial: Partial<EncryptedFinancialInstitutionInformation>);

package/model/embed/FinancialInstitutionInformation.mjs

@@ -1,14 +1,52 @@
 // auto-generated file
 import { expectArray, expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  Represents information about a financial institution, including bank account details and proxy
+ *  account configuration.
+ *  /
+ */
 export class DecryptedFinancialInstitutionInformation {
     constructor(partial) {
+        /**
+         *
+         *  The name of the financial institution.
+         */
         this.name = undefined;
+        /**
+         *
+         *  The key identifying this financial institution information entry.
+         */
         this.key = undefined;
+        /**
+         *
+         *  The bank account number (e.g., IBAN).
+         */
         this.bankAccount = undefined;
+        /**
+         *
+         *  The BIC/SWIFT code of the bank.
+         */
         this.bic = undefined;
+        /**
+         *
+         *  The proxy bank account number.
+         */
         this.proxyBankAccount = undefined;
+        /**
+         *
+         *  The BIC/SWIFT code for the proxy bank.
+         */
         this.proxyBic = undefined;
+        /**
+         *
+         *  Set of insurance or healthcare party identifiers that prefer this financial institution.
+         */
         this.preferredFiiForPartners = [];
+        /**
+         *
+         *  The base64-encoded encrypted content.
+         */
         this.encryptedSelf = undefined;
         this.isEncrypted = false;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== false)
@@ -74,15 +112,53 @@ export class DecryptedFinancialInstitutionInformation {
         return res;
     }
 }
+/**
+ *
+ *  Represents information about a financial institution, including bank account details and proxy
+ *  account configuration.
+ *  /
+ */
 export class EncryptedFinancialInstitutionInformation {
     constructor(partial) {
+        /**
+         *
+         *  The name of the financial institution.
+         */
         this.name = undefined;
+        /**
+         *
+         *  The key identifying this financial institution information entry.
+         */
         this.key = undefined;
+        /**
+         *
+         *  The bank account number (e.g., IBAN).
+         */
         this.bankAccount = undefined;
+        /**
+         *
+         *  The BIC/SWIFT code of the bank.
+         */
         this.bic = undefined;
+        /**
+         *
+         *  The proxy bank account number.
+         */
         this.proxyBankAccount = undefined;
+        /**
+         *
+         *  The BIC/SWIFT code for the proxy bank.
+         */
         this.proxyBic = undefined;
+        /**
+         *
+         *  Set of insurance or healthcare party identifiers that prefer this financial institution.
+         */
         this.preferredFiiForPartners = [];
+        /**
+         *
+         *  The base64-encoded encrypted content.
+         */
         this.encryptedSelf = undefined;
         this.isEncrypted = true;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== true)

package/model/embed/FrontEndMigrationStatus.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *
+ *   Enumerates the possible statuses of a front-end migration process.
+ */
 export declare enum FrontEndMigrationStatus {
     Started = "Started",
     Paused = "Paused",

package/model/embed/FrontEndMigrationStatus.mjs

@@ -1,4 +1,9 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Enumerates the possible statuses of a front-end migration process.
+ */
 export var FrontEndMigrationStatus;
 (function (FrontEndMigrationStatus) {
     FrontEndMigrationStatus["Started"] = "Started";

package/model/embed/Gender.d.mts

@@ -1,3 +1,9 @@
+/**
+ *
+ *
+ *   Enumerates the possible gender values for a patient, including original gender, changed gender,
+ *  and unknown.
+ */
 export declare enum Gender {
     Male = "Male",
     Female = "Female",

package/model/embed/Gender.mjs

@@ -1,4 +1,10 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Enumerates the possible gender values for a patient, including original gender, changed gender,
+ *  and unknown.
+ */
 export var Gender;
 (function (Gender) {
     Gender["Male"] = "Male";

package/model/embed/GroupType.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *
+ *   Enumerates the types of groups in the system hierarchy: root, app, or database.
+ */
 export declare enum GroupType {
     Root = "Root",
     App = "App",

package/model/embed/GroupType.mjs

@@ -1,4 +1,9 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Enumerates the types of groups in the system hierarchy: root, app, or database.
+ */
 export var GroupType;
 (function (GroupType) {
     GroupType["Root"] = "Root";

package/model/embed/IdentityDocumentReader.d.mts

@@ -1,9 +1,39 @@
+/**
+ *
+ *  Represents information about how an identity document (such as a Belgian eID) was read,
+ *  including the document number, support serial number, and encoding details.
+ *  /
+ */
 export declare class IdentityDocumentReader {
+    /**
+     *
+     *  The justification document number.
+     */
     justificatifDocumentNumber: string | undefined;
+    /**
+     *
+     *  The serial number of the support used to read the document.
+     */
     supportSerialNumber: string | undefined;
+    /**
+     *
+     *  The timestamp (unix epoch in ms) when the eID document was read.
+     */
     timeReadingEIdDocument: number | undefined;
+    /**
+     *
+     *  The type of eID document support used.
+     */
     eidDocumentSupportType: number;
+    /**
+     *
+     *  The reason code for manual encoding, if applicable.
+     */
     reasonManualEncoding: number;
+    /**
+     *
+     *  The reason code for using a vignette, if applicable.
+     */
     reasonUsingVignette: number;
     constructor(partial: Partial<IdentityDocumentReader>);
     toJSON(): object;

package/model/embed/IdentityDocumentReader.mjs

@@ -1,12 +1,42 @@
 // auto-generated file
 import { expectNumber, expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
+/**
+ *
+ *  Represents information about how an identity document (such as a Belgian eID) was read,
+ *  including the document number, support serial number, and encoding details.
+ *  /
+ */
 export class IdentityDocumentReader {
     constructor(partial) {
+        /**
+         *
+         *  The justification document number.
+         */
         this.justificatifDocumentNumber = undefined;
+        /**
+         *
+         *  The serial number of the support used to read the document.
+         */
         this.supportSerialNumber = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) when the eID document was read.
+         */
         this.timeReadingEIdDocument = undefined;
+        /**
+         *
+         *  The type of eID document support used.
+         */
         this.eidDocumentSupportType = 0;
+        /**
+         *
+         *  The reason code for manual encoding, if applicable.
+         */
         this.reasonManualEncoding = 0;
+        /**
+         *
+         *  The reason code for using a vignette, if applicable.
+         */
         this.reasonUsingVignette = 0;
         if ('justificatifDocumentNumber' in partial)
             this.justificatifDocumentNumber = partial.justificatifDocumentNumber;

package/model/embed/InvoiceType.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *
+ *   Enumerates the types of invoices based on the recipient or billing channel.
+ */
 export declare enum InvoiceType {
     Patient = "Patient",
     Mutualfund = "Mutualfund",

package/model/embed/InvoiceType.mjs

@@ -1,4 +1,9 @@
 // auto-generated file
+/**
+ *
+ *
+ *   Enumerates the types of invoices based on the recipient or billing channel.
+ */
 export var InvoiceType;
 (function (InvoiceType) {
     InvoiceType["Patient"] = "Patient";