@icure/cardinal-sdk 2.4.4 → 2.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/Kotlin-DateTime-library-kotlinx-datetime.mjs +1 -1
  2. package/api/RoleApi.d.mts +6 -4
  3. package/cardinal-sdk-ts.d.mts +78 -78
  4. package/cardinal-sdk-ts.mjs +39335 -39225
  5. package/cardinal-sdk.mjs +68660 -69414
  6. package/filters/ContactFilters.d.mts +9 -26
  7. package/filters/DocumentFilters.d.mts +6 -12
  8. package/filters/HealthElementFilters.d.mts +15 -41
  9. package/filters/MaintenanceTaskFilters.d.mts +2 -8
  10. package/filters/MessageFilters.d.mts +8 -22
  11. package/filters/PatientFilters.d.mts +24 -62
  12. package/filters/ServiceFilters.d.mts +19 -52
  13. package/kotlin-kotlin-stdlib.mjs +10 -10
  14. package/model/Agenda.d.mts +4 -4
  15. package/model/Agenda.mjs +4 -4
  16. package/model/CalendarItem.d.mts +9 -9
  17. package/model/CalendarItem.mjs +6 -6
  18. package/model/Group.d.mts +1 -1
  19. package/model/Group.mjs +1 -1
  20. package/model/Patient.d.mts +3 -3
  21. package/model/Patient.mjs +3 -3
  22. package/model/Role.d.mts +16 -6
  23. package/model/Role.mjs +20 -5
  24. package/model/User.d.mts +6 -0
  25. package/model/User.mjs +11 -0
  26. package/model/base/CryptoActor.mjs +3 -3
  27. package/model/embed/Partnership.d.mts +60 -3
  28. package/model/embed/Partnership.mjs +85 -4
  29. package/model/embed/Service.d.mts +306 -0
  30. package/model/embed/Service.mjs +214 -0
  31. package/model/embed/form/template/Field.d.mts +1 -1
  32. package/model/embed/form/template/StructureElement.mjs +6 -6
  33. package/model/filter/predicate/Predicate.d.mts +1 -1
  34. package/model/filter/predicate/Predicate.mjs +3 -3
  35. package/model/security/Enable2faRequest.d.mts +20 -1
  36. package/model/security/Enable2faRequest.mjs +23 -1
  37. package/package.json +1 -1
@@ -176,31 +176,24 @@ interface ContactFiltersFactory {
176
176
  * have at least an identifier that has the same exact [Identifier.system] and [Identifier.value] as one of the provided
177
177
  * [identifiers]. Other properties of the provided identifiers are ignored.
178
178
  *
179
- * These options are sortable. When sorting using these options the contacts will be in the same order as the input
180
- * identifiers. In case an entity has multiple identifiers only the first matching identifier is considered for the
181
- * sorting.
182
- *
183
179
  * @param identifiers a list of identifiers
184
180
  */
185
- byIdentifiersForSelf(identifiers: Array<Identifier>): SortableFilterOptions<Contact>;
181
+ byIdentifiersForSelf(identifiers: Array<Identifier>): FilterOptions<Contact>;
186
182
  /**
187
183
  *
188
184
  * Options for contact filtering which match all the contacts shared directly (i.e. ignoring hierarchies) with a specific data owner
189
185
  * that have at least an identifier that has the same exact [Identifier.system] and [Identifier.value] as one of the provided
190
186
  * [identifiers]. Other properties of the provided identifiers are ignored.
191
187
  *
192
- * These options are sortable. When sorting using these options the contacts will be in the same order as the input
193
- * identifiers. In case an entity has multiple identifiers only the first matching identifier is considered for the
194
- * sorting.
195
188
  * @param dataOwnerId a data owner id
196
189
  * @param identifiers a list of identifiers
197
190
  */
198
- byIdentifiersForDataOwner(dataOwnerId: string, identifiers: Array<Identifier>): BaseSortableFilterOptions<Contact>;
191
+ byIdentifiersForDataOwner(dataOwnerId: string, identifiers: Array<Identifier>): BaseFilterOptions<Contact>;
199
192
  /**
200
193
  *
201
194
  * In group version of [byIdentifiersForDataOwner].
202
195
  */
203
- byIdentifiersForDataOwnerInGroup(dataOwner: EntityReferenceInGroup, identifiers: Array<Identifier>): BaseSortableFilterOptions<Contact>;
196
+ byIdentifiersForDataOwnerInGroup(dataOwner: EntityReferenceInGroup, identifiers: Array<Identifier>): BaseFilterOptions<Contact>;
204
197
  /**
205
198
  *
206
199
  * Options for contact filtering which match all contacts shared directly (i.e. ignoring hierarchies) with a specific
@@ -452,18 +445,15 @@ interface ContactFiltersFactory {
452
445
  * simply be ignored.
453
446
  * Note that these may not be used in methods of apis from [CardinalBaseApis].
454
447
  *
455
- * These options are sortable. When sorting using these options the contacts will be sorted by the patients, using
456
- * the same order as the input patients.
457
- *
458
448
  * @param dataOwnerId a data owner id
459
449
  * @param patients a list of patients.
460
450
  */
461
- byPatientsForDataOwner(dataOwnerId: string, patients: Array<Patient>): SortableFilterOptions<Contact>;
451
+ byPatientsForDataOwner(dataOwnerId: string, patients: Array<Patient>): FilterOptions<Contact>;
462
452
  /**
463
453
  *
464
454
  * In group version of [byPatientsForDataOwner].
465
455
  */
466
- byPatientsForDataOwnerInGroup(dataOwner: EntityReferenceInGroup, patients: Array<GroupScoped<Patient>>): SortableFilterOptions<Contact>;
456
+ byPatientsForDataOwnerInGroup(dataOwner: EntityReferenceInGroup, patients: Array<GroupScoped<Patient>>): FilterOptions<Contact>;
467
457
  /**
468
458
  *
469
459
  * Options for contact filtering which match all contacts shared directly (i.e. ignoring hierarchies) with the current data owner that are linked with one
@@ -476,38 +466,31 @@ interface ContactFiltersFactory {
476
466
  * simply be ignored.
477
467
  * Note that these may not be used in methods of apis from [CardinalBaseApis].
478
468
  *
479
- * These options are sortable. When sorting using these options the contacts will be sorted by the patients, using
480
- * the same order as the input patients.
481
- *
482
469
  * @param patients a list of patients.
483
470
  */
484
- byPatientsForSelf(patients: Array<Patient>): SortableFilterOptions<Contact>;
471
+ byPatientsForSelf(patients: Array<Patient>): FilterOptions<Contact>;
485
472
  /**
486
473
  *
487
474
  * Options for contact filtering which match all contacts shared directly (i.e. ignoring hierarchies) with a specific data owner that are linked with a
488
475
  * patient through one of the provided secret ids.
489
- * These options are sortable. When sorting using these options the contacts will be sorted by the linked patients
490
- * secret id, using the same order as the input.
491
476
  *
492
477
  * @param dataOwnerId a data owner id
493
478
  * @param secretIds a list of patients secret ids
494
479
  */
495
- byPatientsSecretIdsForDataOwner(dataOwnerId: string, secretIds: Array<string>): BaseSortableFilterOptions<Contact>;
480
+ byPatientsSecretIdsForDataOwner(dataOwnerId: string, secretIds: Array<string>): BaseFilterOptions<Contact>;
496
481
  /**
497
482
  *
498
483
  * In group version of [byPatientsSecretIdsForDataOwner].
499
484
  */
500
- byPatientsSecretIdsForDataOwnerInGroup(dataOwner: EntityReferenceInGroup, secretIds: Array<string>): BaseSortableFilterOptions<Contact>;
485
+ byPatientsSecretIdsForDataOwnerInGroup(dataOwner: EntityReferenceInGroup, secretIds: Array<string>): BaseFilterOptions<Contact>;
501
486
  /**
502
487
  *
503
488
  * Options for contact filtering which match all contacts shared directly (i.e. ignoring hierarchies) with the current data owner that are linked with a
504
489
  * patient through one of the provided secret ids.
505
- * These options are sortable. When sorting using these options the contacts will be sorted by the linked patients
506
- * secret id, using the same order as the input.
507
490
  *
508
491
  * @param secretIds a list of patients secret ids
509
492
  */
510
- byPatientsSecretIdsForSelf(secretIds: Array<string>): SortableFilterOptions<Contact>;
493
+ byPatientsSecretIdsForSelf(secretIds: Array<string>): FilterOptions<Contact>;
511
494
  /**
512
495
  *
513
496
  * Options for contact filtering which match all contacts that have at least a service with an id in [serviceIds].
@@ -1,4 +1,4 @@
1
- import { BaseSortableFilterOptions, FilterOptions, SortableFilterOptions } from '../cardinal-sdk-ts.mjs';
1
+ import { BaseFilterOptions, BaseSortableFilterOptions, FilterOptions, SortableFilterOptions } from '../cardinal-sdk-ts.mjs';
2
2
  import { Document } from '../model/Document.mjs';
3
3
  import { EntityReferenceInGroup } from '../model/EntityReferenceInGroup.mjs';
4
4
  import { GroupScoped } from '../model/GroupScoped.mjs';
@@ -307,8 +307,6 @@ interface DocumentFiltersFactory {
307
307
  * Options for document filtering which match all documents shared directly (i.e. ignoring hierarchies) with a specific data owner that have a certain code.
308
308
  * If you specify only the [codeType] you will get all entities that have at least a code of that type.
309
309
  *
310
- * These options are sortable. When sorting using these options the documents will be sorted by [codeCode].
311
- *
312
310
  * @param dataOwnerId a data owner id
313
311
  * @param codeType a code type
314
312
  * @param codeCode a code for the provided code type, or null if you want the filter to accept any entity
@@ -316,14 +314,14 @@ interface DocumentFiltersFactory {
316
314
  */
317
315
  byCodeForDataOwner(dataOwnerId: string, codeType: string, options?: {
318
316
  codeCode?: string | undefined;
319
- }): BaseSortableFilterOptions<Document>;
317
+ }): BaseFilterOptions<Document>;
320
318
  /**
321
319
  *
322
320
  * In group version of [byCodeForDataOwner].
323
321
  */
324
322
  byCodeForDataOwnerInGroup(dataOwner: EntityReferenceInGroup, codeType: string, options?: {
325
323
  codeCode?: string | undefined;
326
- }): BaseSortableFilterOptions<Document>;
324
+ }): BaseFilterOptions<Document>;
327
325
  /**
328
326
  *
329
327
  * Options for document filtering which match all documents shared directly (i.e. ignoring hierarchies) with the current data owner that have a certain code.
@@ -343,8 +341,6 @@ interface DocumentFiltersFactory {
343
341
  * Options for document filtering which match all documents shared directly (i.e. ignoring hierarchies) with a specific data owner that have a certain tag.
344
342
  * If you specify only the [tagType] you will get all entities that have at least a tag of that type.
345
343
  *
346
- * These options are sortable. When sorting using these options the documents will be sorted by [tagCode].
347
- *
348
344
  * @param dataOwnerId a data owner id
349
345
  * @param tagType a tag type
350
346
  * @param tagCode a code for the provided tag type, or null if you want the filter to accept any entity
@@ -352,28 +348,26 @@ interface DocumentFiltersFactory {
352
348
  */
353
349
  byTagForDataOwner(dataOwnerId: string, tagType: string, options?: {
354
350
  tagCode?: string | undefined;
355
- }): BaseSortableFilterOptions<Document>;
351
+ }): BaseFilterOptions<Document>;
356
352
  /**
357
353
  *
358
354
  * In group version of [byTagForDataOwner].
359
355
  */
360
356
  byTagForDataOwnerInGroup(dataOwner: EntityReferenceInGroup, tagType: string, options?: {
361
357
  tagCode?: string | undefined;
362
- }): BaseSortableFilterOptions<Document>;
358
+ }): BaseFilterOptions<Document>;
363
359
  /**
364
360
  *
365
361
  * Options for document filtering which match all documents shared directly (i.e. ignoring hierarchies) with the current data owner that have a certain tag.
366
362
  * If you specify only the [tagType] you will get all entities that have at least a tag of that type.
367
363
  *
368
- * These options are sortable. When sorting using these options the documents will be sorted by [tagCode].
369
- *
370
364
  * @param tagType a tag type
371
365
  * @param tagCode a code for the provided tag type, or null if you want the filter to accept any entity
372
366
  * with a tag of the provided type.
373
367
  */
374
368
  byTagForSelf(tagType: string, options?: {
375
369
  tagCode?: string | undefined;
376
- }): SortableFilterOptions<Document>;
370
+ }): FilterOptions<Document>;
377
371
  }
378
372
  export declare const DocumentFilters: DocumentFiltersFactory;
379
373
  export {};
@@ -31,41 +31,31 @@ interface HealthElementFiltersFactory {
31
31
  * an identifier that has the same exact [Identifier.system] and [Identifier.value] as one of the provided
32
32
  * [identifiers]. Other properties of the provided identifiers are ignored.
33
33
  *
34
- * These options are sortable. When sorting using these options the health elements will be in the same order as the input
35
- * identifiers. In case an entity has multiple identifiers only the first matching identifier is considered for the
36
- * sorting.
37
- *
38
34
  * @param dataOwnerId a data owner id or null to use the current data owner id
39
35
  * @param identifiers a list of identifiers
40
36
  * @return options for health element filtering
41
37
  */
42
- byIdentifiersForDataOwner(dataOwnerId: string, identifiers: Array<Identifier>): BaseSortableFilterOptions<HealthElement>;
38
+ byIdentifiersForDataOwner(dataOwnerId: string, identifiers: Array<Identifier>): BaseFilterOptions<HealthElement>;
43
39
  /**
44
40
  *
45
41
  * In group version of [byIdentifiersForDataOwner].
46
42
  */
47
- byIdentifiersForDataOwnerInGroup(dataOwner: EntityReferenceInGroup, identifiers: Array<Identifier>): BaseSortableFilterOptions<HealthElement>;
43
+ byIdentifiersForDataOwnerInGroup(dataOwner: EntityReferenceInGroup, identifiers: Array<Identifier>): BaseFilterOptions<HealthElement>;
48
44
  /**
49
45
  *
50
46
  * Options for health element filtering which match all the health elements shared directly (i.e. ignoring hierarchies) with the current data owner that have at least
51
47
  * an identifier that has the same exact [Identifier.system] and [Identifier.value] as one of the provided
52
48
  * [identifiers]. Other properties of the provided identifiers are ignored.
53
49
  *
54
- * These options are sortable. When sorting using these options the health elements will be in the same order as the input
55
- * identifiers. In case an entity has multiple identifiers only the first matching identifier is considered for the
56
- * sorting.
57
- *
58
50
  * @param identifiers a list of identifiers
59
51
  * @return options for health element filtering
60
52
  */
61
- byIdentifiersForSelf(identifiers: Array<Identifier>): SortableFilterOptions<HealthElement>;
53
+ byIdentifiersForSelf(identifiers: Array<Identifier>): FilterOptions<HealthElement>;
62
54
  /**
63
55
  *
64
56
  * Options for health element filtering which match all health elements shared directly (i.e. ignoring hierarchies) with a specific data owner that have a certain code.
65
57
  * If you specify only the [codeType] you will get all entities that have at least a code of that type.
66
58
  *
67
- * These options are sortable. When sorting using these options the health elements will be sorted by [codeCode].
68
- *
69
59
  * @param dataOwnerId a data owner id
70
60
  * @param codeType a code type
71
61
  * @param codeCode a code for the provided code type, or null if you want the filter to accept any entity
@@ -73,35 +63,31 @@ interface HealthElementFiltersFactory {
73
63
  */
74
64
  byCodeForDataOwner(dataOwnerId: string, codeType: string, options?: {
75
65
  codeCode?: string | undefined;
76
- }): BaseSortableFilterOptions<HealthElement>;
66
+ }): BaseFilterOptions<HealthElement>;
77
67
  /**
78
68
  *
79
69
  * In group version of [byCodeForDataOwner].
80
70
  */
81
71
  byCodeForDataOwnerInGroup(dataOwner: EntityReferenceInGroup, codeType: string, options?: {
82
72
  codeCode?: string | undefined;
83
- }): BaseSortableFilterOptions<HealthElement>;
73
+ }): BaseFilterOptions<HealthElement>;
84
74
  /**
85
75
  *
86
76
  * Options for health element filtering which match all health elements shared directly (i.e. ignoring hierarchies) with the current data owner that have a certain code.
87
77
  * If you specify only the [codeType] you will get all entities that have at least a code of that type.
88
78
  *
89
- * These options are sortable. When sorting using these options the health elements will be sorted by [codeCode].
90
- *
91
79
  * @param codeType a code type
92
80
  * @param codeCode a code for the provided code type, or null if you want the filter to accept any entity
93
81
  * with a code of the provided type.
94
82
  */
95
83
  byCodeForSelf(codeType: string, options?: {
96
84
  codeCode?: string | undefined;
97
- }): SortableFilterOptions<HealthElement>;
85
+ }): FilterOptions<HealthElement>;
98
86
  /**
99
87
  *
100
88
  * Options for health element filtering which match all health elements shared directly (i.e. ignoring hierarchies) with a specific data owner that have a certain tag.
101
89
  * If you specify only the [tagType] you will get all entities that have at least a tag of that type.
102
90
  *
103
- * These options are sortable. When sorting using these options the health elements will be sorted by [tagCode].
104
- *
105
91
  * @param dataOwnerId a data owner id
106
92
  * @param tagType a tag type
107
93
  * @param tagCode a code for the provided tag type, or null if you want the filter to accept any entity
@@ -109,28 +95,26 @@ interface HealthElementFiltersFactory {
109
95
  */
110
96
  byTagForDataOwner(dataOwnerId: string, tagType: string, options?: {
111
97
  tagCode?: string | undefined;
112
- }): BaseSortableFilterOptions<HealthElement>;
98
+ }): BaseFilterOptions<HealthElement>;
113
99
  /**
114
100
  *
115
101
  * In group version of [byTagForDataOwner].
116
102
  */
117
103
  byTagForDataOwnerInGroup(dataOwner: EntityReferenceInGroup, tagType: string, options?: {
118
104
  tagCode?: string | undefined;
119
- }): BaseSortableFilterOptions<HealthElement>;
105
+ }): BaseFilterOptions<HealthElement>;
120
106
  /**
121
107
  *
122
108
  * Options for health element filtering which match all health elements shared directly (i.e. ignoring hierarchies) with the current data owner that have a certain tag.
123
109
  * If you specify only the [tagType] you will get all entities that have at least a tag of that type.
124
110
  *
125
- * These options are sortable. When sorting using these options the health elements will be sorted by [tagCode].
126
- *
127
111
  * @param tagType a tag type
128
112
  * @param tagCode a code for the provided tag type, or null if you want the filter to accept any entity
129
113
  * with a tag of the provided type.
130
114
  */
131
115
  byTagForSelf(tagType: string, options?: {
132
116
  tagCode?: string | undefined;
133
- }): SortableFilterOptions<HealthElement>;
117
+ }): FilterOptions<HealthElement>;
134
118
  /**
135
119
  *
136
120
  * Options for health element filtering which match all health elements shared directly (i.e. ignoring hierarchies) with a specific data owner that are linked with one
@@ -143,18 +127,15 @@ interface HealthElementFiltersFactory {
143
127
  * simply be ignored.
144
128
  * Note that these may not be used in methods of apis from [CardinalBaseApis].
145
129
  *
146
- * These options are sortable. When sorting using these options the health elements will be sorted by the patients, using
147
- * the same order as the input patients.
148
- *
149
130
  * @param dataOwnerId a data owner id
150
131
  * @param patients a list of patients.
151
132
  */
152
- byPatientsForDataOwner(dataOwnerId: string, patients: Array<Patient>): SortableFilterOptions<HealthElement>;
133
+ byPatientsForDataOwner(dataOwnerId: string, patients: Array<Patient>): FilterOptions<HealthElement>;
153
134
  /**
154
135
  *
155
136
  * In group version of [byPatientsForDataOwner].
156
137
  */
157
- byPatientsForDataOwnerInGroup(dataOwner: EntityReferenceInGroup, patients: Array<GroupScoped<Patient>>): SortableFilterOptions<HealthElement>;
138
+ byPatientsForDataOwnerInGroup(dataOwner: EntityReferenceInGroup, patients: Array<GroupScoped<Patient>>): FilterOptions<HealthElement>;
158
139
  /**
159
140
  *
160
141
  * Options for health element filtering which match all health elements shared directly (i.e. ignoring hierarchies) with the current data owner that are linked with one
@@ -167,37 +148,30 @@ interface HealthElementFiltersFactory {
167
148
  * simply be ignored.
168
149
  * Note that these may not be used in methods of apis from [CardinalBaseApis].
169
150
  *
170
- * These options are sortable. When sorting using these options the health elements will be sorted by the patients, using
171
- * the same order as the input patients.
172
- *
173
151
  * @param patients a list of patients.
174
152
  */
175
- byPatientsForSelf(patients: Array<Patient>): SortableFilterOptions<HealthElement>;
153
+ byPatientsForSelf(patients: Array<Patient>): FilterOptions<HealthElement>;
176
154
  /**
177
155
  *
178
156
  * Options for health element filtering which match all health elements shared directly (i.e. ignoring hierarchies) with a specific data owner that are linked with a
179
157
  * patient through one of the provided secret ids.
180
- * These options are sortable. When sorting using these options the health elements will be sorted by the linked patients
181
- * secret id, using the same order as the input.
182
158
  *
183
159
  * @param dataOwnerId a data owner id
184
160
  * @param secretIds a list of patients secret ids
185
161
  */
186
- byPatientsSecretIdsForDataOwner(dataOwnerId: string, secretIds: Array<string>): BaseSortableFilterOptions<HealthElement>;
162
+ byPatientsSecretIdsForDataOwner(dataOwnerId: string, secretIds: Array<string>): BaseFilterOptions<HealthElement>;
187
163
  /**
188
164
  *
189
165
  * In group version of [byPatientsSecretIdsForDataOwner].
190
166
  */
191
- byPatientsSecretIdsForDataOwnerInGroup(dataOwner: EntityReferenceInGroup, secretIds: Array<string>): BaseSortableFilterOptions<HealthElement>;
167
+ byPatientsSecretIdsForDataOwnerInGroup(dataOwner: EntityReferenceInGroup, secretIds: Array<string>): BaseFilterOptions<HealthElement>;
192
168
  /**
193
169
  *
194
170
  * Options for health element filtering which match all health elements shared directly (i.e. ignoring hierarchies) with the current data owner that are linked with a
195
171
  * patient through one of the provided secret ids.
196
- * These options are sortable. When sorting using these options the health elements will be sorted by the linked patients
197
- * secret id, using the same order as the input.
198
172
  * @param secretIds a list of patients secret ids
199
173
  */
200
- byPatientsSecretIdsForSelf(secretIds: Array<string>): SortableFilterOptions<HealthElement>;
174
+ byPatientsSecretIdsForSelf(secretIds: Array<string>): FilterOptions<HealthElement>;
201
175
  /**
202
176
  *
203
177
  * Filter options that match all health elements with one of the provided ids.
@@ -16,27 +16,21 @@ interface MaintenanceTaskFiltersFactory {
16
16
  * an identifier that has the same exact [Identifier.system] and [Identifier.value] as one of the provided
17
17
  * [identifiers]. Other properties of the provided identifiers are ignored.
18
18
  *
19
- * These options are sortable. When sorting using these options the maintenance tasks will be in the same order as the input
20
- * identifiers. In case an entity has multiple identifiers only the first matching identifier is considered for the
21
- * sorting.
22
19
  * @param dataOwnerId a data owner id
23
20
  * @param identifiers a list of identifiers
24
21
  * @return options for maintenance task filtering
25
22
  */
26
- byIdentifiersForDataOwner(dataOwnerId: string, identifiers: Array<Identifier>): BaseSortableFilterOptions<MaintenanceTask>;
23
+ byIdentifiersForDataOwner(dataOwnerId: string, identifiers: Array<Identifier>): BaseFilterOptions<MaintenanceTask>;
27
24
  /**
28
25
  *
29
26
  * Options for maintenance task filtering which match all the maintenance tasks shared directly (i.e. ignoring hierarchies) with the current data owner that have at least
30
27
  * an identifier that has the same exact [Identifier.system] and [Identifier.value] as one of the provided
31
28
  * [identifiers]. Other properties of the provided identifiers are ignored.
32
29
  *
33
- * These options are sortable. When sorting using these options the maintenance tasks will be in the same order as the input
34
- * identifiers. In case an entity has multiple identifiers only the first matching identifier is considered for the
35
- * sorting.
36
30
  * @param identifiers a list of identifiers
37
31
  * @return options for maintenance task filtering
38
32
  */
39
- byIdentifiersForSelf(identifiers: Array<Identifier>): SortableFilterOptions<MaintenanceTask>;
33
+ byIdentifiersForSelf(identifiers: Array<Identifier>): FilterOptions<MaintenanceTask>;
40
34
  /**
41
35
  *
42
36
  * Options for maintenance task filtering which match all the maintenance tasks shared directly (i.e. ignoring hierarchies) with a specific data owner
@@ -22,27 +22,23 @@ interface MessageFiltersFactory {
22
22
  * Creates options for message filtering that will match all messages shared directly (i.e. ignoring hierarchies) with a specific data owner that have the
23
23
  * provided transportGuid.
24
24
  *
25
- * These options are sortable. When sorting using these options the messages will be sorted by [Message.sent].
26
- *
27
25
  * @param dataOwnerId a data owner id
28
26
  * @param transportGuid a message transport guid
29
27
  */
30
- byTransportGuidForDataOwner(dataOwnerId: string, transportGuid: string): BaseSortableFilterOptions<Message>;
28
+ byTransportGuidForDataOwner(dataOwnerId: string, transportGuid: string): BaseFilterOptions<Message>;
31
29
  /**
32
30
  *
33
31
  * In group version of [byTransportGuidForDataOwner].
34
32
  */
35
- byTransportGuidForDataOwnerInGroup(dataOwner: EntityReferenceInGroup, transportGuid: string): BaseSortableFilterOptions<Message>;
33
+ byTransportGuidForDataOwnerInGroup(dataOwner: EntityReferenceInGroup, transportGuid: string): BaseFilterOptions<Message>;
36
34
  /**
37
35
  *
38
36
  * Creates options for message filtering that will match all messages shared directly (i.e. ignoring hierarchies) with the current data owner that have the
39
37
  * provided transportGuid.
40
38
  *
41
- * These options are sortable. When sorting using these options the messages will be sorted by [Message.sent].
42
- *
43
39
  * @param transportGuid a message transport guid
44
40
  */
45
- byTransportGuidForSelf(transportGuid: string): SortableFilterOptions<Message>;
41
+ byTransportGuidForSelf(transportGuid: string): FilterOptions<Message>;
46
42
  /**
47
43
  *
48
44
  * Filter options for message filtering that will match all messages shared directly (i.e. ignoring hierarchies) with a specific data owner
@@ -217,9 +213,6 @@ interface MessageFiltersFactory {
217
213
  * Filter options for message filtering that will match all messages shared directly (i.e. ignoring hierarchies) with a specific data owner
218
214
  * where [Message.transportGuid] is equal to [transportGuid] and [Message.sent] is between [from] (inclusive) and [to] (inclusive).
219
215
  *
220
- * These options are sortable. When sorting using these options the messages will be sorted by [Message.sent] in ascending or
221
- * descending order according to the value of the [descending] parameter.
222
- *
223
216
  * @param dataOwnerId the id of a data owner.
224
217
  * @param transportGuid the transport guid to use in the filter.
225
218
  * @param from the minimum value for [Message.sent].
@@ -228,22 +221,19 @@ interface MessageFiltersFactory {
228
221
  */
229
222
  byTransportGuidSentDateForDataOwner(dataOwnerId: string, transportGuid: string, from: number | undefined, to: number | undefined, options?: {
230
223
  descending?: boolean;
231
- }): BaseSortableFilterOptions<Message>;
224
+ }): BaseFilterOptions<Message>;
232
225
  /**
233
226
  *
234
227
  * In group version of [byTransportGuidSentDateForDataOwner].
235
228
  */
236
229
  byTransportGuidSentDateForDataOwnerInGroup(dataOwner: EntityReferenceInGroup, transportGuid: string, from: number | undefined, to: number | undefined, options?: {
237
230
  descending?: boolean;
238
- }): BaseSortableFilterOptions<Message>;
231
+ }): BaseFilterOptions<Message>;
239
232
  /**
240
233
  *
241
234
  * Filter options for message filtering that will match all messages shared directly (i.e. ignoring hierarchies) with the current data owner
242
235
  * where [Message.transportGuid] is equal to [transportGuid] and [Message.sent] is between [from] (inclusive) and [to] (inclusive).
243
236
  *
244
- * These options are sortable. When sorting using these options the messages will be sorted by [Message.sent] in ascending or
245
- * descending order according to the value of the [descending] parameter.
246
- *
247
237
  * @param transportGuid the transport guid to use in the filter.
248
238
  * @param from the minimum value for [Message.sent].
249
239
  * @param to the maximum value for [Message.sent].
@@ -251,7 +241,7 @@ interface MessageFiltersFactory {
251
241
  */
252
242
  byTransportGuidSentDateForSelf(transportGuid: string, from: number | undefined, to: number | undefined, options?: {
253
243
  descending?: boolean;
254
- }): SortableFilterOptions<Message>;
244
+ }): FilterOptions<Message>;
255
245
  /**
256
246
  *
257
247
  * Filter options for message filtering that will match all messages shared directly (i.e. ignoring hierarchies) with a specific data owner
@@ -349,15 +339,13 @@ interface MessageFiltersFactory {
349
339
  * Options for message filtering which match all messages shared directly (i.e. ignoring hierarchies) with the current data owner that have a certain code.
350
340
  * If you specify only the [codeType] you will get all entities that have at least a code of that type.
351
341
  *
352
- * These options are sortable. When sorting using these options the messages will be sorted by [codeCode].
353
- *
354
342
  * @param codeType a code type
355
343
  * @param codeCode a code for the provided code type, or null if you want the filter to accept any entity
356
344
  * with a code of the provided type.
357
345
  */
358
346
  byCodeForSelf(codeType: string, options?: {
359
347
  codeCode?: string | undefined;
360
- }): SortableFilterOptions<Message>;
348
+ }): FilterOptions<Message>;
361
349
  /**
362
350
  *
363
351
  * Options for message filtering which match all messages shared directly (i.e. ignoring hierarchies) with a specific data owner that have a certain tag.
@@ -385,15 +373,13 @@ interface MessageFiltersFactory {
385
373
  * Options for message filtering which match all messages shared directly (i.e. ignoring hierarchies) with the current data owner that have a certain tag.
386
374
  * If you specify only the [tagType] you will get all entities that have at least a tag of that type.
387
375
  *
388
- * These options are sortable. When sorting using these options the messages will be sorted by [tagCode].
389
- *
390
376
  * @param tagType a tag type
391
377
  * @param tagCode a code for the provided tag type, or null if you want the filter to accept any entity
392
378
  * with a tag of the provided type.
393
379
  */
394
380
  byTagForSelf(tagType: string, options?: {
395
381
  tagCode?: string | undefined;
396
- }): SortableFilterOptions<Message>;
382
+ }): FilterOptions<Message>;
397
383
  }
398
384
  export declare const MessageFilters: MessageFiltersFactory;
399
385
  export {};