@icure/cardinal-sdk 2.1.1 → 2.1.3

package/filters/DocumentFilters.d.mts

@@ -6,36 +6,158 @@ import { Message } from '../model/Message.mjs';
 import { Patient } from '../model/Patient.mjs';
 import { DocumentType } from '../model/embed/DocumentType.mjs';
 interface DocumentFiltersFactory {
+    /**
+     *
+     *  Options for document filtering which match all documents shared directly (i.e. ignoring hierarchies) with a specific data owner
+     *  that are linked with one of the provided patients.
+     *  This Options also allows to restrict the documents based on [Document.created]:
+     *  - if the [from] is not null, only the documents where [Document.created] is greater than or equal to [from] will be returned.
+     *  - if the [to] is not null, only the documents where [Document.created] is less than or equal to [to] will be returned.
+     *
+     *  When using these options the sdk will automatically extract the secret ids from the provided patients and use
+     *  those for filtering.
+     *  If you already have the secret ids of the patient you may instead use [byOwningEntitySecretIdsCreatedForDataOwner].
+     *  If the current data owner does not have access to any secret id of one of the provide patients the patient will
+     *  simply be ignored.
+     *  Note that these may not be used in methods of apis from [CardinalBaseApis].
+     *
+     *  These options are sortable. When sorting using these options the documents will be sorted by [Document.created] in ascending or
+     *  descending order according to the value of the [descending] parameter.
+     *
+     *  @param dataOwnerId a data owner id
+     *  @param patients a list of patients.
+     *  @param from the minimum value for [Document.created] (default: no limit).
+     *  @param to the maximum value for [Document.created] (default: no limit).
+     *  @param descending whether to sort the result in descending or ascending order by [Document.created] (default: ascending).
+     */
     byPatientsCreatedForDataOwner(dataOwnerId: string, patients: Array<Patient>, options?: {
         from?: number | undefined;
         to?: number | undefined;
         descending?: boolean;
     }): SortableFilterOptions<Document>;
+    /**
+     *
+     *  In group version of [byPatientsCreatedForDataOwner].
+     */
     byPatientsCreatedForDataOwnerInGroup(dataOwner: EntityReferenceInGroup, patients: Array<GroupScoped<Patient>>, options?: {
         from?: number | undefined;
         to?: number | undefined;
         descending?: boolean;
     }): SortableFilterOptions<Document>;
+    /**
+     *
+     *  Options for document filtering which match all documents shared directly (i.e. ignoring hierarchies) with a specific data owner
+     *  that are linked with one of the provided messages.
+     *  This Options also allows to restrict the documents based on [Document.created]:
+     *  - if the [from] is not null, only the documents where [Document.created] is greater than or equal to [from] will be returned.
+     *  - if the [to] is not null, only the documents where [Document.created] is less than or equal to [to] will be returned.
+     *
+     *  When using these options the sdk will automatically extract the secret ids from the provided patients and use
+     *  those for filtering.
+     *  If you already have the secret ids of the message you may instead use [byOwningEntitySecretIdsCreatedForDataOwner].
+     *  If the current data owner does not have access to any secret id of one of the provided messages the message will
+     *  simply be ignored.
+     *  Note that these may not be used in methods of apis from [CardinalBaseApis].
+     *
+     *  These options are sortable. When sorting using these options the documents will be sorted by [Document.created] in ascending or
+     *  descending order according to the value of the [descending] parameter.
+     *
+     *  @param dataOwnerId a data owner id
+     *  @param messages a list of messages.
+     *  @param from the minimum value for [Document.created] (default: no limit).
+     *  @param to the maximum value for [Document.created] (default: no limit).
+     *  @param descending whether to sort the result in descending or ascending order by [Document.created] (default: ascending).
+     */
     byMessagesCreatedForDataOwner(dataOwnerId: string, messages: Array<Message>, options?: {
         from?: number | undefined;
         to?: number | undefined;
         descending?: boolean;
     }): SortableFilterOptions<Document>;
+    /**
+     *
+     *  In group version of [byMessagesCreatedForDataOwner].
+     */
     byMessagesCreatedForDataOwnerInGroup(dataOwner: EntityReferenceInGroup, messages: Array<GroupScoped<Message>>, options?: {
         from?: number | undefined;
         to?: number | undefined;
         descending?: boolean;
     }): SortableFilterOptions<Document>;
+    /**
+     *
+     *  Options for document filtering which match all documents shared directly (i.e. ignoring hierarchies) with the current data owner
+     *  that are linked with one of the provided patients.
+     *  This Options also allows to restrict the documents based on [Document.created]:
+     *  - if the [from] is not null, only the documents where [Document.created] is greater than or equal to [from] will be returned.
+     *  - if the [to] is not null, only the documents where [Document.created] is less than or equal to [to] will be returned.
+     *
+     *  When using these options the sdk will automatically extract the secret ids from the provided patients and use
+     *  those for filtering.
+     *  If you already have the secret ids of the patient you may instead use [byOwningEntitySecretIdsCreatedForSelf].
+     *  If the current data owner does not have access to any secret id of one of the provide patients the patient will
+     *  simply be ignored.
+     *  Note that these may not be used in methods of apis from [CardinalBaseApis].
+     *
+     *  These options are sortable. When sorting using these options the documents will be sorted by [Document.created] in ascending or
+     *  descending order according to the value of the [descending] parameter.
+     *
+     *  @param patients a list of patients.
+     *  @param from the minimum value for [Document.created] (default: no limit).
+     *  @param to the maximum value for [Document.created] (default: no limit).
+     *  @param descending whether to sort the result in descending or ascending order by [Document.created] (default: ascending).
+     */
     byPatientsCreatedForSelf(patients: Array<Patient>, options?: {
         from?: number | undefined;
         to?: number | undefined;
         descending?: boolean;
     }): SortableFilterOptions<Document>;
+    /**
+     *
+     *  Options for document filtering which match all documents shared directly (i.e. ignoring hierarchies) with the current data owner
+     *  that are linked with one of the provided messages.
+     *  This Options also allows to restrict the documents based on [Document.created]:
+     *  - if the [from] is not null, only the documents where [Document.created] is greater than or equal to [from] will be returned.
+     *  - if the [to] is not null, only the documents where [Document.created] is less than or equal to [to] will be returned.
+     *
+     *  When using these options the sdk will automatically extract the secret ids from the provided messages and use
+     *  those for filtering.
+     *  If you already have the secret ids of the message you may instead use [byOwningEntitySecretIdsCreatedForSelf].
+     *  If the current data owner does not have access to any secret id of one of the provided messages the message will
+     *  simply be ignored.
+     *  Note that these may not be used in methods of apis from [CardinalBaseApis].
+     *
+     *  These options are sortable. When sorting using these options the documents will be sorted by [Document.created] in ascending or
+     *  descending order according to the value of the [descending] parameter.
+     *
+     *  @param messages a list of messages.
+     *  @param from the minimum value for [Document.created] (default: no limit).
+     *  @param to the maximum value for [Document.created] (default: no limit).
+     *  @param descending whether to sort the result in descending or ascending order by [Document.created] (default: ascending).
+     */
     byMessagesCreatedForSelf(messages: Array<Message>, options?: {
         from?: number | undefined;
         to?: number | undefined;
         descending?: boolean;
     }): SortableFilterOptions<Document>;
+    /**
+     *
+     *  Options for document filtering which match all documents shared directly (i.e. ignoring hierarchies) with a specific owner
+     *  that are linked with one of the provided patients through one of the provided secret ids.
+     *  This Options also allows to restrict the documents based on [Document.created]:
+     *  - if the [from] is not null, only the documents where [Document.created] is greater than or equal to [from] will be returned.
+     *  - if the [to] is not null, only the documents where [Document.created] is less than or equal to [to] will be returned.
+     *
+     *  If the current data owner does not have access to any secret id of one of the provide patients the patient will
+     *  simply be ignored.
+     *
+     *  These options are sortable. When sorting using these options the documents will be sorted by [Document.created] in ascending or
+     *  descending order according to the value of the [descending] parameter.
+     *
+     *  @param dataOwnerId the id of a data owner.
+     *  @param secretIds a list of patient secret ids.
+     *  @param from the minimum value for [Document.created] (default: no limit).
+     *  @param to the maximum value for [Document.created] (default: no limit).
+     *  @param descending whether to sort the result in descending or ascending order by [Document.created] (default: ascending).
+     */
     byOwningEntitySecretIdsCreatedForDataOwner(dataOwnerId: string, secretIds: Array<string>, options?: {
         from?: number | undefined;
         to?: number | undefined;
@@ -46,35 +168,209 @@ interface DocumentFiltersFactory {
         to?: number | undefined;
         descending?: boolean;
     }): BaseSortableFilterOptions<Document>;
+    /**
+     *
+     *  Options for document filtering which match all documents shared directly (i.e. ignoring hierarchies) with the current data owner
+     *  that are linked with one of the provided owning entities through one of the provided secret ids.
+     *  This Options also allows to restrict the documents based on [Document.created]:
+     *  - if the [from] is not null, only the documents where [Document.created] is greater than or equal to [from] will be returned.
+     *  - if the [to] is not null, only the documents where [Document.created] is less than or equal to [to] will be returned.
+     *
+     *  If the current data owner does not have access to any secret id of one of the provide owning entities the owning entity will
+     *  simply be ignored.
+     *  Note that these may not be used in methods of apis from [CardinalBaseApis].
+     *
+     *  These options are sortable. When sorting using these options the documents will be sorted by [Document.created] in ascending or
+     *  descending order according to the value of the [descending] parameter.
+     *
+     *  @param secretIds a list of owning entity secret ids.
+     *  @param from the minimum value for [Document.created] (default: no limit).
+     *  @param to the maximum value for [Document.created] (default: no limit).
+     *  @param descending whether to sort the result in descending or ascending order by [Document.created] (default: ascending).
+     */
     byOwningEntitySecretIdsCreatedForSelf(secretIds: Array<string>, options?: {
         from?: number | undefined;
         to?: number | undefined;
         descending?: boolean;
     }): SortableFilterOptions<Document>;
+    /**
+     *
+     *  Options for document filter which match all the documents shared directly (i.e. ignoring hierarchies) with a specific data owner
+     *  that are linked with of the provided patients and where [Document.documentType] is equal to [documentType].
+     *
+     *  When using these options the sdk will automatically extract the secret ids from the provided patients and use
+     *  those for filtering.
+     *  If you already have the secret ids of the patient you may instead use [byOwningEntitySecretIdsAndTypeForDataOwner].
+     *  If the current data owner does not have access to any secret id of one of the provided patients the patient will
+     *  simply be ignored.
+     *  Note that these may not be used in methods of apis from [CardinalBaseApis].
+     *
+     *  @param dataOwnerId the id of a data owner.
+     *  @param documentType the document type to search.
+     *  @param patients a list of patients.
+     */
     byPatientsAndTypeForDataOwner(dataOwnerId: string, documentType: DocumentType, patients: Array<Patient>): FilterOptions<Document>;
+    /**
+     *
+     *  In group version of [byPatientsAndTypeForDataOwner].
+     */
     byPatientsAndTypeForDataOwnerInGroup(dataOwner: EntityReferenceInGroup, documentType: DocumentType, patients: Array<GroupScoped<Patient>>): FilterOptions<Document>;
+    /**
+     *
+     *  Options for document filter which match all the documents shared directly (i.e. ignoring hierarchies) with a specific data owner
+     *  that are linked with of the provided messages and where [Document.documentType] is equal to [documentType].
+     *
+     *  When using these options the sdk will automatically extract the secret ids from the provided messages and use
+     *  those for filtering.
+     *  If you already have the secret ids of the message you may instead use [byOwningEntitySecretIdsAndTypeForDataOwner].
+     *  If the current data owner does not have access to any secret id of one of the provided messages the message will
+     *  simply be ignored.
+     *  Note that these may not be used in methods of apis from [CardinalBaseApis].
+     *
+     *  @param dataOwnerId the id of a data owner.
+     *  @param documentType the document type to search.
+     *  @param messages a list of messages.
+     */
     byMessagesAndTypeForDataOwner(dataOwnerId: string, documentType: DocumentType, messages: Array<Message>): FilterOptions<Document>;
+    /**
+     *
+     *  In group version of [byMessagesAndTypeForDataOwner].
+     */
     byMessagesAndTypeForDataOwnerInGroup(dataOwner: EntityReferenceInGroup, documentType: DocumentType, messages: Array<GroupScoped<Message>>): FilterOptions<Document>;
+    /**
+     *
+     *  Options for document filter which match all the documents shared directly (i.e. ignoring hierarchies) with the current data owner
+     *  that are linked with of the provided patients and where [Document.documentType] is equal to [documentType].
+     *
+     *  When using these options the sdk will automatically extract the secret ids from the provided patients and use
+     *  those for filtering.
+     *  If you already have the secret ids of the patient you may instead use [byOwningEntitySecretIdsAndTypeForSelf].
+     *  If the current data owner does not have access to any secret id of one of the provide patients the patient will
+     *  simply be ignored.
+     *  Note that these may not be used in methods of apis from [CardinalBaseApis].
+     *
+     *  @param documentType the document type to search.
+     *  @param patients a list of patients.
+     */
     byPatientsAndTypeForSelf(documentType: DocumentType, patients: Array<Patient>): FilterOptions<Document>;
+    /**
+     *
+     *  Options for document filter which match all the documents shared directly (i.e. ignoring hierarchies) with the current data owner
+     *  that are linked with of the provided messages and where [Document.documentType] is equal to [documentType].
+     *
+     *  When using these options the sdk will automatically extract the secret ids from the provided messages and use
+     *  those for filtering.
+     *  If you already have the secret ids of the message you may instead use [byOwningEntitySecretIdsAndTypeForSelf].
+     *  If the current data owner does not have access to any secret id of one of the provide messages the message will
+     *  simply be ignored.
+     *  Note that these may not be used in methods of apis from [CardinalBaseApis].
+     *
+     *  @param documentType the document type to search.
+     *  @param messages a list of messages.
+     */
     byMessagesAndTypeForSelf(documentType: DocumentType, messages: Array<Message>): FilterOptions<Document>;
+    /**
+     *
+     *  Options for document filter which match all the documents shared directly (i.e. ignoring hierarchies) with a specific data owner
+     *  that are linked with of the provided owning entities through one of the provided secret ids and where [Document.documentType] is equal
+     *  to [documentType].
+     *
+     *  If the current data owner does not have access to any secret id of one of the provided owning entities the owning entity will
+     *  simply be ignored.
+     *
+     *  @param dataOwnerId the id of a data owner.
+     *  @param documentType the document type to search.
+     *  @param secretIds a list of patient secret ids.
+     */
     byOwningEntitySecretIdsAndTypeForDataOwner(dataOwnerId: string, documentType: DocumentType, secretIds: Array<string>): FilterOptions<Document>;
+    /**
+     *
+     *  In group version of [byOwningEntitySecretIdsAndTypeForDataOwner].
+     */
     byOwningEntitySecretIdsAndTypeForDataOwnerInGroup(dataOwner: EntityReferenceInGroup, documentType: DocumentType, secretIds: Array<string>): FilterOptions<Document>;
+    /**
+     *
+     *  Options for document filter which match all the documents shared directly (i.e. ignoring hierarchies) with the current data owner
+     *  that are linked with of the provided owning entities through one of the provided secret ids and where [Document.documentType] is equal
+     *  to [documentType].
+     *
+     *  If the current data owner does not have access to any secret id of one of the provide owning entities the owning entity will
+     *  simply be ignored.
+     *  Note that these may not be used in methods of apis from [CardinalBaseApis].
+     *
+     *  @param documentType the document type to search.
+     *  @param secretIds a list of patient secret ids.
+     */
     byOwningEntitySecretIdsAndTypeForSelf(documentType: DocumentType, secretIds: Array<string>): FilterOptions<Document>;
+    /**
+     *
+     *  Options for document filtering which match all documents shared directly (i.e. ignoring hierarchies) with a specific data owner that have a certain code.
+     *  If you specify only the [codeType] you will get all entities that have at least a code of that type.
+     *
+     *  These options are sortable. When sorting using these options the documents will be sorted by [codeCode].
+     *
+     *  @param dataOwnerId a data owner id
+     *  @param codeType a code type
+     *  @param codeCode a code for the provided code type, or null if you want the filter to accept any entity
+     *  with a code of the provided type.
+     */
     byCodeForDataOwner(dataOwnerId: string, codeType: string, options?: {
         codeCode?: string | undefined;
     }): BaseSortableFilterOptions<Document>;
+    /**
+     *
+     *  In group version of [byCodeForDataOwner].
+     */
     byCodeForDataOwnerInGroup(dataOwner: EntityReferenceInGroup, codeType: string, options?: {
         codeCode?: string | undefined;
     }): BaseSortableFilterOptions<Document>;
+    /**
+     *
+     *  Options for document filtering which match all documents shared directly (i.e. ignoring hierarchies) with the current data owner that have a certain code.
+     *  If you specify only the [codeType] you will get all entities that have at least a code of that type.
+     *
+     *  These options are sortable. When sorting using these options the documents will be sorted by [codeCode].
+     *
+     *  @param codeType a code type
+     *  @param codeCode a code for the provided code type, or null if you want the filter to accept any entity
+     *  with a code of the provided type.
+     */
     byCodeForSelf(codeType: string, options?: {
         codeCode?: string | undefined;
     }): SortableFilterOptions<Document>;
+    /**
+     *
+     *  Options for document filtering which match all documents shared directly (i.e. ignoring hierarchies) with a specific data owner that have a certain tag.
+     *  If you specify only the [tagType] you will get all entities that have at least a tag of that type.
+     *
+     *  These options are sortable. When sorting using these options the documents will be sorted by [tagCode].
+     *
+     *  @param dataOwnerId a data owner id
+     *  @param tagType a tag type
+     *  @param tagCode a code for the provided tag type, or null if you want the filter to accept any entity
+     *  with a tag of the provided type.
+     */
     byTagForDataOwner(dataOwnerId: string, tagType: string, options?: {
         tagCode?: string | undefined;
     }): BaseSortableFilterOptions<Document>;
+    /**
+     *
+     *  In group version of [byTagForDataOwner].
+     */
     byTagForDataOwnerInGroup(dataOwner: EntityReferenceInGroup, tagType: string, options?: {
         tagCode?: string | undefined;
     }): BaseSortableFilterOptions<Document>;
+    /**
+     *
+     *  Options for document filtering which match all documents shared directly (i.e. ignoring hierarchies) with the current data owner that have a certain tag.
+     *  If you specify only the [tagType] you will get all entities that have at least a tag of that type.
+     *
+     *  These options are sortable. When sorting using these options the documents will be sorted by [tagCode].
+     *
+     *  @param tagType a tag type
+     *  @param tagCode a code for the provided tag type, or null if you want the filter to accept any entity
+     *  with a tag of the provided type.
+     */
     byTagForSelf(tagType: string, options?: {
         tagCode?: string | undefined;
     }): SortableFilterOptions<Document>;

package/filters/FormFilters.d.mts

@@ -4,9 +4,52 @@ import { Form } from '../model/Form.mjs';
 import { GroupScoped } from '../model/GroupScoped.mjs';
 import { Patient } from '../model/Patient.mjs';
 interface FormFiltersFactory {
+    /**
+     *
+     *  Options for form filter which match all the forms shared directly (i.e. ignoring hierarchies) with a specific data owner and where
+     *  [Form.parent] is equal to [parentId].
+     *
+     *  @param dataOwnerId the id of a data owner.
+     *  @param parentId the form parent id.
+     */
     byParentIdForDataOwner(dataOwnerId: string, parentId: string): BaseFilterOptions<Form>;
+    /**
+     *
+     *  In group version of [byParentIdForDataOwner].
+     */
     byParentIdForDataOwnerInGroup(dataOwner: EntityReferenceInGroup, parentId: string): BaseFilterOptions<Form>;
+    /**
+     *
+     *  Options for form filter which match all the forms shared directly (i.e. ignoring hierarchies) with the current data owner and where
+     *  [Form.parent] is equal to [parentId].
+     *
+     *  @param parentId the form parent id.
+     */
     byParentIdForSelf(parentId: string): FilterOptions<Form>;
+    /**
+     *
+     *  Options for form filtering which match all forms shared directly (i.e. ignoring hierarchies) with a specific data owner
+     *  that are linked with one of the provided patients.
+     *  This Options also allows to restrict the forms based on [Form.openingDate]:
+     *  - if the [from] fuzzy date is not null, only the forms where [Form.openingDate] is greater than or equal to [from] will be returned.
+     *  - if the [to] fuzzy date is not null, only the forms where [Form.openingDate] is less than or equal to [to] will be returned.
+     *
+     *  When using these options the sdk will automatically extract the secret ids from the provided patients and use
+     *  those for filtering.
+     *  If you already have the secret ids of the patient you may instead use [byPatientSecretIdsOpeningDateForDataOwner].
+     *  If the current data owner does not have access to any secret id of one of the provide patients the patient will
+     *  simply be ignored.
+     *  Note that these may not be used in methods of apis from [CardinalBaseApis].
+     *
+     *  These options are sortable. When sorting using these options the forms will be sorted by [Form.openingDate] in ascending or
+     *  descending order according to the value of the [descending] parameter.
+     *
+     *  @param dataOwnerId a data owner id
+     *  @param patients a list of patients.
+     *  @param from the minimum fuzzy date for [Form.openingDate], in the YYYYMMDDHHMMSS format (default: no limit).
+     *  @param to the maximum fuzzy date for [Form.openingDate], in the YYYYMMDDHHMMSS format (default: no limit).
+     *  @param descending whether to sort the result in descending or ascending order by [Form.openingDate] (default: ascending).
+     */
     byPatientsOpeningDateForDataOwner(dataOwnerId: string, patients: Array<Patient>, options?: {
         from?: number | undefined;
         to?: number | undefined;
@@ -17,26 +60,103 @@ interface FormFiltersFactory {
         to?: number | undefined;
         descending?: boolean;
     }): SortableFilterOptions<Form>;
+    /**
+     *
+     *  Options for form filtering which match all forms shared directly (i.e. ignoring hierarchies) with the current data owner
+     *  that are linked with one of the provided patients.
+     *  This Options also allows to restrict the forms based on [Form.openingDate]:
+     *  - if the [from] fuzzy date is not null, only the forms where [Form.openingDate] is greater than or equal to [from] will be returned.
+     *  - if the [to] fuzzy date is not null, only the forms where [Form.openingDate] is less than or equal to [to] will be returned.
+     *
+     *  When using these options the sdk will automatically extract the secret ids from the provided patients and use
+     *  those for filtering.
+     *  If you already have the secret ids of the patient you may instead use [byPatientSecretIdsOpeningDateForSelf].
+     *  If the current data owner does not have access to any secret id of one of the provide patients the patient will
+     *  simply be ignored.
+     *  Note that these may not be used in methods of apis from [CardinalBaseApis].
+     *
+     *  These options are sortable. When sorting using these options the forms will be sorted by [Form.openingDate] in ascending or
+     *  descending order according to the value of the [descending] parameter.
+     *
+     *  @param patients a list of patients.
+     *  @param from the minimum fuzzy date for [Form.openingDate], in the YYYYMMDDHHMMSS format (default: no limit).
+     *  @param to the maximum fuzzy date for [Form.openingDate], in the YYYYMMDDHHMMSS format (default: no limit).
+     *  @param descending whether to sort the result in descending or ascending order by [Form.openingDate] (default: ascending).
+     */
     byPatientsOpeningDateForSelf(patients: Array<Patient>, options?: {
         from?: number | undefined;
         to?: number | undefined;
         descending?: boolean;
     }): SortableFilterOptions<Form>;
+    /**
+     *
+     *  Options for form filtering which match all forms shared directly (i.e. ignoring hierarchies) with the current data owner
+     *  that are linked with one of the provided patients through one of the provided secret ids.
+     *  This Options also allows to restrict the forms based on [Form.openingDate]:
+     *  - if the [from] fuzzy date is not null, only the forms where [Form.openingDate] is greater than or equal to [from] will be returned.
+     *  - if the [to] fuzzy date is not null, only the forms where [Form.openingDate] is less than or equal to [to] will be returned.
+     *
+     *  If the current data owner does not have access to any secret id of one of the provide patients the patient will
+     *  simply be ignored.
+     *
+     *  These options are sortable. When sorting using these options the forms will be sorted by [Form.openingDate] in ascending or
+     *  descending order according to the value of the [descending] parameter.
+     *
+     *  @param dataOwnerId a data owner id.
+     *  @param secretIds a list of patient secret ids.
+     *  @param from the minimum fuzzy date for [Form.openingDate], in the YYYYMMDDHHMMSS format (default: no limit).
+     *  @param to the maximum fuzzy date for [Form.openingDate], in the YYYYMMDDHHMMSS format (default: no limit).
+     *  @param descending whether to sort the result in descending or ascending order by [Form.openingDate] (default: ascending).
+     */
     byPatientSecretIdsOpeningDateForDataOwner(dataOwnerId: string, secretIds: Array<string>, options?: {
         from?: number | undefined;
         to?: number | undefined;
         descending?: boolean;
     }): BaseSortableFilterOptions<Form>;
+    /**
+     *
+     *  In group version of [byPatientSecretIdsOpeningDateForDataOwner].
+     */
     byPatientSecretIdsOpeningDateForDataOwnerInGroup(dataOwner: EntityReferenceInGroup, secretIds: Array<string>, options?: {
         from?: number | undefined;
         to?: number | undefined;
         descending?: boolean;
     }): BaseSortableFilterOptions<Form>;
+    /**
+     *
+     *  Options for form filtering which match all forms shared directly (i.e. ignoring hierarchies) with the current data owner
+     *  that are linked with one of the provided patients through one of the provided secret ids.
+     *  This Options also allows to restrict the forms based on [Form.openingDate]:
+     *  - if the [from] fuzzy date is not null, only the forms where [Form.openingDate] is greater than or equal to [from] will be returned.
+     *  - if the [to] fuzzy date is not null, only the forms where [Form.openingDate] is less than or equal to [to] will be returned.
+     *
+     *  If the current data owner does not have access to any secret id of one of the provide patients the patient will
+     *  simply be ignored.
+     *  Note that these may not be used in methods of apis from [CardinalBaseApis].
+     *
+     *  These options are sortable. When sorting using these options the forms will be sorted by [Form.openingDate] in ascending or
+     *  descending order according to the value of the [descending] parameter.
+     *
+     *  @param secretIds a list of patient secret ids.
+     *  @param from the minimum fuzzy date for [Form.openingDate], in the YYYYMMDDHHMMSS format (default: no limit).
+     *  @param to the maximum fuzzy date for [Form.openingDate], in the YYYYMMDDHHMMSS format (default: no limit).
+     *  @param descending whether to sort the result in descending or ascending order by [Form.openingDate] (default: ascending).
+     */
     byPatientSecretIdsOpeningDateForSelf(secretIds: Array<string>, options?: {
         from?: number | undefined;
         to?: number | undefined;
         descending?: boolean;
     }): SortableFilterOptions<Form>;
+    /**
+     *
+     *  Options for form filtering which mach all the forms where [Form.uniqueId] is equal to [uniqueId].
+     *
+     *  These options are sortable. When sorting using these options, the forms will be sorted by [Form.created] in ascending or descending
+     *  order according to the value of the [descending] parameter.
+     *
+     *  @param uniqueId the [Form.uniqueId] to use for filtering.
+     *  @param descending whether to sort the results in descending or ascending order by [Form.created] (default: ascending).
+     */
     byUniqueId(uniqueId: string, options?: {
         descending?: boolean;
     }): BaseSortableFilterOptions<Form>;

package/filters/FormTemplateFilters.d.mts

@@ -1,6 +1,12 @@
 import { BaseFilterOptions } from '../cardinal-sdk-ts.mjs';
 import { FormTemplate } from '../model/FormTemplate.mjs';
 interface FormTemplateFiltersFactory {
+    /**
+     *
+     *  Filter options that match all form template with the specified specialty code.
+     *
+     *  @param specialtyCode the specialty code.
+     */
     bySpecialtyCode(specialtyCode: string): BaseFilterOptions<FormTemplate>;
 }
 export declare const FormTemplateFilters: FormTemplateFiltersFactory;

package/filters/GroupFilters.d.mts

@@ -1,8 +1,35 @@
 import { BaseFilterOptions, BaseSortableFilterOptions } from '../cardinal-sdk-ts.mjs';
 import { Group } from '../model/Group.mjs';
 interface GroupFiltersFactory {
+    /**
+     *
+     *  Filter options to match all agendas.
+     *  These options are not sortable.
+     */
     all(): BaseFilterOptions<Group>;
+    /**
+     *
+     *  Options for group filtering that returns all the groups where [Group.superGroup] is equal to [superGroupId].
+     *
+     *  @param superGroupId the id of the super group.
+     */
     bySuperGroup(superGroupId: string): BaseFilterOptions<Group>;
+    /**
+     *
+     *  Options for group filtering that returns all the groups where [Group.superGroup] is equal to [superGroupId] and one or more of the
+     *  following is true:
+     *  - [Group.id] starts with the provided [searchString].
+     *  - [Group.name] starts with the provided [searchString].
+     *  - In [Group.properties] there is at least one property where the identifier in the property type starts with [searchString] or where
+     *    property string value starts with [searchString].
+     *  If a group matches for more than one option, only the first will be considered.
+     *
+     *  These options are sortable. When sorting using these options the groups will be sorted lexicographically by the aforementioned
+     *  properties.
+     *
+     *  @param superGroupId the id of the super group.
+     *  @param searchString the query to search in the group id, name, or properties.
+     */
     withContent(superGroupId: string, searchString: string): BaseSortableFilterOptions<Group>;
 }
 export declare const GroupFilters: GroupFiltersFactory;