@icure/cardinal-sdk 2.7.0 → 2.8.1

package/api/CalendarItemApi.d.mts

@@ -2,6 +2,7 @@ import { FilterOptions, PaginatedListIterator, SortableFilterOptions } from '../
 import { CalendarItemShareOptions } from '../crypto/entities/CalendarItemShareOptions.mjs';
 import { SecretIdUseOption } from '../crypto/entities/SecretIdUseOption.mjs';
 import { CalendarItem, DecryptedCalendarItem, EncryptedCalendarItem } from '../model/CalendarItem.mjs';
+import { CalendarItemOccupancy } from '../model/CalendarItemOccupancy.mjs';
 import { EntityReferenceInGroup } from '../model/EntityReferenceInGroup.mjs';
 import { Patient } from '../model/Patient.mjs';
 import { StoredDocumentIdentifier } from '../model/StoredDocumentIdentifier.mjs';
@@ -153,6 +154,41 @@ export interface CalendarItemApi {
      *  @return a list of calendarItem ids
      */
     matchCalendarItemsBySorted(filter: SortableFilterOptions<CalendarItem>): Promise<Array<string>>;
+    /**
+     *
+     *  Computes the concurrent-occupancy histogram of the calendar items for the current data owner over the
+     *  period [startDate]..[endDate] (fuzzy date-times, either bound may be null = open).
+     *
+     *  Only calendar items whose whole interval fits within the search range are considered. By default, the
+     *  range is exactly [startDate]..[endDate], so items starting before [startDate] or ending after [endDate]
+     *  are ignored. Pass [extensionInDays] to widen the range by that many days on each side, which lets items
+     *  that start shortly before [startDate] (contributing to the occupancy baseline) or end shortly after
+     *  [endDate] be taken into account. Items reaching beyond the extended range are still ignored.
+     */
+    getCalendarItemsOccupancyByPeriodForSelf(startDate: number, endDate: number, extensionInDays: number | undefined): Promise<Array<CalendarItemOccupancy>>;
+    /**
+     *
+     *  Computes the concurrent-occupancy histogram of the calendar items of [hcPartyId] over the
+     *  period [startDate]..[endDate] (fuzzy date-times, either bound may be null = open).
+     *
+     *  Only calendar items whose whole interval fits within the search range are considered. By default, the
+     *  range is exactly [startDate]..[endDate], so items starting before [startDate] or ending after [endDate]
+     *  are ignored. Pass [extensionInDays] to widen the range by that many days on each side, which lets items
+     *  that start shortly before [startDate] (contributing to the occupancy baseline) or end shortly after
+     *  [endDate] be taken into account. Items reaching beyond the extended range are still ignored.
+     */
+    getCalendarItemsOccupancyByPeriodForHealthcareParty(startDate: number, endDate: number, hcPartyId: string, extensionInDays: number | undefined): Promise<Array<CalendarItemOccupancy>>;
+    /**
+     *
+     *  Computes the concurrent-occupancy histogram of the calendar items of the agenda [agendaId] over the
+     *  period [startDate]..[endDate] (fuzzy date-times, either bound may be null = open).
+     *
+     *  Only calendar items whose whole interval fits within the search range are considered. By default, the range
+     *  is exactly [startDate]..[endDate], you can pass a non-null [extensionInDays] to widen it by that many days on each side (e.g.
+     *  to include items that start before [startDate] but are still open during the period). Items reaching beyond
+     *  the extended range are ignored.
+     */
+    getCalendarItemsOccupancyByPeriodAndAgendaId(startDate: number, endDate: number, agendaId: string, extensionInDays: number | undefined): Promise<Array<CalendarItemOccupancy>>;
     /**
      *
      *  Deletes a calendarItem. If you don't have write access to the calendarItem the method will fail.

package/api/CalendarItemBasicApi.d.mts

@@ -1,5 +1,6 @@
 import { BaseFilterOptions, BaseSortableFilterOptions, FilterOptions, PaginatedListIterator } from '../cardinal-sdk-ts.mjs';
 import { CalendarItem, EncryptedCalendarItem } from '../model/CalendarItem.mjs';
+import { CalendarItemOccupancy } from '../model/CalendarItemOccupancy.mjs';
 import { StoredDocumentIdentifier } from '../model/StoredDocumentIdentifier.mjs';
 import { EntitySubscription } from '../subscription/EntitySubscription.mjs';
 import { EntitySubscriptionConfiguration } from '../subscription/EntitySubscriptionConfiguration.mjs';
@@ -57,6 +58,41 @@ export interface CalendarItemBasicApi {
      *  @return an iterator that iterates over all calendarItems matching the provided filter.
      */
     filterCalendarItemsBySorted(filter: BaseSortableFilterOptions<CalendarItem>): Promise<PaginatedListIterator<EncryptedCalendarItem>>;
+    /**
+     *
+     *  Computes the concurrent-occupancy histogram of the calendar items for the current data owner over the
+     *  period [startDate]..[endDate] (fuzzy date-times, either bound may be null = open).
+     *
+     *  Only calendar items whose whole interval fits within the search range are considered. By default, the
+     *  range is exactly [startDate]..[endDate], so items starting before [startDate] or ending after [endDate]
+     *  are ignored. Pass [extensionInDays] to widen the range by that many days on each side, which lets items
+     *  that start shortly before [startDate] (contributing to the occupancy baseline) or end shortly after
+     *  [endDate] be taken into account. Items reaching beyond the extended range are still ignored.
+     */
+    getCalendarItemsOccupancyByPeriodForSelf(startDate: number, endDate: number, extensionInDays: number | undefined): Promise<Array<CalendarItemOccupancy>>;
+    /**
+     *
+     *  Computes the concurrent-occupancy histogram of the calendar items of [hcPartyId] over the
+     *  period [startDate]..[endDate] (fuzzy date-times, either bound may be null = open).
+     *
+     *  Only calendar items whose whole interval fits within the search range are considered. By default, the
+     *  range is exactly [startDate]..[endDate], so items starting before [startDate] or ending after [endDate]
+     *  are ignored. Pass [extensionInDays] to widen the range by that many days on each side, which lets items
+     *  that start shortly before [startDate] (contributing to the occupancy baseline) or end shortly after
+     *  [endDate] be taken into account. Items reaching beyond the extended range are still ignored.
+     */
+    getCalendarItemsOccupancyByPeriodForHealthcareParty(startDate: number, endDate: number, hcPartyId: string, extensionInDays: number | undefined): Promise<Array<CalendarItemOccupancy>>;
+    /**
+     *
+     *  Computes the concurrent-occupancy histogram of the calendar items of the agenda [agendaId] over the
+     *  period [startDate]..[endDate] (fuzzy date-times, either bound may be null = open).
+     *
+     *  Only calendar items whose whole interval fits within the search range are considered. By default, the range
+     *  is exactly [startDate]..[endDate], you can pass a non-null [extensionInDays] to widen it by that many days on each side (e.g.
+     *  to include items that start before [startDate] but are still open during the period). Items reaching beyond
+     *  the extended range are ignored.
+     */
+    getCalendarItemsOccupancyByPeriodAndAgendaId(startDate: number, endDate: number, agendaId: string, extensionInDays: number | undefined): Promise<Array<CalendarItemOccupancy>>;
     /**
      *
      *  Deletes a calendarItem. If you don't have write access to the calendarItem the method will fail.

package/api/CalendarItemBasicInGroupApi.d.mts

@@ -1,5 +1,6 @@
 import { BaseFilterOptions, BaseSortableFilterOptions, PaginatedListIterator } from '../cardinal-sdk-ts.mjs';
 import { CalendarItem, EncryptedCalendarItem } from '../model/CalendarItem.mjs';
+import { CalendarItemOccupancy } from '../model/CalendarItemOccupancy.mjs';
 import { GroupScoped } from '../model/GroupScoped.mjs';
 import { StoredDocumentIdentifier } from '../model/StoredDocumentIdentifier.mjs';
 export interface CalendarItemBasicInGroupApi {
@@ -23,6 +24,21 @@ export interface CalendarItemBasicInGroupApi {
      *  In-group version of [CalendarItemBasicApi.filterCalendarItemsBySorted]
      */
     filterCalendarItemsBySorted(groupId: string, filter: BaseSortableFilterOptions<CalendarItem>): Promise<PaginatedListIterator<GroupScoped<EncryptedCalendarItem>>>;
+    /**
+     *
+     *  In-group version of [getCalendarItemsOccupancyByPeriodForSelf].
+     */
+    getCalendarItemsOccupancyByPeriodForSelf(groupId: string, startDate: number, endDate: number, extensionInDays: number | undefined): Promise<Array<CalendarItemOccupancy>>;
+    /**
+     *
+     *  In-group version of [getCalendarItemsOccupancyByPeriodForHealthcareParty].
+     */
+    getCalendarItemsOccupancyByPeriodForHealthcareParty(groupId: string, startDate: number, endDate: number, hcPartyId: string, extensionInDays: number | undefined): Promise<Array<CalendarItemOccupancy>>;
+    /**
+     *
+     *  In-group version of [getCalendarItemsOccupancyByPeriodAndAgendaId].
+     */
+    getCalendarItemsOccupancyByPeriodAndAgendaId(groupId: string, startDate: number, endDate: number, agendaId: string, extensionInDays: number | undefined): Promise<Array<CalendarItemOccupancy>>;
     /**
      *
      *  In-group version of [CalendarItemBasicFlavourlessApi.deleteCalendarItemById]

package/api/CalendarItemInGroupApi.d.mts

@@ -2,6 +2,7 @@ import { FilterOptions, PaginatedListIterator, SortableFilterOptions } from '../
 import { CalendarItemShareOptions } from '../crypto/entities/CalendarItemShareOptions.mjs';
 import { SecretIdUseOption } from '../crypto/entities/SecretIdUseOption.mjs';
 import { CalendarItem, DecryptedCalendarItem, EncryptedCalendarItem } from '../model/CalendarItem.mjs';
+import { CalendarItemOccupancy } from '../model/CalendarItemOccupancy.mjs';
 import { EntityReferenceInGroup } from '../model/EntityReferenceInGroup.mjs';
 import { GroupScoped } from '../model/GroupScoped.mjs';
 import { Patient } from '../model/Patient.mjs';
@@ -72,6 +73,21 @@ export interface CalendarItemInGroupApi {
      *  In-group version of [CalendarItemApi.matchCalendarItemsBySorted]
      */
     matchCalendarItemsBySorted(groupId: string, filter: SortableFilterOptions<CalendarItem>): Promise<Array<string>>;
+    /**
+     *
+     *  In-group version of [CalendarItemApi.getCalendarItemsOccupancyByPeriodForSelf].
+     */
+    getCalendarItemsOccupancyByPeriodForSelf(groupId: string, startDate: number, endDate: number, extensionInDays: number | undefined): Promise<Array<CalendarItemOccupancy>>;
+    /**
+     *
+     *  In-group version of [CalendarItemApi.getCalendarItemsOccupancyByPeriodForHealthcareParty].
+     */
+    getCalendarItemsOccupancyByPeriodForHealthcareParty(groupId: string, startDate: number, endDate: number, hcPartyId: string, extensionInDays: number | undefined): Promise<Array<CalendarItemOccupancy>>;
+    /**
+     *
+     *  In-group version of [CalendarItemApi.getCalendarItemsOccupancyByPeriodAndAgendaId].
+     */
+    getCalendarItemsOccupancyByPeriodAndAgendaId(groupId: string, startDate: number, endDate: number, agendaId: string, extensionInDays: number | undefined): Promise<Array<CalendarItemOccupancy>>;
     /**
      *
      *  In-group version of [CalendarItemBasicFlavourlessApi.deleteCalendarItemById]