@wix/auto_sdk_bookings_services 1.0.24 → 1.0.26

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 +294 -533
  11. package/build/cjs/src/bookings-services-v2-service-services.universal.js +53 -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 +294 -533
  23. package/build/es/src/bookings-services-v2-service-services.universal.js +51 -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 +294 -533
  35. package/build/internal/cjs/src/bookings-services-v2-service-services.universal.js +53 -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 +294 -533
  47. package/build/internal/es/src/bookings-services-v2-service-services.universal.js +51 -50
  48. package/build/internal/es/src/bookings-services-v2-service-services.universal.js.map +1 -1
  49. package/package.json +2 -2
@@ -1160,7 +1160,7 @@ export interface Settings {
1160
1160
  */
1161
1161
  keywords?: Keyword[];
1162
1162
  }
1163
- export interface AddOnsGroup {
1163
+ export interface AddOnGroup {
1164
1164
  /**
1165
1165
  * ID of the group.
1166
1166
  * @readonly
@@ -1207,41 +1207,41 @@ export interface SetCustomSlugEvent {
1207
1207
  }
1208
1208
  export interface ServicesUrlsChanged {
1209
1209
  }
1210
- export interface CreateAddOnsGroupRequest {
1211
- /** AddOnsGroup to create. */
1212
- addOnsGroup?: AddOnsGroup;
1210
+ export interface CreateAddOnGroupRequest {
1211
+ /** AddOnGroup to create. */
1212
+ addOnGroup?: AddOnGroup;
1213
1213
  /**
1214
- * ID of the service to create the AddOnsGroup for.
1214
+ * ID of the service to create the AddOnGroup for.
1215
1215
  * @format GUID
1216
1216
  */
1217
1217
  serviceId?: string | null;
1218
1218
  }
1219
- export interface CreateAddOnsGroupResponse {
1220
- /** Created AddOnsGroup. */
1221
- addOnsGroup?: AddOnsGroup;
1219
+ export interface CreateAddOnGroupResponse {
1220
+ /** Created AddOnGroup. */
1221
+ addOnGroup?: AddOnGroup;
1222
1222
  }
1223
- export interface DeleteAddOnsGroupRequest {
1223
+ export interface DeleteAddOnGroupRequest {
1224
1224
  /**
1225
- * ID of the AddOnsGroup to delete.
1225
+ * ID of the AddOnGroup to delete.
1226
1226
  * @format GUID
1227
1227
  */
1228
- addOnsGroupId?: string | null;
1228
+ addOnGroupId?: string | null;
1229
1229
  }
1230
- export interface DeleteAddOnsGroupResponse {
1230
+ export interface DeleteAddOnGroupResponse {
1231
1231
  }
1232
- export interface UpdateAddOnsGroupRequest {
1233
- /** AddOnsGroup to update. */
1234
- addOnsGroup?: AddOnsGroup;
1232
+ export interface UpdateAddOnGroupRequest {
1233
+ /** AddOnGroup to update. */
1234
+ addOnGroup?: AddOnGroup;
1235
1235
  /** Explicit list of fields to update. */
1236
1236
  mask?: string[];
1237
1237
  }
1238
- export interface UpdateAddOnsGroupResponse {
1239
- /** Updated AddOnsGroup */
1240
- addOnsGroup?: AddOnsGroup;
1238
+ export interface UpdateAddOnGroupResponse {
1239
+ /** Updated AddOnGroup */
1240
+ addOnGroup?: AddOnGroup;
1241
1241
  }
1242
- export interface ListAddOnsGroupsByServiceIdRequest {
1242
+ export interface ListAddOnGroupsByServiceIdRequest {
1243
1243
  /**
1244
- * ID of the service to retrieve AddOns for.
1244
+ * ID of the service to retrieve AddOnGroups for.
1245
1245
  * @format GUID
1246
1246
  */
1247
1247
  serviceId?: string | null;
@@ -1252,12 +1252,12 @@ export interface ListAddOnsGroupsByServiceIdRequest {
1252
1252
  */
1253
1253
  groupIds?: string[] | null;
1254
1254
  }
1255
- export interface ListAddOnsGroupsByServiceIdResponse {
1255
+ export interface ListAddOnGroupsByServiceIdResponse {
1256
1256
  /**
1257
1257
  * List of group IDs and their linked AddOns.
1258
1258
  * @maxSize 3
1259
1259
  */
1260
- addOnsGroupsDetails?: AddOnsGroupDetail[];
1260
+ addOnGroupsDetails?: AddOnGroupDetail[];
1261
1261
  }
1262
1262
  export interface AddOn extends AddOnAddOnInfoOneOf {
1263
1263
  /** The AddOn description. */
@@ -1287,7 +1287,7 @@ export interface AddOnAddOnInfoOneOf {
1287
1287
  /** The AddOn max quantity. */
1288
1288
  maxQuantity?: number;
1289
1289
  }
1290
- export interface AddOnsGroupDetail {
1290
+ export interface AddOnGroupDetail {
1291
1291
  /**
1292
1292
  * The group ID.
1293
1293
  * @format GUID
@@ -1510,6 +1510,139 @@ export declare enum WebhookIdentityType {
1510
1510
  WIX_USER = "WIX_USER",
1511
1511
  APP = "APP"
1512
1512
  }
1513
+ export interface AddOnsGroup {
1514
+ /**
1515
+ * ID of the group.
1516
+ * @readonly
1517
+ * @format GUID
1518
+ */
1519
+ id?: string | null;
1520
+ /**
1521
+ * The name of the group.
1522
+ * @maxLength 100
1523
+ */
1524
+ name?: string | null;
1525
+ /**
1526
+ * The maximum number of AddOns that can be selected from this group.
1527
+ * If not set, there is no upper limit.
1528
+ */
1529
+ maxNumberOfAddOns?: number | null;
1530
+ /**
1531
+ * List of AddOn IDs that are part of this group.
1532
+ * @format GUID
1533
+ * @maxSize 7
1534
+ */
1535
+ addOnIds?: string[] | null;
1536
+ /**
1537
+ * The group prompt.
1538
+ * @maxLength 200
1539
+ */
1540
+ prompt?: string | null;
1541
+ }
1542
+ export interface CreateAddOnsGroupRequest {
1543
+ /** AddOnsGroup to create. */
1544
+ addOnsGroup?: AddOnsGroup;
1545
+ /**
1546
+ * ID of the service to create the AddOnsGroup for.
1547
+ * @format GUID
1548
+ */
1549
+ serviceId?: string | null;
1550
+ }
1551
+ export interface CreateAddOnsGroupResponse {
1552
+ /** Created AddOnsGroup. */
1553
+ addOnsGroup?: AddOnsGroup;
1554
+ }
1555
+ export interface DeleteAddOnsGroupRequest {
1556
+ /**
1557
+ * ID of the AddOnsGroup to delete.
1558
+ * @format GUID
1559
+ */
1560
+ addOnsGroupId?: string | null;
1561
+ }
1562
+ export interface DeleteAddOnsGroupResponse {
1563
+ }
1564
+ export interface UpdateAddOnsGroupRequest {
1565
+ /** AddOnsGroup to update. */
1566
+ addOnsGroup?: AddOnsGroup;
1567
+ /** Explicit list of fields to update. */
1568
+ mask?: string[];
1569
+ }
1570
+ export interface UpdateAddOnsGroupResponse {
1571
+ /** Updated AddOnsGroup */
1572
+ addOnsGroup?: AddOnsGroup;
1573
+ }
1574
+ export interface ListAddOnsGroupsByServiceIdRequest {
1575
+ /**
1576
+ * ID of the service to retrieve AddOns for.
1577
+ * @format GUID
1578
+ */
1579
+ serviceId?: string | null;
1580
+ /**
1581
+ * List of group ids to return. If not provided, all groups are returned.
1582
+ * @format GUID
1583
+ * @maxSize 3
1584
+ */
1585
+ groupIds?: string[] | null;
1586
+ }
1587
+ export interface ListAddOnsGroupsByServiceIdResponse {
1588
+ /**
1589
+ * List of group IDs and their linked AddOns.
1590
+ * @maxSize 3
1591
+ */
1592
+ addOnsGroupsDetails?: AddOnsGroupDetail[];
1593
+ }
1594
+ export interface ListAddOnsGroupsByServiceIdResponseAddOn extends ListAddOnsGroupsByServiceIdResponseAddOnAddOnInfoOneOf {
1595
+ /** The AddOn description. */
1596
+ durationInMinutes?: number;
1597
+ /** The AddOn max quantity. */
1598
+ maxQuantity?: number;
1599
+ /**
1600
+ * The AddOn ID.
1601
+ * @format GUID
1602
+ */
1603
+ addOnId?: string | null;
1604
+ /**
1605
+ * The AddOn name.
1606
+ * @maxLength 100
1607
+ */
1608
+ name?: string | null;
1609
+ /**
1610
+ * The AddOn price.
1611
+ * @maxLength 100
1612
+ */
1613
+ formattedAmount?: string | null;
1614
+ }
1615
+ /** @oneof */
1616
+ export interface ListAddOnsGroupsByServiceIdResponseAddOnAddOnInfoOneOf {
1617
+ /** The AddOn description. */
1618
+ durationInMinutes?: number;
1619
+ /** The AddOn max quantity. */
1620
+ maxQuantity?: number;
1621
+ }
1622
+ export interface AddOnsGroupDetail {
1623
+ /**
1624
+ * The group ID.
1625
+ * @format GUID
1626
+ */
1627
+ groupId?: string | null;
1628
+ /** The group max number of AddOns. */
1629
+ maxNumberOfAddOns?: number | null;
1630
+ /**
1631
+ * The group name.
1632
+ * @maxLength 100
1633
+ */
1634
+ groupName?: string | null;
1635
+ /**
1636
+ * The AddOns information linked to the group.
1637
+ * @maxSize 7
1638
+ */
1639
+ addOns?: ListAddOnsGroupsByServiceIdResponseAddOn[];
1640
+ /**
1641
+ * The group prompt.
1642
+ * @maxLength 200
1643
+ */
1644
+ prompt?: string | null;
1645
+ }
1513
1646
  /**
1514
1647
  * Message for reindexing search data to a given search schema. Support both upsert and delete flows as well as
1515
1648
  * performs context manipulation with adding tenant, provided in message to callscope.
@@ -1774,9 +1907,9 @@ export interface DeleteServiceRequest {
1774
1907
  * Whether to notify participants about the change and an optional
1775
1908
  * custom message.
1776
1909
  */
1777
- participantNotification?: V2ParticipantNotification;
1910
+ participantNotification?: ParticipantNotification;
1778
1911
  }
1779
- export interface V2ParticipantNotification {
1912
+ export interface ParticipantNotification {
1780
1913
  /**
1781
1914
  * Whether to send the message about the changes to the customer.
1782
1915
  *
@@ -1808,7 +1941,7 @@ export interface BulkDeleteServicesRequest {
1808
1941
  * Whether to notify participants about the change and an optional
1809
1942
  * custom message.
1810
1943
  */
1811
- participantNotification?: V2ParticipantNotification;
1944
+ participantNotification?: ParticipantNotification;
1812
1945
  }
1813
1946
  export interface BulkDeleteServicesResponse {
1814
1947
  /** The result of each service removal. */
@@ -1826,7 +1959,7 @@ export interface BulkDeleteServicesByFilterRequest {
1826
1959
  */
1827
1960
  preserveFutureSessionsWithParticipants?: boolean;
1828
1961
  /** Whether to notify participants about the change and an optional custom message. */
1829
- participantNotification?: V2ParticipantNotification;
1962
+ participantNotification?: ParticipantNotification;
1830
1963
  }
1831
1964
  export interface BulkDeleteServicesByFilterResponse {
1832
1965
  /**
@@ -2689,7 +2822,7 @@ export interface SetServiceLocationsRequest {
2689
2822
  * Whether to notify participants about the change of location, and an
2690
2823
  * Optional custom message. The notification is sent only to participants of sessions that are affected by the change.
2691
2824
  */
2692
- participantNotification?: V2ParticipantNotification;
2825
+ participantNotification?: ParticipantNotification;
2693
2826
  }
2694
2827
  export interface RemovedLocationSessionsAction extends RemovedLocationSessionsActionActionOptionsOneOf {
2695
2828
  /**
@@ -2880,11 +3013,11 @@ export interface Category {
2880
3013
  * Default: `CREATED`
2881
3014
  * @readonly
2882
3015
  */
2883
- status?: CategoryStatus;
3016
+ status?: Status;
2884
3017
  /** Sort order of the category in the live site and dashboard. */
2885
3018
  sortOrder?: number | null;
2886
3019
  }
2887
- export declare enum CategoryStatus {
3020
+ export declare enum Status {
2888
3021
  /** The category was created. */
2889
3022
  CREATED = "CREATED",
2890
3023
  /** The category was deleted. */
@@ -2900,124 +3033,183 @@ export declare enum CategoryNotificationEvent {
2900
3033
  }
2901
3034
  export interface Empty {
2902
3035
  }
2903
- export interface ScheduleNotification extends ScheduleNotificationEventOneOf {
2904
- scheduleCreated?: ScheduleCreated;
2905
- scheduleUpdated?: ScheduleUpdated;
2906
- scheduleCancelled?: ScheduleCancelled;
2907
- sessionCreated?: SessionCreated;
2908
- sessionUpdated?: SessionUpdated;
2909
- sessionCancelled?: SessionCancelled;
2910
- availabilityPolicyUpdated?: AvailabilityPolicyUpdated;
2911
- /** @deprecated */
2912
- intervalSplit?: IntervalSplit;
2913
- recurringSessionSplit?: RecurringSessionSplit;
2914
- /**
2915
- * Inspect `schedule.scheduleOwnerUserId` on `scheduleUpdated` instead.
2916
- * @deprecated
2917
- */
2918
- scheduleUnassignedFromUser?: ScheduleUnassignedFromUser;
2919
- preserveFutureSessionsWithParticipants?: boolean | null;
3036
+ export interface ResourceNotification {
2920
3037
  /**
2921
- * Whether to notify participants about changed sessions. deprecated, use participant_notification
2922
- * @deprecated
2923
- */
2924
- notifyParticipants?: boolean;
2925
- /** site properties. Optional. Given in create schedule notification. */
2926
- siteProperties?: SitePropertiesOnScheduleCreation;
2927
- instanceId?: string;
2928
- }
2929
- /** @oneof */
2930
- export interface ScheduleNotificationEventOneOf {
2931
- scheduleCreated?: ScheduleCreated;
2932
- scheduleUpdated?: ScheduleUpdated;
2933
- scheduleCancelled?: ScheduleCancelled;
2934
- sessionCreated?: SessionCreated;
2935
- sessionUpdated?: SessionUpdated;
2936
- sessionCancelled?: SessionCancelled;
2937
- availabilityPolicyUpdated?: AvailabilityPolicyUpdated;
2938
- /** @deprecated */
2939
- intervalSplit?: IntervalSplit;
2940
- recurringSessionSplit?: RecurringSessionSplit;
2941
- /**
2942
- * Inspect `schedule.scheduleOwnerUserId` on `scheduleUpdated` instead.
2943
- * @deprecated
3038
+ * Updated resource entity.
3039
+ * 'resource.schedules' is deprecated and will not be returned. Please use 'resource.scheduleIds' instead.
2944
3040
  */
2945
- scheduleUnassignedFromUser?: ScheduleUnassignedFromUser;
2946
- }
2947
- export interface ScheduleCreated {
2948
- schedule?: Schedule;
3041
+ resource?: Resource;
3042
+ /** Event type. */
3043
+ event?: ResourceNotificationEvent;
2949
3044
  }
2950
- export interface Schedule {
2951
- /** Schedule ID. */
2952
- id?: string;
2953
- /** ID of the schedule's owner entity. This may be a resource ID or a service ID. */
2954
- scheduleOwnerId?: string | null;
3045
+ export interface Resource {
2955
3046
  /**
2956
- * Schedule's time zone in [Area/Location](https://en.wikipedia.org/wiki/Tz_database) format. Read-only.
2957
- * Derived from the Wix Business time zone.
3047
+ * Resource ID.
3048
+ * @format GUID
2958
3049
  * @readonly
2959
3050
  */
2960
- timeZone?: string | null;
3051
+ id?: string | null;
2961
3052
  /**
2962
- * Deprecated. Please use the [Sessions API](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/session) instead.
2963
- * @deprecated
3053
+ * Resource name.
3054
+ * @maxLength 1200
2964
3055
  */
2965
- intervals?: RecurringInterval[];
3056
+ name?: string | null;
2966
3057
  /**
2967
- * Default title for the schedule's sessions. Maximum length: 6000 characters.
2968
- * @maxLength 6000
3058
+ * Resource email address.
3059
+ * @maxLength 500
2969
3060
  */
2970
- title?: string | null;
3061
+ email?: string | null;
2971
3062
  /**
2972
- * __Deprecated.__
2973
- * Tags for grouping schedules. These tags are the default tags for the schedule's sessions.
2974
- * The Wix Bookings app uses the following predefined tags to set schedule type: `"INDIVIDUAL"`, `"GROUP"`, and `"COURSE"`. Once the schedule type is set using these tags, you cannot update it. In addition to the app's tags, you can create and update your own tags.
2975
- * @deprecated
3063
+ * Resource phone number.
3064
+ * @maxLength 500
2976
3065
  */
2977
- tags?: string[] | null;
2978
- /** Default location for the schedule's sessions. */
2979
- location?: Location;
3066
+ phone?: string | null;
2980
3067
  /**
2981
- * Maximum number of participants that can be added to the schedule's sessions.
2982
- * Must be at most `1` for schedule whose availability is affected by another schedule. E.g, appointment schedules of the Wix Bookings app.
2983
- * @min 1
2984
- * @max 1000
3068
+ * Resource description.
3069
+ * @maxLength 500
2985
3070
  */
2986
- capacity?: number | null;
3071
+ description?: string | null;
2987
3072
  /**
2988
- * Deprecated. Please use the [Booking Services V2](https://dev.wix.com/api/rest/wix-bookings/services-v2) payment instead.
3073
+ * Deprecated. Please use tags.
3074
+ * @maxLength 500
2989
3075
  * @deprecated
2990
3076
  */
2991
- rate?: Rate;
3077
+ tag?: string | null;
2992
3078
  /**
2993
- * __Deprecated.__
2994
- * @deprecated
3079
+ * Resource tags. Tags are used to identify, group, and filter the different types of resources. For example, 'staff' or 'room'.
3080
+ * @maxLength 200
2995
3081
  */
2996
- availability?: Availability;
3082
+ tags?: string[] | null;
3083
+ /** Resource images. */
3084
+ images?: CommonImage[];
2997
3085
  /**
2998
- * Number of participants registered to sessions in this schedule, calculated as the sum of the party sizes.
2999
- * @readonly
3086
+ * Deprecated. Please use scheduleIds. List of the schedules owned by this resource. Min size 1.
3087
+ * @deprecated
3000
3088
  */
3001
- totalNumberOfParticipants?: number;
3089
+ schedules?: Schedule[];
3002
3090
  /**
3003
- * *Partial list** of participants which are registered to sessions in this schedule.
3004
- * Participants who are registered in the schedule are automatically registered to any session that is created for the schedule.
3005
- * To retrieve the full list of schedule participants please use the [Query Extended Bookings API](https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/query-extended-bookings).
3091
+ * List of IDs of schedules owned by this resource.
3092
+ * @format GUID
3006
3093
  * @readonly
3007
3094
  */
3008
- participants?: Participant[];
3009
- /**
3010
- * __Deprecated.__
3011
- * @deprecated
3012
- */
3013
- externalCalendarOverrides?: ExternalCalendarOverrides;
3095
+ scheduleIds?: string[] | null;
3014
3096
  /**
3015
- * Schedule status. Default: Created
3097
+ * Resource status. Default: `CREATED`.
3016
3098
  * @readonly
3017
3099
  */
3018
- status?: ScheduleStatus;
3100
+ status?: ResourceStatus;
3019
3101
  /**
3020
- * Schedule creation date.
3102
+ * Wix user ID, if the resource is associated with the Wix user.
3103
+ * A staff member resource can be associated with a Wix user via assignment of a permissions role in the business manager.
3104
+ * @format GUID
3105
+ * @readonly
3106
+ */
3107
+ wixUserId?: string | null;
3108
+ }
3109
+ export interface CommonImage {
3110
+ /** WixMedia image ID. */
3111
+ id?: string;
3112
+ /** Image URL. */
3113
+ url?: string;
3114
+ /**
3115
+ * Original image height.
3116
+ * @readonly
3117
+ */
3118
+ height?: number;
3119
+ /**
3120
+ * Original image width.
3121
+ * @readonly
3122
+ */
3123
+ width?: number;
3124
+ /** Image alt text. */
3125
+ altText?: string | null;
3126
+ /**
3127
+ * Image filename.
3128
+ * @readonly
3129
+ */
3130
+ filename?: string | null;
3131
+ }
3132
+ export interface FocalPoint {
3133
+ /** X-coordinate of the focal point. */
3134
+ x?: number;
3135
+ /** Y-coordinate of the focal point. */
3136
+ y?: number;
3137
+ /** crop by height */
3138
+ height?: number | null;
3139
+ /** crop by width */
3140
+ width?: number | null;
3141
+ }
3142
+ export interface Schedule {
3143
+ /** Schedule ID. */
3144
+ id?: string;
3145
+ /** ID of the schedule's owner entity. This may be a resource ID or a service ID. */
3146
+ scheduleOwnerId?: string | null;
3147
+ /**
3148
+ * Schedule's time zone in [Area/Location](https://en.wikipedia.org/wiki/Tz_database) format. Read-only.
3149
+ * Derived from the Wix Business time zone.
3150
+ * @readonly
3151
+ */
3152
+ timeZone?: string | null;
3153
+ /**
3154
+ * Deprecated. Please use the [Sessions API](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/session) instead.
3155
+ * @deprecated
3156
+ */
3157
+ intervals?: RecurringInterval[];
3158
+ /**
3159
+ * Default title for the schedule's sessions. Maximum length: 6000 characters.
3160
+ * @maxLength 6000
3161
+ */
3162
+ title?: string | null;
3163
+ /**
3164
+ * __Deprecated.__
3165
+ * Tags for grouping schedules. These tags are the default tags for the schedule's sessions.
3166
+ * The Wix Bookings app uses the following predefined tags to set schedule type: `"INDIVIDUAL"`, `"GROUP"`, and `"COURSE"`. Once the schedule type is set using these tags, you cannot update it. In addition to the app's tags, you can create and update your own tags.
3167
+ * @deprecated
3168
+ */
3169
+ tags?: string[] | null;
3170
+ /** Default location for the schedule's sessions. */
3171
+ location?: Location;
3172
+ /**
3173
+ * Maximum number of participants that can be added to the schedule's sessions.
3174
+ * Must be at most `1` for schedule whose availability is affected by another schedule. E.g, appointment schedules of the Wix Bookings app.
3175
+ * @min 1
3176
+ * @max 1000
3177
+ */
3178
+ capacity?: number | null;
3179
+ /**
3180
+ * Deprecated. Please use the [Booking Services V2](https://dev.wix.com/api/rest/wix-bookings/services-v2) payment instead.
3181
+ * @deprecated
3182
+ */
3183
+ rate?: Rate;
3184
+ /**
3185
+ * __Deprecated.__
3186
+ * @deprecated
3187
+ */
3188
+ availability?: Availability;
3189
+ /**
3190
+ * Number of participants registered to sessions in this schedule, calculated as the sum of the party sizes.
3191
+ * @readonly
3192
+ */
3193
+ totalNumberOfParticipants?: number;
3194
+ /**
3195
+ * *Partial list** of participants which are registered to sessions in this schedule.
3196
+ * Participants who are registered in the schedule are automatically registered to any session that is created for the schedule.
3197
+ * To retrieve the full list of schedule participants please use the [Query Extended Bookings API](https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/query-extended-bookings).
3198
+ * @readonly
3199
+ */
3200
+ participants?: Participant[];
3201
+ /**
3202
+ * __Deprecated.__
3203
+ * @deprecated
3204
+ */
3205
+ externalCalendarOverrides?: ExternalCalendarOverrides;
3206
+ /**
3207
+ * Schedule status. Default: Created
3208
+ * @readonly
3209
+ */
3210
+ status?: ScheduleStatus;
3211
+ /**
3212
+ * Schedule creation date.
3021
3213
  * @readonly
3022
3214
  */
3023
3215
  created?: Date | null;
@@ -3580,489 +3772,6 @@ export declare enum ConferenceType {
3580
3772
  /** User-defined meeting. */
3581
3773
  CUSTOM = "CUSTOM"
3582
3774
  }
3583
- export interface ScheduleUpdated {
3584
- /** The old schedule before the update. */
3585
- oldSchedule?: Schedule;
3586
- /** The new schedule after the update. */
3587
- newSchedule?: Schedule;
3588
- /**
3589
- * Recurring sessions updated event. If this field is given, the reason for the schedule updated event was
3590
- * updating at least one of the given schedule's recurring sessions.
3591
- * This event is triggered by create/update/delete recurring session apis.
3592
- */
3593
- recurringSessions?: RecurringSessionsUpdated;
3594
- /** Whether to notify participants about the change and an optional custom message */
3595
- participantNotification?: ParticipantNotification;
3596
- /**
3597
- * Whether this notification was created as a result of an anonymization request, such as GDPR.
3598
- * An anonymized participant will have the following details:
3599
- * name = "deleted"
3600
- * phone = "deleted"
3601
- * email = "deleted@deleted.com"
3602
- */
3603
- triggeredByAnonymizeRequest?: boolean | null;
3604
- }
3605
- export interface RecurringSessionsUpdated {
3606
- /** Old schedule's recurring session list. */
3607
- oldRecurringSessions?: Session[];
3608
- /** New schedule's recurring session list. */
3609
- newRecurringSessions?: Session[];
3610
- }
3611
- export interface Session {
3612
- /**
3613
- * Session ID.
3614
- * @readonly
3615
- */
3616
- id?: string | null;
3617
- /**
3618
- * ID of the schedule that the session belongs to.
3619
- * @immutable
3620
- */
3621
- scheduleId?: string;
3622
- /**
3623
- * ID of the resource or service that the session's schedule belongs to.
3624
- * @readonly
3625
- */
3626
- scheduleOwnerId?: string | null;
3627
- /** Original start date and time of the session in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)) format. */
3628
- originalStart?: Date | null;
3629
- /** An object specifying the start date and time of the session. If the session is a recurring session, `start` must contain a `localDateTime`. */
3630
- start?: CalendarDateTime;
3631
- /**
3632
- * 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`.
3633
- * If the session is a recurring session, `end` must contain a `localDateTime`.
3634
- */
3635
- end?: CalendarDateTime;
3636
- /**
3637
- * 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.
3638
- * The array is inherited from the schedule and can be overridden even if the session is a recurring session.
3639
- */
3640
- affectedSchedules?: LinkedSchedule[];
3641
- /**
3642
- * Session title.
3643
- * The value is inherited from the schedule and can be overridden unless the session is a recurring session.
3644
- * @maxLength 6000
3645
- */
3646
- title?: string | null;
3647
- /**
3648
- * __Deprecated.__
3649
- * Tags for the session.
3650
- * The value is inherited from the schedule and can be overridden unless the session is a recurring session.
3651
- * @maxLength 200
3652
- * @deprecated
3653
- */
3654
- tags?: string[] | null;
3655
- /**
3656
- * An object describing the location where the session takes place.
3657
- * Defaults to the schedule location.
3658
- * 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`.
3659
- */
3660
- location?: Location;
3661
- /**
3662
- * Maximum number of participants that can be added to the session. Defaults to the schedule capacity.
3663
- * The value is inherited from the schedule and can be overridden unless the session is a recurring session.
3664
- * @max 1000
3665
- */
3666
- capacity?: number | null;
3667
- /**
3668
- * Deprecated. Please use the [Booking Services V2](https://dev.wix.com/api/rest/wix-bookings/services-v2) payment instead.
3669
- * @deprecated
3670
- */
3671
- rate?: Rate;
3672
- /**
3673
- * Time reserved after the session end time, derived from the schedule availability constraints and the time between slots. Read-only.
3674
- * If the session is a recurring session, this field must be empty.
3675
- */
3676
- timeReservedAfter?: number | null;
3677
- /**
3678
- * Additional information about the session.
3679
- * Notes are not supported for recurring sessions.
3680
- * @maxLength 10000
3681
- */
3682
- notes?: string;
3683
- /**
3684
- * The number of participants booked for the session. Read-only.
3685
- * Calculated as the sum of the party sizes.
3686
- * @readonly
3687
- */
3688
- totalNumberOfParticipants?: number;
3689
- /**
3690
- * *Partial list** list of participants booked for the session.
3691
- * The list includes participants who have registered for this specific session, and participants who have registered for a schedule that includes this session.
3692
- * If the session is a recurring session, this field must be empty.
3693
- * 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).
3694
- */
3695
- participants?: Participant[];
3696
- /**
3697
- * A list of properties for which values were inherited from the schedule.
3698
- * This does not include participants that were inherited from the schedule.
3699
- * @readonly
3700
- */
3701
- inheritedFields?: string[];
3702
- /**
3703
- * __Deprecated.__
3704
- * @deprecated
3705
- */
3706
- externalCalendarOverrides?: ExternalCalendarOverrides;
3707
- /**
3708
- * Session status.
3709
- * @readonly
3710
- */
3711
- status?: Status;
3712
- /**
3713
- * Recurring interval ID. Defined when a session will be a recurring session. read-only. Optional.
3714
- * For example, when creating a class service with recurring sessions, you add a recurrence rule to create recurring sessions.
3715
- * This field is omitted for single sessions or instances of recurring sessions.
3716
- * Specified when the session was originally generated from a schedule recurring interval.
3717
- * Deprecated. Use `recurringSessionId`.
3718
- * @readonly
3719
- * @deprecated
3720
- */
3721
- recurringIntervalId?: string | null;
3722
- /**
3723
- * 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.
3724
- * @readonly
3725
- */
3726
- recurringSessionId?: string | null;
3727
- /** Session type. */
3728
- type?: SessionType;
3729
- /**
3730
- * A conference created for the session according to the details set in the schedule's conference provider information.
3731
- * If the session is a recurring session, this field is inherited from the schedule.
3732
- * **Partially deprecated.** Only `hostUrl` and `guestUrl` are to be supported.
3733
- * @deprecated
3734
- */
3735
- calendarConference?: CalendarConference;
3736
- /**
3737
- * 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).
3738
- * 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.
3739
- * The RRULE defines a rule for repeating a session.
3740
- * Supported parameters are:
3741
- *
3742
- * |Keyword|Description|Supported values|
3743
- * |--|--|---|
3744
- * |`FREQ`|The frequency at which the session is recurs. Required.|`WEEKLY`|
3745
- * |`INTERVAL`|How often, in terms of `FREQ`, the session recurs. Default is 1. Optional.|
3746
- * |`UNTIL`|The UTC end date and time of the recurrence. Optional.|
3747
- * |`BYDAY`|Day of the week when the event should recur. Required.|One of: `MO`, `TU`, `WE`, `TH`, `FR`, `SA`, `SU`|
3748
- *
3749
- *
3750
- * For example, a session that repeats every second week on a Monday until January 7, 2022 at 8 AM:
3751
- * `"FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;UNTIL=20220107T080000Z"`
3752
- *
3753
- * <!--ORIGINAL COMMENTS:
3754
- * `FREQ` — The frequency with which the session should be repeated (such as DAILY or WEEKLY).
3755
- * Supported `WEEKLY` value is supported.
3756
- * 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.
3757
- * COUNT — The number of times this event should be repeated. Not yet supported.
3758
- * 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.
3759
- * 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'.
3760
- * BYDAY - The days of the week when the event should be repeated. Currently, only a single day is supported. This parameter is mandatory.
3761
- * Possible values are: MO, TU, WE, TH, FR, SA, SU
3762
- * 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.
3763
- * **Example**: FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;UNTIL=20200427T070000Z
3764
- * ORIGINAL COMMENTS-->
3765
- */
3766
- recurrence?: string | null;
3767
- /**
3768
- * A string representing a recurrence rule (RRULE) if the session is an instance of a recurrence pattern.
3769
- * 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.
3770
- * @readonly
3771
- */
3772
- instanceOfRecurrence?: string | null;
3773
- /**
3774
- * The session version.
3775
- * Composed by the schedule, session and participants versions.
3776
- * @readonly
3777
- */
3778
- version?: SessionVersion;
3779
- }
3780
- export interface CalendarDateTime {
3781
- /**
3782
- * 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"`.
3783
- * Required if `localDateTime` is not specified.
3784
- * If `localDateTime` is specified, `timestamp` is calculated as `localDateTime`, using the business's time zone.
3785
- */
3786
- timestamp?: Date | null;
3787
- /** An object containing the local date and time for the business's time zone. */
3788
- localDateTime?: LocalDateTime;
3789
- /**
3790
- * The time zone. Optional. Derived from the schedule's time zone.
3791
- * In case this field is associated with recurring session, this field is empty.
3792
- * @readonly
3793
- */
3794
- timeZone?: string | null;
3795
- }
3796
- export interface LocalDateTime {
3797
- /** Year. 4-digit format. */
3798
- year?: number | null;
3799
- /**
3800
- * Month number, from 1-12.
3801
- * @min 1
3802
- * @max 12
3803
- */
3804
- monthOfYear?: number | null;
3805
- /** Day of the month, from 1-31. */
3806
- dayOfMonth?: number | null;
3807
- /**
3808
- * Hour of the day in 24-hour format, from 0-23.
3809
- * @max 23
3810
- */
3811
- hourOfDay?: number | null;
3812
- /**
3813
- * Minute, from 0-59.
3814
- * @max 59
3815
- */
3816
- minutesOfHour?: number | null;
3817
- }
3818
- export interface ExternalCalendarInfo {
3819
- /** The external calendar type (e.g. Google Calendar, iCal, etc). */
3820
- calendarType?: CalendarType;
3821
- }
3822
- export declare enum CalendarType {
3823
- /** There is no information about the external calendar type. */
3824
- UNDEFINED = "UNDEFINED",
3825
- /** [Google Calendar](https://developers.google.com/calendar/api/guides/overview). */
3826
- GOOGLE = "GOOGLE",
3827
- /** Apple iCalendar. */
3828
- I_CAL = "I_CAL",
3829
- /** __Deprecated__. Use `MICROSOFT` instead. */
3830
- OUTLOOK = "OUTLOOK",
3831
- /** __Deprecated__. Use `MICROSOFT` instead. */
3832
- OFFICE_365 = "OFFICE_365",
3833
- /** Microsoft Calendar. For example, Office 365 calendar or Outlook calendar. */
3834
- MICROSOFT = "MICROSOFT",
3835
- /** A different type of external calendar, not listed here. */
3836
- OTHER = "OTHER"
3837
- }
3838
- export declare enum Status {
3839
- /** Undefined status. */
3840
- UNDEFINED = "UNDEFINED",
3841
- /** Session is confirmed. Default status. */
3842
- CONFIRMED = "CONFIRMED",
3843
- /**
3844
- * Session is cancelled.
3845
- * A cancelled session can be the cancellation of a recurring session that should no longer be displayed or a deleted single session.
3846
- * The ListSessions returns cancelled sessions only if 'includeDelete' flag is set to true.
3847
- */
3848
- CANCELLED = "CANCELLED"
3849
- }
3850
- export declare enum SessionType {
3851
- UNDEFINED = "UNDEFINED",
3852
- /**
3853
- * Creates an event on the calendar for the owner of the schedule that the session belongs to.
3854
- * Default type.
3855
- */
3856
- EVENT = "EVENT",
3857
- /** Represents a resource's available working hours. */
3858
- WORKING_HOURS = "WORKING_HOURS",
3859
- /** Deprecated. Please use WORKING_HOURS. */
3860
- TIME_AVAILABILITY = "TIME_AVAILABILITY",
3861
- /** Deprecated. Represents a resource's available hours. Please use WORKING_HOURS. */
3862
- AVAILABILITY = "AVAILABILITY"
3863
- }
3864
- export interface SessionVersion {
3865
- /** Incremental version number, which is updated on each change to the session or on changes affecting the session. */
3866
- number?: string | null;
3867
- }
3868
- export interface ParticipantNotification {
3869
- /**
3870
- * Whether to send the message about the changes to the customer.
3871
- *
3872
- * Default: `false`
3873
- */
3874
- notifyParticipants?: boolean;
3875
- /** Custom message to send to the participants about the changes to the booking. */
3876
- message?: string | null;
3877
- }
3878
- export interface ScheduleCancelled {
3879
- schedule?: Schedule;
3880
- /** Whether to notify participants about the change and an optional custom message */
3881
- participantNotification?: ParticipantNotification;
3882
- oldSchedule?: Schedule;
3883
- }
3884
- export interface SessionCreated {
3885
- session?: Session;
3886
- }
3887
- export interface SessionUpdated {
3888
- oldSession?: Session;
3889
- newSession?: Session;
3890
- /** Whether to notify participants about the change and an optional custom message */
3891
- participantNotification?: ParticipantNotification;
3892
- /**
3893
- * Whether this notification was created as a result of an anonymization request, such as GDPR.
3894
- * An anonymized participant will have the following details:
3895
- * name = "deleted"
3896
- * phone = "deleted"
3897
- * email = "deleted@deleted.com"
3898
- */
3899
- triggeredByAnonymizeRequest?: boolean | null;
3900
- }
3901
- export interface SessionCancelled {
3902
- session?: Session;
3903
- /** Whether to notify participants about the change and an optional custom message */
3904
- participantNotification?: ParticipantNotification;
3905
- }
3906
- export interface AvailabilityPolicyUpdated {
3907
- availabilityPolicy?: AvailabilityPolicy;
3908
- }
3909
- /** Availability policy applied to all site schedules. */
3910
- export interface AvailabilityPolicy {
3911
- /** Specify how to split the schedule slots in intervals of minutes. */
3912
- splitInterval?: SplitInterval;
3913
- }
3914
- export interface IntervalSplit {
3915
- scheduleId?: string;
3916
- intervals?: RecurringInterval[];
3917
- newScheduleVersion?: number | null;
3918
- oldScheduleVersion?: number | null;
3919
- }
3920
- export interface RecurringSessionSplit {
3921
- scheduleId?: string;
3922
- recurringSessions?: Session[];
3923
- newScheduleVersion?: number | null;
3924
- oldScheduleVersion?: number | null;
3925
- }
3926
- /** Schedule unassigned from user. */
3927
- export interface ScheduleUnassignedFromUser {
3928
- /**
3929
- * The Wix user id.
3930
- * @format GUID
3931
- */
3932
- userId?: string | null;
3933
- /** The schedule that was unassigned from the user. */
3934
- schedule?: Schedule;
3935
- }
3936
- export interface MultipleSessionsCreated {
3937
- schedulesWithSessions?: ScheduleWithSessions[];
3938
- }
3939
- export interface ScheduleWithSessions {
3940
- schedule?: Schedule;
3941
- siteProperties?: SitePropertiesOnScheduleCreation;
3942
- sessions?: Session[];
3943
- }
3944
- export interface SitePropertiesOnScheduleCreation {
3945
- /** The global time zone value. */
3946
- timeZone?: string | null;
3947
- }
3948
- export interface MigrationEvent {
3949
- migrationData?: MigrationData;
3950
- }
3951
- export interface MigrationData {
3952
- businessId?: string | null;
3953
- staffs?: StaffData[];
3954
- }
3955
- export interface StaffData {
3956
- resourceId?: string;
3957
- syncRequestEmail?: string;
3958
- refreshToken?: string;
3959
- }
3960
- export interface ResourceNotification {
3961
- /**
3962
- * Updated resource entity.
3963
- * 'resource.schedules' is deprecated and will not be returned. Please use 'resource.scheduleIds' instead.
3964
- */
3965
- resource?: Resource;
3966
- /** Event type. */
3967
- event?: ResourceNotificationEvent;
3968
- }
3969
- export interface Resource {
3970
- /**
3971
- * Resource ID.
3972
- * @format GUID
3973
- * @readonly
3974
- */
3975
- id?: string | null;
3976
- /**
3977
- * Resource name.
3978
- * @maxLength 1200
3979
- */
3980
- name?: string | null;
3981
- /**
3982
- * Resource email address.
3983
- * @maxLength 500
3984
- */
3985
- email?: string | null;
3986
- /**
3987
- * Resource phone number.
3988
- * @maxLength 500
3989
- */
3990
- phone?: string | null;
3991
- /**
3992
- * Resource description.
3993
- * @maxLength 500
3994
- */
3995
- description?: string | null;
3996
- /**
3997
- * Deprecated. Please use tags.
3998
- * @maxLength 500
3999
- * @deprecated
4000
- */
4001
- tag?: string | null;
4002
- /**
4003
- * Resource tags. Tags are used to identify, group, and filter the different types of resources. For example, 'staff' or 'room'.
4004
- * @maxLength 200
4005
- */
4006
- tags?: string[] | null;
4007
- /** Resource images. */
4008
- images?: CommonImage[];
4009
- /**
4010
- * Deprecated. Please use scheduleIds. List of the schedules owned by this resource. Min size 1.
4011
- * @deprecated
4012
- */
4013
- schedules?: Schedule[];
4014
- /**
4015
- * List of IDs of schedules owned by this resource.
4016
- * @format GUID
4017
- * @readonly
4018
- */
4019
- scheduleIds?: string[] | null;
4020
- /**
4021
- * Resource status. Default: `CREATED`.
4022
- * @readonly
4023
- */
4024
- status?: ResourceStatus;
4025
- /**
4026
- * Wix user ID, if the resource is associated with the Wix user.
4027
- * A staff member resource can be associated with a Wix user via assignment of a permissions role in the business manager.
4028
- * @format GUID
4029
- * @readonly
4030
- */
4031
- wixUserId?: string | null;
4032
- }
4033
- export interface CommonImage {
4034
- /** WixMedia image ID. */
4035
- id?: string;
4036
- /** Image URL. */
4037
- url?: string;
4038
- /**
4039
- * Original image height.
4040
- * @readonly
4041
- */
4042
- height?: number;
4043
- /**
4044
- * Original image width.
4045
- * @readonly
4046
- */
4047
- width?: number;
4048
- /** Image alt text. */
4049
- altText?: string | null;
4050
- /**
4051
- * Image filename.
4052
- * @readonly
4053
- */
4054
- filename?: string | null;
4055
- }
4056
- export interface FocalPoint {
4057
- /** X-coordinate of the focal point. */
4058
- x?: number;
4059
- /** Y-coordinate of the focal point. */
4060
- y?: number;
4061
- /** crop by height */
4062
- height?: number | null;
4063
- /** crop by width */
4064
- width?: number | null;
4065
- }
4066
3775
  export declare enum ResourceStatus {
4067
3776
  /** Undefined resource status. */
4068
3777
  UNDEFINED = "UNDEFINED",