@icure/cardinal-sdk 2.1.1 → 2.1.2

package/crypto/entities/AccessLogShareOptions.d.mts

@@ -4,6 +4,10 @@ import { ShareMetadataBehaviour } from './ShareMetadataBehaviour.mjs';
 export declare class AccessLogShareOptions {
     requestedPermissions: RequestedPermission;
     shareEncryptionKey: ShareMetadataBehaviour;
+    /**
+     *
+     *  Specifies if the id of the patient linked to the access log should be shared with the delegate
+     */
     sharePatientId: ShareMetadataBehaviour;
     shareSecretIds: SecretIdShareOptions;
     constructor(partial: Partial<AccessLogShareOptions>);

package/crypto/entities/AccessLogShareOptions.mjs

@@ -6,6 +6,10 @@ export class AccessLogShareOptions {
     constructor(partial) {
         this.requestedPermissions = RequestedPermission.MaxWrite;
         this.shareEncryptionKey = ShareMetadataBehaviour.IfAvailable;
+        /**
+         *
+         *  Specifies if the id of the patient linked to the access log should be shared with the delegate
+         */
         this.sharePatientId = ShareMetadataBehaviour.IfAvailable;
         this.shareSecretIds = new SecretIdShareOptions.AllAvailable({});
         if ('requestedPermissions' in partial && partial.requestedPermissions !== undefined)

package/crypto/entities/CalendarItemShareOptions.d.mts

@@ -4,6 +4,10 @@ import { ShareMetadataBehaviour } from './ShareMetadataBehaviour.mjs';
 export declare class CalendarItemShareOptions {
     requestedPermissions: RequestedPermission;
     shareEncryptionKey: ShareMetadataBehaviour;
+    /**
+     *
+     *  Specifies if the id of the patient linked to the calendar item should be shared with the delegate
+     */
     sharePatientId: ShareMetadataBehaviour;
     shareSecretIds: SecretIdShareOptions;
     constructor(partial: Partial<CalendarItemShareOptions>);

package/crypto/entities/CalendarItemShareOptions.mjs

@@ -6,6 +6,10 @@ export class CalendarItemShareOptions {
     constructor(partial) {
         this.requestedPermissions = RequestedPermission.MaxWrite;
         this.shareEncryptionKey = ShareMetadataBehaviour.IfAvailable;
+        /**
+         *
+         *  Specifies if the id of the patient linked to the calendar item should be shared with the delegate
+         */
         this.sharePatientId = ShareMetadataBehaviour.IfAvailable;
         this.shareSecretIds = new SecretIdShareOptions.AllAvailable({});
         if ('requestedPermissions' in partial && partial.requestedPermissions !== undefined)

package/crypto/entities/ClassificationShareOptions.d.mts

@@ -4,6 +4,10 @@ import { ShareMetadataBehaviour } from './ShareMetadataBehaviour.mjs';
 export declare class ClassificationShareOptions {
     requestedPermissions: RequestedPermission;
     shareEncryptionKey: ShareMetadataBehaviour;
+    /**
+     *
+     *  Specifies if the id of the patient linked to the classification should be shared with the delegate
+     */
     sharePatientId: ShareMetadataBehaviour;
     shareSecretIds: SecretIdShareOptions;
     constructor(partial: Partial<ClassificationShareOptions>);

package/crypto/entities/ClassificationShareOptions.mjs

@@ -6,6 +6,10 @@ export class ClassificationShareOptions {
     constructor(partial) {
         this.requestedPermissions = RequestedPermission.MaxWrite;
         this.shareEncryptionKey = ShareMetadataBehaviour.IfAvailable;
+        /**
+         *
+         *  Specifies if the id of the patient linked to the classification should be shared with the delegate
+         */
         this.sharePatientId = ShareMetadataBehaviour.IfAvailable;
         this.shareSecretIds = new SecretIdShareOptions.AllAvailable({});
         if ('requestedPermissions' in partial && partial.requestedPermissions !== undefined)

package/crypto/entities/ContactShareOptions.d.mts

@@ -4,6 +4,10 @@ import { ShareMetadataBehaviour } from './ShareMetadataBehaviour.mjs';
 export declare class ContactShareOptions {
     requestedPermissions: RequestedPermission;
     shareEncryptionKey: ShareMetadataBehaviour;
+    /**
+     *
+     *  Specifies if the id of the patient linked to the contact should be shared with the delegate
+     */
     sharePatientId: ShareMetadataBehaviour;
     shareSecretIds: SecretIdShareOptions;
     constructor(partial: Partial<ContactShareOptions>);

package/crypto/entities/ContactShareOptions.mjs

@@ -6,6 +6,10 @@ export class ContactShareOptions {
     constructor(partial) {
         this.requestedPermissions = RequestedPermission.MaxWrite;
         this.shareEncryptionKey = ShareMetadataBehaviour.IfAvailable;
+        /**
+         *
+         *  Specifies if the id of the patient linked to the contact should be shared with the delegate
+         */
         this.sharePatientId = ShareMetadataBehaviour.IfAvailable;
         this.shareSecretIds = new SecretIdShareOptions.AllAvailable({});
         if ('requestedPermissions' in partial && partial.requestedPermissions !== undefined)

package/crypto/entities/DocumentShareOptions.d.mts

@@ -4,6 +4,10 @@ import { ShareMetadataBehaviour } from './ShareMetadataBehaviour.mjs';
 export declare class DocumentShareOptions {
     requestedPermissions: RequestedPermission;
     shareEncryptionKey: ShareMetadataBehaviour;
+    /**
+     *
+     *  Specifies if the id of the message linked to the document (if any) should be shared with the delegate
+     */
     shareMessageId: ShareMetadataBehaviour;
     shareSecretIds: SecretIdShareOptions;
     constructor(partial: Partial<DocumentShareOptions>);

package/crypto/entities/DocumentShareOptions.mjs

@@ -6,6 +6,10 @@ export class DocumentShareOptions {
     constructor(partial) {
         this.requestedPermissions = RequestedPermission.MaxWrite;
         this.shareEncryptionKey = ShareMetadataBehaviour.IfAvailable;
+        /**
+         *
+         *  Specifies if the id of the message linked to the document (if any) should be shared with the delegate
+         */
         this.shareMessageId = ShareMetadataBehaviour.IfAvailable;
         this.shareSecretIds = new SecretIdShareOptions.AllAvailable({});
         if ('requestedPermissions' in partial && partial.requestedPermissions !== undefined)

package/crypto/entities/EntityAccessInformation.d.mts

@@ -1,11 +1,32 @@
 import { EntityReferenceInGroup } from '../../model/EntityReferenceInGroup.mjs';
 import { AccessLevel } from '../../model/embed/AccessLevel.mjs';
 import { ArrayWithUniqueKeys } from '../../utils/ArrayWithUniqueKeys.mjs';
+/**
+ *
+ *  Details on data owners with access to an entity
+ */
 export declare class EntityAccessInformation {
+    /**
+     *
+     *  The data owners with access to the entity, and the access level they have to the entity.
+     *
+     *  When not using intergroup sharing the [EntityReferenceInGroup.groupId] will always be null.
+     *
+     *  When using intergroup sharing the [EntityReferenceInGroup.groupId] is always represented in relation to the group
+     *  of the SDK used to get this information: if the SDK is working by default on `groupU` and you extract the access
+     *  information from an entity coming from `groupE` accessible to `dataOwnerA` in `groupU` and `dataOwnerB` in
+     *  `groupB` the keys will be `EntityReferenceInGroup(dataOwnerA, null)` and
+     *  `EntityReferenceInGroup(dataOwnerB, groupE)`.
+     */
     permissionsByDataOwnerId: ArrayWithUniqueKeys<{
         delegate: EntityReferenceInGroup;
         accessLevel: AccessLevel;
     }, 'delegate'>;
+    /**
+     *
+     *  True if the entity has been shared with anonymous data owners which couldn't be identified using the information
+     *  available to the instance of SDK used.
+     */
     hasUnknownAnonymousDataOwners: boolean;
     constructor(partial: Partial<EntityAccessInformation> & Pick<EntityAccessInformation, "permissionsByDataOwnerId" | "hasUnknownAnonymousDataOwners">);
 }

package/crypto/entities/EntityAccessInformation.mjs

@@ -1,3 +1,7 @@
+/**
+ *
+ *  Details on data owners with access to an entity
+ */
 export class EntityAccessInformation {
     constructor(partial) {
         this.permissionsByDataOwnerId = partial.permissionsByDataOwnerId;

package/crypto/entities/EntityWithEncryptionMetadataTypeName.d.mts

@@ -1,3 +1,9 @@
+/**
+ *
+ *  Types of encryptable entities, to support segregation of secure delegation keys.
+ *  These types do not include stubs and metadata entities (such as SecureDelegationKeyMap) since they use the actual
+ *  type of the related entity, and does not include services as they use the type of Contact.
+ */
 export declare enum EntityWithEncryptionMetadataTypeName {
     Article = "Article",
     AccessLog = "AccessLog",

package/crypto/entities/EntityWithEncryptionMetadataTypeName.mjs

@@ -1,4 +1,10 @@
 // auto-generated file
+/**
+ *
+ *  Types of encryptable entities, to support segregation of secure delegation keys.
+ *  These types do not include stubs and metadata entities (such as SecureDelegationKeyMap) since they use the actual
+ *  type of the related entity, and does not include services as they use the type of Contact.
+ */
 export var EntityWithEncryptionMetadataTypeName;
 (function (EntityWithEncryptionMetadataTypeName) {
     EntityWithEncryptionMetadataTypeName["Article"] = "Article";

package/crypto/entities/ExchangeDataInjectionDetails.d.mts

@@ -1,3 +1,7 @@
+/**
+ *
+ *  Data class representing the details required to inject exchange data.
+ */
 export declare class ExchangeDataInjectionDetails {
     exchangeDataId: string;
     accessControlSecret: Int8Array;

package/crypto/entities/ExchangeDataInjectionDetails.mjs

@@ -1,4 +1,8 @@
 // auto-generated file
+/**
+ *
+ *  Data class representing the details required to inject exchange data.
+ */
 export class ExchangeDataInjectionDetails {
     constructor(partial) {
         this.exchangeDataId = partial.exchangeDataId;

package/crypto/entities/FormShareOptions.d.mts

@@ -4,6 +4,10 @@ import { ShareMetadataBehaviour } from './ShareMetadataBehaviour.mjs';
 export declare class FormShareOptions {
     requestedPermissions: RequestedPermission;
     shareEncryptionKey: ShareMetadataBehaviour;
+    /**
+     *
+     *  Specifies if the id of the patient linked to the form should be shared with the delegate
+     */
     sharePatientId: ShareMetadataBehaviour;
     shareSecretIds: SecretIdShareOptions;
     constructor(partial: Partial<FormShareOptions>);

package/crypto/entities/FormShareOptions.mjs

@@ -6,6 +6,10 @@ export class FormShareOptions {
     constructor(partial) {
         this.requestedPermissions = RequestedPermission.MaxWrite;
         this.shareEncryptionKey = ShareMetadataBehaviour.IfAvailable;
+        /**
+         *
+         *  Specifies if the id of the patient linked to the form should be shared with the delegate
+         */
         this.sharePatientId = ShareMetadataBehaviour.IfAvailable;
         this.shareSecretIds = new SecretIdShareOptions.AllAvailable({});
         if ('requestedPermissions' in partial && partial.requestedPermissions !== undefined)

package/crypto/entities/HealthElementShareOptions.d.mts

@@ -4,6 +4,10 @@ import { ShareMetadataBehaviour } from './ShareMetadataBehaviour.mjs';
 export declare class HealthElementShareOptions {
     requestedPermissions: RequestedPermission;
     shareEncryptionKey: ShareMetadataBehaviour;
+    /**
+     *
+     *  Specifies if the id of the patient linked to the health element should be shared with the delegate
+     */
     sharePatientId: ShareMetadataBehaviour;
     shareSecretIds: SecretIdShareOptions;
     constructor(partial: Partial<HealthElementShareOptions>);

package/crypto/entities/HealthElementShareOptions.mjs

@@ -6,6 +6,10 @@ export class HealthElementShareOptions {
     constructor(partial) {
         this.requestedPermissions = RequestedPermission.MaxWrite;
         this.shareEncryptionKey = ShareMetadataBehaviour.IfAvailable;
+        /**
+         *
+         *  Specifies if the id of the patient linked to the health element should be shared with the delegate
+         */
         this.sharePatientId = ShareMetadataBehaviour.IfAvailable;
         this.shareSecretIds = new SecretIdShareOptions.AllAvailable({});
         if ('requestedPermissions' in partial && partial.requestedPermissions !== undefined)

package/crypto/entities/InvoiceShareOptions.d.mts

@@ -4,6 +4,10 @@ import { ShareMetadataBehaviour } from './ShareMetadataBehaviour.mjs';
 export declare class InvoiceShareOptions {
     requestedPermissions: RequestedPermission;
     shareEncryptionKey: ShareMetadataBehaviour;
+    /**
+     *
+     *  Specifies if the id of the patient linked to the invoice should be shared with the delegate
+     */
     sharePatientId: ShareMetadataBehaviour;
     shareSecretIds: SecretIdShareOptions;
     constructor(partial: Partial<InvoiceShareOptions>);

package/crypto/entities/InvoiceShareOptions.mjs

@@ -6,6 +6,10 @@ export class InvoiceShareOptions {
     constructor(partial) {
         this.requestedPermissions = RequestedPermission.MaxWrite;
         this.shareEncryptionKey = ShareMetadataBehaviour.IfAvailable;
+        /**
+         *
+         *  Specifies if the id of the patient linked to the invoice should be shared with the delegate
+         */
         this.sharePatientId = ShareMetadataBehaviour.IfAvailable;
         this.shareSecretIds = new SecretIdShareOptions.AllAvailable({});
         if ('requestedPermissions' in partial && partial.requestedPermissions !== undefined)

package/crypto/entities/MessageShareOptions.d.mts

@@ -4,6 +4,10 @@ import { ShareMetadataBehaviour } from './ShareMetadataBehaviour.mjs';
 export declare class MessageShareOptions {
     requestedPermissions: RequestedPermission;
     shareEncryptionKey: ShareMetadataBehaviour;
+    /**
+     *
+     *  Specifies if the id of the patient linked to the message should be shared with the delegate
+     */
     sharePatientId: ShareMetadataBehaviour;
     shareSecretIds: SecretIdShareOptions;
     constructor(partial: Partial<MessageShareOptions>);

package/crypto/entities/MessageShareOptions.mjs

@@ -6,6 +6,10 @@ export class MessageShareOptions {
     constructor(partial) {
         this.requestedPermissions = RequestedPermission.MaxWrite;
         this.shareEncryptionKey = ShareMetadataBehaviour.IfAvailable;
+        /**
+         *
+         *  Specifies if the id of the patient linked to the message should be shared with the delegate
+         */
         this.sharePatientId = ShareMetadataBehaviour.IfAvailable;
         this.shareSecretIds = new SecretIdShareOptions.AllAvailable({});
         if ('requestedPermissions' in partial && partial.requestedPermissions !== undefined)

package/crypto/entities/RawDecryptedExchangeData.d.mts

@@ -1,3 +1,11 @@
+/**
+ *
+ *  The raw decrypted content of an exchange data.
+ *  @param exchangeDataId the id of the exchange data.
+ *  @param exchangeKey the raw exchange key of the exchange data.
+ *  @param accessControlSecret the raw access control secret of the exchange data.
+ *  @param sharedSignatureKey the raw shared signature key of the exchange data.
+ */
 export declare class RawDecryptedExchangeData {
     exchangeDataId: string;
     exchangeKey: Int8Array;

package/crypto/entities/RawDecryptedExchangeData.mjs

@@ -1,4 +1,12 @@
 // auto-generated file
+/**
+ *
+ *  The raw decrypted content of an exchange data.
+ *  @param exchangeDataId the id of the exchange data.
+ *  @param exchangeKey the raw exchange key of the exchange data.
+ *  @param accessControlSecret the raw access control secret of the exchange data.
+ *  @param sharedSignatureKey the raw shared signature key of the exchange data.
+ */
 export class RawDecryptedExchangeData {
     constructor(partial) {
         this.exchangeDataId = partial.exchangeDataId;

package/crypto/entities/RecoveryKeyOptions.d.mts

@@ -1,12 +1,25 @@
 import { RecoveryDataKey } from './RecoveryDataKey.mjs';
 import { RecoveryKeySize } from './RecoveryKeySize.mjs';
+/**
+ *
+ *  Allows to configure which recovery key to use when creating recovery data.
+ */
 export type RecoveryKeyOptions = RecoveryKeyOptions.Generate | RecoveryKeyOptions.Use;
 export declare namespace RecoveryKeyOptions {
+    /**
+     *
+     *  Generate a new key for the recovery data. This is the default behavior, and should be used in most cases.
+     *  @param recoveryKeySize specifies the size of the recovery key to generate
+     */
     class Generate {
         recoveryKeySize: RecoveryKeySize;
         readonly $ktClass: 'com.icure.cardinal.sdk.crypto.entities.RecoveryKeyOptions.Generate';
         constructor(partial: Partial<Generate> & Pick<Generate, "recoveryKeySize">);
     }
+    /**
+     *
+     *  Specifies to use a pre-created recovery key.
+     */
     class Use {
         key: RecoveryDataKey;
         readonly $ktClass: 'com.icure.cardinal.sdk.crypto.entities.RecoveryKeyOptions.Use';

package/crypto/entities/RecoveryKeyOptions.mjs

@@ -1,5 +1,10 @@
 export var RecoveryKeyOptions;
 (function (RecoveryKeyOptions) {
+    /**
+     *
+     *  Generate a new key for the recovery data. This is the default behavior, and should be used in most cases.
+     *  @param recoveryKeySize specifies the size of the recovery key to generate
+     */
     class Generate {
         constructor(partial) {
             this.$ktClass = 'com.icure.cardinal.sdk.crypto.entities.RecoveryKeyOptions.Generate';
@@ -7,6 +12,10 @@ export var RecoveryKeyOptions;
         }
     }
     RecoveryKeyOptions.Generate = Generate;
+    /**
+     *
+     *  Specifies to use a pre-created recovery key.
+     */
     class Use {
         constructor(partial) {
             this.$ktClass = 'com.icure.cardinal.sdk.crypto.entities.RecoveryKeyOptions.Use';

package/crypto/entities/RecoveryKeySize.d.mts

@@ -1,3 +1,7 @@
+/**
+ *
+ *  Possible sizes for a recovery key.
+ */
 export declare enum RecoveryKeySize {
     Bytes16 = "Bytes16",
     Bytes32 = "Bytes32"

package/crypto/entities/RecoveryKeySize.mjs

@@ -1,4 +1,8 @@
 // auto-generated file
+/**
+ *
+ *  Possible sizes for a recovery key.
+ */
 export var RecoveryKeySize;
 (function (RecoveryKeySize) {
     RecoveryKeySize["Bytes16"] = "Bytes16";

package/crypto/entities/SecretIdShareOptions.d.mts

@@ -1,10 +1,29 @@
+/**
+ *
+ *  Configure how secret ids should be shared
+ */
 export type SecretIdShareOptions = SecretIdShareOptions.AllAvailable | SecretIdShareOptions.UseExactly;
 export declare namespace SecretIdShareOptions {
+    /**
+     *
+     *  Share all available secret ids
+     *  @param requireAtLeastOne if true the sharing will fail if the current user can't access any secret id of the entity
+     */
     class AllAvailable {
         requireAtLeastOne: boolean;
         readonly $ktClass: 'com.icure.cardinal.sdk.crypto.entities.SecretIdShareOptions.AllAvailable';
         constructor(partial: Partial<AllAvailable>);
     }
+    /**
+     *
+     *  Share exactly the provided secret ids.
+     *  In case any of the provided secret ids is not known by the SDK (the current user can't extract that secret id
+     *  from the entity):
+     *  - If createUnknownSecretIds is false the sharing will fail
+     *  - If createUnknownSecretIds is true the method will ignore unknown entries, effectively creating new secret ids.
+     *  @param secretIds the secret ids that will be shared.
+     *  @param createUnknownSecretIds true if unknown secret ids can be used
+     */
     class UseExactly {
         secretIds: Array<string>;
         createUnknownSecretIds: boolean;

package/crypto/entities/SecretIdShareOptions.mjs

@@ -1,6 +1,11 @@
 // auto-generated file
 export var SecretIdShareOptions;
 (function (SecretIdShareOptions) {
+    /**
+     *
+     *  Share all available secret ids
+     *  @param requireAtLeastOne if true the sharing will fail if the current user can't access any secret id of the entity
+     */
     class AllAvailable {
         constructor(partial) {
             this.requireAtLeastOne = false;
@@ -10,6 +15,16 @@ export var SecretIdShareOptions;
         }
     }
     SecretIdShareOptions.AllAvailable = AllAvailable;
+    /**
+     *
+     *  Share exactly the provided secret ids.
+     *  In case any of the provided secret ids is not known by the SDK (the current user can't extract that secret id
+     *  from the entity):
+     *  - If createUnknownSecretIds is false the sharing will fail
+     *  - If createUnknownSecretIds is true the method will ignore unknown entries, effectively creating new secret ids.
+     *  @param secretIds the secret ids that will be shared.
+     *  @param createUnknownSecretIds true if unknown secret ids can be used
+     */
     class UseExactly {
         constructor(partial) {
             this.$ktClass = 'com.icure.cardinal.sdk.crypto.entities.SecretIdShareOptions.UseExactly';

package/crypto/entities/SecretIdUseOption.d.mts

@@ -1,3 +1,8 @@
+/**
+ *
+ *  Configuration for which secret id to use for linking to a owning entity (e.g. which secret id of patient to use
+ *  when linking a contact to the patient)
+ */
 export type SecretIdUseOption = typeof SecretIdUseOption.UseAnyConfidential | typeof SecretIdUseOption.UseAllConfidential | typeof SecretIdUseOption.UseAnySharedWithParent | typeof SecretIdUseOption.UseAllSharedWithParent | SecretIdUseOption.Use | typeof SecretIdUseOption.UseNone;
 export declare namespace SecretIdUseOption {
     const UseAnyConfidential: {
@@ -12,6 +17,12 @@ export declare namespace SecretIdUseOption {
     const UseAllSharedWithParent: {
         readonly $ktClass: 'com.icure.cardinal.sdk.crypto.entities.SecretIdUseOption.UseAllSharedWithParent';
     };
+    /**
+     *
+     *  Specify explicitly which secret ids to use. The secretIds can also be empty, in which case the value is
+     *  equivalent to [UseNone].
+     *  Note that the SDK will not check that the secret id you used is actually a secret id of the owning entity.
+     */
     class Use {
         secretIds: Array<string>;
         readonly $ktClass: 'com.icure.cardinal.sdk.crypto.entities.SecretIdUseOption.Use';

package/crypto/entities/SecretIdUseOption.mjs

@@ -13,6 +13,12 @@ export var SecretIdUseOption;
     SecretIdUseOption.UseAllSharedWithParent = {
         $ktClass: 'com.icure.cardinal.sdk.crypto.entities.SecretIdUseOption.UseAllSharedWithParent'
     };
+    /**
+     *
+     *  Specify explicitly which secret ids to use. The secretIds can also be empty, in which case the value is
+     *  equivalent to [UseNone].
+     *  Note that the SDK will not check that the secret id you used is actually a secret id of the owning entity.
+     */
     class Use {
         constructor(partial) {
             this.$ktClass = 'com.icure.cardinal.sdk.crypto.entities.SecretIdUseOption.Use';

package/crypto/entities/ShamirUpdateRequest.d.mts

@@ -1,5 +1,17 @@
+/**
+ *
+ *  Information on how to update the splits for a specific key.
+ */
 export declare class ShamirUpdateRequest {
+    /**
+     *
+     *  The ids of the data owners which will hold a copy of the key part.
+     */
     notariesIds: Array<string>;
+    /**
+     *
+     *  The minimum number of shares required to reconstruct the key.
+     */
     minShares: number;
     constructor(partial: Partial<ShamirUpdateRequest> & Pick<ShamirUpdateRequest, "notariesIds" | "minShares">);
 }

package/crypto/entities/ShamirUpdateRequest.mjs

@@ -1,4 +1,8 @@
 // auto-generated file
+/**
+ *
+ *  Information on how to update the splits for a specific key.
+ */
 export class ShamirUpdateRequest {
     constructor(partial) {
         this.notariesIds = partial.notariesIds;

package/crypto/entities/ShareAllPatientDataOptions.d.mts

@@ -2,6 +2,10 @@ import { EncryptedPatient } from '../../model/Patient.mjs';
 import { FailedRequestDetails } from './FailedRequestDetails.mjs';
 import { ShareAllPatientDataOptions as ShareAllPatientDataOptions_ } from './ShareAllPatientDataOptions.mjs';
 export declare namespace ShareAllPatientDataOptions {
+    /**
+     *
+     *  Specifies which entities related to a Patient will be shared by [PatientApi.shareAllDataOfPatient].
+     */
     enum Tag {
         All = "All",
         MedicalInformation = "MedicalInformation",

package/crypto/entities/ShareAllPatientDataOptions.mjs

@@ -1,5 +1,9 @@
 export var ShareAllPatientDataOptions;
 (function (ShareAllPatientDataOptions) {
+    /**
+     *
+     *  Specifies which entities related to a Patient will be shared by [PatientApi.shareAllDataOfPatient].
+     */
     let Tag;
     (function (Tag) {
         Tag["All"] = "All";

package/crypto/entities/ShareMetadataBehaviour.d.mts

@@ -1,3 +1,7 @@
+/**
+ *
+ *  Specifies a behaviour for the sharing of encryption keys or owning entity ids in the extended apis 'share' methods.
+ */
 export declare enum ShareMetadataBehaviour {
     Required = "Required",
     IfAvailable = "IfAvailable",

package/crypto/entities/ShareMetadataBehaviour.mjs

@@ -1,4 +1,8 @@
 // auto-generated file
+/**
+ *
+ *  Specifies a behaviour for the sharing of encryption keys or owning entity ids in the extended apis 'share' methods.
+ */
 export var ShareMetadataBehaviour;
 (function (ShareMetadataBehaviour) {
     ShareMetadataBehaviour["Required"] = "Required";

package/crypto/entities/TopicShareOptions.d.mts

@@ -4,6 +4,10 @@ import { ShareMetadataBehaviour } from './ShareMetadataBehaviour.mjs';
 export declare class TopicShareOptions {
     requestedPermissions: RequestedPermission;
     shareEncryptionKey: ShareMetadataBehaviour;
+    /**
+     *
+     *  Specifies if the id of the patient linked to the topic should be shared with the delegate
+     */
     sharePatientId: ShareMetadataBehaviour;
     shareSecretIds: SecretIdShareOptions;
     constructor(partial: Partial<TopicShareOptions>);

package/crypto/entities/TopicShareOptions.mjs

@@ -6,6 +6,10 @@ export class TopicShareOptions {
     constructor(partial) {
         this.requestedPermissions = RequestedPermission.MaxWrite;
         this.shareEncryptionKey = ShareMetadataBehaviour.IfAvailable;
+        /**
+         *
+         *  Specifies if the id of the patient linked to the topic should be shared with the delegate
+         */
         this.sharePatientId = ShareMetadataBehaviour.IfAvailable;
         this.shareSecretIds = new SecretIdShareOptions.AllAvailable({});
         if ('requestedPermissions' in partial && partial.requestedPermissions !== undefined)