import { EventDefinition, HttpClient } from '@wix/sdk-types'; import { BulkCancelEventOptions, BulkCancelEventResponse, BulkCancelEventResponseNonNullableFields, BulkCreateEventOptions, BulkCreateEventResponse, BulkCreateEventResponseNonNullableFields, BulkUpdateEventOptions, BulkUpdateEventRequestMaskedEvent, BulkUpdateEventResponse, BulkUpdateEventResponseNonNullableFields, CancelEventOptions, CancelEventResponse, CancelEventResponseNonNullableFields, CreateEventOptions, Event, EventCancelledEnvelope, EventCreatedEnvelope, EventNonNullableFields, EventRecurringSplitEnvelope, EventUpdatedEnvelope, EventsQueryBuilder, Field, GetEventOptions, ListEventsByContactIdOptions, ListEventsByContactIdResponse, ListEventsByContactIdResponseNonNullableFields, ListEventsByMemberIdOptions, ListEventsByMemberIdResponse, ListEventsByMemberIdResponseNonNullableFields, ListEventsOptions, ListEventsResponse, ListEventsResponseNonNullableFields, MaskedEvent, QueryEventsOptions, RestoreEventDefaultsOptions, RestoreEventDefaultsResponse, RestoreEventDefaultsResponseNonNullableFields, SplitRecurringEventOptions, SplitRecurringEventResponse, SplitRecurringEventResponseNonNullableFields, UpdateEvent, UpdateEventOptions } from './calendar-v3-event-events.universal.js'; export declare const __metadata: { PACKAGE_NAME: string; }; export declare function getEvent(httpClient: HttpClient): GetEventSignature; interface GetEventSignature { /** * Retrieves an event. * @param - ID of the event to retrieve. * * Min: 36 characters * Max: 250 characters * @returns Retrieved event. */ (eventId: string | null, options?: GetEventOptions | undefined): Promise; } export declare function listEvents(httpClient: HttpClient): ListEventsSignature; interface ListEventsSignature { /** * Retrieves a list of events by their IDs. * @param - IDs of the events to retrieve. * * Min: 1 event ID * Min: 100 event IDs */ (eventIds: string[], options?: ListEventsOptions | undefined): Promise; } export declare function queryEvents(httpClient: HttpClient): QueryEventsSignature; interface QueryEventsSignature { /** * Creates a query to retrieve a list of events. * * The `queryEvents()` function builds a query to retrieve a list of events and returns an `EventsQueryBuilder` object. * * The returned object contains the query definition, which is typically used to run the query using the [find()](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/events-query-builder/find) function. * * You can refine the query by chaining `EventsQueryBuilder` functions onto the query. `EventsQueryBuilder` functions enable you to sort, filter, and control the results that `queryEvents()` returns. * * `queryEvents()` runs with the following `EventsQueryBuilder` default that you can override: * * + `limit` is `50`. * + Sorted by `event.start` in ascending order. * * The functions that are chained to `queryEvents()` are applied in the order they are called. * * The following `EventsQueryBuilder` functions are supported for the `queryEvents()` function. For a full description of the events object, see the object returned for the [items](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/events-query-result/items) property in `EventsQueryResult`. * */ (options?: QueryEventsOptions | undefined): EventsQueryBuilder; } export declare function createEvent(httpClient: HttpClient): CreateEventSignature; interface CreateEventSignature { /** * Creates an event. * * * If you provide `recurrenceRule`, an event with `{"recurrenceType": "MASTER"}` is created. Then, you can't set `start.localDate` to a past date, though the time can be earlier on the same day. You can, however, create single-occurrence events for past dates. * * You can't create an event with `recurrenceType` set to `INSTANCE` or `EXCEPTION`. `INSTANCE` events are generated automatically based on the recurrence rule in the relevant `MASTER` event. `EXCEPTION` events are automatically created when you [update](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/update-event) an `INSTANCE` event, which changes its `recurrenceType` to `EXCEPTION`. * @param - Event to create. * @returns Created event. */ (event: Event, options?: CreateEventOptions | undefined): Promise; } export declare function bulkCreateEvent(httpClient: HttpClient): BulkCreateEventSignature; interface BulkCreateEventSignature { /** * Creates multiple events in bulk. * * * If you provide `recurrenceRule`, an event with `{"recurrenceType": "MASTER"}` is * created. Then, you can't set `start.localDate` to a past date, though the time can be * earlier on the same day. You can, however, create single-occurrence events for * past dates. * * You can't create an event with `recurrenceType` set to `INSTANCE` or `EXCEPTION`. * `INSTANCE` events are generated automatically based on the recurrence rule in the * relevant `MASTER` event. `EXCEPTION` events are automatically created when you * [update](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/update-event) * an `INSTANCE` event, which changes its `recurrenceType` to `EXCEPTION`. * @param - Events to create. */ (events: MaskedEvent[], options?: BulkCreateEventOptions | undefined): Promise; } export declare function updateEvent(httpClient: HttpClient): UpdateEventSignature; interface UpdateEventSignature { /** * Updates an event. * * * When updating an event with `{"recurrenceType": "INSTANCE"}`, the * `recurrenceType` automatically changes to `EXCEPTION`. * * When updating an event with `{"recurrenceType": "MASTER"}`: * + Past `INSTANCE` and `EXCEPTION` events remain unchanged. * + For future `INSTANCE` events, all relevant fields are updated. * + For future `EXCEPTION` events, only changes to the `inheritedFields` are * applied, while other fields remain unchanged. * @param - Event ID. * @returns Updated event. */ (_id: string | null, event: UpdateEvent, options?: UpdateEventOptions | undefined): Promise; } export declare function bulkUpdateEvent(httpClient: HttpClient): BulkUpdateEventSignature; interface BulkUpdateEventSignature { /** * Updates multiple events in bulk. * * * When updating an event with `{"recurrenceType": "INSTANCE"}`, the * `recurrenceType` automatically changes to `EXCEPTION`. * * When updating an event with `{"recurrenceType": "MASTER"}`: * + Past `INSTANCE` and `EXCEPTION` events remain unchanged. * + For future `INSTANCE` events, all relevant fields are updated. * + For future `EXCEPTION` events, only changes to the `inheritedFields` are * applied, while other fields remain unchanged. * @param - Events to update. * * Min: 1 event * Max: 50 events */ (events: BulkUpdateEventRequestMaskedEvent[], options?: BulkUpdateEventOptions | undefined): Promise; } export declare function restoreEventDefaults(httpClient: HttpClient): RestoreEventDefaultsSignature; interface RestoreEventDefaultsSignature { /** * Restores the event's default values from the relevant schedule or `MASTER` * event. * * * You must provide `fields` to specify which `inheritedFields` are restored. * * For example, if you've created an event that takes place in a non-default * location with a custom title and capacity, but you want to reset only title * and capacity to default values without affecting the location, provide the * event ID and set `fields` to `["TITLE", "CAPACITY"]`. * * Refer to the [default values article](https://dev.wix.com/docs/sdk/backend-modules/calendar/default-values) * for more information. * @param - ID of the event for which to restore default values. * @param - Fields for which to restore default values. * * `TIME` restores default values for `start` and `end`. * * Min: 1 field */ (eventId: string | null, fields: Field[], options?: RestoreEventDefaultsOptions | undefined): Promise; } export declare function splitRecurringEvent(httpClient: HttpClient): SplitRecurringEventSignature; interface SplitRecurringEventSignature { /** * Splits a recurring `MASTER` event into 2 separate `MASTER` events. * * * You must provide a `splitLocalDate` that's in the future and after the `start` * date of the next `INSTANCE` or `EXCEPTION` event in the series. Additionally, * there must be another `INSTANCE` or `EXCEPTION` event following this next event, * as the changes wouldn't affect any event without a subsequent occurrence. * * If you want to modify a `MASTER` event with the changes already applying to * the very next event, use * [updateEvent()](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/update-event) * instead, as this preserves past events and only modifies future events. * * The main consequences are: * - **The original `MASTER` event is shortened**. Its `recurrenceRule.until.localDate` * is updated to `end.localDate` of the latest `INSTANCE` or `EXCEPTION` * event starting before `splitLocalDate`. If an `INSTANCE` or `EXCEPTION` event * starts before but ends after `splitLocalDate`, `until.localDate` is set * to value that's later than `splitLocalDate`. * - **A new `MASTER` event is created**, starting from the first event that * begins after `splitLocalDate`. * - **Existing `INSTANCE` and `EXCEPTION` events that occur after the split are updated**. * Their `recurringEventId` is set to the ID of the newly created `MASTER` event. * @param - ID of the `MASTER` event to split. * @param - Local date and time at which the `MASTER` event is split in * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example, * `2025-03-11T09:00:00`. * Must be a future date that's after the `start` date of the next `INSTANCE` or * `EXCEPTION` event in the series. Additionally, there must be another * `INSTANCE` or `EXCEPTION` event following this next event, as the changes * wouldn't affect any event without a subsequent occurrence. */ (recurringEventId: string | null, splitLocalDate: string | null, options?: SplitRecurringEventOptions | undefined): Promise; } export declare function cancelEvent(httpClient: HttpClient): CancelEventSignature; interface CancelEventSignature { /** * Cancels an event. * @param - ID of the event to cancel. */ (eventId: string | null, options?: CancelEventOptions | undefined): Promise; } export declare function bulkCancelEvent(httpClient: HttpClient): BulkCancelEventSignature; interface BulkCancelEventSignature { /** * Cancels multiple events in bulk. * @param - IDs of the events to cancel. */ (eventIds: string[], options?: BulkCancelEventOptions | undefined): Promise; } export declare function listEventsByContactId(httpClient: HttpClient): ListEventsByContactIdSignature; interface ListEventsByContactIdSignature { /** * Retrieves a list of events filtered by the participant's * [contact](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction) * ID. * * * You can't set `toLocalDate` to a value that's more than a full year after * `fromLocalDate`. * @param - ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object) * to retrieve events for. Required, unless you provide `cursorPaging`. */ (contactId: string | null, options?: ListEventsByContactIdOptions | undefined): Promise; } export declare function listEventsByMemberId(httpClient: HttpClient): ListEventsByMemberIdSignature; interface ListEventsByMemberIdSignature { /** * Retrieves a list of events filtered by the participant's * [member](https://dev.wix.com/docs/sdk/backend-modules/members/members/introduction) * ID. * * * You can't set `toLocalDate` to a value that's more than a full year after * `fromLocalDate`. * @param - ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object) * to retrieve events for. Required, unless you provide `cursorPaging`. * Provide `me` to retrieve events for the currently logged-in member. * You must have the `Read Calendars - Including PI` * [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app) * to retrieve events for members who aren't the currently logged in member. */ (memberId: string | null, options?: ListEventsByMemberIdOptions | undefined): Promise; } export declare const onEventCancelled: EventDefinition; export declare const onEventCreated: EventDefinition; export declare const onEventRecurringSplit: EventDefinition; export declare const onEventUpdated: EventDefinition; export { ActionEvent, Address, AddressHint, ApplicationError, BaseEventMetadata, BulkActionMetadata, BulkCancelEventOptions, BulkCancelEventRequest, BulkCancelEventResponse, BulkCancelEventResponseNonNullableFields, BulkCreateEventOptions, BulkCreateEventRequest, BulkCreateEventResponse, BulkCreateEventResponseNonNullableFields, BulkEventResult, BulkUpdateEventOptions, BulkUpdateEventRequest, BulkUpdateEventRequestMaskedEvent, BulkUpdateEventResponse, BulkUpdateEventResponseNonNullableFields, BusinessSchedule, CancelEventOptions, CancelEventRequest, CancelEventResponse, CancelEventResponseNonNullableFields, Categories, ChangeContext, ChangeContextPayloadOneOf, CommonCursorPaging, CommonCursorPagingMetadata, CommonCursors, CommonIdentificationData, CommonIdentificationDataIdOneOf, ConferencingDetails, ConsentPolicy, CreateEventOptions, CreateEventRequest, CreateEventResponse, CreateEventResponseNonNullableFields, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, Day, DayOfWeek, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, Event, EventCancelled, EventCancelledEnvelope, EventCreatedEnvelope, EventMetadata, EventNonNullableFields, EventRecurringSplitEnvelope, EventUpdatedEnvelope, EventUpdatedWithMetadata, EventsQueryBuilder, EventsQueryResult, ExtendedFields, Field, Frequency, GeoCoordinates, GetEventOptions, GetEventRequest, GetEventResponse, GetEventResponseNonNullableFields, IdentificationData, IdentificationDataIdOneOf, IdentityType, ItemMetadata, ListEventsByContactIdOptions, ListEventsByContactIdRequest, ListEventsByContactIdResponse, ListEventsByContactIdResponseNonNullableFields, ListEventsByMemberIdOptions, ListEventsByMemberIdRequest, ListEventsByMemberIdResponse, ListEventsByMemberIdResponseNonNullableFields, ListEventsOptions, ListEventsRequest, ListEventsResponse, ListEventsResponseNonNullableFields, ListRecurringEventInstancesHistoryRequest, ListRecurringEventInstancesHistoryResponse, Locale, Location, LocationType, MaskedEvent, MessageEnvelope, MigrateSiteRequest, MigrateSiteResponse, Multilingual, Participant, ParticipantNotification, Participants, ParticipantsStatus, Permission, PlacementType, Properties, PropertiesChange, QueryEventsOptions, QueryEventsRequest, QueryEventsResponse, QueryEventsResponseNonNullableFields, RecurrenceRule, RecurrenceType, RecurringEventSplit, RequestedFields, ResolutionMethod, Resource, RestoreEventDefaultsOptions, RestoreEventDefaultsRequest, RestoreEventDefaultsResponse, RestoreEventDefaultsResponseNonNullableFields, RestoreInfo, Role, SiteCloned, SiteCreated, SitePropertiesEvent, SitePropertiesNotification, SortOrder, Sorting, SpecialHourPeriod, SplitRecurringEventOptions, SplitRecurringEventRequest, SplitRecurringEventResponse, SplitRecurringEventResponseNonNullableFields, Status, SupportedLanguage, TimePeriod, Translation, Transparency, Type, UpdateEvent, UpdateEventOptions, UpdateEventParticipantsRequest, UpdateEventParticipantsResponse, UpdateEventRequest, UpdateEventResponse, UpdateEventResponseNonNullableFields, UpdateEventsWithFixedBusinessResourceIdRequest, UpdateEventsWithFixedBusinessResourceIdResponse, UpdateScheduleWithFixedBusinessResourceIdRequest, UpdateScheduleWithFixedBusinessResourceIdResponse, WebhookIdentityType, ZonedDate, } from './calendar-v3-event-events.universal.js';