@wix/auto_sdk_calendar_events 1.0.36 → 1.0.38

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.
@@ -1837,11 +1837,13 @@ interface BulkCancelEventResponse {
1837
1837
  /** Total successes and failures. */
1838
1838
  bulkActionMetadata?: BulkActionMetadata;
1839
1839
  }
1840
+ /** @docsIgnore */
1840
1841
  type CancelEventApplicationErrors = {
1841
1842
  code?: 'EVENT_ALREADY_CANCELLED';
1842
1843
  description?: string;
1843
1844
  data?: Record<string, any>;
1844
1845
  };
1846
+ /** @docsIgnore */
1845
1847
  type BulkCancelEventApplicationErrors = {
1846
1848
  code?: 'EVENT_ALREADY_CANCELLED';
1847
1849
  description?: string;
@@ -2008,7 +2010,6 @@ interface EventUpdatedEnvelope {
2008
2010
  * @slug updated
2009
2011
  */
2010
2012
  declare function onEventUpdated(handler: (event: EventUpdatedEnvelope) => void | Promise<void>): void;
2011
- type EventNonNullablePaths = `status` | `recurrenceType` | `recurrenceRule.frequency` | `recurrenceRule.days` | `transparency` | `location.type` | `resources` | `resources.${number}.transparency` | `resources.${number}.permissionRole` | `participants.list` | `participants.status` | `conferencingDetails.type` | `inheritedFields` | `permissions` | `permissions.${number}.identity.wixUserId` | `permissions.${number}.role`;
2012
2013
  /**
2013
2014
  * Retrieves a list of events filtered by the participant's
2014
2015
  * [contact](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction)
@@ -2025,9 +2026,7 @@ type EventNonNullablePaths = `status` | `recurrenceType` | `recurrenceRule.frequ
2025
2026
  * @applicableIdentity APP
2026
2027
  * @fqn wix.calendar.participantevents.v3.ParticipantEventsService.ListEventsByContactId
2027
2028
  */
2028
- declare function listEventsByContactId(contactId: string, options?: ListEventsByContactIdOptions): Promise<NonNullablePaths<ListEventsByContactIdResponse, {
2029
- [P in EventNonNullablePaths]: `events.${number}.${P}`;
2030
- }[EventNonNullablePaths]>>;
2029
+ declare function listEventsByContactId(contactId: string, options?: ListEventsByContactIdOptions): Promise<NonNullablePaths<ListEventsByContactIdResponse, `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>>;
2031
2030
  interface ListEventsByContactIdOptions {
2032
2031
  /**
2033
2032
  * Local start date and time from which events are returned in
@@ -2092,12 +2091,9 @@ interface ListEventsByContactIdOptions {
2092
2091
  * @permissionId CALENDAR.EVENT_READ
2093
2092
  * @permissionId CALENDAR.EVENT_READ_PI
2094
2093
  * @applicableIdentity APP
2095
- * @applicableIdentity VISITOR
2096
2094
  * @fqn wix.calendar.participantevents.v3.ParticipantEventsService.ListEventsByMemberId
2097
2095
  */
2098
- declare function listEventsByMemberId(memberId: string, options?: ListEventsByMemberIdOptions): Promise<NonNullablePaths<ListEventsByMemberIdResponse, {
2099
- [P in EventNonNullablePaths]: `events.${number}.${P}`;
2100
- }[EventNonNullablePaths]>>;
2096
+ declare function listEventsByMemberId(memberId: string, options?: ListEventsByMemberIdOptions): Promise<NonNullablePaths<ListEventsByMemberIdResponse, `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>>;
2101
2097
  interface ListEventsByMemberIdOptions {
2102
2098
  /**
2103
2099
  * Local start date and time from which events are returned in
@@ -2164,11 +2160,10 @@ interface ListEventsByMemberIdOptions {
2164
2160
  * @permissionId CALENDAR.EVENT_READ
2165
2161
  * @permissionId CALENDAR.EVENT_READ_PI
2166
2162
  * @applicableIdentity APP
2167
- * @applicableIdentity VISITOR
2168
2163
  * @returns Retrieved event.
2169
2164
  * @fqn wix.calendar.events.v3.EventsService.GetEvent
2170
2165
  */
2171
- declare function getEvent(eventId: string, options?: GetEventOptions): Promise<NonNullablePaths<Event, EventNonNullablePaths>>;
2166
+ declare function getEvent(eventId: string, options?: GetEventOptions): Promise<NonNullablePaths<Event, `status` | `recurrenceType` | `recurrenceRule.frequency` | `recurrenceRule.days` | `transparency` | `location.type` | `resources` | `resources.${number}.transparency` | `resources.${number}.permissionRole` | `participants.list` | `participants.status` | `conferencingDetails.type` | `inheritedFields` | `permissions` | `permissions.${number}.identity.wixUserId` | `permissions.${number}.role`, 5>>;
2172
2167
  interface GetEventOptions {
2173
2168
  /**
2174
2169
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
@@ -2204,12 +2199,9 @@ interface GetEventOptions {
2204
2199
  * @permissionId CALENDAR.EVENT_READ
2205
2200
  * @permissionId CALENDAR.EVENT_READ_PI
2206
2201
  * @applicableIdentity APP
2207
- * @applicableIdentity VISITOR
2208
2202
  * @fqn wix.calendar.events.v3.EventsService.ListEvents
2209
2203
  */
2210
- declare function listEvents(eventIds: string[], options?: ListEventsOptions): Promise<NonNullablePaths<ListEventsResponse, {
2211
- [P in EventNonNullablePaths]: `events.${number}.${P}`;
2212
- }[EventNonNullablePaths]>>;
2204
+ declare function listEvents(eventIds: string[], options?: ListEventsOptions): Promise<NonNullablePaths<ListEventsResponse, `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>>;
2213
2205
  interface ListEventsOptions {
2214
2206
  /**
2215
2207
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
@@ -2256,7 +2248,6 @@ interface ListEventsOptions {
2256
2248
  * @permissionId CALENDAR.EVENT_READ
2257
2249
  * @permissionId CALENDAR.EVENT_READ_PI
2258
2250
  * @applicableIdentity APP
2259
- * @applicableIdentity VISITOR
2260
2251
  * @fqn wix.calendar.events.v3.EventsService.QueryEvents
2261
2252
  */
2262
2253
  declare function queryEvents(options?: QueryEventsOptions): EventsQueryBuilder;
@@ -2398,7 +2389,7 @@ interface EventsQueryBuilder {
2398
2389
  * @returns Created event.
2399
2390
  * @fqn wix.calendar.events.v3.EventsService.CreateEvent
2400
2391
  */
2401
- declare function createEvent(event: NonNullablePaths<Event, `conferencingDetails.guestUrl` | `conferencingDetails.hostUrl` | `conferencingDetails.type` | `end` | `end.localDate` | `location.type` | `participants.list.${number}.name` | `recurrenceRule.days` | `recurrenceRule.frequency` | `recurrenceRule.until.localDate` | `resources.${number}._id` | `scheduleId` | `start` | `start.localDate`>, options?: CreateEventOptions): Promise<NonNullablePaths<Event, EventNonNullablePaths>>;
2392
+ declare function createEvent(event: NonNullablePaths<Event, `conferencingDetails.guestUrl` | `conferencingDetails.hostUrl` | `conferencingDetails.type` | `end` | `end.localDate` | `location.type` | `participants.list.${number}.name` | `recurrenceRule.days` | `recurrenceRule.frequency` | `recurrenceRule.until.localDate` | `resources.${number}._id` | `scheduleId` | `start` | `start.localDate`, 5>, options?: CreateEventOptions): Promise<NonNullablePaths<Event, `status` | `recurrenceType` | `recurrenceRule.frequency` | `recurrenceRule.days` | `transparency` | `location.type` | `resources` | `resources.${number}.transparency` | `resources.${number}.permissionRole` | `participants.list` | `participants.status` | `conferencingDetails.type` | `inheritedFields` | `permissions` | `permissions.${number}.identity.wixUserId` | `permissions.${number}.role`, 5>>;
2402
2393
  interface CreateEventOptions {
2403
2394
  /**
2404
2395
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
@@ -2452,9 +2443,7 @@ interface CreateEventOptions {
2452
2443
  * @applicableIdentity APP
2453
2444
  * @fqn wix.calendar.events.v3.EventsService.BulkCreateEvent
2454
2445
  */
2455
- declare function bulkCreateEvent(events: NonNullablePaths<MaskedEvent, `event` | `event.conferencingDetails.guestUrl` | `event.conferencingDetails.hostUrl` | `event.conferencingDetails.type` | `event.end` | `event.end.localDate` | `event.location.type` | `event.participants.list.${number}.name` | `event.recurrenceRule.days` | `event.recurrenceRule.frequency` | `event.recurrenceRule.until.localDate` | `event.resources.${number}._id` | `event.scheduleId` | `event.start` | `event.start.localDate`>[], options?: BulkCreateEventOptions): Promise<NonNullablePaths<BulkCreateEventResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
2456
- [P in EventNonNullablePaths]: `results.${number}.item.${P}`;
2457
- }[EventNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures`>>;
2446
+ declare function bulkCreateEvent(events: NonNullablePaths<MaskedEvent, `event` | `event.conferencingDetails.guestUrl` | `event.conferencingDetails.hostUrl` | `event.conferencingDetails.type` | `event.end` | `event.end.localDate` | `event.location.type` | `event.participants.list.${number}.name` | `event.recurrenceRule.days` | `event.recurrenceRule.frequency` | `event.recurrenceRule.until.localDate` | `event.resources.${number}._id` | `event.scheduleId` | `event.start` | `event.start.localDate`, 6>[], options?: BulkCreateEventOptions): Promise<NonNullablePaths<BulkCreateEventResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.status` | `results.${number}.item.recurrenceType` | `results.${number}.item.recurrenceRule.frequency` | `results.${number}.item.transparency` | `results.${number}.item.location.type` | `results.${number}.item.participants.status` | `results.${number}.item.conferencingDetails.type` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures`, 6>>;
2458
2447
  interface BulkCreateEventOptions {
2459
2448
  /**
2460
2449
  * Whether to return created events.
@@ -2505,7 +2494,7 @@ interface BulkCreateEventOptions {
2505
2494
  * @returns Updated event.
2506
2495
  * @fqn wix.calendar.events.v3.EventsService.UpdateEvent
2507
2496
  */
2508
- declare function updateEvent(_id: string, event: NonNullablePaths<UpdateEvent, `conferencingDetails.guestUrl` | `conferencingDetails.hostUrl` | `conferencingDetails.type` | `end.localDate` | `location.type` | `participants.list.${number}.name` | `recurrenceRule.days` | `recurrenceRule.frequency` | `recurrenceRule.until.localDate` | `resources.${number}._id` | `revision` | `start.localDate`>, options?: UpdateEventOptions): Promise<NonNullablePaths<Event, EventNonNullablePaths>>;
2497
+ declare function updateEvent(_id: string, event: NonNullablePaths<UpdateEvent, `conferencingDetails.guestUrl` | `conferencingDetails.hostUrl` | `conferencingDetails.type` | `end.localDate` | `location.type` | `participants.list.${number}.name` | `recurrenceRule.days` | `recurrenceRule.frequency` | `recurrenceRule.until.localDate` | `resources.${number}._id` | `revision` | `start.localDate`, 5>, options?: UpdateEventOptions): Promise<NonNullablePaths<Event, `status` | `recurrenceType` | `recurrenceRule.frequency` | `recurrenceRule.days` | `transparency` | `location.type` | `resources` | `resources.${number}.transparency` | `resources.${number}.permissionRole` | `participants.list` | `participants.status` | `conferencingDetails.type` | `inheritedFields` | `permissions` | `permissions.${number}.identity.wixUserId` | `permissions.${number}.role`, 5>>;
2509
2498
  interface UpdateEvent {
2510
2499
  /**
2511
2500
  * Event ID.
@@ -2789,9 +2778,7 @@ interface UpdateEventOptions {
2789
2778
  * @applicableIdentity APP
2790
2779
  * @fqn wix.calendar.events.v3.EventsService.BulkUpdateEvent
2791
2780
  */
2792
- declare function bulkUpdateEvent(events: NonNullablePaths<BulkUpdateEventRequestMaskedEvent, `event` | `event._id` | `event.conferencingDetails.guestUrl` | `event.conferencingDetails.hostUrl` | `event.conferencingDetails.type` | `event.end.localDate` | `event.location.type` | `event.participants.list.${number}.name` | `event.recurrenceRule.days` | `event.recurrenceRule.frequency` | `event.recurrenceRule.until.localDate` | `event.resources.${number}._id` | `event.revision` | `event.start.localDate`>[], options?: BulkUpdateEventOptions): Promise<NonNullablePaths<BulkUpdateEventResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
2793
- [P in EventNonNullablePaths]: `results.${number}.item.${P}`;
2794
- }[EventNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures`>>;
2781
+ declare function bulkUpdateEvent(events: NonNullablePaths<BulkUpdateEventRequestMaskedEvent, `event` | `event._id` | `event.conferencingDetails.guestUrl` | `event.conferencingDetails.hostUrl` | `event.conferencingDetails.type` | `event.end.localDate` | `event.location.type` | `event.participants.list.${number}.name` | `event.recurrenceRule.days` | `event.recurrenceRule.frequency` | `event.recurrenceRule.until.localDate` | `event.resources.${number}._id` | `event.revision` | `event.start.localDate`, 6>[], options?: BulkUpdateEventOptions): Promise<NonNullablePaths<BulkUpdateEventResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.status` | `results.${number}.item.recurrenceType` | `results.${number}.item.recurrenceRule.frequency` | `results.${number}.item.transparency` | `results.${number}.item.location.type` | `results.${number}.item.participants.status` | `results.${number}.item.conferencingDetails.type` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures`, 6>>;
2795
2782
  interface BulkUpdateEventOptions {
2796
2783
  /**
2797
2784
  * Whether to return the updated events.
@@ -2841,9 +2828,7 @@ interface BulkUpdateEventOptions {
2841
2828
  * @applicableIdentity APP
2842
2829
  * @fqn wix.calendar.events.v3.EventsService.RestoreEventDefaults
2843
2830
  */
2844
- declare function restoreEventDefaults(eventId: string, fields: FieldWithLiterals[], options?: RestoreEventDefaultsOptions): Promise<NonNullablePaths<RestoreEventDefaultsResponse, {
2845
- [P in EventNonNullablePaths]: `event.${P}`;
2846
- }[EventNonNullablePaths]>>;
2831
+ declare function restoreEventDefaults(eventId: string, fields: FieldWithLiterals[], options?: RestoreEventDefaultsOptions): Promise<NonNullablePaths<RestoreEventDefaultsResponse, `event.status` | `event.recurrenceType` | `event.recurrenceRule.frequency` | `event.recurrenceRule.days` | `event.transparency` | `event.location.type` | `event.resources` | `event.resources.${number}.transparency` | `event.resources.${number}.permissionRole` | `event.participants.list` | `event.participants.status` | `event.conferencingDetails.type` | `event.inheritedFields` | `event.permissions` | `event.permissions.${number}.identity.wixUserId` | `event.permissions.${number}.role`, 6>>;
2847
2832
  interface RestoreEventDefaultsOptions {
2848
2833
  /**
2849
2834
  * Information about whether participants of the updated event are notified and
@@ -2899,11 +2884,7 @@ interface RestoreEventDefaultsOptions {
2899
2884
  * @applicableIdentity APP
2900
2885
  * @fqn wix.calendar.events.v3.EventsService.SplitRecurringEvent
2901
2886
  */
2902
- declare function splitRecurringEvent(recurringEventId: string, splitLocalDate: string, options?: SplitRecurringEventOptions): Promise<NonNullablePaths<SplitRecurringEventResponse, {
2903
- [P in EventNonNullablePaths]: `updatedRecurringEventEndingBeforeSplit.${P}`;
2904
- }[EventNonNullablePaths] | {
2905
- [P in EventNonNullablePaths]: `newRecurringEventStartingFromSplit.${P}`;
2906
- }[EventNonNullablePaths]>>;
2887
+ declare function splitRecurringEvent(recurringEventId: string, splitLocalDate: string, options?: SplitRecurringEventOptions): Promise<NonNullablePaths<SplitRecurringEventResponse, `updatedRecurringEventEndingBeforeSplit.status` | `updatedRecurringEventEndingBeforeSplit.recurrenceType` | `updatedRecurringEventEndingBeforeSplit.recurrenceRule.frequency` | `updatedRecurringEventEndingBeforeSplit.recurrenceRule.days` | `updatedRecurringEventEndingBeforeSplit.transparency` | `updatedRecurringEventEndingBeforeSplit.location.type` | `updatedRecurringEventEndingBeforeSplit.resources` | `updatedRecurringEventEndingBeforeSplit.resources.${number}.transparency` | `updatedRecurringEventEndingBeforeSplit.resources.${number}.permissionRole` | `updatedRecurringEventEndingBeforeSplit.participants.list` | `updatedRecurringEventEndingBeforeSplit.participants.status` | `updatedRecurringEventEndingBeforeSplit.conferencingDetails.type` | `updatedRecurringEventEndingBeforeSplit.inheritedFields` | `updatedRecurringEventEndingBeforeSplit.permissions` | `updatedRecurringEventEndingBeforeSplit.permissions.${number}.identity.wixUserId` | `updatedRecurringEventEndingBeforeSplit.permissions.${number}.role` | `newRecurringEventStartingFromSplit.status` | `newRecurringEventStartingFromSplit.recurrenceType` | `newRecurringEventStartingFromSplit.recurrenceRule.frequency` | `newRecurringEventStartingFromSplit.recurrenceRule.days` | `newRecurringEventStartingFromSplit.transparency` | `newRecurringEventStartingFromSplit.location.type` | `newRecurringEventStartingFromSplit.resources` | `newRecurringEventStartingFromSplit.resources.${number}.transparency` | `newRecurringEventStartingFromSplit.resources.${number}.permissionRole` | `newRecurringEventStartingFromSplit.participants.list` | `newRecurringEventStartingFromSplit.participants.status` | `newRecurringEventStartingFromSplit.conferencingDetails.type` | `newRecurringEventStartingFromSplit.inheritedFields` | `newRecurringEventStartingFromSplit.permissions` | `newRecurringEventStartingFromSplit.permissions.${number}.identity.wixUserId` | `newRecurringEventStartingFromSplit.permissions.${number}.role`, 6>>;
2907
2888
  interface SplitRecurringEventOptions {
2908
2889
  /**
2909
2890
  * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
@@ -2924,9 +2905,7 @@ interface SplitRecurringEventOptions {
2924
2905
  * @applicableIdentity APP
2925
2906
  * @fqn wix.calendar.events.v3.EventsService.CancelEvent
2926
2907
  */
2927
- declare function cancelEvent(eventId: string, options?: CancelEventOptions): Promise<NonNullablePaths<CancelEventResponse, {
2928
- [P in EventNonNullablePaths]: `event.${P}`;
2929
- }[EventNonNullablePaths]> & {
2908
+ declare function cancelEvent(eventId: string, options?: CancelEventOptions): Promise<NonNullablePaths<CancelEventResponse, `event.status` | `event.recurrenceType` | `event.recurrenceRule.frequency` | `event.recurrenceRule.days` | `event.transparency` | `event.location.type` | `event.resources` | `event.resources.${number}.transparency` | `event.resources.${number}.permissionRole` | `event.participants.list` | `event.participants.status` | `event.conferencingDetails.type` | `event.inheritedFields` | `event.permissions` | `event.permissions.${number}.identity.wixUserId` | `event.permissions.${number}.role`, 6> & {
2930
2909
  __applicationErrorsType?: CancelEventApplicationErrors;
2931
2910
  }>;
2932
2911
  interface CancelEventOptions {
@@ -2954,9 +2933,7 @@ interface CancelEventOptions {
2954
2933
  * @applicableIdentity APP
2955
2934
  * @fqn wix.calendar.events.v3.EventsService.BulkCancelEvent
2956
2935
  */
2957
- declare function bulkCancelEvent(eventIds: string[], options?: BulkCancelEventOptions): Promise<NonNullablePaths<BulkCancelEventResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
2958
- [P in EventNonNullablePaths]: `results.${number}.item.${P}`;
2959
- }[EventNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures`> & {
2936
+ declare function bulkCancelEvent(eventIds: string[], options?: BulkCancelEventOptions): Promise<NonNullablePaths<BulkCancelEventResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.status` | `results.${number}.item.recurrenceType` | `results.${number}.item.recurrenceRule.frequency` | `results.${number}.item.transparency` | `results.${number}.item.location.type` | `results.${number}.item.participants.status` | `results.${number}.item.conferencingDetails.type` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures`, 6> & {
2960
2937
  __applicationErrorsType?: BulkCancelEventApplicationErrors;
2961
2938
  }>;
2962
2939
  interface BulkCancelEventOptions {