@icure/cardinal-sdk 2.4.4 → 2.6.0

package/model/Group.d.mts

@@ -26,7 +26,7 @@ export declare class Group implements StoredDocument, HasTags {
     rev: string | undefined;
     /**
      *
-     *  Hard delete (unix epoch in ms) timestamp of the object.
+     *  Soft delete (unix epoch in ms) timestamp of the object.
      */
     deletionDate: number | undefined;
     /**

package/model/Group.mjs

@@ -24,7 +24,7 @@ export class Group {
         this.rev = undefined;
         /**
          *
-         *  Hard delete (unix epoch in ms) timestamp of the object.
+         *  Soft delete (unix epoch in ms) timestamp of the object.
          */
         this.deletionDate = undefined;
         /**

package/model/Patient.d.mts

@@ -14,7 +14,7 @@ import { DecryptedFinancialInstitutionInformation, EncryptedFinancialInstitution
 import { Gender } from './embed/Gender.mjs';
 import { DecryptedInsurability, EncryptedInsurability, Insurability } from './embed/Insurability.mjs';
 import { DecryptedMedicalHouseContract, EncryptedMedicalHouseContract, MedicalHouseContract } from './embed/MedicalHouseContract.mjs';
-import { Partnership } from './embed/Partnership.mjs';
+import { DecryptedPartnership, EncryptedPartnership, Partnership } from './embed/Partnership.mjs';
 import { DecryptedPatientHealthCareParty, EncryptedPatientHealthCareParty, PatientHealthCareParty } from './embed/PatientHealthCareParty.mjs';
 import { PersonName } from './embed/PersonName.mjs';
 import { PersonalStatus } from './embed/PersonalStatus.mjs';
@@ -461,7 +461,7 @@ export declare class DecryptedPatient {
      *
      *  List of partners, or persons of contact.
      */
-    partnerships: Array<Partnership>;
+    partnerships: Array<DecryptedPartnership>;
     /**
      *
      *  Links between this patient and healthcare parties.
@@ -829,7 +829,7 @@ export declare class EncryptedPatient {
      *
      *  List of partners, or persons of contact.
      */
-    partnerships: Array<Partnership>;
+    partnerships: Array<EncryptedPartnership>;
     /**
      *
      *  Links between this patient and healthcare parties.

package/model/Patient.mjs

@@ -11,7 +11,7 @@ import { DecryptedFinancialInstitutionInformation, EncryptedFinancialInstitution
 import { Gender } from './embed/Gender.mjs';
 import { DecryptedInsurability, EncryptedInsurability } from './embed/Insurability.mjs';
 import { DecryptedMedicalHouseContract, EncryptedMedicalHouseContract } from './embed/MedicalHouseContract.mjs';
-import { Partnership } from './embed/Partnership.mjs';
+import { DecryptedPartnership, EncryptedPartnership } from './embed/Partnership.mjs';
 import { DecryptedPatientHealthCareParty, EncryptedPatientHealthCareParty } from './embed/PatientHealthCareParty.mjs';
 import { PersonName } from './embed/PersonName.mjs';
 import { PersonalStatus } from './embed/PersonalStatus.mjs';
@@ -652,7 +652,7 @@ export class DecryptedPatient {
             race: expectString(extractEntry(jCpy, 'race', false, path), true, [...path, ".race"]),
             ethnicity: expectString(extractEntry(jCpy, 'ethnicity', false, path), true, [...path, ".ethnicity"]),
             insurabilities: expectArray(extractEntry(jCpy, 'insurabilities', false, path), false, [...path, ".insurabilities"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, DecryptedInsurability.fromJSON)),
-            partnerships: expectArray(extractEntry(jCpy, 'partnerships', false, path), false, [...path, ".partnerships"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, Partnership.fromJSON)),
+            partnerships: expectArray(extractEntry(jCpy, 'partnerships', false, path), false, [...path, ".partnerships"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, DecryptedPartnership.fromJSON)),
             patientHealthCareParties: expectArray(extractEntry(jCpy, 'patientHealthCareParties', false, path), false, [...path, ".patientHealthCareParties"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, DecryptedPatientHealthCareParty.fromJSON)),
             financialInstitutionInformation: expectArray(extractEntry(jCpy, 'financialInstitutionInformation', false, path), false, [...path, ".financialInstitutionInformation"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, DecryptedFinancialInstitutionInformation.fromJSON)),
             medicalHouseContracts: expectArray(extractEntry(jCpy, 'medicalHouseContracts', false, path), false, [...path, ".medicalHouseContracts"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, DecryptedMedicalHouseContract.fromJSON)),
@@ -1318,7 +1318,7 @@ export class EncryptedPatient {
             race: expectString(extractEntry(jCpy, 'race', false, path), true, [...path, ".race"]),
             ethnicity: expectString(extractEntry(jCpy, 'ethnicity', false, path), true, [...path, ".ethnicity"]),
             insurabilities: expectArray(extractEntry(jCpy, 'insurabilities', false, path), false, [...path, ".insurabilities"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, EncryptedInsurability.fromJSON)),
-            partnerships: expectArray(extractEntry(jCpy, 'partnerships', false, path), false, [...path, ".partnerships"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, Partnership.fromJSON)),
+            partnerships: expectArray(extractEntry(jCpy, 'partnerships', false, path), false, [...path, ".partnerships"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, EncryptedPartnership.fromJSON)),
             patientHealthCareParties: expectArray(extractEntry(jCpy, 'patientHealthCareParties', false, path), false, [...path, ".patientHealthCareParties"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, EncryptedPatientHealthCareParty.fromJSON)),
             financialInstitutionInformation: expectArray(extractEntry(jCpy, 'financialInstitutionInformation', false, path), false, [...path, ".financialInstitutionInformation"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, EncryptedFinancialInstitutionInformation.fromJSON)),
             medicalHouseContracts: expectArray(extractEntry(jCpy, 'medicalHouseContracts', false, path), false, [...path, ".medicalHouseContracts"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, EncryptedMedicalHouseContract.fromJSON)),

package/model/Role.d.mts

@@ -1,16 +1,16 @@
 import { StoredDocument } from './base/StoredDocument.mjs';
 /**
  *
- *  The RoleDto class represents a role in the system, which can have permissions and can be
+ *
+ *   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
+ *   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 {
     /**
      *
-     *  The unique identifier of the role.
+     *  The unique identifier of the role. It is automatically set to <GROUP_ID>:<ROLE_NAME>
      */
     id: string;
     /**
@@ -25,12 +25,22 @@ export declare class Role implements StoredDocument {
     deletionDate: number | undefined;
     /**
      *
-     *  The name of the role.
+     *  The name of the role. It can only contain uppercase letters, numbers, and underscores for a max
+     *  length of 40 characters.
      */
     name: string | undefined;
     /**
      *
-     *  The maximum level of inheritance for this role, indicating how far
+     *  A short description for the role. It cannot exceed 300 characters.
+     */
+    description: string | undefined;
+    /**
+     *
+     *
+     *   Represents the levels in the descendant groups hierarchy where this role can be used. Eg:
+     *   - null: all the users in the descendants of the group can use this role.
+     *   - 0: only the users in the group can use this role.
+     *   - 1: only the users in the group and in its children groups can use this role.
      */
     inheritableUpTo: number | undefined;
     /**

package/model/Role.mjs

@@ -3,11 +3,11 @@ import { expectArray, expectNumber, expectString, extractEntry } from '../intern
 import { randomUuid } from '../utils/Id.mjs';
 /**
  *
- *  The RoleDto class represents a role in the system, which can have permissions and can be
+ *
+ *   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
+ *   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,12 +24,22 @@ export class Role {
         this.deletionDate = undefined;
         /**
          *
-         *  The name of the role.
+         *  The name of the role. It can only contain uppercase letters, numbers, and underscores for a max
+         *  length of 40 characters.
          */
         this.name = undefined;
         /**
          *
-         *  The maximum level of inheritance for this role, indicating how far
+         *  A short description for the role. It cannot exceed 300 characters.
+         */
+        this.description = undefined;
+        /**
+         *
+         *
+         *   Represents the levels in the descendant groups hierarchy where this role can be used. Eg:
+         *   - null: all the users in the descendants of the group can use this role.
+         *   - 0: only the users in the group can use this role.
+         *   - 1: only the users in the group and in its children groups can use this role.
          */
         this.inheritableUpTo = undefined;
         /**
@@ -45,6 +55,8 @@ export class Role {
             this.deletionDate = partial.deletionDate;
         if ('name' in partial)
             this.name = partial.name;
+        if ('description' in partial)
+            this.description = partial.description;
         if ('inheritableUpTo' in partial)
             this.inheritableUpTo = partial.inheritableUpTo;
         if ('permissions' in partial && partial.permissions !== undefined)
@@ -59,6 +71,8 @@ export class Role {
             res['deletionDate'] = this.deletionDate;
         if (this.name != undefined)
             res['name'] = this.name;
+        if (this.description != undefined)
+            res['description'] = this.description;
         if (this.inheritableUpTo != undefined)
             res['inheritableUpTo'] = this.inheritableUpTo;
         res['permissions'] = this.permissions.map((x0) => x0);
@@ -73,6 +87,7 @@ export class Role {
             rev: expectString(extractEntry(jCpy, 'rev', false, path), true, [...path, ".rev"]),
             deletionDate: expectNumber(extractEntry(jCpy, 'deletionDate', false, path), true, true, [...path, ".deletionDate"]),
             name: expectString(extractEntry(jCpy, 'name', false, path), true, [...path, ".name"]),
+            description: expectString(extractEntry(jCpy, 'description', false, path), true, [...path, ".description"]),
             inheritableUpTo: expectNumber(extractEntry(jCpy, 'inheritableUpTo', false, path), true, true, [...path, ".inheritableUpTo"]),
             permissions: expectArray(extractEntry(jCpy, 'permissions', false, path), false, [...path, ".permissions"], (x0, p0) => expectString(x0, false, p0)),
         });

package/model/User.d.mts

@@ -141,6 +141,12 @@ export declare namespace User {
         loginIdentifiers: Array<LoginIdentifier>;
         verifiedEmail: boolean | undefined;
         verifiedMobilePhone: boolean | undefined;
+        /**
+         *
+         *
+         *   True if the user has 2fa enabled for login with password
+         */
+        uses2fa: boolean | undefined;
         constructor(partial: Partial<SystemMetadata> & Pick<SystemMetadata, "roles" | "isAdmin" | "inheritsRoles">);
         toJSON(): object;
         static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): SystemMetadata;

package/model/User.mjs

@@ -251,6 +251,12 @@ export class User {
             this.loginIdentifiers = [];
             this.verifiedEmail = undefined;
             this.verifiedMobilePhone = undefined;
+            /**
+             *
+             *
+             *   True if the user has 2fa enabled for login with password
+             */
+            this.uses2fa = undefined;
             this.roles = partial.roles;
             this.isAdmin = partial.isAdmin;
             this.inheritsRoles = partial.inheritsRoles;
@@ -260,6 +266,8 @@ export class User {
                 this.verifiedEmail = partial.verifiedEmail;
             if ('verifiedMobilePhone' in partial)
                 this.verifiedMobilePhone = partial.verifiedMobilePhone;
+            if ('uses2fa' in partial)
+                this.uses2fa = partial.uses2fa;
         }
         toJSON() {
             const res = {};
@@ -271,6 +279,8 @@ export class User {
                 res['verifiedEmail'] = this.verifiedEmail;
             if (this.verifiedMobilePhone != undefined)
                 res['verifiedMobilePhone'] = this.verifiedMobilePhone;
+            if (this.uses2fa != undefined)
+                res['uses2fa'] = this.uses2fa;
             return res;
         }
         static fromJSON(json, ignoreUnknownKeys = false, path = ['SystemMetadata']) {
@@ -284,6 +294,7 @@ export class User {
                 loginIdentifiers: expectArray(extractEntry(jCpy, 'loginIdentifiers', false, path), false, [...path, ".loginIdentifiers"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, LoginIdentifier.fromJSON)),
                 verifiedEmail: expectBoolean(extractEntry(jCpy, 'verifiedEmail', false, path), true, [...path, ".verifiedEmail"]),
                 verifiedMobilePhone: expectBoolean(extractEntry(jCpy, 'verifiedMobilePhone', false, path), true, [...path, ".verifiedMobilePhone"]),
+                uses2fa: expectBoolean(extractEntry(jCpy, 'uses2fa', false, path), true, [...path, ".uses2fa"]),
             });
             if (!ignoreUnknownKeys) {
                 const unused = Object.keys(jCpy);

package/model/base/CryptoActor.mjs

@@ -8,10 +8,10 @@ export var CryptoActor;
     function fromJSON(json, ignoreUnknownKeys = false, path = ['CryptoActor']) {
         switch (json.$ktClass) {
             case 'com.icure.cardinal.sdk.model.Device': return Device.fromJSON(json, ignoreUnknownKeys);
-            case 'com.icure.cardinal.sdk.model.DecryptedPatient': return DecryptedPatient.fromJSON(json, ignoreUnknownKeys);
-            case 'com.icure.cardinal.sdk.model.EncryptedPatient': return EncryptedPatient.fromJSON(json, ignoreUnknownKeys);
-            case 'com.icure.cardinal.sdk.model.HealthcareParty': return HealthcareParty.fromJSON(json, ignoreUnknownKeys);
             case 'com.icure.cardinal.sdk.model.CryptoActorStub': return CryptoActorStub.fromJSON(json, ignoreUnknownKeys);
+            case 'com.icure.cardinal.sdk.model.HealthcareParty': return HealthcareParty.fromJSON(json, ignoreUnknownKeys);
+            case 'com.icure.cardinal.sdk.model.EncryptedPatient': return EncryptedPatient.fromJSON(json, ignoreUnknownKeys);
+            case 'com.icure.cardinal.sdk.model.DecryptedPatient': return DecryptedPatient.fromJSON(json, ignoreUnknownKeys);
             default: throw new Error('Unexpected discriminator for CryptoActor: ' + json.$ktClass);
         }
     }

package/model/embed/Partnership.d.mts

@@ -1,3 +1,5 @@
+import { Base64String } from '../specializations/Base64String.mjs';
+import { Encryptable } from './Encryptable.mjs';
 import { PartnershipStatus } from './PartnershipStatus.mjs';
 import { PartnershipType } from './PartnershipType.mjs';
 /**
@@ -6,7 +8,7 @@ import { PartnershipType } from './PartnershipType.mjs';
  *  patient).
  *  /
  */
-export declare class Partnership {
+export interface Partnership extends Encryptable {
     /**
      *
      *  The type of relationship (from CD-CONTACT-PERSON codes).
@@ -22,7 +24,62 @@ export declare class Partnership {
      *  The UUID of the contact person or patient in this relationship.
      */
     partnerId: string | undefined;
-    constructor(partial: Partial<Partnership>);
+    readonly isEncrypted: boolean;
     toJSON(): object;
-    static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): Partnership;
+}
+/**
+ *
+ *  Represents a relationship between a patient and another person (contact person or another
+ *  patient).
+ *  /
+ */
+export declare class DecryptedPartnership {
+    /**
+     *
+     *  The type of relationship (from CD-CONTACT-PERSON codes).
+     */
+    type: PartnershipType | undefined;
+    /**
+     *
+     *  The status of the relationship.
+     */
+    status: PartnershipStatus | undefined;
+    /**
+     *
+     *  The UUID of the contact person or patient in this relationship.
+     */
+    partnerId: string | undefined;
+    encryptedSelf: Base64String | undefined;
+    readonly isEncrypted: false;
+    constructor(partial: Partial<DecryptedPartnership>);
+    toJSON(): object;
+    static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): DecryptedPartnership;
+}
+/**
+ *
+ *  Represents a relationship between a patient and another person (contact person or another
+ *  patient).
+ *  /
+ */
+export declare class EncryptedPartnership {
+    /**
+     *
+     *  The type of relationship (from CD-CONTACT-PERSON codes).
+     */
+    type: PartnershipType | undefined;
+    /**
+     *
+     *  The status of the relationship.
+     */
+    status: PartnershipStatus | undefined;
+    /**
+     *
+     *  The UUID of the contact person or patient in this relationship.
+     */
+    partnerId: string | undefined;
+    encryptedSelf: Base64String | undefined;
+    readonly isEncrypted: true;
+    constructor(partial: Partial<EncryptedPartnership>);
+    toJSON(): object;
+    static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): EncryptedPartnership;
 }

package/model/embed/Partnership.mjs

@@ -8,7 +8,7 @@ import { PartnershipType } from './PartnershipType.mjs';
  *  patient).
  *  /
  */
-export class Partnership {
+export class DecryptedPartnership {
     constructor(partial) {
         /**
          *
@@ -25,12 +25,18 @@ export class Partnership {
          *  The UUID of the contact person or patient in this relationship.
          */
         this.partnerId = undefined;
+        this.encryptedSelf = undefined;
+        this.isEncrypted = false;
+        if (partial.isEncrypted !== undefined && partial.isEncrypted !== false)
+            throw new Error('partial.isEncrypted must be undefined or false');
         if ('type' in partial)
             this.type = partial.type;
         if ('status' in partial)
             this.status = partial.status;
         if ('partnerId' in partial)
             this.partnerId = partial.partnerId;
+        if ('encryptedSelf' in partial)
+            this.encryptedSelf = partial.encryptedSelf;
     }
     toJSON() {
         const res = {};
@@ -40,21 +46,96 @@ export class Partnership {
             res['status'] = this.status;
         if (this.partnerId != undefined)
             res['partnerId'] = this.partnerId;
+        if (this.encryptedSelf != undefined)
+            res['encryptedSelf'] = this.encryptedSelf;
+        res['isEncrypted'] = false;
         return res;
     }
-    static fromJSON(json, ignoreUnknownKeys = false, path = ['Partnership']) {
+    static fromJSON(json, ignoreUnknownKeys = false, path = ['DecryptedPartnership']) {
         if (typeof json != 'object')
             throw new Error(`Expected json object at path ${path.join("")}`);
         const jCpy = Object.assign({}, json);
-        const res = new Partnership({
+        if (extractEntry(jCpy, "isEncrypted", true, path) !== false)
+            throw new Error(`Unexpected value for ${path.join("")} isEncrypted marker, should be false. The provided json doesn't represent a DecryptedPartnership`);
+        const res = new DecryptedPartnership({
             type: expectStringEnum(extractEntry(jCpy, 'type', false, path), true, [...path, ".type"], PartnershipType, 'PartnershipType'),
             status: expectStringEnum(extractEntry(jCpy, 'status', false, path), true, [...path, ".status"], PartnershipStatus, 'PartnershipStatus'),
             partnerId: expectString(extractEntry(jCpy, 'partnerId', false, path), true, [...path, ".partnerId"]),
+            encryptedSelf: expectString(extractEntry(jCpy, 'encryptedSelf', false, path), true, [...path, ".encryptedSelf"]),
         });
         if (!ignoreUnknownKeys) {
             const unused = Object.keys(jCpy);
             if (unused.length > 0)
-                throw new Error(`Unexpected key(s) for json object Partnership at path ${path.join("")}: ${unused}`);
+                throw new Error(`Unexpected key(s) for json object DecryptedPartnership at path ${path.join("")}: ${unused}`);
+        }
+        return res;
+    }
+}
+/**
+ *
+ *  Represents a relationship between a patient and another person (contact person or another
+ *  patient).
+ *  /
+ */
+export class EncryptedPartnership {
+    constructor(partial) {
+        /**
+         *
+         *  The type of relationship (from CD-CONTACT-PERSON codes).
+         */
+        this.type = undefined;
+        /**
+         *
+         *  The status of the relationship.
+         */
+        this.status = undefined;
+        /**
+         *
+         *  The UUID of the contact person or patient in this relationship.
+         */
+        this.partnerId = undefined;
+        this.encryptedSelf = undefined;
+        this.isEncrypted = true;
+        if (partial.isEncrypted !== undefined && partial.isEncrypted !== true)
+            throw new Error('partial.isEncrypted must be undefined or true');
+        if ('type' in partial)
+            this.type = partial.type;
+        if ('status' in partial)
+            this.status = partial.status;
+        if ('partnerId' in partial)
+            this.partnerId = partial.partnerId;
+        if ('encryptedSelf' in partial)
+            this.encryptedSelf = partial.encryptedSelf;
+    }
+    toJSON() {
+        const res = {};
+        if (this.type != undefined)
+            res['type'] = this.type;
+        if (this.status != undefined)
+            res['status'] = this.status;
+        if (this.partnerId != undefined)
+            res['partnerId'] = this.partnerId;
+        if (this.encryptedSelf != undefined)
+            res['encryptedSelf'] = this.encryptedSelf;
+        res['isEncrypted'] = true;
+        return res;
+    }
+    static fromJSON(json, ignoreUnknownKeys = false, path = ['EncryptedPartnership']) {
+        if (typeof json != 'object')
+            throw new Error(`Expected json object at path ${path.join("")}`);
+        const jCpy = Object.assign({}, json);
+        if (extractEntry(jCpy, "isEncrypted", true, path) !== true)
+            throw new Error(`Unexpected value for ${path.join("")} isEncrypted marker, should be true. The provided json doesn't represent a EncryptedPartnership`);
+        const res = new EncryptedPartnership({
+            type: expectStringEnum(extractEntry(jCpy, 'type', false, path), true, [...path, ".type"], PartnershipType, 'PartnershipType'),
+            status: expectStringEnum(extractEntry(jCpy, 'status', false, path), true, [...path, ".status"], PartnershipStatus, 'PartnershipStatus'),
+            partnerId: expectString(extractEntry(jCpy, 'partnerId', false, path), true, [...path, ".partnerId"]),
+            encryptedSelf: expectString(extractEntry(jCpy, 'encryptedSelf', false, path), true, [...path, ".encryptedSelf"]),
+        });
+        if (!ignoreUnknownKeys) {
+            const unused = Object.keys(jCpy);
+            if (unused.length > 0)
+                throw new Error(`Unexpected key(s) for json object EncryptedPartnership at path ${path.join("")}: ${unused}`);
         }
         return res;
     }