@icure/cardinal-sdk 2.10.2 → 2.11.0

package/api/PatientApi.d.mts

@@ -1,5 +1,6 @@
 import { FilterOptions, PaginatedListIterator, SortableFilterOptions } from '../cardinal-sdk-ts.mjs';
 import { EntityAccessInformation } from '../crypto/entities/EntityAccessInformation.mjs';
+import { PatientDelegateOptions } from '../crypto/entities/PatientDelegateOptions.mjs';
 import { PatientShareOptions } from '../crypto/entities/PatientShareOptions.mjs';
 import { ShareAllPatientDataOptions } from '../crypto/entities/ShareAllPatientDataOptions.mjs';
 import { EntityReferenceInGroup } from '../model/EntityReferenceInGroup.mjs';
@@ -80,6 +81,25 @@ export interface PatientApi {
         };
         alternateRootDelegateId?: string | undefined;
     }): Promise<DecryptedPatient>;
+    /**
+     *
+     *  Creates a new access log with initialized encryption metadata, specifying fine-grained options for each additional data owner that
+     *  will have access to the entity.
+     *  @param base a patient with initialized content and uninitialized encryption metadata. The result of this
+     *  method takes the content from [base] if provided.
+     *  @param user the current user, will be used for the auto-delegations if provided.
+     *  @param delegates additional data owners that will have access to the newly created entity. You may choose the
+     *  permissions that the delegates will have on the entity and if they will have access to the secretIds, encryptionKeys, and/or
+     *  owningEntityIds of the new entity.
+     *  @return a patient with initialized encryption metadata.
+     *  @throws IllegalArgumentException if base is not null and has a revision or has encryption metadata.
+     */
+    withEncryptionMetadataAndDelegates(base: DecryptedPatient | undefined, delegates: {
+        [key: string]: PatientDelegateOptions;
+    }, options?: {
+        user?: User | undefined;
+        alternateRootDelegateId?: string | undefined;
+    }): Promise<DecryptedPatient>;
     /**
      *
      *  Specifies if the current user has write access to a patient through delegations.

package/api/PatientInGroupApi.d.mts

@@ -1,5 +1,6 @@
 import { FilterOptions, PaginatedListIterator, SortableFilterOptions } from '../cardinal-sdk-ts.mjs';
 import { EntityAccessInformation } from '../crypto/entities/EntityAccessInformation.mjs';
+import { PatientDelegateOptions } from '../crypto/entities/PatientDelegateOptions.mjs';
 import { PatientShareOptions } from '../crypto/entities/PatientShareOptions.mjs';
 import { EntityReferenceInGroup } from '../model/EntityReferenceInGroup.mjs';
 import { GroupScoped } from '../model/GroupScoped.mjs';
@@ -52,6 +53,17 @@ export interface PatientInGroupApi {
         }, 'delegate'>;
         alternateRootDelegateReference?: EntityReferenceInGroup | undefined;
     }): Promise<GroupScoped<DecryptedPatient>>;
+    /**
+     *
+     *  In-group version of [PatientApi.withEncryptionMetadataAndDelegates]
+     */
+    withEncryptionMetadataAndDelegates(entityGroupId: string, base: DecryptedPatient | undefined, delegates: ArrayWithUniqueKeys<{
+        delegate: EntityReferenceInGroup;
+        delegateOptions: PatientDelegateOptions;
+    }, 'delegate'>, options?: {
+        user?: User | undefined;
+        alternateRootDelegateReference?: EntityReferenceInGroup | undefined;
+    }): Promise<GroupScoped<DecryptedPatient>>;
     /**
      *
      *  In-group version of [PatientApi.hasWriteAccess]

package/api/ReceiptApi.d.mts

@@ -1,3 +1,4 @@
+import { ReceiptDelegateOptions } from '../crypto/entities/ReceiptDelegateOptions.mjs';
 import { ReceiptShareOptions } from '../crypto/entities/ReceiptShareOptions.mjs';
 import { SecretIdUseOption } from '../crypto/entities/SecretIdUseOption.mjs';
 import { EntityReferenceInGroup } from '../model/EntityReferenceInGroup.mjs';
@@ -21,6 +22,13 @@ export interface ReceiptApi {
         secretId?: SecretIdUseOption;
         alternateRootDelegateId?: string | undefined;
     }): Promise<DecryptedReceipt>;
+    withEncryptionMetadataAndDelegates(base: DecryptedReceipt | undefined, patient: Patient | undefined, delegates: {
+        [key: string]: ReceiptDelegateOptions;
+    }, options?: {
+        user?: User | undefined;
+        secretId?: SecretIdUseOption;
+        alternateRootDelegateId?: string | undefined;
+    }): Promise<DecryptedReceipt>;
     getAndDecryptReceiptAttachment(receipt: Receipt, attachmentId: string): Promise<Int8Array>;
     encryptAndSetReceiptAttachment(receipt: Receipt, blobType: string, attachment: Int8Array): Promise<EncryptedReceipt>;
     getEncryptionKeysOf(receipt: Receipt): Promise<Array<HexString>>;
@@ -204,4 +212,19 @@ export interface ReceiptApi {
      */
     getReceipts(entityIds: Array<string>): Promise<Array<DecryptedReceipt>>;
     listByReference(reference: string): Promise<Array<DecryptedReceipt>>;
+    /**
+     *
+     *  Lists the receipts created within the provided date interval (based on the receipt `created`
+     *  timestamp, both bounds inclusive). A null bound leaves that side of the interval open.
+     *  Flavoured method.
+     *  @param startDate the start of the interval (inclusive), no lower bound if null
+     *  @param endDate the end of the interval (inclusive), no upper bound if null
+     *  @param descending whether to sort the result from the most recent to the oldest
+     *  @return the receipts created within the provided interval
+     */
+    listReceiptsBetweenDates(options?: {
+        startDate?: number | undefined;
+        endDate?: number | undefined;
+        descending?: boolean;
+    }): Promise<Array<DecryptedReceipt>>;
 }

package/api/ReceiptBasicApi.d.mts

@@ -156,4 +156,19 @@ export interface ReceiptBasicApi {
      */
     getReceipts(entityIds: Array<string>): Promise<Array<EncryptedReceipt>>;
     listByReference(reference: string): Promise<Array<EncryptedReceipt>>;
+    /**
+     *
+     *  Lists the receipts created within the provided date interval (based on the receipt `created`
+     *  timestamp, both bounds inclusive). A null bound leaves that side of the interval open.
+     *  Flavoured method.
+     *  @param startDate the start of the interval (inclusive), no lower bound if null
+     *  @param endDate the end of the interval (inclusive), no upper bound if null
+     *  @param descending whether to sort the result from the most recent to the oldest
+     *  @return the receipts created within the provided interval
+     */
+    listReceiptsBetweenDates(options?: {
+        startDate?: number | undefined;
+        endDate?: number | undefined;
+        descending?: boolean;
+    }): Promise<Array<EncryptedReceipt>>;
 }

package/api/ReceiptBasicInGroupApi.d.mts

@@ -42,6 +42,11 @@ export interface ReceiptBasicInGroupApi {
      *  In-group version of [ReceiptBasicFlavourlessApi.purgeReceipts]
      */
     purgeReceipts(receipts: Array<GroupScoped<Receipt>>): Promise<Array<GroupScoped<StoredDocumentIdentifier>>>;
+    /**
+     *
+     *  In-group version of [ReceiptBasicFlavourlessApi.getRawReceiptAttachment]
+     */
+    getRawReceiptAttachment(groupId: string, receiptId: string, attachmentId: string): Promise<Int8Array>;
     /**
      *
      *  In-group version of [ReceiptApi.createReceipt]
@@ -92,4 +97,13 @@ export interface ReceiptBasicInGroupApi {
      *  In-group version of [ReceiptBasicFlavouredApi.getReceipts]
      */
     getReceipts(groupId: string, entityIds: Array<string>): Promise<Array<GroupScoped<EncryptedReceipt>>>;
+    /**
+     *
+     *  In-group version of [ReceiptBasicFlavouredApi.listReceiptsBetweenDates]
+     */
+    listReceiptsBetweenDates(groupId: string, options?: {
+        startDate?: number | undefined;
+        endDate?: number | undefined;
+        descending?: boolean;
+    }): Promise<Array<GroupScoped<EncryptedReceipt>>>;
 }

package/api/ReceiptFlavouredApi.d.mts

@@ -109,4 +109,19 @@ export interface ReceiptFlavouredApi<E extends Receipt> {
      */
     getReceipts(entityIds: Array<string>): Promise<Array<E>>;
     listByReference(reference: string): Promise<Array<E>>;
+    /**
+     *
+     *  Lists the receipts created within the provided date interval (based on the receipt `created`
+     *  timestamp, both bounds inclusive). A null bound leaves that side of the interval open.
+     *  Flavoured method.
+     *  @param startDate the start of the interval (inclusive), no lower bound if null
+     *  @param endDate the end of the interval (inclusive), no upper bound if null
+     *  @param descending whether to sort the result from the most recent to the oldest
+     *  @return the receipts created within the provided interval
+     */
+    listReceiptsBetweenDates(options?: {
+        startDate?: number | undefined;
+        endDate?: number | undefined;
+        descending?: boolean;
+    }): Promise<Array<E>>;
 }

package/api/ReceiptFlavouredInGroupApi.d.mts

@@ -70,4 +70,13 @@ export interface ReceiptFlavouredInGroupApi<E extends Receipt> {
      *  In-group version of [ReceiptBasicFlavouredApi.getReceipts]
      */
     getReceipts(groupId: string, entityIds: Array<string>): Promise<Array<GroupScoped<E>>>;
+    /**
+     *
+     *  In-group version of [ReceiptBasicFlavouredApi.listReceiptsBetweenDates]
+     */
+    listReceiptsBetweenDates(groupId: string, options?: {
+        startDate?: number | undefined;
+        endDate?: number | undefined;
+        descending?: boolean;
+    }): Promise<Array<GroupScoped<E>>>;
 }

package/api/ReceiptInGroupApi.d.mts

@@ -1,3 +1,4 @@
+import { ReceiptDelegateOptions } from '../crypto/entities/ReceiptDelegateOptions.mjs';
 import { ReceiptShareOptions } from '../crypto/entities/ReceiptShareOptions.mjs';
 import { SecretIdUseOption } from '../crypto/entities/SecretIdUseOption.mjs';
 import { EntityReferenceInGroup } from '../model/EntityReferenceInGroup.mjs';
@@ -25,6 +26,17 @@ export interface ReceiptInGroupApi {
         secretId?: SecretIdUseOption;
         alternateRootDelegateId?: string | undefined;
     }): Promise<GroupScoped<DecryptedReceipt>>;
+    /**
+     *
+     *  In-group version of [ReceiptApi.withEncryptionMetadataAndDelegates]
+     */
+    withEncryptionMetadataAndDelegates(groupId: string, base: DecryptedReceipt | undefined, patient: GroupScoped<Patient> | undefined, delegates: {
+        [key: string]: ReceiptDelegateOptions;
+    }, options?: {
+        user?: User | undefined;
+        secretId?: SecretIdUseOption;
+        alternateRootDelegateId?: string | undefined;
+    }): Promise<GroupScoped<DecryptedReceipt>>;
     /**
      *
      *  In-group version of [ReceiptApi.getEncryptionKeysOf]
@@ -95,6 +107,11 @@ export interface ReceiptInGroupApi {
      *  In-group version of [ReceiptBasicFlavourlessApi.purgeReceipts]
      */
     purgeReceipts(receipts: Array<GroupScoped<Receipt>>): Promise<Array<GroupScoped<StoredDocumentIdentifier>>>;
+    /**
+     *
+     *  In-group version of [ReceiptBasicFlavourlessApi.getRawReceiptAttachment]
+     */
+    getRawReceiptAttachment(groupId: string, receiptId: string, attachmentId: string): Promise<Int8Array>;
     /**
      *
      *  In-group version of [ReceiptFlavouredApi.shareWith]
@@ -160,4 +177,13 @@ export interface ReceiptInGroupApi {
      *  In-group version of [ReceiptBasicFlavouredApi.getReceipts]
      */
     getReceipts(groupId: string, entityIds: Array<string>): Promise<Array<GroupScoped<DecryptedReceipt>>>;
+    /**
+     *
+     *  In-group version of [ReceiptBasicFlavouredApi.listReceiptsBetweenDates]
+     */
+    listReceiptsBetweenDates(groupId: string, options?: {
+        startDate?: number | undefined;
+        endDate?: number | undefined;
+        descending?: boolean;
+    }): Promise<Array<GroupScoped<DecryptedReceipt>>>;
 }

package/api/TopicApi.d.mts

@@ -1,5 +1,6 @@
 import { FilterOptions, PaginatedListIterator, SortableFilterOptions } from '../cardinal-sdk-ts.mjs';
 import { SecretIdUseOption } from '../crypto/entities/SecretIdUseOption.mjs';
+import { TopicDelegateOptions } from '../crypto/entities/TopicDelegateOptions.mjs';
 import { TopicShareOptions } from '../crypto/entities/TopicShareOptions.mjs';
 import { EntityReferenceInGroup } from '../model/EntityReferenceInGroup.mjs';
 import { Patient } from '../model/Patient.mjs';
@@ -39,6 +40,28 @@ export interface TopicApi {
         secretId?: SecretIdUseOption;
         alternateRootDelegateId?: string | undefined;
     }): Promise<DecryptedTopic>;
+    /**
+     *
+     *  Creates a new topic with initialized encryption metadata, specifying fine-grained options for each additional data owner that
+     *  will have access to the entity.
+     *  @param base a topic with initialized content and uninitialized encryption metadata. The result of this
+     *  method takes the content from [base] if provided.
+     *  @param patient the patient linked to the topic.
+     *  @param user the current user, will be used for the auto-delegations if provided.
+     *  @param delegates additional data owners that will have access to the newly created entity. You may choose the
+     *  permissions that the delegates will have on the entity and if they will have access to the secretIds, encryptionKeys, and/or
+     *  owningEntityIds of the new entity.
+     *  @param secretId specifies which secret id of [patient] to use for the new topic
+     *  @return a topic with initialized encryption metadata.
+     *  @throws IllegalArgumentException if base is not null and has a revision or has encryption metadata.
+     */
+    withEncryptionMetadataAndDelegates(base: DecryptedTopic | undefined, patient: Patient | undefined, delegates: {
+        [key: string]: TopicDelegateOptions;
+    }, options?: {
+        user?: User | undefined;
+        secretId?: SecretIdUseOption;
+        alternateRootDelegateId?: string | undefined;
+    }): Promise<DecryptedTopic>;
     /**
      *
      *  Attempts to extract the encryption keys of a topic. If the user does not have access to any encryption key

package/api/TopicInGroupApi.d.mts

@@ -1,5 +1,6 @@
 import { FilterOptions, PaginatedListIterator, SortableFilterOptions } from '../cardinal-sdk-ts.mjs';
 import { SecretIdUseOption } from '../crypto/entities/SecretIdUseOption.mjs';
+import { TopicDelegateOptions } from '../crypto/entities/TopicDelegateOptions.mjs';
 import { TopicShareOptions } from '../crypto/entities/TopicShareOptions.mjs';
 import { EntityReferenceInGroup } from '../model/EntityReferenceInGroup.mjs';
 import { GroupScoped } from '../model/GroupScoped.mjs';
@@ -26,6 +27,18 @@ export interface TopicInGroupApi {
         secretId?: SecretIdUseOption;
         alternateRootDelegateId?: string | undefined;
     }): Promise<GroupScoped<DecryptedTopic>>;
+    /**
+     *
+     *  In-group version of [TopicApi.withEncryptionMetadataAndDelegates]
+     */
+    withEncryptionMetadataAndDelegates(groupId: string, base: DecryptedTopic | undefined, patient: GroupScoped<Patient> | undefined, delegates: ArrayWithUniqueKeys<{
+        delegate: EntityReferenceInGroup;
+        delegateOptions: TopicDelegateOptions;
+    }, 'delegate'>, options?: {
+        user?: User | undefined;
+        secretId?: SecretIdUseOption;
+        alternateRootDelegateId?: string | undefined;
+    }): Promise<GroupScoped<DecryptedTopic>>;
     /**
      *
      *  In-group version of [TopicApi.getEncryptionKeysOf]

package/api/UserApi.d.mts

@@ -84,6 +84,16 @@ export interface UserApi {
      *  that is modifying the user tokens when performing the request.
      */
     modifyUserMobilePhone(userId: string, newMobilePhone: string, previousMobilePhone: string | undefined): Promise<User>;
+    /**
+     *
+     *  Removes a user mobile phone given its previous value, throwing a [RevisionConflictException] if the provided
+     *  [previousMobilePhone] does not match the stored value.
+     *
+     *  This method should be favored over a simple [modifyUser] when changing the MobilePhone as it does not require knowing
+     *  the revision of the user directly, and can work even if there is a [com.icure.cardinal.sdk.auth.services.SmartAuthProvider]
+     *  that is modifying the user tokens when performing the request.
+     */
+    removeUserMobilePhone(userId: string, previousMobilePhone: string | undefined): Promise<User>;
     /**
      *
      *  Deletes a user. If you don't have write access to the user the method will fail.

package/cardinal-sdk-ts.d.mts

@@ -237,25 +237,6 @@ export declare namespace InternalCalendarItemFiltersObj {
         }
     }
 }
-export declare abstract class InternalClassificationFiltersObj {
-    static readonly getInstance: () => typeof InternalClassificationFiltersObj.$metadata$.type;
-    private constructor();
-}
-export declare namespace InternalClassificationFiltersObj {
-    /** @deprecated $metadata$ is used for internal purposes, please don't use it in your code, because it can be removed at any moment */
-    namespace $metadata$ {
-        abstract class type extends KtSingleton<constructor>() {
-            private constructor();
-        }
-        abstract class constructor {
-            byPatientsCreatedForDataOwner(dataOwnerId: string, patients: Array<model.Patient>, options: any): SortableFilterOptions<model.Classification>;
-            byPatientsCreatedForSelf(patients: Array<model.Patient>, options: any): SortableFilterOptions<model.Classification>;
-            byPatientSecretIdsCreatedForDataOwner(dataOwnerId: string, secretIds: Array<string>, options: any): BaseSortableFilterOptions<model.Classification>;
-            byPatientSecretIdsCreatedForSelf(secretIds: Array<string>, options: any): SortableFilterOptions<model.Classification>;
-            private constructor();
-        }
-    }
-}
 export declare abstract class InternalCodeFiltersObj {
     static readonly getInstance: () => typeof InternalCodeFiltersObj.$metadata$.type;
     private constructor();