@wix/auto_sdk_bookings_services 1.0.24 → 1.0.25

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.
Files changed (49) hide show
  1. package/build/cjs/src/bookings-services-v2-service-services.context.d.ts +2 -2
  2. package/build/cjs/src/bookings-services-v2-service-services.context.js +3 -6
  3. package/build/cjs/src/bookings-services-v2-service-services.context.js.map +1 -1
  4. package/build/cjs/src/bookings-services-v2-service-services.public.d.ts +1 -1
  5. package/build/cjs/src/bookings-services-v2-service-services.public.js +2 -5
  6. package/build/cjs/src/bookings-services-v2-service-services.public.js.map +1 -1
  7. package/build/cjs/src/bookings-services-v2-service-services.types.d.ts +312 -603
  8. package/build/cjs/src/bookings-services-v2-service-services.types.js +6 -51
  9. package/build/cjs/src/bookings-services-v2-service-services.types.js.map +1 -1
  10. package/build/cjs/src/bookings-services-v2-service-services.universal.d.ts +242 -533
  11. package/build/cjs/src/bookings-services-v2-service-services.universal.js +7 -52
  12. package/build/cjs/src/bookings-services-v2-service-services.universal.js.map +1 -1
  13. package/build/es/src/bookings-services-v2-service-services.context.d.ts +2 -2
  14. package/build/es/src/bookings-services-v2-service-services.context.js +1 -1
  15. package/build/es/src/bookings-services-v2-service-services.context.js.map +1 -1
  16. package/build/es/src/bookings-services-v2-service-services.public.d.ts +1 -1
  17. package/build/es/src/bookings-services-v2-service-services.public.js +1 -1
  18. package/build/es/src/bookings-services-v2-service-services.public.js.map +1 -1
  19. package/build/es/src/bookings-services-v2-service-services.types.d.ts +312 -603
  20. package/build/es/src/bookings-services-v2-service-services.types.js +5 -50
  21. package/build/es/src/bookings-services-v2-service-services.types.js.map +1 -1
  22. package/build/es/src/bookings-services-v2-service-services.universal.d.ts +242 -533
  23. package/build/es/src/bookings-services-v2-service-services.universal.js +5 -50
  24. package/build/es/src/bookings-services-v2-service-services.universal.js.map +1 -1
  25. package/build/internal/cjs/src/bookings-services-v2-service-services.context.d.ts +2 -2
  26. package/build/internal/cjs/src/bookings-services-v2-service-services.context.js +3 -6
  27. package/build/internal/cjs/src/bookings-services-v2-service-services.context.js.map +1 -1
  28. package/build/internal/cjs/src/bookings-services-v2-service-services.public.d.ts +1 -1
  29. package/build/internal/cjs/src/bookings-services-v2-service-services.public.js +2 -5
  30. package/build/internal/cjs/src/bookings-services-v2-service-services.public.js.map +1 -1
  31. package/build/internal/cjs/src/bookings-services-v2-service-services.types.d.ts +312 -603
  32. package/build/internal/cjs/src/bookings-services-v2-service-services.types.js +6 -51
  33. package/build/internal/cjs/src/bookings-services-v2-service-services.types.js.map +1 -1
  34. package/build/internal/cjs/src/bookings-services-v2-service-services.universal.d.ts +242 -533
  35. package/build/internal/cjs/src/bookings-services-v2-service-services.universal.js +7 -52
  36. package/build/internal/cjs/src/bookings-services-v2-service-services.universal.js.map +1 -1
  37. package/build/internal/es/src/bookings-services-v2-service-services.context.d.ts +2 -2
  38. package/build/internal/es/src/bookings-services-v2-service-services.context.js +1 -1
  39. package/build/internal/es/src/bookings-services-v2-service-services.context.js.map +1 -1
  40. package/build/internal/es/src/bookings-services-v2-service-services.public.d.ts +1 -1
  41. package/build/internal/es/src/bookings-services-v2-service-services.public.js +1 -1
  42. package/build/internal/es/src/bookings-services-v2-service-services.public.js.map +1 -1
  43. package/build/internal/es/src/bookings-services-v2-service-services.types.d.ts +312 -603
  44. package/build/internal/es/src/bookings-services-v2-service-services.types.js +5 -50
  45. package/build/internal/es/src/bookings-services-v2-service-services.types.js.map +1 -1
  46. package/build/internal/es/src/bookings-services-v2-service-services.universal.d.ts +242 -533
  47. package/build/internal/es/src/bookings-services-v2-service-services.universal.js +5 -50
  48. package/build/internal/es/src/bookings-services-v2-service-services.universal.js.map +1 -1
  49. package/package.json +2 -2
@@ -1121,7 +1121,7 @@ export interface Settings {
1121
1121
  */
1122
1122
  keywords?: Keyword[];
1123
1123
  }
1124
- export interface AddOnsGroup {
1124
+ export interface AddOnGroup {
1125
1125
  /**
1126
1126
  * ID of the group.
1127
1127
  * @readonly
@@ -1168,41 +1168,41 @@ export interface SetCustomSlugEvent {
1168
1168
  }
1169
1169
  export interface ServicesUrlsChanged {
1170
1170
  }
1171
- export interface CreateAddOnsGroupRequest {
1172
- /** AddOnsGroup to create. */
1173
- addOnsGroup?: AddOnsGroup;
1171
+ export interface CreateAddOnGroupRequest {
1172
+ /** AddOnGroup to create. */
1173
+ addOnGroup?: AddOnGroup;
1174
1174
  /**
1175
- * ID of the service to create the AddOnsGroup for.
1175
+ * ID of the service to create the AddOnGroup for.
1176
1176
  * @format GUID
1177
1177
  */
1178
1178
  serviceId?: string | null;
1179
1179
  }
1180
- export interface CreateAddOnsGroupResponse {
1181
- /** Created AddOnsGroup. */
1182
- addOnsGroup?: AddOnsGroup;
1180
+ export interface CreateAddOnGroupResponse {
1181
+ /** Created AddOnGroup. */
1182
+ addOnGroup?: AddOnGroup;
1183
1183
  }
1184
- export interface DeleteAddOnsGroupRequest {
1184
+ export interface DeleteAddOnGroupRequest {
1185
1185
  /**
1186
- * ID of the AddOnsGroup to delete.
1186
+ * ID of the AddOnGroup to delete.
1187
1187
  * @format GUID
1188
1188
  */
1189
- addOnsGroupId?: string | null;
1189
+ addOnGroupId?: string | null;
1190
1190
  }
1191
- export interface DeleteAddOnsGroupResponse {
1191
+ export interface DeleteAddOnGroupResponse {
1192
1192
  }
1193
- export interface UpdateAddOnsGroupRequest {
1194
- /** AddOnsGroup to update. */
1195
- addOnsGroup?: AddOnsGroup;
1193
+ export interface UpdateAddOnGroupRequest {
1194
+ /** AddOnGroup to update. */
1195
+ addOnGroup?: AddOnGroup;
1196
1196
  /** Explicit list of fields to update. */
1197
1197
  mask?: string[];
1198
1198
  }
1199
- export interface UpdateAddOnsGroupResponse {
1200
- /** Updated AddOnsGroup */
1201
- addOnsGroup?: AddOnsGroup;
1199
+ export interface UpdateAddOnGroupResponse {
1200
+ /** Updated AddOnGroup */
1201
+ addOnGroup?: AddOnGroup;
1202
1202
  }
1203
- export interface ListAddOnsGroupsByServiceIdRequest {
1203
+ export interface ListAddOnGroupsByServiceIdRequest {
1204
1204
  /**
1205
- * ID of the service to retrieve AddOns for.
1205
+ * ID of the service to retrieve AddOnGroups for.
1206
1206
  * @format GUID
1207
1207
  */
1208
1208
  serviceId?: string | null;
@@ -1213,12 +1213,12 @@ export interface ListAddOnsGroupsByServiceIdRequest {
1213
1213
  */
1214
1214
  groupIds?: string[] | null;
1215
1215
  }
1216
- export interface ListAddOnsGroupsByServiceIdResponse {
1216
+ export interface ListAddOnGroupsByServiceIdResponse {
1217
1217
  /**
1218
1218
  * List of group IDs and their linked AddOns.
1219
1219
  * @maxSize 3
1220
1220
  */
1221
- addOnsGroupsDetails?: AddOnsGroupDetail[];
1221
+ addOnGroupsDetails?: AddOnGroupDetail[];
1222
1222
  }
1223
1223
  export interface AddOn extends AddOnAddOnInfoOneOf {
1224
1224
  /** The AddOn description. */
@@ -1248,7 +1248,7 @@ export interface AddOnAddOnInfoOneOf {
1248
1248
  /** The AddOn max quantity. */
1249
1249
  maxQuantity?: number;
1250
1250
  }
1251
- export interface AddOnsGroupDetail {
1251
+ export interface AddOnGroupDetail {
1252
1252
  /**
1253
1253
  * The group ID.
1254
1254
  * @format GUID
@@ -1469,6 +1469,139 @@ export declare enum WebhookIdentityType {
1469
1469
  WIX_USER = "WIX_USER",
1470
1470
  APP = "APP"
1471
1471
  }
1472
+ export interface AddOnsGroup {
1473
+ /**
1474
+ * ID of the group.
1475
+ * @readonly
1476
+ * @format GUID
1477
+ */
1478
+ _id?: string | null;
1479
+ /**
1480
+ * The name of the group.
1481
+ * @maxLength 100
1482
+ */
1483
+ name?: string | null;
1484
+ /**
1485
+ * The maximum number of AddOns that can be selected from this group.
1486
+ * If not set, there is no upper limit.
1487
+ */
1488
+ maxNumberOfAddOns?: number | null;
1489
+ /**
1490
+ * List of AddOn IDs that are part of this group.
1491
+ * @format GUID
1492
+ * @maxSize 7
1493
+ */
1494
+ addOnIds?: string[] | null;
1495
+ /**
1496
+ * The group prompt.
1497
+ * @maxLength 200
1498
+ */
1499
+ prompt?: string | null;
1500
+ }
1501
+ export interface CreateAddOnsGroupRequest {
1502
+ /** AddOnsGroup to create. */
1503
+ addOnsGroup?: AddOnsGroup;
1504
+ /**
1505
+ * ID of the service to create the AddOnsGroup for.
1506
+ * @format GUID
1507
+ */
1508
+ serviceId?: string | null;
1509
+ }
1510
+ export interface CreateAddOnsGroupResponse {
1511
+ /** Created AddOnsGroup. */
1512
+ addOnsGroup?: AddOnsGroup;
1513
+ }
1514
+ export interface DeleteAddOnsGroupRequest {
1515
+ /**
1516
+ * ID of the AddOnsGroup to delete.
1517
+ * @format GUID
1518
+ */
1519
+ addOnsGroupId?: string | null;
1520
+ }
1521
+ export interface DeleteAddOnsGroupResponse {
1522
+ }
1523
+ export interface UpdateAddOnsGroupRequest {
1524
+ /** AddOnsGroup to update. */
1525
+ addOnsGroup?: AddOnsGroup;
1526
+ /** Explicit list of fields to update. */
1527
+ mask?: string[];
1528
+ }
1529
+ export interface UpdateAddOnsGroupResponse {
1530
+ /** Updated AddOnsGroup */
1531
+ addOnsGroup?: AddOnsGroup;
1532
+ }
1533
+ export interface ListAddOnsGroupsByServiceIdRequest {
1534
+ /**
1535
+ * ID of the service to retrieve AddOns for.
1536
+ * @format GUID
1537
+ */
1538
+ serviceId?: string | null;
1539
+ /**
1540
+ * List of group ids to return. If not provided, all groups are returned.
1541
+ * @format GUID
1542
+ * @maxSize 3
1543
+ */
1544
+ groupIds?: string[] | null;
1545
+ }
1546
+ export interface ListAddOnsGroupsByServiceIdResponse {
1547
+ /**
1548
+ * List of group IDs and their linked AddOns.
1549
+ * @maxSize 3
1550
+ */
1551
+ addOnsGroupsDetails?: AddOnsGroupDetail[];
1552
+ }
1553
+ export interface ListAddOnsGroupsByServiceIdResponseAddOn extends ListAddOnsGroupsByServiceIdResponseAddOnAddOnInfoOneOf {
1554
+ /** The AddOn description. */
1555
+ durationInMinutes?: number;
1556
+ /** The AddOn max quantity. */
1557
+ maxQuantity?: number;
1558
+ /**
1559
+ * The AddOn ID.
1560
+ * @format GUID
1561
+ */
1562
+ addOnId?: string | null;
1563
+ /**
1564
+ * The AddOn name.
1565
+ * @maxLength 100
1566
+ */
1567
+ name?: string | null;
1568
+ /**
1569
+ * The AddOn price.
1570
+ * @maxLength 100
1571
+ */
1572
+ formattedAmount?: string | null;
1573
+ }
1574
+ /** @oneof */
1575
+ export interface ListAddOnsGroupsByServiceIdResponseAddOnAddOnInfoOneOf {
1576
+ /** The AddOn description. */
1577
+ durationInMinutes?: number;
1578
+ /** The AddOn max quantity. */
1579
+ maxQuantity?: number;
1580
+ }
1581
+ export interface AddOnsGroupDetail {
1582
+ /**
1583
+ * The group ID.
1584
+ * @format GUID
1585
+ */
1586
+ groupId?: string | null;
1587
+ /** The group max number of AddOns. */
1588
+ maxNumberOfAddOns?: number | null;
1589
+ /**
1590
+ * The group name.
1591
+ * @maxLength 100
1592
+ */
1593
+ groupName?: string | null;
1594
+ /**
1595
+ * The AddOns information linked to the group.
1596
+ * @maxSize 7
1597
+ */
1598
+ addOns?: ListAddOnsGroupsByServiceIdResponseAddOn[];
1599
+ /**
1600
+ * The group prompt.
1601
+ * @maxLength 200
1602
+ */
1603
+ prompt?: string | null;
1604
+ }
1472
1605
  /**
1473
1606
  * Message for reindexing search data to a given search schema. Support both upsert and delete flows as well as
1474
1607
  * performs context manipulation with adding tenant, provided in message to callscope.
@@ -1733,9 +1866,9 @@ export interface DeleteServiceRequest {
1733
1866
  * Whether to notify participants about the change and an optional
1734
1867
  * custom message.
1735
1868
  */
1736
- participantNotification?: V2ParticipantNotification;
1869
+ participantNotification?: ParticipantNotification;
1737
1870
  }
1738
- export interface V2ParticipantNotification {
1871
+ export interface ParticipantNotification {
1739
1872
  /**
1740
1873
  * Whether to send the message about the changes to the customer.
1741
1874
  *
@@ -1767,7 +1900,7 @@ export interface BulkDeleteServicesRequest {
1767
1900
  * Whether to notify participants about the change and an optional
1768
1901
  * custom message.
1769
1902
  */
1770
- participantNotification?: V2ParticipantNotification;
1903
+ participantNotification?: ParticipantNotification;
1771
1904
  }
1772
1905
  export interface BulkDeleteServicesResponse {
1773
1906
  /** The result of each service removal. */
@@ -1785,7 +1918,7 @@ export interface BulkDeleteServicesByFilterRequest {
1785
1918
  */
1786
1919
  preserveFutureSessionsWithParticipants?: boolean;
1787
1920
  /** Whether to notify participants about the change and an optional custom message. */
1788
- participantNotification?: V2ParticipantNotification;
1921
+ participantNotification?: ParticipantNotification;
1789
1922
  }
1790
1923
  export interface BulkDeleteServicesByFilterResponse {
1791
1924
  /**
@@ -2648,7 +2781,7 @@ export interface SetServiceLocationsRequest {
2648
2781
  * Whether to notify participants about the change of location, and an
2649
2782
  * Optional custom message. The notification is sent only to participants of sessions that are affected by the change.
2650
2783
  */
2651
- participantNotification?: V2ParticipantNotification;
2784
+ participantNotification?: ParticipantNotification;
2652
2785
  }
2653
2786
  export interface RemovedLocationSessionsAction extends RemovedLocationSessionsActionActionOptionsOneOf {
2654
2787
  /**
@@ -2839,11 +2972,11 @@ export interface Category {
2839
2972
  * Default: `CREATED`
2840
2973
  * @readonly
2841
2974
  */
2842
- status?: CategoryStatus;
2975
+ status?: Status;
2843
2976
  /** Sort order of the category in the live site and dashboard. */
2844
2977
  sortOrder?: number | null;
2845
2978
  }
2846
- export declare enum CategoryStatus {
2979
+ export declare enum Status {
2847
2980
  /** The category was created. */
2848
2981
  CREATED = "CREATED",
2849
2982
  /** The category was deleted. */
@@ -2859,52 +2992,88 @@ export declare enum CategoryNotificationEvent {
2859
2992
  }
2860
2993
  export interface Empty {
2861
2994
  }
2862
- export interface ScheduleNotification extends ScheduleNotificationEventOneOf {
2863
- scheduleCreated?: ScheduleCreated;
2864
- scheduleUpdated?: ScheduleUpdated;
2865
- scheduleCancelled?: ScheduleCancelled;
2866
- sessionCreated?: SessionCreated;
2867
- sessionUpdated?: SessionUpdated;
2868
- sessionCancelled?: SessionCancelled;
2869
- availabilityPolicyUpdated?: AvailabilityPolicyUpdated;
2870
- /** @deprecated */
2871
- intervalSplit?: IntervalSplit;
2872
- recurringSessionSplit?: RecurringSessionSplit;
2873
- /**
2874
- * Inspect `schedule.scheduleOwnerUserId` on `scheduleUpdated` instead.
2875
- * @deprecated
2995
+ export interface ResourceNotification {
2996
+ /**
2997
+ * Updated resource entity.
2998
+ * 'resource.schedules' is deprecated and will not be returned. Please use 'resource.scheduleIds' instead.
2876
2999
  */
2877
- scheduleUnassignedFromUser?: ScheduleUnassignedFromUser;
2878
- preserveFutureSessionsWithParticipants?: boolean | null;
3000
+ resource?: Resource;
3001
+ /** Event type. */
3002
+ event?: ResourceNotificationEvent;
3003
+ }
3004
+ export interface Resource {
2879
3005
  /**
2880
- * Whether to notify participants about changed sessions. deprecated, use participant_notification
3006
+ * Resource ID.
3007
+ * @format GUID
3008
+ * @readonly
3009
+ */
3010
+ _id?: string | null;
3011
+ /**
3012
+ * Resource name.
3013
+ * @maxLength 1200
3014
+ */
3015
+ name?: string | null;
3016
+ /**
3017
+ * Resource email address.
3018
+ * @maxLength 500
3019
+ */
3020
+ email?: string | null;
3021
+ /**
3022
+ * Resource phone number.
3023
+ * @maxLength 500
3024
+ */
3025
+ phone?: string | null;
3026
+ /**
3027
+ * Resource description.
3028
+ * @maxLength 500
3029
+ */
3030
+ description?: string | null;
3031
+ /**
3032
+ * Deprecated. Please use tags.
3033
+ * @maxLength 500
2881
3034
  * @deprecated
2882
3035
  */
2883
- notifyParticipants?: boolean;
2884
- /** site properties. Optional. Given in create schedule notification. */
2885
- siteProperties?: SitePropertiesOnScheduleCreation;
2886
- instanceId?: string;
2887
- }
2888
- /** @oneof */
2889
- export interface ScheduleNotificationEventOneOf {
2890
- scheduleCreated?: ScheduleCreated;
2891
- scheduleUpdated?: ScheduleUpdated;
2892
- scheduleCancelled?: ScheduleCancelled;
2893
- sessionCreated?: SessionCreated;
2894
- sessionUpdated?: SessionUpdated;
2895
- sessionCancelled?: SessionCancelled;
2896
- availabilityPolicyUpdated?: AvailabilityPolicyUpdated;
2897
- /** @deprecated */
2898
- intervalSplit?: IntervalSplit;
2899
- recurringSessionSplit?: RecurringSessionSplit;
2900
- /**
2901
- * Inspect `schedule.scheduleOwnerUserId` on `scheduleUpdated` instead.
3036
+ tag?: string | null;
3037
+ /**
3038
+ * Resource tags. Tags are used to identify, group, and filter the different types of resources. For example, 'staff' or 'room'.
3039
+ * @maxLength 200
3040
+ */
3041
+ tags?: string[] | null;
3042
+ /** Resource images. */
3043
+ images?: string[];
3044
+ /**
3045
+ * Deprecated. Please use scheduleIds. List of the schedules owned by this resource. Min size 1.
2902
3046
  * @deprecated
2903
3047
  */
2904
- scheduleUnassignedFromUser?: ScheduleUnassignedFromUser;
3048
+ schedules?: Schedule[];
3049
+ /**
3050
+ * List of IDs of schedules owned by this resource.
3051
+ * @format GUID
3052
+ * @readonly
3053
+ */
3054
+ scheduleIds?: string[] | null;
3055
+ /**
3056
+ * Resource status. Default: `CREATED`.
3057
+ * @readonly
3058
+ */
3059
+ status?: ResourceStatus;
3060
+ /**
3061
+ * Wix user ID, if the resource is associated with the Wix user.
3062
+ * A staff member resource can be associated with a Wix user via assignment of a permissions role in the business manager.
3063
+ * @format GUID
3064
+ * @readonly
3065
+ */
3066
+ wixUserId?: string | null;
2905
3067
  }
2906
- export interface ScheduleCreated {
2907
- schedule?: Schedule;
3068
+ export interface FocalPoint {
3069
+ /** X-coordinate of the focal point. */
3070
+ x?: number;
3071
+ /** Y-coordinate of the focal point. */
3072
+ y?: number;
3073
+ /** crop by height */
3074
+ height?: number | null;
3075
+ /** crop by width */
3076
+ width?: number | null;
2908
3077
  }
2909
3078
  export interface Schedule {
2910
3079
  /** Schedule ID. */
@@ -3534,466 +3703,6 @@ export declare enum ConferenceType {
3534
3703
  /** User-defined meeting. */
3535
3704
  CUSTOM = "CUSTOM"
3536
3705
  }
3537
- export interface ScheduleUpdated {
3538
- /** The old schedule before the update. */
3539
- oldSchedule?: Schedule;
3540
- /** The new schedule after the update. */
3541
- newSchedule?: Schedule;
3542
- /**
3543
- * Recurring sessions updated event. If this field is given, the reason for the schedule updated event was
3544
- * updating at least one of the given schedule's recurring sessions.
3545
- * This event is triggered by create/update/delete recurring session apis.
3546
- */
3547
- recurringSessions?: RecurringSessionsUpdated;
3548
- /** Whether to notify participants about the change and an optional custom message */
3549
- participantNotification?: ParticipantNotification;
3550
- /**
3551
- * Whether this notification was created as a result of an anonymization request, such as GDPR.
3552
- * An anonymized participant will have the following details:
3553
- * name = "deleted"
3554
- * phone = "deleted"
3555
- * email = "deleted@deleted.com"
3556
- */
3557
- triggeredByAnonymizeRequest?: boolean | null;
3558
- }
3559
- export interface RecurringSessionsUpdated {
3560
- /** Old schedule's recurring session list. */
3561
- oldRecurringSessions?: Session[];
3562
- /** New schedule's recurring session list. */
3563
- newRecurringSessions?: Session[];
3564
- }
3565
- export interface Session {
3566
- /**
3567
- * Session ID.
3568
- * @readonly
3569
- */
3570
- _id?: string | null;
3571
- /**
3572
- * ID of the schedule that the session belongs to.
3573
- * @immutable
3574
- */
3575
- scheduleId?: string;
3576
- /**
3577
- * ID of the resource or service that the session's schedule belongs to.
3578
- * @readonly
3579
- */
3580
- scheduleOwnerId?: string | null;
3581
- /** Original start date and time of the session in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)) format. */
3582
- originalStart?: Date | null;
3583
- /** An object specifying the start date and time of the session. If the session is a recurring session, `start` must contain a `localDateTime`. */
3584
- start?: CalendarDateTime;
3585
- /**
3586
- * An object specifying the end date and time of the session. The `end` time must be after the `start` time and be same type as `start`.
3587
- * If the session is a recurring session, `end` must contain a `localDateTime`.
3588
- */
3589
- end?: CalendarDateTime;
3590
- /**
3591
- * An object specifying a list of schedules and the way each schedule's availability is affected by the session. For example, the schedule of an instructor is affected by sessions of the class that they instruct.
3592
- * The array is inherited from the schedule and can be overridden even if the session is a recurring session.
3593
- */
3594
- affectedSchedules?: LinkedSchedule[];
3595
- /**
3596
- * Session title.
3597
- * The value is inherited from the schedule and can be overridden unless the session is a recurring session.
3598
- * @maxLength 6000
3599
- */
3600
- title?: string | null;
3601
- /**
3602
- * __Deprecated.__
3603
- * Tags for the session.
3604
- * The value is inherited from the schedule and can be overridden unless the session is a recurring session.
3605
- * @maxLength 200
3606
- * @deprecated
3607
- */
3608
- tags?: string[] | null;
3609
- /**
3610
- * An object describing the location where the session takes place.
3611
- * Defaults to the schedule location.
3612
- * For single sessions, `session.location.businessLocation` can only be provided for locations that are defined in the schedule using `schedule.location` or `schedule.availability.locations`.
3613
- */
3614
- location?: Location;
3615
- /**
3616
- * Maximum number of participants that can be added to the session. Defaults to the schedule capacity.
3617
- * The value is inherited from the schedule and can be overridden unless the session is a recurring session.
3618
- * @max 1000
3619
- */
3620
- capacity?: number | null;
3621
- /**
3622
- * Deprecated. Please use the [Booking Services V2](https://dev.wix.com/api/rest/wix-bookings/services-v2) payment instead.
3623
- * @deprecated
3624
- */
3625
- rate?: Rate;
3626
- /**
3627
- * Time reserved after the session end time, derived from the schedule availability constraints and the time between slots. Read-only.
3628
- * If the session is a recurring session, this field must be empty.
3629
- */
3630
- timeReservedAfter?: number | null;
3631
- /**
3632
- * Additional information about the session.
3633
- * Notes are not supported for recurring sessions.
3634
- * @maxLength 10000
3635
- */
3636
- notes?: string;
3637
- /**
3638
- * The number of participants booked for the session. Read-only.
3639
- * Calculated as the sum of the party sizes.
3640
- * @readonly
3641
- */
3642
- totalNumberOfParticipants?: number;
3643
- /**
3644
- * *Partial list** list of participants booked for the session.
3645
- * The list includes participants who have registered for this specific session, and participants who have registered for a schedule that includes this session.
3646
- * If the session is a recurring session, this field must be empty.
3647
- * To retrieve the full list of session participants please use the [Query Extended Bookings API](https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/query-extended-bookings).
3648
- */
3649
- participants?: Participant[];
3650
- /**
3651
- * A list of properties for which values were inherited from the schedule.
3652
- * This does not include participants that were inherited from the schedule.
3653
- * @readonly
3654
- */
3655
- inheritedFields?: string[];
3656
- /**
3657
- * __Deprecated.__
3658
- * @deprecated
3659
- */
3660
- externalCalendarOverrides?: ExternalCalendarOverrides;
3661
- /**
3662
- * Session status.
3663
- * @readonly
3664
- */
3665
- status?: Status;
3666
- /**
3667
- * Recurring interval ID. Defined when a session will be a recurring session. read-only. Optional.
3668
- * For example, when creating a class service with recurring sessions, you add a recurrence rule to create recurring sessions.
3669
- * This field is omitted for single sessions or instances of recurring sessions.
3670
- * Specified when the session was originally generated from a schedule recurring interval.
3671
- * Deprecated. Use `recurringSessionId`.
3672
- * @readonly
3673
- * @deprecated
3674
- */
3675
- recurringIntervalId?: string | null;
3676
- /**
3677
- * The ID of the recurring session if this session is an instance of a recurrence. Use this ID to update the recurrence and all of the instances.
3678
- * @readonly
3679
- */
3680
- recurringSessionId?: string | null;
3681
- /** Session type. */
3682
- type?: SessionType;
3683
- /**
3684
- * A conference created for the session according to the details set in the schedule's conference provider information.
3685
- * If the session is a recurring session, this field is inherited from the schedule.
3686
- * **Partially deprecated.** Only `hostUrl` and `guestUrl` are to be supported.
3687
- * @deprecated
3688
- */
3689
- calendarConference?: CalendarConference;
3690
- /**
3691
- * A string representing a recurrence rule (RRULE) for a recurring session, as defined in [iCalendar RFC 5545](https://icalendar.org/iCalendar-RFC-5545/3-3-10-recurrence-rule.html).
3692
- * If the session is an instance of a recurrence pattern, the `instanceOfRecurrence` property will be contain the recurrence rule and this property will be empty.
3693
- * The RRULE defines a rule for repeating a session.
3694
- * Supported parameters are:
3695
- *
3696
- * |Keyword|Description|Supported values|
3697
- * |--|--|---|
3698
- * |`FREQ`|The frequency at which the session is recurs. Required.|`WEEKLY`|
3699
- * |`INTERVAL`|How often, in terms of `FREQ`, the session recurs. Default is 1. Optional.|
3700
- * |`UNTIL`|The UTC end date and time of the recurrence. Optional.|
3701
- * |`BYDAY`|Day of the week when the event should recur. Required.|One of: `MO`, `TU`, `WE`, `TH`, `FR`, `SA`, `SU`|
3702
- *
3703
- *
3704
- * For example, a session that repeats every second week on a Monday until January 7, 2022 at 8 AM:
3705
- * `"FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;UNTIL=20220107T080000Z"`
3706
- *
3707
- * <!--ORIGINAL COMMENTS:
3708
- * `FREQ` — The frequency with which the session should be repeated (such as DAILY or WEEKLY).
3709
- * Supported `WEEKLY` value is supported.
3710
- * INTERVAL — Works together with FREQ to specify how often the session should be repeated. For example, FREQ=WEEKLY;INTERVAL=2 means once every two weeks. Optional. Default value is 1.
3711
- * COUNT — The number of times this event should be repeated. Not yet supported.
3712
- * UNTIL — The UTC date & time until which the session should be repeated. This parameter is optional. When it is not specified, the event repeats forever.
3713
- * The format is a short ISO date, followed by 'T' and a short time with seconds and without milliseconds, terminated by the UTC designator 'Z'. For example, until Jan. 19th 2018 at 7:00 AM: 'UNTIL=20180119T070000Z'.
3714
- * BYDAY - The days of the week when the event should be repeated. Currently, only a single day is supported. This parameter is mandatory.
3715
- * Possible values are: MO, TU, WE, TH, FR, SA, SU
3716
- * Note that DTSTART and DTEND lines are not allowed in this field; session start and end times are specified in the start and end fields.
3717
- * **Example**: FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;UNTIL=20200427T070000Z
3718
- * ORIGINAL COMMENTS-->
3719
- */
3720
- recurrence?: string | null;
3721
- /**
3722
- * A string representing a recurrence rule (RRULE) if the session is an instance of a recurrence pattern.
3723
- * Empty when the session is not an instance of a recurrence rule, or if the session defines a recurrence pattern, and `recurrence` is not empty.
3724
- * @readonly
3725
- */
3726
- instanceOfRecurrence?: string | null;
3727
- /**
3728
- * The session version.
3729
- * Composed by the schedule, session and participants versions.
3730
- * @readonly
3731
- */
3732
- version?: SessionVersion;
3733
- }
3734
- export interface CalendarDateTime {
3735
- /**
3736
- * UTC date-time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)) format. If a time zone offset is specified, the time is converted to UTC. For example, if you specify `new Date('2021-01-06T16:00:00.000-07:00')`, the stored value will be `"2021-01-06T23:00:00.000Z"`.
3737
- * Required if `localDateTime` is not specified.
3738
- * If `localDateTime` is specified, `timestamp` is calculated as `localDateTime`, using the business's time zone.
3739
- */
3740
- timestamp?: Date | null;
3741
- /** An object containing the local date and time for the business's time zone. */
3742
- localDateTime?: LocalDateTime;
3743
- /**
3744
- * The time zone. Optional. Derived from the schedule's time zone.
3745
- * In case this field is associated with recurring session, this field is empty.
3746
- * @readonly
3747
- */
3748
- timeZone?: string | null;
3749
- }
3750
- export interface LocalDateTime {
3751
- /** Year. 4-digit format. */
3752
- year?: number | null;
3753
- /**
3754
- * Month number, from 1-12.
3755
- * @min 1
3756
- * @max 12
3757
- */
3758
- monthOfYear?: number | null;
3759
- /** Day of the month, from 1-31. */
3760
- dayOfMonth?: number | null;
3761
- /**
3762
- * Hour of the day in 24-hour format, from 0-23.
3763
- * @max 23
3764
- */
3765
- hourOfDay?: number | null;
3766
- /**
3767
- * Minute, from 0-59.
3768
- * @max 59
3769
- */
3770
- minutesOfHour?: number | null;
3771
- }
3772
- export interface ExternalCalendarInfo {
3773
- /** The external calendar type (e.g. Google Calendar, iCal, etc). */
3774
- calendarType?: CalendarType;
3775
- }
3776
- export declare enum CalendarType {
3777
- /** There is no information about the external calendar type. */
3778
- UNDEFINED = "UNDEFINED",
3779
- /** [Google Calendar](https://developers.google.com/calendar/api/guides/overview). */
3780
- GOOGLE = "GOOGLE",
3781
- /** Apple iCalendar. */
3782
- I_CAL = "I_CAL",
3783
- /** __Deprecated__. Use `MICROSOFT` instead. */
3784
- OUTLOOK = "OUTLOOK",
3785
- /** __Deprecated__. Use `MICROSOFT` instead. */
3786
- OFFICE_365 = "OFFICE_365",
3787
- /** Microsoft Calendar. For example, Office 365 calendar or Outlook calendar. */
3788
- MICROSOFT = "MICROSOFT",
3789
- /** A different type of external calendar, not listed here. */
3790
- OTHER = "OTHER"
3791
- }
3792
- export declare enum Status {
3793
- /** Undefined status. */
3794
- UNDEFINED = "UNDEFINED",
3795
- /** Session is confirmed. Default status. */
3796
- CONFIRMED = "CONFIRMED",
3797
- /**
3798
- * Session is cancelled.
3799
- * A cancelled session can be the cancellation of a recurring session that should no longer be displayed or a deleted single session.
3800
- * The ListSessions returns cancelled sessions only if 'includeDelete' flag is set to true.
3801
- */
3802
- CANCELLED = "CANCELLED"
3803
- }
3804
- export declare enum SessionType {
3805
- UNDEFINED = "UNDEFINED",
3806
- /**
3807
- * Creates an event on the calendar for the owner of the schedule that the session belongs to.
3808
- * Default type.
3809
- */
3810
- EVENT = "EVENT",
3811
- /** Represents a resource's available working hours. */
3812
- WORKING_HOURS = "WORKING_HOURS",
3813
- /** Deprecated. Please use WORKING_HOURS. */
3814
- TIME_AVAILABILITY = "TIME_AVAILABILITY",
3815
- /** Deprecated. Represents a resource's available hours. Please use WORKING_HOURS. */
3816
- AVAILABILITY = "AVAILABILITY"
3817
- }
3818
- export interface SessionVersion {
3819
- /** Incremental version number, which is updated on each change to the session or on changes affecting the session. */
3820
- number?: string | null;
3821
- }
3822
- export interface ParticipantNotification {
3823
- /**
3824
- * Whether to send the message about the changes to the customer.
3825
- *
3826
- * Default: `false`
3827
- */
3828
- notifyParticipants?: boolean;
3829
- /** Custom message to send to the participants about the changes to the booking. */
3830
- message?: string | null;
3831
- }
3832
- export interface ScheduleCancelled {
3833
- schedule?: Schedule;
3834
- /** Whether to notify participants about the change and an optional custom message */
3835
- participantNotification?: ParticipantNotification;
3836
- oldSchedule?: Schedule;
3837
- }
3838
- export interface SessionCreated {
3839
- session?: Session;
3840
- }
3841
- export interface SessionUpdated {
3842
- oldSession?: Session;
3843
- newSession?: Session;
3844
- /** Whether to notify participants about the change and an optional custom message */
3845
- participantNotification?: ParticipantNotification;
3846
- /**
3847
- * Whether this notification was created as a result of an anonymization request, such as GDPR.
3848
- * An anonymized participant will have the following details:
3849
- * name = "deleted"
3850
- * phone = "deleted"
3851
- * email = "deleted@deleted.com"
3852
- */
3853
- triggeredByAnonymizeRequest?: boolean | null;
3854
- }
3855
- export interface SessionCancelled {
3856
- session?: Session;
3857
- /** Whether to notify participants about the change and an optional custom message */
3858
- participantNotification?: ParticipantNotification;
3859
- }
3860
- export interface AvailabilityPolicyUpdated {
3861
- availabilityPolicy?: AvailabilityPolicy;
3862
- }
3863
- /** Availability policy applied to all site schedules. */
3864
- export interface AvailabilityPolicy {
3865
- /** Specify how to split the schedule slots in intervals of minutes. */
3866
- splitInterval?: SplitInterval;
3867
- }
3868
- export interface IntervalSplit {
3869
- scheduleId?: string;
3870
- intervals?: RecurringInterval[];
3871
- newScheduleVersion?: number | null;
3872
- oldScheduleVersion?: number | null;
3873
- }
3874
- export interface RecurringSessionSplit {
3875
- scheduleId?: string;
3876
- recurringSessions?: Session[];
3877
- newScheduleVersion?: number | null;
3878
- oldScheduleVersion?: number | null;
3879
- }
3880
- /** Schedule unassigned from user. */
3881
- export interface ScheduleUnassignedFromUser {
3882
- /**
3883
- * The Wix user id.
3884
- * @format GUID
3885
- */
3886
- userId?: string | null;
3887
- /** The schedule that was unassigned from the user. */
3888
- schedule?: Schedule;
3889
- }
3890
- export interface MultipleSessionsCreated {
3891
- schedulesWithSessions?: ScheduleWithSessions[];
3892
- }
3893
- export interface ScheduleWithSessions {
3894
- schedule?: Schedule;
3895
- siteProperties?: SitePropertiesOnScheduleCreation;
3896
- sessions?: Session[];
3897
- }
3898
- export interface SitePropertiesOnScheduleCreation {
3899
- /** The global time zone value. */
3900
- timeZone?: string | null;
3901
- }
3902
- export interface MigrationEvent {
3903
- migrationData?: MigrationData;
3904
- }
3905
- export interface MigrationData {
3906
- businessId?: string | null;
3907
- staffs?: StaffData[];
3908
- }
3909
- export interface StaffData {
3910
- resourceId?: string;
3911
- syncRequestEmail?: string;
3912
- refreshToken?: string;
3913
- }
3914
- export interface ResourceNotification {
3915
- /**
3916
- * Updated resource entity.
3917
- * 'resource.schedules' is deprecated and will not be returned. Please use 'resource.scheduleIds' instead.
3918
- */
3919
- resource?: Resource;
3920
- /** Event type. */
3921
- event?: ResourceNotificationEvent;
3922
- }
3923
- export interface Resource {
3924
- /**
3925
- * Resource ID.
3926
- * @format GUID
3927
- * @readonly
3928
- */
3929
- _id?: string | null;
3930
- /**
3931
- * Resource name.
3932
- * @maxLength 1200
3933
- */
3934
- name?: string | null;
3935
- /**
3936
- * Resource email address.
3937
- * @maxLength 500
3938
- */
3939
- email?: string | null;
3940
- /**
3941
- * Resource phone number.
3942
- * @maxLength 500
3943
- */
3944
- phone?: string | null;
3945
- /**
3946
- * Resource description.
3947
- * @maxLength 500
3948
- */
3949
- description?: string | null;
3950
- /**
3951
- * Deprecated. Please use tags.
3952
- * @maxLength 500
3953
- * @deprecated
3954
- */
3955
- tag?: string | null;
3956
- /**
3957
- * Resource tags. Tags are used to identify, group, and filter the different types of resources. For example, 'staff' or 'room'.
3958
- * @maxLength 200
3959
- */
3960
- tags?: string[] | null;
3961
- /** Resource images. */
3962
- images?: string[];
3963
- /**
3964
- * Deprecated. Please use scheduleIds. List of the schedules owned by this resource. Min size 1.
3965
- * @deprecated
3966
- */
3967
- schedules?: Schedule[];
3968
- /**
3969
- * List of IDs of schedules owned by this resource.
3970
- * @format GUID
3971
- * @readonly
3972
- */
3973
- scheduleIds?: string[] | null;
3974
- /**
3975
- * Resource status. Default: `CREATED`.
3976
- * @readonly
3977
- */
3978
- status?: ResourceStatus;
3979
- /**
3980
- * Wix user ID, if the resource is associated with the Wix user.
3981
- * A staff member resource can be associated with a Wix user via assignment of a permissions role in the business manager.
3982
- * @format GUID
3983
- * @readonly
3984
- */
3985
- wixUserId?: string | null;
3986
- }
3987
- export interface FocalPoint {
3988
- /** X-coordinate of the focal point. */
3989
- x?: number;
3990
- /** Y-coordinate of the focal point. */
3991
- y?: number;
3992
- /** crop by height */
3993
- height?: number | null;
3994
- /** crop by width */
3995
- width?: number | null;
3996
- }
3997
3706
  export declare enum ResourceStatus {
3998
3707
  /** Undefined resource status. */
3999
3708
  UNDEFINED = "UNDEFINED",
@@ -5227,7 +4936,7 @@ export interface DeleteServiceOptions {
5227
4936
  * Whether to notify participants about the change and an optional
5228
4937
  * custom message.
5229
4938
  */
5230
- participantNotification?: V2ParticipantNotification;
4939
+ participantNotification?: ParticipantNotification;
5231
4940
  }
5232
4941
  /**
5233
4942
  * Deletes multiple services.
@@ -5262,7 +4971,7 @@ export interface BulkDeleteServicesOptions {
5262
4971
  * Whether to notify participants about the change and an optional
5263
4972
  * custom message.
5264
4973
  */
5265
- participantNotification?: V2ParticipantNotification;
4974
+ participantNotification?: ParticipantNotification;
5266
4975
  }
5267
4976
  /**
5268
4977
  * Deletes multiple services by filter.
@@ -5301,7 +5010,7 @@ export interface BulkDeleteServicesByFilterOptions {
5301
5010
  */
5302
5011
  preserveFutureSessionsWithParticipants?: boolean;
5303
5012
  /** Whether to notify participants about the change and an optional custom message. */
5304
- participantNotification?: V2ParticipantNotification;
5013
+ participantNotification?: ParticipantNotification;
5305
5014
  }
5306
5015
  /**
5307
5016
  * Creates a query to retrieve a list of `service` objects.
@@ -5810,7 +5519,7 @@ export interface SetServiceLocationsOptions {
5810
5519
  * Whether to notify participants about the change of location, and an
5811
5520
  * Optional custom message. The notification is sent only to participants of sessions that are affected by the change.
5812
5521
  */
5813
- participantNotification?: V2ParticipantNotification;
5522
+ participantNotification?: ParticipantNotification;
5814
5523
  }
5815
5524
  /**
5816
5525
  * Adds a list of *pricing plan IDs*