@wix/calendar 1.0.46 → 1.0.48
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.
- package/package.json +6 -6
- package/type-bundles/context.bundle.d.ts +104 -86
- package/type-bundles/index.bundle.d.ts +104 -86
- package/type-bundles/meta.bundle.d.ts +36 -27
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/calendar",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.48",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"registry": "https://registry.npmjs.org/",
|
|
6
6
|
"access": "public"
|
|
@@ -21,11 +21,11 @@
|
|
|
21
21
|
"type-bundles"
|
|
22
22
|
],
|
|
23
23
|
"dependencies": {
|
|
24
|
-
"@wix/calendar_event-views": "1.0.
|
|
25
|
-
"@wix/calendar_events": "1.0.
|
|
24
|
+
"@wix/calendar_event-views": "1.0.16",
|
|
25
|
+
"@wix/calendar_events": "1.0.30",
|
|
26
26
|
"@wix/calendar_participations": "1.0.12",
|
|
27
|
-
"@wix/calendar_schedule-time-frames": "1.0.
|
|
28
|
-
"@wix/calendar_schedules": "1.0.
|
|
27
|
+
"@wix/calendar_schedule-time-frames": "1.0.20",
|
|
28
|
+
"@wix/calendar_schedules": "1.0.24"
|
|
29
29
|
},
|
|
30
30
|
"devDependencies": {
|
|
31
31
|
"glob": "^10.4.1",
|
|
@@ -50,5 +50,5 @@
|
|
|
50
50
|
"fqdn": ""
|
|
51
51
|
}
|
|
52
52
|
},
|
|
53
|
-
"falconPackageHash": "
|
|
53
|
+
"falconPackageHash": "170bf682cee861a1454e5e166c5aa58a7221af02c180b518cd6e0dd9"
|
|
54
54
|
}
|
|
@@ -499,6 +499,8 @@ interface Event$1 {
|
|
|
499
499
|
scheduleId?: string | null;
|
|
500
500
|
/**
|
|
501
501
|
* ID of the external schedule the event belongs to.
|
|
502
|
+
*
|
|
503
|
+
* For example, if the event belongs to a Bookings staff member, identical to the ID of the [resource](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction). If the schedule belongs to a Bookings service, identical to the ID of the [service](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/setup).
|
|
502
504
|
* @readonly
|
|
503
505
|
*/
|
|
504
506
|
externalScheduleId?: string | null;
|
|
@@ -508,11 +510,11 @@ interface Event$1 {
|
|
|
508
510
|
*/
|
|
509
511
|
scheduleName?: string | null;
|
|
510
512
|
/**
|
|
511
|
-
* Event type. You can
|
|
513
|
+
* Event type. You can set the event type but you can't update it.
|
|
512
514
|
*
|
|
513
515
|
* Supported values:
|
|
514
516
|
* + `DEFAULT`: A standard event that's not further specified.
|
|
515
|
-
* + `WORKING_HOURS`:
|
|
517
|
+
* + `WORKING_HOURS`: The event adds working hours to a schedule. By default not returned in [queryEvents()](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/query-events).
|
|
516
518
|
*
|
|
517
519
|
* Additional supported values, if Wix Bookings is installed:
|
|
518
520
|
* + `APPOINTMENT`: Bookings appointment event.
|
|
@@ -587,6 +589,7 @@ interface Event$1 {
|
|
|
587
589
|
* Recurrence pattern for a series of events. This field is required when
|
|
588
590
|
* creating a `MASTER` event and isn't available for non-recurring events.
|
|
589
591
|
* You can't update the recurrence rule for `INSTANCE` or `EXCEPTION` events.
|
|
592
|
+
*
|
|
590
593
|
* For example, an event that repeats every second Monday until January 7, 2026,
|
|
591
594
|
* at 8:00 AM has the following `recurrenceRule`:
|
|
592
595
|
* - `frequency = WEEKLY`
|
|
@@ -2244,11 +2247,11 @@ interface EventMetadata$4 extends BaseEventMetadata$4 {
|
|
|
2244
2247
|
*/
|
|
2245
2248
|
entityEventSequence?: string | null;
|
|
2246
2249
|
}
|
|
2247
|
-
interface
|
|
2248
|
-
|
|
2250
|
+
interface EventCancelledEnvelope {
|
|
2251
|
+
data: EventCancelled;
|
|
2249
2252
|
metadata: EventMetadata$4;
|
|
2250
2253
|
}
|
|
2251
|
-
interface
|
|
2254
|
+
interface EventCreatedEnvelope {
|
|
2252
2255
|
entity: Event$1;
|
|
2253
2256
|
metadata: EventMetadata$4;
|
|
2254
2257
|
}
|
|
@@ -2256,8 +2259,8 @@ interface EventRecurringSplitEnvelope {
|
|
|
2256
2259
|
data: RecurringEventSplit;
|
|
2257
2260
|
metadata: EventMetadata$4;
|
|
2258
2261
|
}
|
|
2259
|
-
interface
|
|
2260
|
-
|
|
2262
|
+
interface EventUpdatedEnvelope {
|
|
2263
|
+
entity: Event$1;
|
|
2261
2264
|
metadata: EventMetadata$4;
|
|
2262
2265
|
}
|
|
2263
2266
|
interface GetEventOptions {
|
|
@@ -2460,6 +2463,8 @@ interface UpdateEvent {
|
|
|
2460
2463
|
scheduleId?: string | null;
|
|
2461
2464
|
/**
|
|
2462
2465
|
* ID of the external schedule the event belongs to.
|
|
2466
|
+
*
|
|
2467
|
+
* For example, if the event belongs to a Bookings staff member, identical to the ID of the [resource](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction). If the schedule belongs to a Bookings service, identical to the ID of the [service](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/setup).
|
|
2463
2468
|
* @readonly
|
|
2464
2469
|
*/
|
|
2465
2470
|
externalScheduleId?: string | null;
|
|
@@ -2469,11 +2474,11 @@ interface UpdateEvent {
|
|
|
2469
2474
|
*/
|
|
2470
2475
|
scheduleName?: string | null;
|
|
2471
2476
|
/**
|
|
2472
|
-
* Event type. You can
|
|
2477
|
+
* Event type. You can set the event type but you can't update it.
|
|
2473
2478
|
*
|
|
2474
2479
|
* Supported values:
|
|
2475
2480
|
* + `DEFAULT`: A standard event that's not further specified.
|
|
2476
|
-
* + `WORKING_HOURS`:
|
|
2481
|
+
* + `WORKING_HOURS`: The event adds working hours to a schedule. By default not returned in [queryEvents()](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/query-events).
|
|
2477
2482
|
*
|
|
2478
2483
|
* Additional supported values, if Wix Bookings is installed:
|
|
2479
2484
|
* + `APPOINTMENT`: Bookings appointment event.
|
|
@@ -2548,6 +2553,7 @@ interface UpdateEvent {
|
|
|
2548
2553
|
* Recurrence pattern for a series of events. This field is required when
|
|
2549
2554
|
* creating a `MASTER` event and isn't available for non-recurring events.
|
|
2550
2555
|
* You can't update the recurrence rule for `INSTANCE` or `EXCEPTION` events.
|
|
2556
|
+
*
|
|
2551
2557
|
* For example, an event that repeats every second Monday until January 7, 2026,
|
|
2552
2558
|
* at 8:00 AM has the following `recurrenceRule`:
|
|
2553
2559
|
* - `frequency = WEEKLY`
|
|
@@ -2889,16 +2895,9 @@ interface CreateEventSignature {
|
|
|
2889
2895
|
* Creates an event.
|
|
2890
2896
|
*
|
|
2891
2897
|
*
|
|
2892
|
-
* If you provide `recurrenceRule`, an event with `{"recurrenceType": "MASTER"}` is
|
|
2893
|
-
* created. Then, you can't set `start.localDate` to a past date, though the time can be
|
|
2894
|
-
* earlier on the same day. You can, however, create single-occurrence events for
|
|
2895
|
-
* past dates.
|
|
2898
|
+
* 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.
|
|
2896
2899
|
*
|
|
2897
|
-
* You can't create an event with `recurrenceType` set to `INSTANCE` or `EXCEPTION`.
|
|
2898
|
-
* `INSTANCE` events are generated automatically based on the recurrence rule in the
|
|
2899
|
-
* relevant `MASTER` event. `EXCEPTION` events are automatically created when you
|
|
2900
|
-
* [update](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/update-event)
|
|
2901
|
-
* an `INSTANCE` event, which changes its `recurrenceType` to `EXCEPTION`.
|
|
2900
|
+
* 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`.
|
|
2902
2901
|
* @param - Event to create.
|
|
2903
2902
|
* @returns Created event.
|
|
2904
2903
|
*/
|
|
@@ -2979,7 +2978,7 @@ interface RestoreEventDefaultsSignature {
|
|
|
2979
2978
|
* event ID and set `fields` to `["TITLE", "CAPACITY"]`.
|
|
2980
2979
|
*
|
|
2981
2980
|
* Refer to the [default values article](https://dev.wix.com/docs/sdk/backend-modules/calendar/default-values)
|
|
2982
|
-
*
|
|
2981
|
+
* for more information.
|
|
2983
2982
|
* @param - ID of the event for which to restore default values.
|
|
2984
2983
|
* @param - Fields for which to restore default values.
|
|
2985
2984
|
*
|
|
@@ -3076,10 +3075,10 @@ interface ListEventsByMemberIdSignature {
|
|
|
3076
3075
|
*/
|
|
3077
3076
|
(memberId: string | null, options?: ListEventsByMemberIdOptions | undefined): Promise<ListEventsByMemberIdResponse & ListEventsByMemberIdResponseNonNullableFields>;
|
|
3078
3077
|
}
|
|
3078
|
+
declare const onEventCancelled$1: EventDefinition<EventCancelledEnvelope, "wix.calendar.v3.event_cancelled">;
|
|
3079
3079
|
declare const onEventCreated$1: EventDefinition<EventCreatedEnvelope, "wix.calendar.v3.event_created">;
|
|
3080
|
-
declare const onEventUpdated$1: EventDefinition<EventUpdatedEnvelope, "wix.calendar.v3.event_updated">;
|
|
3081
3080
|
declare const onEventRecurringSplit$1: EventDefinition<EventRecurringSplitEnvelope, "wix.calendar.v3.event_recurring_split">;
|
|
3082
|
-
declare const
|
|
3081
|
+
declare const onEventUpdated$1: EventDefinition<EventUpdatedEnvelope, "wix.calendar.v3.event_updated">;
|
|
3083
3082
|
|
|
3084
3083
|
declare function createEventModule$4<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
|
3085
3084
|
|
|
@@ -3097,17 +3096,26 @@ declare const bulkCancelEvent: MaybeContext<BuildRESTFunction<typeof bulkCancelE
|
|
|
3097
3096
|
declare const listEventsByContactId: MaybeContext<BuildRESTFunction<typeof listEventsByContactId$1> & typeof listEventsByContactId$1>;
|
|
3098
3097
|
declare const listEventsByMemberId: MaybeContext<BuildRESTFunction<typeof listEventsByMemberId$1> & typeof listEventsByMemberId$1>;
|
|
3099
3098
|
|
|
3100
|
-
type
|
|
3099
|
+
type _publicOnEventCancelledType = typeof onEventCancelled$1;
|
|
3101
3100
|
/**
|
|
3102
|
-
* Triggered when an event is
|
|
3101
|
+
* Triggered when an event is canceled.
|
|
3102
|
+
*
|
|
3103
|
+
* Not triggered when `INSTANCE` events are canceled. You can use the
|
|
3104
|
+
* [Events View API](https://dev.wix.com/docs/rest/business-management/calendar/event-views-v3/introduction)
|
|
3105
|
+
* to get notified about `INSTANCE` events.
|
|
3103
3106
|
*/
|
|
3104
|
-
declare const
|
|
3107
|
+
declare const onEventCancelled: ReturnType<typeof createEventModule$4<_publicOnEventCancelledType>>;
|
|
3105
3108
|
|
|
3106
|
-
type
|
|
3109
|
+
type _publicOnEventCreatedType = typeof onEventCreated$1;
|
|
3107
3110
|
/**
|
|
3108
|
-
* Triggered when an event is
|
|
3111
|
+
* Triggered when an event is created, including when an existing `MASTER`
|
|
3112
|
+
* event is split.
|
|
3113
|
+
*
|
|
3114
|
+
* Not triggered when `INSTANCE` events are created. You can use the
|
|
3115
|
+
* [Events View API](https://dev.wix.com/docs/rest/business-management/calendar/event-views-v3/introduction)
|
|
3116
|
+
* to get notified about `INSTANCE` events.
|
|
3109
3117
|
*/
|
|
3110
|
-
declare const
|
|
3118
|
+
declare const onEventCreated: ReturnType<typeof createEventModule$4<_publicOnEventCreatedType>>;
|
|
3111
3119
|
|
|
3112
3120
|
type _publicOnEventRecurringSplitType = typeof onEventRecurringSplit$1;
|
|
3113
3121
|
/**
|
|
@@ -3115,11 +3123,15 @@ type _publicOnEventRecurringSplitType = typeof onEventRecurringSplit$1;
|
|
|
3115
3123
|
*/
|
|
3116
3124
|
declare const onEventRecurringSplit: ReturnType<typeof createEventModule$4<_publicOnEventRecurringSplitType>>;
|
|
3117
3125
|
|
|
3118
|
-
type
|
|
3126
|
+
type _publicOnEventUpdatedType = typeof onEventUpdated$1;
|
|
3119
3127
|
/**
|
|
3120
|
-
* Triggered when an event is canceled.
|
|
3128
|
+
* Triggered when an event is updated, including when it's canceled.
|
|
3129
|
+
*
|
|
3130
|
+
* Not triggered when `INSTANCE` events are updated. You can use the
|
|
3131
|
+
* [Events View API](https://dev.wix.com/docs/rest/business-management/calendar/event-views-v3/introduction)
|
|
3132
|
+
* to get notified about `INSTANCE` events.
|
|
3121
3133
|
*/
|
|
3122
|
-
declare const
|
|
3134
|
+
declare const onEventUpdated: ReturnType<typeof createEventModule$4<_publicOnEventUpdatedType>>;
|
|
3123
3135
|
|
|
3124
3136
|
type context$4_ApplicationError = ApplicationError;
|
|
3125
3137
|
type context$4_BulkActionMetadata = BulkActionMetadata;
|
|
@@ -3319,6 +3331,11 @@ interface Event {
|
|
|
3319
3331
|
scheduleId?: string | null;
|
|
3320
3332
|
/**
|
|
3321
3333
|
* ID of the external schedule the event belongs to.
|
|
3334
|
+
*
|
|
3335
|
+
* For example, if the event belongs to a Bookings staff member, identical to
|
|
3336
|
+
* the ID of the [resource](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object).
|
|
3337
|
+
* If the schedule belongs to a Bookings service,
|
|
3338
|
+
* identical to the ID of the [service](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/service-object).
|
|
3322
3339
|
* @readonly
|
|
3323
3340
|
*/
|
|
3324
3341
|
externalScheduleId?: string | null;
|
|
@@ -3328,11 +3345,11 @@ interface Event {
|
|
|
3328
3345
|
*/
|
|
3329
3346
|
scheduleName?: string | null;
|
|
3330
3347
|
/**
|
|
3331
|
-
* Event type. You can
|
|
3348
|
+
* Event type. You can set the event type but you can't update it.
|
|
3332
3349
|
*
|
|
3333
3350
|
* Supported values:
|
|
3334
3351
|
* + `DEFAULT`: A standard event that's not further specified.
|
|
3335
|
-
* + `WORKING_HOURS`:
|
|
3352
|
+
* + `WORKING_HOURS`: The event adds working hours to a schedule. By default not returned in [Query Events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/query-events).
|
|
3336
3353
|
*
|
|
3337
3354
|
* Additional supported values, if Wix Bookings is installed:
|
|
3338
3355
|
* + `APPOINTMENT`: Bookings appointment event.
|
|
@@ -3407,6 +3424,7 @@ interface Event {
|
|
|
3407
3424
|
* Recurrence pattern for a series of events. This field is required when
|
|
3408
3425
|
* creating a `MASTER` event and isn't available for non-recurring events.
|
|
3409
3426
|
* You can't update the recurrence rule for `INSTANCE` or `EXCEPTION` events.
|
|
3427
|
+
*
|
|
3410
3428
|
* For example, an event that repeats every second Monday until January 7, 2026,
|
|
3411
3429
|
* at 8:00 AM has the following `recurrenceRule`:
|
|
3412
3430
|
* - `frequency = WEEKLY`
|
|
@@ -4079,7 +4097,7 @@ type _publicOnEventsViewProjectionUpdatedType = typeof onEventsViewProjectionUpd
|
|
|
4079
4097
|
* Triggered when an [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction)
|
|
4080
4098
|
* is added to, removed from, or updated within the current event view. This includes cases when:
|
|
4081
4099
|
* + A new event is created within the view.
|
|
4082
|
-
* + An existing event within the view is updated,
|
|
4100
|
+
* + An existing event within the view is updated, including when it's rescheduled to start outside the view.
|
|
4083
4101
|
* + An event within the view is deleted.
|
|
4084
4102
|
* + An event previously outside the view is rescheduled to fall within it.
|
|
4085
4103
|
* + The view is extended, bringing an existing event into scope.
|
|
@@ -4809,9 +4827,9 @@ interface Schedule {
|
|
|
4809
4827
|
* External ID. You can't update the external ID.
|
|
4810
4828
|
*
|
|
4811
4829
|
* If the schedule belongs to a Bookings staff member, identical to the ID of
|
|
4812
|
-
* the [resource](https://dev.wix.com/docs/
|
|
4830
|
+
* the [resource](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction).
|
|
4813
4831
|
* If the schedule belongs to a Bookings service, identical to the ID of
|
|
4814
|
-
* the [service](https://dev.wix.com/docs/
|
|
4832
|
+
* the [service](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/setup).
|
|
4815
4833
|
*/
|
|
4816
4834
|
externalId?: string | null;
|
|
4817
4835
|
/**
|
|
@@ -4837,7 +4855,7 @@ interface Schedule {
|
|
|
4837
4855
|
* [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
|
|
4838
4856
|
* For example, `America/New_York`.
|
|
4839
4857
|
*
|
|
4840
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/
|
|
4858
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
4841
4859
|
*
|
|
4842
4860
|
* Min: 1 character
|
|
4843
4861
|
* Max: 150 characters
|
|
@@ -4845,13 +4863,13 @@ interface Schedule {
|
|
|
4845
4863
|
timeZone?: string | null;
|
|
4846
4864
|
/**
|
|
4847
4865
|
* Whether the schedule's `timeZone` is automatically synced from
|
|
4848
|
-
* `timeZone` of the business [site properties](https://dev.wix.com/docs/
|
|
4866
|
+
* `timeZone` of the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
4849
4867
|
*
|
|
4850
4868
|
* Default: `true`
|
|
4851
4869
|
*/
|
|
4852
4870
|
businessTimeZoneEnabled?: boolean | null;
|
|
4853
4871
|
/**
|
|
4854
|
-
* Default `title` for [events](https://dev.wix.com/docs/
|
|
4872
|
+
* Default `title` for [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
|
|
4855
4873
|
* that are added to the schedule.
|
|
4856
4874
|
*
|
|
4857
4875
|
* Min: 1 character
|
|
@@ -4859,34 +4877,34 @@ interface Schedule {
|
|
|
4859
4877
|
*/
|
|
4860
4878
|
defaultTitle?: string | null;
|
|
4861
4879
|
/**
|
|
4862
|
-
* Default `location` for [events](https://dev.wix.com/docs/
|
|
4880
|
+
* Default `location` for [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
|
|
4863
4881
|
* that are added to the schedule.
|
|
4864
4882
|
*/
|
|
4865
4883
|
defaultLocation?: Location;
|
|
4866
4884
|
/**
|
|
4867
|
-
* Default `totalCapacity` for [events](https://dev.wix.com/docs/
|
|
4885
|
+
* Default `totalCapacity` for [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
|
|
4868
4886
|
* that are added to the schedule.
|
|
4869
4887
|
*
|
|
4870
4888
|
* Min: `0`
|
|
4871
4889
|
*/
|
|
4872
4890
|
defaultCapacity?: number | null;
|
|
4873
4891
|
/**
|
|
4874
|
-
* Default `conferencingDetails` for [events](https://dev.wix.com/docs/
|
|
4892
|
+
* Default `conferencingDetails` for [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
|
|
4875
4893
|
* that are added to the schedule.
|
|
4876
|
-
* Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/
|
|
4894
|
+
* Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#retrieve-personal-information).
|
|
4877
4895
|
*/
|
|
4878
4896
|
defaultConferencingDetails?: ConferencingDetails;
|
|
4879
4897
|
/**
|
|
4880
4898
|
* ID of the app that's associated with the schedule. You can't update `appId`.
|
|
4881
4899
|
* If you want to create a schedule and ensure its associated events appear
|
|
4882
4900
|
* in the [Bookings calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar),
|
|
4883
|
-
* you must provide the
|
|
4901
|
+
* you must provide the Wix Bookings app ID
|
|
4884
4902
|
* `13d21c63-b5ec-5912-8397-c3a5ddb27a97`.
|
|
4885
4903
|
*/
|
|
4886
4904
|
appId?: string | null;
|
|
4887
4905
|
/**
|
|
4888
4906
|
* List of permissions associated with the schedule. Refer to the
|
|
4889
|
-
* [permissions article](https://dev.wix.com/docs/
|
|
4907
|
+
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#roles)
|
|
4890
4908
|
* for more information.
|
|
4891
4909
|
*
|
|
4892
4910
|
* Max: 1 permission
|
|
@@ -4921,7 +4939,7 @@ declare enum Status$1 {
|
|
|
4921
4939
|
}
|
|
4922
4940
|
interface Location {
|
|
4923
4941
|
/**
|
|
4924
|
-
* [Location](https://dev.wix.com/docs/
|
|
4942
|
+
* [Location](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction)
|
|
4925
4943
|
* ID. Available only for `BUSINESS` locations.
|
|
4926
4944
|
*/
|
|
4927
4945
|
_id?: string | null;
|
|
@@ -4936,7 +4954,7 @@ interface Location {
|
|
|
4936
4954
|
type?: LocationType;
|
|
4937
4955
|
/**
|
|
4938
4956
|
* Location name. For `BUSINESS` locations, it's identical to the
|
|
4939
|
-
* [location](https://dev.wix.com/docs/
|
|
4957
|
+
* [location](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction)
|
|
4940
4958
|
* `name`.
|
|
4941
4959
|
*
|
|
4942
4960
|
* Min: 1 character
|
|
@@ -5053,7 +5071,7 @@ interface GetScheduleRequest {
|
|
|
5053
5071
|
scheduleId: string | null;
|
|
5054
5072
|
/**
|
|
5055
5073
|
* Information about which fields containing personal data to return. Refer to the
|
|
5056
|
-
* [permissions article](https://dev.wix.com/docs/
|
|
5074
|
+
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
|
|
5057
5075
|
* for more information.
|
|
5058
5076
|
*
|
|
5059
5077
|
* Supported values:
|
|
@@ -5081,7 +5099,7 @@ interface QuerySchedulesRequest {
|
|
|
5081
5099
|
query?: CursorQuery;
|
|
5082
5100
|
/**
|
|
5083
5101
|
* Information about which fields containing personal data to return. Refer to the
|
|
5084
|
-
* [permissions article](https://dev.wix.com/docs/
|
|
5102
|
+
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
|
|
5085
5103
|
* for more information.
|
|
5086
5104
|
*
|
|
5087
5105
|
* Supported values:
|
|
@@ -6016,7 +6034,7 @@ interface ScheduleCancelledEnvelope {
|
|
|
6016
6034
|
interface GetScheduleOptions {
|
|
6017
6035
|
/**
|
|
6018
6036
|
* Information about which fields containing personal data to return. Refer to the
|
|
6019
|
-
* [permissions article](https://dev.wix.com/docs/
|
|
6037
|
+
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
|
|
6020
6038
|
* for more information.
|
|
6021
6039
|
*
|
|
6022
6040
|
* Supported values:
|
|
@@ -6031,7 +6049,7 @@ interface GetScheduleOptions {
|
|
|
6031
6049
|
interface QuerySchedulesOptions {
|
|
6032
6050
|
/**
|
|
6033
6051
|
* Information about which fields containing personal data to return. Refer to the
|
|
6034
|
-
* [permissions article](https://dev.wix.com/docs/
|
|
6052
|
+
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
|
|
6035
6053
|
* for more information.
|
|
6036
6054
|
*
|
|
6037
6055
|
* Supported values:
|
|
@@ -6092,9 +6110,9 @@ interface UpdateSchedule {
|
|
|
6092
6110
|
* External ID. You can't update the external ID.
|
|
6093
6111
|
*
|
|
6094
6112
|
* If the schedule belongs to a Bookings staff member, identical to the ID of
|
|
6095
|
-
* the [resource](https://dev.wix.com/docs/
|
|
6113
|
+
* the [resource](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction).
|
|
6096
6114
|
* If the schedule belongs to a Bookings service, identical to the ID of
|
|
6097
|
-
* the [service](https://dev.wix.com/docs/
|
|
6115
|
+
* the [service](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/setup).
|
|
6098
6116
|
*/
|
|
6099
6117
|
externalId?: string | null;
|
|
6100
6118
|
/**
|
|
@@ -6120,7 +6138,7 @@ interface UpdateSchedule {
|
|
|
6120
6138
|
* [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
|
|
6121
6139
|
* For example, `America/New_York`.
|
|
6122
6140
|
*
|
|
6123
|
-
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/
|
|
6141
|
+
* Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
6124
6142
|
*
|
|
6125
6143
|
* Min: 1 character
|
|
6126
6144
|
* Max: 150 characters
|
|
@@ -6128,13 +6146,13 @@ interface UpdateSchedule {
|
|
|
6128
6146
|
timeZone?: string | null;
|
|
6129
6147
|
/**
|
|
6130
6148
|
* Whether the schedule's `timeZone` is automatically synced from
|
|
6131
|
-
* `timeZone` of the business [site properties](https://dev.wix.com/docs/
|
|
6149
|
+
* `timeZone` of the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
|
|
6132
6150
|
*
|
|
6133
6151
|
* Default: `true`
|
|
6134
6152
|
*/
|
|
6135
6153
|
businessTimeZoneEnabled?: boolean | null;
|
|
6136
6154
|
/**
|
|
6137
|
-
* Default `title` for [events](https://dev.wix.com/docs/
|
|
6155
|
+
* Default `title` for [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
|
|
6138
6156
|
* that are added to the schedule.
|
|
6139
6157
|
*
|
|
6140
6158
|
* Min: 1 character
|
|
@@ -6147,29 +6165,29 @@ interface UpdateSchedule {
|
|
|
6147
6165
|
*/
|
|
6148
6166
|
defaultLocation?: Location;
|
|
6149
6167
|
/**
|
|
6150
|
-
* Default `totalCapacity` for [events](https://dev.wix.com/docs/
|
|
6168
|
+
* Default `totalCapacity` for [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
|
|
6151
6169
|
* that are added to the schedule.
|
|
6152
6170
|
*
|
|
6153
6171
|
* Min: `0`
|
|
6154
6172
|
*/
|
|
6155
6173
|
defaultCapacity?: number | null;
|
|
6156
6174
|
/**
|
|
6157
|
-
* Default `conferencingDetails` for [events](https://dev.wix.com/docs/
|
|
6175
|
+
* Default `conferencingDetails` for [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
|
|
6158
6176
|
* that are added to the schedule.
|
|
6159
|
-
* Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/
|
|
6177
|
+
* Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#retrieve-personal-information).
|
|
6160
6178
|
*/
|
|
6161
6179
|
defaultConferencingDetails?: ConferencingDetails;
|
|
6162
6180
|
/**
|
|
6163
6181
|
* ID of the app that's associated with the schedule. You can't update `appId`.
|
|
6164
6182
|
* If you want to create a schedule and ensure its associated events appear
|
|
6165
6183
|
* in the [Bookings calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar),
|
|
6166
|
-
* you must provide the
|
|
6184
|
+
* you must provide the Wix Bookings app ID
|
|
6167
6185
|
* `13d21c63-b5ec-5912-8397-c3a5ddb27a97`.
|
|
6168
6186
|
*/
|
|
6169
6187
|
appId?: string | null;
|
|
6170
6188
|
/**
|
|
6171
6189
|
* List of permissions associated with the schedule. Refer to the
|
|
6172
|
-
* [permissions article](https://dev.wix.com/docs/
|
|
6190
|
+
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#roles)
|
|
6173
6191
|
* for more information.
|
|
6174
6192
|
*
|
|
6175
6193
|
* Max: 1 permission
|
|
@@ -6227,24 +6245,22 @@ interface GetScheduleSignature {
|
|
|
6227
6245
|
declare function querySchedules$1(httpClient: HttpClient): QuerySchedulesSignature;
|
|
6228
6246
|
interface QuerySchedulesSignature {
|
|
6229
6247
|
/**
|
|
6230
|
-
*
|
|
6248
|
+
* Creates a query to retrieve a list of schedules.
|
|
6231
6249
|
*
|
|
6250
|
+
* The `querySchedules()` function builds a query to retrieve a list of tip settings and returns a `SchedulesQueryBuilder` object.
|
|
6232
6251
|
*
|
|
6252
|
+
* 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/schedules/schedules-query-builder/find) function.
|
|
6233
6253
|
*
|
|
6234
|
-
*
|
|
6235
|
-
* `status` filter.
|
|
6254
|
+
* You can refine the query by chaining `SchedulesQueryBuilder` functions onto the query. `SchedulesQueryBuilder` functions enable you to sort, filter, and control the results that `querySchedules()` returns.
|
|
6236
6255
|
*
|
|
6237
|
-
*
|
|
6256
|
+
* `querySchedules()` runs with the following `SchedulesQueryBuilder` default that you can override:
|
|
6238
6257
|
*
|
|
6239
|
-
*
|
|
6240
|
-
*
|
|
6258
|
+
* + `limit` is `50`.
|
|
6259
|
+
* + Sorted by `id` in ascending order.
|
|
6241
6260
|
*
|
|
6242
|
-
* For
|
|
6243
|
-
* [Schedules V3: Supported Filters](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/supported-filters).
|
|
6261
|
+
* The functions that are chained to `querySchedules()` are applied in the order they are called. For example, if you apply `ascending("status")` and then `ascending("externalId")`, the results are sorted first by the `"status"`, and then, if there are multiple results with the same `"status"`, the items are sorted by `"externalId"`.
|
|
6244
6262
|
*
|
|
6245
|
-
*
|
|
6246
|
-
* [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
|
|
6247
|
-
* and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
6263
|
+
* The following `SchedulesQueryBuilder` functions are supported for the `querySchedules()` function. For a full description of the tip settings object, see the object returned for the [items](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/schedules-query-result/items) property in `SchedulesQueryResult`.
|
|
6248
6264
|
*/
|
|
6249
6265
|
(options?: QuerySchedulesOptions | undefined): SchedulesQueryBuilder;
|
|
6250
6266
|
}
|
|
@@ -6285,7 +6301,7 @@ interface CancelScheduleSignature {
|
|
|
6285
6301
|
* Sets a schedule's `status` to `CANCELLED`.
|
|
6286
6302
|
*
|
|
6287
6303
|
*
|
|
6288
|
-
*
|
|
6304
|
+
* Also cancels future events belonging to the schedule.
|
|
6289
6305
|
*
|
|
6290
6306
|
* Once a schedule is marked as `CANCELLED`, you can't reactivate it, update it,
|
|
6291
6307
|
* or assign new events.
|
|
@@ -6440,7 +6456,7 @@ declare namespace context$1 {
|
|
|
6440
6456
|
*/
|
|
6441
6457
|
interface ScheduleTimeFrame {
|
|
6442
6458
|
/**
|
|
6443
|
-
* ID of the [schedule](https://dev.wix.com/docs/
|
|
6459
|
+
* ID of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
|
|
6444
6460
|
* to which the time frame belongs.
|
|
6445
6461
|
* @readonly
|
|
6446
6462
|
*/
|
|
@@ -6449,21 +6465,21 @@ interface ScheduleTimeFrame {
|
|
|
6449
6465
|
* Information about the presence of recurring events within the schedule.
|
|
6450
6466
|
*
|
|
6451
6467
|
* Supported values:
|
|
6452
|
-
* + `NONE`: No [events](https://dev.wix.com/docs/
|
|
6468
|
+
* + `NONE`: No [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction) are scheduled within the schedule.
|
|
6453
6469
|
* + `FINITE`: All recurring events within the schedule have a defined end date, or there are no recurring events.
|
|
6454
6470
|
* + `INFINITE`: At least one recurring event within the schedule has no end date, meaning it follows an unlimited repetition pattern.
|
|
6455
6471
|
* @readonly
|
|
6456
6472
|
*/
|
|
6457
6473
|
status?: Status;
|
|
6458
6474
|
/**
|
|
6459
|
-
* Start date of the first [event](https://dev.wix.com/docs/
|
|
6475
|
+
* Start date of the first [event](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
|
|
6460
6476
|
* within the schedule. Identical to `event.start.localDate`. Available only if
|
|
6461
6477
|
* `status` is set to `FINITE` or `INFINITE`.
|
|
6462
6478
|
* @readonly
|
|
6463
6479
|
*/
|
|
6464
6480
|
firstEventStartDate?: ZonedDate;
|
|
6465
6481
|
/**
|
|
6466
|
-
* End date of the last [event](https://dev.wix.com/docs/
|
|
6482
|
+
* End date of the last [event](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
|
|
6467
6483
|
* belonging to the schedule. Identical to `event.end.localDate`. Available only if
|
|
6468
6484
|
* `status` is set to `FINITE`.
|
|
6469
6485
|
* @readonly
|
|
@@ -6472,16 +6488,16 @@ interface ScheduleTimeFrame {
|
|
|
6472
6488
|
/**
|
|
6473
6489
|
* Start date of the first [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
|
|
6474
6490
|
* belonging to the schedule, adjusted to `timeZone` of the
|
|
6475
|
-
* [site properties](https://dev.wix.com/docs/
|
|
6491
|
+
* [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
|
|
6476
6492
|
* or the `timeZone` specified in the request.
|
|
6477
6493
|
* Identical to `event.adjustedStart.localDate`.
|
|
6478
6494
|
* @readonly
|
|
6479
6495
|
*/
|
|
6480
6496
|
adjustedFirstEventStartDate?: ZonedDate;
|
|
6481
6497
|
/**
|
|
6482
|
-
* End date of the last [event](https://dev.wix.com/docs/
|
|
6498
|
+
* End date of the last [event](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
|
|
6483
6499
|
* belonging to the schedule, adjusted to `timeZone` of the
|
|
6484
|
-
* [site properties](https://dev.wix.com/docs/
|
|
6500
|
+
* [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
|
|
6485
6501
|
* or the `timeZone` specified in the request.
|
|
6486
6502
|
* Identical to `event.adjustedEnd.localDate`.
|
|
6487
6503
|
* @readonly
|
|
@@ -6531,7 +6547,7 @@ interface ScheduleTimeFrameUpdatedWithMetadata {
|
|
|
6531
6547
|
}
|
|
6532
6548
|
interface GetScheduleTimeFrameRequest {
|
|
6533
6549
|
/**
|
|
6534
|
-
* [Schedule](https://dev.wix.com/docs/
|
|
6550
|
+
* [Schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
|
|
6535
6551
|
* ID for which to retrieve the schedule time frame.
|
|
6536
6552
|
*/
|
|
6537
6553
|
_id: string | null;
|
|
@@ -6997,17 +7013,17 @@ interface ScheduleTimeFrameUpdatedEnvelope {
|
|
|
6997
7013
|
}
|
|
6998
7014
|
interface GetScheduleTimeFrameOptions {
|
|
6999
7015
|
/**
|
|
7000
|
-
* Time zone for adjusting the times of the returned schedule time frame.
|
|
7016
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting the times of the returned schedule time frame. For example, `America/New_York` or `UTC`.
|
|
7001
7017
|
*
|
|
7002
|
-
* Default: `timeZone` of the [site properties](https://dev.wix.com/docs/
|
|
7018
|
+
* Default: `timeZone` of the [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
|
|
7003
7019
|
*/
|
|
7004
7020
|
timeZone?: string | null;
|
|
7005
7021
|
}
|
|
7006
7022
|
interface ListScheduleTimeFramesOptions {
|
|
7007
7023
|
/**
|
|
7008
|
-
* Time zone for adjusting the times of the returned schedule time
|
|
7024
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting the times of the returned schedule time frame. For example, `America/New_York` or `UTC`.
|
|
7009
7025
|
*
|
|
7010
|
-
* Default: `timeZone` of the [site properties](https://dev.wix.com/docs/
|
|
7026
|
+
* Default: `timeZone` of the [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
|
|
7011
7027
|
*/
|
|
7012
7028
|
timeZone?: string | null;
|
|
7013
7029
|
}
|
|
@@ -7016,7 +7032,7 @@ declare function getScheduleTimeFrame$1(httpClient: HttpClient): GetScheduleTime
|
|
|
7016
7032
|
interface GetScheduleTimeFrameSignature {
|
|
7017
7033
|
/**
|
|
7018
7034
|
* Retrieves a schedule time frame by schedule ID.
|
|
7019
|
-
* @param - [Schedule](https://dev.wix.com/docs/
|
|
7035
|
+
* @param - [Schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
|
|
7020
7036
|
* ID for which to retrieve the schedule time frame.
|
|
7021
7037
|
* @returns Retrieved schedule time frame.
|
|
7022
7038
|
*/
|
|
@@ -7045,7 +7061,9 @@ declare const listScheduleTimeFrames: MaybeContext<BuildRESTFunction<typeof list
|
|
|
7045
7061
|
|
|
7046
7062
|
type _publicOnScheduleTimeFrameUpdatedType = typeof onScheduleTimeFrameUpdated$1;
|
|
7047
7063
|
/**
|
|
7048
|
-
* Triggered when a schedule time frame is updated
|
|
7064
|
+
* Triggered when a schedule's time frame is updated, indicating a new first or
|
|
7065
|
+
* last event or a change in the recurrence period, such as an extension or
|
|
7066
|
+
* reduction.
|
|
7049
7067
|
*/
|
|
7050
7068
|
declare const onScheduleTimeFrameUpdated: ReturnType<typeof createEventModule<_publicOnScheduleTimeFrameUpdatedType>>;
|
|
7051
7069
|
|