@wix/auto_sdk_calendar_events 1.0.48 → 1.0.50

package/build/internal/es/index.typings.d.mts

@@ -1,4 +1,4 @@
-import { NonNullablePaths } from '@wix/sdk-types';
+import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
 
 /**
  * An event is a scheduled entry on a calendar that includes details like timing,
@@ -662,6 +662,15 @@ interface ParticipantNotification {
      * @maxLength 5000
      */
     message?: string | null;
+    /**
+     * Information about the delivery channels used to send the notification.
+     * For example, `{"channels": "SMS" }`, `{"channels": "EMAIL" }`, or `{"channels": "EMAIL, SMS" }`.
+     *
+     * Max: 10 keys
+     * Max key length: 64 characters
+     * Max value length: 1000 characters
+     */
+    metadata?: Record<string, string>;
 }
 /** Deprecated. Use EventUpdated instead, which includes the modified fields and additional metadata. */
 interface EventUpdatedWithMetadata {
@@ -1981,6 +1990,8 @@ declare function onEventRecurringSplit(handler: (event: EventRecurringSplitEnvel
 interface EventUpdatedEnvelope {
     entity: Event;
     metadata: EventMetadata;
+    /** @hidden */
+    modifiedFields: Record<string, any>;
 }
 /**
  * Triggered when an event is updated, including when it's canceled.
@@ -2362,7 +2373,102 @@ interface EventsQueryBuilder {
  * @fqn wix.calendar.events.v3.EventsService.QueryEvents
  * @requiredField query
  */
-declare function typedQueryEvents(query: CursorQuery, options?: QueryEventsOptions): Promise<NonNullablePaths<QueryEventsResponse, `events` | `events.${number}.status` | `events.${number}.recurrenceType` | `events.${number}.recurrenceRule.frequency` | `events.${number}.transparency` | `events.${number}.location.type` | `events.${number}.participants.status` | `events.${number}.conferencingDetails.type`, 5>>;
+declare function typedQueryEvents(query: EventQuery, options?: QueryEventsOptions): Promise<NonNullablePaths<QueryEventsResponse, `events` | `events.${number}.status` | `events.${number}.recurrenceType` | `events.${number}.recurrenceRule.frequency` | `events.${number}.transparency` | `events.${number}.location.type` | `events.${number}.participants.status` | `events.${number}.conferencingDetails.type`, 5>>;
+interface EventQuerySpec extends QuerySpec {
+    paging: 'cursor';
+    wql: [
+        {
+            fields: ['transparency'];
+            operators: ['$eq'];
+            sort: 'NONE';
+        },
+        {
+            fields: [
+                'appId',
+                'externalScheduleId',
+                'location._id',
+                'location.type',
+                'recurringEventId',
+                'scheduleId',
+                'type'
+            ];
+            operators: ['$eq', '$in'];
+            sort: 'NONE';
+        },
+        {
+            fields: ['participants.total', 'remainingCapacity'];
+            operators: ['$eq', '$gt', '$gte', '$lt', '$lte', '$ne'];
+            sort: 'NONE';
+        },
+        {
+            fields: ['totalCapacity'];
+            operators: ['$eq', '$exists', '$gt', '$gte', '$lt', '$lte', '$ne'];
+            sort: 'NONE';
+        },
+        {
+            fields: ['resources._id', 'resources.transparency', 'resources.type'];
+            operators: ['$hasAll', '$hasSome'];
+            sort: 'NONE';
+        },
+        {
+            fields: ['conferencingDetails', 'location'];
+            operators: ['$exists'];
+            sort: 'NONE';
+        }
+    ];
+}
+type CommonQueryWithEntityContext = Query<Event, EventQuerySpec>;
+type EventQuery = {
+    /**
+    Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`.
+    */
+    cursorPaging?: {
+        /**
+      Number of events to return.
+      Defaults to `50`. Maximum `1000`.
+      @min: 1,
+      @max: 1000
+      */
+        limit?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['limit'] | null;
+        /**
+      Pointer to the next or previous page in the list of results.
+    
+      You can get the relevant cursor token
+      from the `pagingMetadata` object in the previous call's response.
+      Not relevant for the first request.
+      */
+        cursor?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['cursor'] | null;
+    };
+    /**
+    Filter object.
+    See [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language)
+    for more information.
+  
+    Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
+  
+    Do not specify filters for start and end dates inside `query.filter`, instead
+    specify `fromLocalDate` and `toLocalDate`. For a detailed list of supported
+    filters, refer to the [supported filters article](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/supported-filters-and-sorting).
+    */
+    filter?: CommonQueryWithEntityContext['filter'] | null;
+    /**
+    Whether to sort events by their start date in ascending order or by their end date in descending order.
+    Default is start ascending.
+    @maxSize: 1
+    */
+    sort?: {
+        /**
+      The field to sort by.
+      Either `start` or `end`.
+      Default is `start`.
+      */
+        fieldName?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['fieldName'];
+        /**
+      Sort order.
+      */
+        order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
+    }[];
+};
 /**
  * Creates an event.
  *
@@ -2962,4 +3068,4 @@ interface BulkCancelEventOptions {
     timeZone?: string | null;
 }
 
-export { type ActionEvent, type Address, type AddressHint, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkCancelEventApplicationErrors, type BulkCancelEventOptions, type BulkCancelEventRequest, type BulkCancelEventResponse, type BulkCreateEventOptions, type BulkCreateEventRequest, type BulkCreateEventResponse, type BulkEventResult, type BulkUpdateEventOptions, type BulkUpdateEventRequest, type BulkUpdateEventRequestMaskedEvent, type BulkUpdateEventResponse, type BusinessSchedule, type CancelEventApplicationErrors, type CancelEventOptions, type CancelEventRequest, type CancelEventResponse, type Categories, type ChangeContext, type ChangeContextPayloadOneOf, type CommonCursorPaging, type CommonCursorPagingMetadata, type CommonCursors, type CommonIdentificationData, type CommonIdentificationDataIdOneOf, type ConferencingDetails, type ConsentPolicy, type CreateEventOptions, type CreateEventRequest, type CreateEventResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, Day, DayOfWeek, type DayOfWeekWithLiterals, type DayWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type Event, type EventCancelled, type EventCancelledEnvelope, type EventCreatedEnvelope, type EventMetadata, type EventRecurringSplitEnvelope, type EventUpdatedEnvelope, type EventUpdatedWithMetadata, type EventsQueryBuilder, type EventsQueryResult, type ExtendedFields, Field, type FieldWithLiterals, Frequency, type FrequencyWithLiterals, type GeoCoordinates, type GetEventOptions, type GetEventRequest, type GetEventResponse, type IdentificationData, type IdentificationDataIdOneOf, IdentityType, type IdentityTypeWithLiterals, type ItemMetadata, type ListEventsByContactIdOptions, type ListEventsByContactIdRequest, type ListEventsByContactIdResponse, type ListEventsByMemberIdOptions, type ListEventsByMemberIdRequest, type ListEventsByMemberIdResponse, type ListEventsOptions, type ListEventsRequest, type ListEventsResponse, type ListRecurringEventInstancesHistoryRequest, type ListRecurringEventInstancesHistoryResponse, type Locale, type Location, LocationType, type LocationTypeWithLiterals, type MaskedEvent, type MessageEnvelope, type Multilingual, type Participant, type ParticipantNotification, type Participants, ParticipantsStatus, type ParticipantsStatusWithLiterals, type Permission, PlacementType, type PlacementTypeWithLiterals, type Properties, type PropertiesChange, type QueryEventsOptions, type QueryEventsRequest, type QueryEventsResponse, type RecurrenceRule, RecurrenceType, type RecurrenceTypeWithLiterals, type RecurringEventSplit, RequestedFields, type RequestedFieldsWithLiterals, ResolutionMethod, type ResolutionMethodWithLiterals, type Resource, type RestoreEventDefaultsOptions, type RestoreEventDefaultsRequest, type RestoreEventDefaultsResponse, type RestoreInfo, Role, type RoleWithLiterals, type SiteCloned, type SiteCreated, type SitePropertiesEvent, type SitePropertiesNotification, SortOrder, type SortOrderWithLiterals, type Sorting, type SpecialHourPeriod, type SplitRecurringEventOptions, type SplitRecurringEventRequest, type SplitRecurringEventResponse, Status, type StatusWithLiterals, type SupportedLanguage, type TimePeriod, type Translation, Transparency, type TransparencyWithLiterals, Type, type TypeWithLiterals, type UpdateEvent, type UpdateEventOptions, type UpdateEventParticipantsRequest, type UpdateEventParticipantsResponse, type UpdateEventRequest, type UpdateEventResponse, type UpdateEventsWithFixedBusinessResourceIdRequest, type UpdateEventsWithFixedBusinessResourceIdResponse, type UpdateScheduleWithFixedBusinessResourceIdRequest, type UpdateScheduleWithFixedBusinessResourceIdResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type ZonedDate, bulkCancelEvent, bulkCreateEvent, bulkUpdateEvent, cancelEvent, createEvent, getEvent, listEvents, listEventsByContactId, listEventsByMemberId, onEventCancelled, onEventCreated, onEventRecurringSplit, onEventUpdated, queryEvents, restoreEventDefaults, splitRecurringEvent, typedQueryEvents, updateEvent };
+export { type ActionEvent, type Address, type AddressHint, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkCancelEventApplicationErrors, type BulkCancelEventOptions, type BulkCancelEventRequest, type BulkCancelEventResponse, type BulkCreateEventOptions, type BulkCreateEventRequest, type BulkCreateEventResponse, type BulkEventResult, type BulkUpdateEventOptions, type BulkUpdateEventRequest, type BulkUpdateEventRequestMaskedEvent, type BulkUpdateEventResponse, type BusinessSchedule, type CancelEventApplicationErrors, type CancelEventOptions, type CancelEventRequest, type CancelEventResponse, type Categories, type ChangeContext, type ChangeContextPayloadOneOf, type CommonCursorPaging, type CommonCursorPagingMetadata, type CommonCursors, type CommonIdentificationData, type CommonIdentificationDataIdOneOf, type CommonQueryWithEntityContext, type ConferencingDetails, type ConsentPolicy, type CreateEventOptions, type CreateEventRequest, type CreateEventResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, Day, DayOfWeek, type DayOfWeekWithLiterals, type DayWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type Event, type EventCancelled, type EventCancelledEnvelope, type EventCreatedEnvelope, type EventMetadata, type EventQuery, type EventQuerySpec, type EventRecurringSplitEnvelope, type EventUpdatedEnvelope, type EventUpdatedWithMetadata, type EventsQueryBuilder, type EventsQueryResult, type ExtendedFields, Field, type FieldWithLiterals, Frequency, type FrequencyWithLiterals, type GeoCoordinates, type GetEventOptions, type GetEventRequest, type GetEventResponse, type IdentificationData, type IdentificationDataIdOneOf, IdentityType, type IdentityTypeWithLiterals, type ItemMetadata, type ListEventsByContactIdOptions, type ListEventsByContactIdRequest, type ListEventsByContactIdResponse, type ListEventsByMemberIdOptions, type ListEventsByMemberIdRequest, type ListEventsByMemberIdResponse, type ListEventsOptions, type ListEventsRequest, type ListEventsResponse, type ListRecurringEventInstancesHistoryRequest, type ListRecurringEventInstancesHistoryResponse, type Locale, type Location, LocationType, type LocationTypeWithLiterals, type MaskedEvent, type MessageEnvelope, type Multilingual, type Participant, type ParticipantNotification, type Participants, ParticipantsStatus, type ParticipantsStatusWithLiterals, type Permission, PlacementType, type PlacementTypeWithLiterals, type Properties, type PropertiesChange, type QueryEventsOptions, type QueryEventsRequest, type QueryEventsResponse, type RecurrenceRule, RecurrenceType, type RecurrenceTypeWithLiterals, type RecurringEventSplit, RequestedFields, type RequestedFieldsWithLiterals, ResolutionMethod, type ResolutionMethodWithLiterals, type Resource, type RestoreEventDefaultsOptions, type RestoreEventDefaultsRequest, type RestoreEventDefaultsResponse, type RestoreInfo, Role, type RoleWithLiterals, type SiteCloned, type SiteCreated, type SitePropertiesEvent, type SitePropertiesNotification, SortOrder, type SortOrderWithLiterals, type Sorting, type SpecialHourPeriod, type SplitRecurringEventOptions, type SplitRecurringEventRequest, type SplitRecurringEventResponse, Status, type StatusWithLiterals, type SupportedLanguage, type TimePeriod, type Translation, Transparency, type TransparencyWithLiterals, Type, type TypeWithLiterals, type UpdateEvent, type UpdateEventOptions, type UpdateEventParticipantsRequest, type UpdateEventParticipantsResponse, type UpdateEventRequest, type UpdateEventResponse, type UpdateEventsWithFixedBusinessResourceIdRequest, type UpdateEventsWithFixedBusinessResourceIdResponse, type UpdateScheduleWithFixedBusinessResourceIdRequest, type UpdateScheduleWithFixedBusinessResourceIdResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type ZonedDate, bulkCancelEvent, bulkCreateEvent, bulkUpdateEvent, cancelEvent, createEvent, getEvent, listEvents, listEventsByContactId, listEventsByMemberId, onEventCancelled, onEventCreated, onEventRecurringSplit, onEventUpdated, queryEvents, restoreEventDefaults, splitRecurringEvent, typedQueryEvents, updateEvent };