@wix/auto_sdk_bookings_services 1.0.23 → 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.
- package/build/cjs/src/bookings-services-v2-service-services.context.d.ts +2 -2
- package/build/cjs/src/bookings-services-v2-service-services.context.js +3 -6
- package/build/cjs/src/bookings-services-v2-service-services.context.js.map +1 -1
- package/build/cjs/src/bookings-services-v2-service-services.public.d.ts +1 -1
- package/build/cjs/src/bookings-services-v2-service-services.public.js +2 -5
- package/build/cjs/src/bookings-services-v2-service-services.public.js.map +1 -1
- package/build/cjs/src/bookings-services-v2-service-services.types.d.ts +322 -607
- package/build/cjs/src/bookings-services-v2-service-services.types.js +6 -51
- package/build/cjs/src/bookings-services-v2-service-services.types.js.map +1 -1
- package/build/cjs/src/bookings-services-v2-service-services.universal.d.ts +253 -538
- package/build/cjs/src/bookings-services-v2-service-services.universal.js +7 -52
- package/build/cjs/src/bookings-services-v2-service-services.universal.js.map +1 -1
- package/build/es/src/bookings-services-v2-service-services.context.d.ts +2 -2
- package/build/es/src/bookings-services-v2-service-services.context.js +1 -1
- package/build/es/src/bookings-services-v2-service-services.context.js.map +1 -1
- package/build/es/src/bookings-services-v2-service-services.public.d.ts +1 -1
- package/build/es/src/bookings-services-v2-service-services.public.js +1 -1
- package/build/es/src/bookings-services-v2-service-services.public.js.map +1 -1
- package/build/es/src/bookings-services-v2-service-services.types.d.ts +322 -607
- package/build/es/src/bookings-services-v2-service-services.types.js +5 -50
- package/build/es/src/bookings-services-v2-service-services.types.js.map +1 -1
- package/build/es/src/bookings-services-v2-service-services.universal.d.ts +253 -538
- package/build/es/src/bookings-services-v2-service-services.universal.js +5 -50
- package/build/es/src/bookings-services-v2-service-services.universal.js.map +1 -1
- package/build/internal/cjs/src/bookings-services-v2-service-services.context.d.ts +2 -2
- package/build/internal/cjs/src/bookings-services-v2-service-services.context.js +3 -6
- package/build/internal/cjs/src/bookings-services-v2-service-services.context.js.map +1 -1
- package/build/internal/cjs/src/bookings-services-v2-service-services.public.d.ts +1 -1
- package/build/internal/cjs/src/bookings-services-v2-service-services.public.js +2 -5
- package/build/internal/cjs/src/bookings-services-v2-service-services.public.js.map +1 -1
- package/build/internal/cjs/src/bookings-services-v2-service-services.types.d.ts +322 -607
- package/build/internal/cjs/src/bookings-services-v2-service-services.types.js +6 -51
- package/build/internal/cjs/src/bookings-services-v2-service-services.types.js.map +1 -1
- package/build/internal/cjs/src/bookings-services-v2-service-services.universal.d.ts +253 -538
- package/build/internal/cjs/src/bookings-services-v2-service-services.universal.js +7 -52
- package/build/internal/cjs/src/bookings-services-v2-service-services.universal.js.map +1 -1
- package/build/internal/es/src/bookings-services-v2-service-services.context.d.ts +2 -2
- package/build/internal/es/src/bookings-services-v2-service-services.context.js +1 -1
- package/build/internal/es/src/bookings-services-v2-service-services.context.js.map +1 -1
- package/build/internal/es/src/bookings-services-v2-service-services.public.d.ts +1 -1
- package/build/internal/es/src/bookings-services-v2-service-services.public.js +1 -1
- package/build/internal/es/src/bookings-services-v2-service-services.public.js.map +1 -1
- package/build/internal/es/src/bookings-services-v2-service-services.types.d.ts +322 -607
- package/build/internal/es/src/bookings-services-v2-service-services.types.js +5 -50
- package/build/internal/es/src/bookings-services-v2-service-services.types.js.map +1 -1
- package/build/internal/es/src/bookings-services-v2-service-services.universal.d.ts +253 -538
- package/build/internal/es/src/bookings-services-v2-service-services.universal.js +5 -50
- package/build/internal/es/src/bookings-services-v2-service-services.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -1121,7 +1121,7 @@ export interface Settings {
|
|
|
1121
1121
|
*/
|
|
1122
1122
|
keywords?: Keyword[];
|
|
1123
1123
|
}
|
|
1124
|
-
export interface
|
|
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
|
|
1172
|
-
/**
|
|
1173
|
-
|
|
1171
|
+
export interface CreateAddOnGroupRequest {
|
|
1172
|
+
/** AddOnGroup to create. */
|
|
1173
|
+
addOnGroup?: AddOnGroup;
|
|
1174
1174
|
/**
|
|
1175
|
-
* ID of the service to create the
|
|
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
|
|
1181
|
-
/** Created
|
|
1182
|
-
|
|
1180
|
+
export interface CreateAddOnGroupResponse {
|
|
1181
|
+
/** Created AddOnGroup. */
|
|
1182
|
+
addOnGroup?: AddOnGroup;
|
|
1183
1183
|
}
|
|
1184
|
-
export interface
|
|
1184
|
+
export interface DeleteAddOnGroupRequest {
|
|
1185
1185
|
/**
|
|
1186
|
-
* ID of the
|
|
1186
|
+
* ID of the AddOnGroup to delete.
|
|
1187
1187
|
* @format GUID
|
|
1188
1188
|
*/
|
|
1189
|
-
|
|
1189
|
+
addOnGroupId?: string | null;
|
|
1190
1190
|
}
|
|
1191
|
-
export interface
|
|
1191
|
+
export interface DeleteAddOnGroupResponse {
|
|
1192
1192
|
}
|
|
1193
|
-
export interface
|
|
1194
|
-
/**
|
|
1195
|
-
|
|
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
|
|
1200
|
-
/** Updated
|
|
1201
|
-
|
|
1199
|
+
export interface UpdateAddOnGroupResponse {
|
|
1200
|
+
/** Updated AddOnGroup */
|
|
1201
|
+
addOnGroup?: AddOnGroup;
|
|
1202
1202
|
}
|
|
1203
|
-
export interface
|
|
1203
|
+
export interface ListAddOnGroupsByServiceIdRequest {
|
|
1204
1204
|
/**
|
|
1205
|
-
* ID of the service to retrieve
|
|
1205
|
+
* ID of the service to retrieve AddOnGroups for.
|
|
1206
1206
|
* @format GUID
|
|
1207
1207
|
*/
|
|
1208
1208
|
serviceId?: string | null;
|
|
@@ -1213,14 +1213,18 @@ export interface ListAddOnsGroupsByServiceIdRequest {
|
|
|
1213
1213
|
*/
|
|
1214
1214
|
groupIds?: string[] | null;
|
|
1215
1215
|
}
|
|
1216
|
-
export interface
|
|
1216
|
+
export interface ListAddOnGroupsByServiceIdResponse {
|
|
1217
1217
|
/**
|
|
1218
1218
|
* List of group IDs and their linked AddOns.
|
|
1219
1219
|
* @maxSize 3
|
|
1220
1220
|
*/
|
|
1221
|
-
|
|
1221
|
+
addOnGroupsDetails?: AddOnGroupDetail[];
|
|
1222
1222
|
}
|
|
1223
|
-
export interface AddOn {
|
|
1223
|
+
export interface AddOn extends AddOnAddOnInfoOneOf {
|
|
1224
|
+
/** The AddOn description. */
|
|
1225
|
+
durationInMinutes?: number;
|
|
1226
|
+
/** The AddOn max quantity. */
|
|
1227
|
+
maxQuantity?: number;
|
|
1224
1228
|
/**
|
|
1225
1229
|
* The AddOn ID.
|
|
1226
1230
|
* @format GUID
|
|
@@ -1231,18 +1235,20 @@ export interface AddOn {
|
|
|
1231
1235
|
* @maxLength 100
|
|
1232
1236
|
*/
|
|
1233
1237
|
name?: string | null;
|
|
1234
|
-
/** The AddOn description. */
|
|
1235
|
-
durationInMinutes?: number | null;
|
|
1236
1238
|
/**
|
|
1237
1239
|
* The AddOn price.
|
|
1238
|
-
* @readonly
|
|
1239
1240
|
* @maxLength 100
|
|
1240
1241
|
*/
|
|
1241
1242
|
formattedAmount?: string | null;
|
|
1243
|
+
}
|
|
1244
|
+
/** @oneof */
|
|
1245
|
+
export interface AddOnAddOnInfoOneOf {
|
|
1246
|
+
/** The AddOn description. */
|
|
1247
|
+
durationInMinutes?: number;
|
|
1242
1248
|
/** The AddOn max quantity. */
|
|
1243
|
-
maxQuantity?: number
|
|
1249
|
+
maxQuantity?: number;
|
|
1244
1250
|
}
|
|
1245
|
-
export interface
|
|
1251
|
+
export interface AddOnGroupDetail {
|
|
1246
1252
|
/**
|
|
1247
1253
|
* The group ID.
|
|
1248
1254
|
* @format GUID
|
|
@@ -1463,6 +1469,139 @@ export declare enum WebhookIdentityType {
|
|
|
1463
1469
|
WIX_USER = "WIX_USER",
|
|
1464
1470
|
APP = "APP"
|
|
1465
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
|
+
}
|
|
1466
1605
|
/**
|
|
1467
1606
|
* Message for reindexing search data to a given search schema. Support both upsert and delete flows as well as
|
|
1468
1607
|
* performs context manipulation with adding tenant, provided in message to callscope.
|
|
@@ -1727,9 +1866,9 @@ export interface DeleteServiceRequest {
|
|
|
1727
1866
|
* Whether to notify participants about the change and an optional
|
|
1728
1867
|
* custom message.
|
|
1729
1868
|
*/
|
|
1730
|
-
participantNotification?:
|
|
1869
|
+
participantNotification?: ParticipantNotification;
|
|
1731
1870
|
}
|
|
1732
|
-
export interface
|
|
1871
|
+
export interface ParticipantNotification {
|
|
1733
1872
|
/**
|
|
1734
1873
|
* Whether to send the message about the changes to the customer.
|
|
1735
1874
|
*
|
|
@@ -1761,7 +1900,7 @@ export interface BulkDeleteServicesRequest {
|
|
|
1761
1900
|
* Whether to notify participants about the change and an optional
|
|
1762
1901
|
* custom message.
|
|
1763
1902
|
*/
|
|
1764
|
-
participantNotification?:
|
|
1903
|
+
participantNotification?: ParticipantNotification;
|
|
1765
1904
|
}
|
|
1766
1905
|
export interface BulkDeleteServicesResponse {
|
|
1767
1906
|
/** The result of each service removal. */
|
|
@@ -1779,7 +1918,7 @@ export interface BulkDeleteServicesByFilterRequest {
|
|
|
1779
1918
|
*/
|
|
1780
1919
|
preserveFutureSessionsWithParticipants?: boolean;
|
|
1781
1920
|
/** Whether to notify participants about the change and an optional custom message. */
|
|
1782
|
-
participantNotification?:
|
|
1921
|
+
participantNotification?: ParticipantNotification;
|
|
1783
1922
|
}
|
|
1784
1923
|
export interface BulkDeleteServicesByFilterResponse {
|
|
1785
1924
|
/**
|
|
@@ -2642,7 +2781,7 @@ export interface SetServiceLocationsRequest {
|
|
|
2642
2781
|
* Whether to notify participants about the change of location, and an
|
|
2643
2782
|
* Optional custom message. The notification is sent only to participants of sessions that are affected by the change.
|
|
2644
2783
|
*/
|
|
2645
|
-
participantNotification?:
|
|
2784
|
+
participantNotification?: ParticipantNotification;
|
|
2646
2785
|
}
|
|
2647
2786
|
export interface RemovedLocationSessionsAction extends RemovedLocationSessionsActionActionOptionsOneOf {
|
|
2648
2787
|
/**
|
|
@@ -2833,11 +2972,11 @@ export interface Category {
|
|
|
2833
2972
|
* Default: `CREATED`
|
|
2834
2973
|
* @readonly
|
|
2835
2974
|
*/
|
|
2836
|
-
status?:
|
|
2975
|
+
status?: Status;
|
|
2837
2976
|
/** Sort order of the category in the live site and dashboard. */
|
|
2838
2977
|
sortOrder?: number | null;
|
|
2839
2978
|
}
|
|
2840
|
-
export declare enum
|
|
2979
|
+
export declare enum Status {
|
|
2841
2980
|
/** The category was created. */
|
|
2842
2981
|
CREATED = "CREATED",
|
|
2843
2982
|
/** The category was deleted. */
|
|
@@ -2853,52 +2992,88 @@ export declare enum CategoryNotificationEvent {
|
|
|
2853
2992
|
}
|
|
2854
2993
|
export interface Empty {
|
|
2855
2994
|
}
|
|
2856
|
-
export interface
|
|
2857
|
-
|
|
2858
|
-
|
|
2859
|
-
|
|
2860
|
-
|
|
2861
|
-
|
|
2862
|
-
|
|
2863
|
-
|
|
2864
|
-
|
|
2865
|
-
|
|
2866
|
-
|
|
2867
|
-
|
|
2868
|
-
*
|
|
2869
|
-
* @
|
|
2995
|
+
export interface ResourceNotification {
|
|
2996
|
+
/**
|
|
2997
|
+
* Updated resource entity.
|
|
2998
|
+
* 'resource.schedules' is deprecated and will not be returned. Please use 'resource.scheduleIds' instead.
|
|
2999
|
+
*/
|
|
3000
|
+
resource?: Resource;
|
|
3001
|
+
/** Event type. */
|
|
3002
|
+
event?: ResourceNotificationEvent;
|
|
3003
|
+
}
|
|
3004
|
+
export interface Resource {
|
|
3005
|
+
/**
|
|
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
|
|
2870
3024
|
*/
|
|
2871
|
-
|
|
2872
|
-
|
|
3025
|
+
phone?: string | null;
|
|
3026
|
+
/**
|
|
3027
|
+
* Resource description.
|
|
3028
|
+
* @maxLength 500
|
|
3029
|
+
*/
|
|
3030
|
+
description?: string | null;
|
|
2873
3031
|
/**
|
|
2874
|
-
*
|
|
3032
|
+
* Deprecated. Please use tags.
|
|
3033
|
+
* @maxLength 500
|
|
2875
3034
|
* @deprecated
|
|
2876
3035
|
*/
|
|
2877
|
-
|
|
2878
|
-
/**
|
|
2879
|
-
|
|
2880
|
-
|
|
2881
|
-
|
|
2882
|
-
|
|
2883
|
-
|
|
2884
|
-
|
|
2885
|
-
|
|
2886
|
-
|
|
2887
|
-
sessionCreated?: SessionCreated;
|
|
2888
|
-
sessionUpdated?: SessionUpdated;
|
|
2889
|
-
sessionCancelled?: SessionCancelled;
|
|
2890
|
-
availabilityPolicyUpdated?: AvailabilityPolicyUpdated;
|
|
2891
|
-
/** @deprecated */
|
|
2892
|
-
intervalSplit?: IntervalSplit;
|
|
2893
|
-
recurringSessionSplit?: RecurringSessionSplit;
|
|
2894
|
-
/**
|
|
2895
|
-
* 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.
|
|
2896
3046
|
* @deprecated
|
|
2897
3047
|
*/
|
|
2898
|
-
|
|
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;
|
|
2899
3067
|
}
|
|
2900
|
-
export interface
|
|
2901
|
-
|
|
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;
|
|
2902
3077
|
}
|
|
2903
3078
|
export interface Schedule {
|
|
2904
3079
|
/** Schedule ID. */
|
|
@@ -3528,466 +3703,6 @@ export declare enum ConferenceType {
|
|
|
3528
3703
|
/** User-defined meeting. */
|
|
3529
3704
|
CUSTOM = "CUSTOM"
|
|
3530
3705
|
}
|
|
3531
|
-
export interface ScheduleUpdated {
|
|
3532
|
-
/** The old schedule before the update. */
|
|
3533
|
-
oldSchedule?: Schedule;
|
|
3534
|
-
/** The new schedule after the update. */
|
|
3535
|
-
newSchedule?: Schedule;
|
|
3536
|
-
/**
|
|
3537
|
-
* Recurring sessions updated event. If this field is given, the reason for the schedule updated event was
|
|
3538
|
-
* updating at least one of the given schedule's recurring sessions.
|
|
3539
|
-
* This event is triggered by create/update/delete recurring session apis.
|
|
3540
|
-
*/
|
|
3541
|
-
recurringSessions?: RecurringSessionsUpdated;
|
|
3542
|
-
/** Whether to notify participants about the change and an optional custom message */
|
|
3543
|
-
participantNotification?: ParticipantNotification;
|
|
3544
|
-
/**
|
|
3545
|
-
* Whether this notification was created as a result of an anonymization request, such as GDPR.
|
|
3546
|
-
* An anonymized participant will have the following details:
|
|
3547
|
-
* name = "deleted"
|
|
3548
|
-
* phone = "deleted"
|
|
3549
|
-
* email = "deleted@deleted.com"
|
|
3550
|
-
*/
|
|
3551
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
3552
|
-
}
|
|
3553
|
-
export interface RecurringSessionsUpdated {
|
|
3554
|
-
/** Old schedule's recurring session list. */
|
|
3555
|
-
oldRecurringSessions?: Session[];
|
|
3556
|
-
/** New schedule's recurring session list. */
|
|
3557
|
-
newRecurringSessions?: Session[];
|
|
3558
|
-
}
|
|
3559
|
-
export interface Session {
|
|
3560
|
-
/**
|
|
3561
|
-
* Session ID.
|
|
3562
|
-
* @readonly
|
|
3563
|
-
*/
|
|
3564
|
-
_id?: string | null;
|
|
3565
|
-
/**
|
|
3566
|
-
* ID of the schedule that the session belongs to.
|
|
3567
|
-
* @immutable
|
|
3568
|
-
*/
|
|
3569
|
-
scheduleId?: string;
|
|
3570
|
-
/**
|
|
3571
|
-
* ID of the resource or service that the session's schedule belongs to.
|
|
3572
|
-
* @readonly
|
|
3573
|
-
*/
|
|
3574
|
-
scheduleOwnerId?: string | null;
|
|
3575
|
-
/** Original start date and time of the session in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)) format. */
|
|
3576
|
-
originalStart?: Date | null;
|
|
3577
|
-
/** An object specifying the start date and time of the session. If the session is a recurring session, `start` must contain a `localDateTime`. */
|
|
3578
|
-
start?: CalendarDateTime;
|
|
3579
|
-
/**
|
|
3580
|
-
* 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`.
|
|
3581
|
-
* If the session is a recurring session, `end` must contain a `localDateTime`.
|
|
3582
|
-
*/
|
|
3583
|
-
end?: CalendarDateTime;
|
|
3584
|
-
/**
|
|
3585
|
-
* 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.
|
|
3586
|
-
* The array is inherited from the schedule and can be overridden even if the session is a recurring session.
|
|
3587
|
-
*/
|
|
3588
|
-
affectedSchedules?: LinkedSchedule[];
|
|
3589
|
-
/**
|
|
3590
|
-
* Session title.
|
|
3591
|
-
* The value is inherited from the schedule and can be overridden unless the session is a recurring session.
|
|
3592
|
-
* @maxLength 6000
|
|
3593
|
-
*/
|
|
3594
|
-
title?: string | null;
|
|
3595
|
-
/**
|
|
3596
|
-
* __Deprecated.__
|
|
3597
|
-
* Tags for the session.
|
|
3598
|
-
* The value is inherited from the schedule and can be overridden unless the session is a recurring session.
|
|
3599
|
-
* @maxLength 200
|
|
3600
|
-
* @deprecated
|
|
3601
|
-
*/
|
|
3602
|
-
tags?: string[] | null;
|
|
3603
|
-
/**
|
|
3604
|
-
* An object describing the location where the session takes place.
|
|
3605
|
-
* Defaults to the schedule location.
|
|
3606
|
-
* 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`.
|
|
3607
|
-
*/
|
|
3608
|
-
location?: Location;
|
|
3609
|
-
/**
|
|
3610
|
-
* Maximum number of participants that can be added to the session. Defaults to the schedule capacity.
|
|
3611
|
-
* The value is inherited from the schedule and can be overridden unless the session is a recurring session.
|
|
3612
|
-
* @max 1000
|
|
3613
|
-
*/
|
|
3614
|
-
capacity?: number | null;
|
|
3615
|
-
/**
|
|
3616
|
-
* Deprecated. Please use the [Booking Services V2](https://dev.wix.com/api/rest/wix-bookings/services-v2) payment instead.
|
|
3617
|
-
* @deprecated
|
|
3618
|
-
*/
|
|
3619
|
-
rate?: Rate;
|
|
3620
|
-
/**
|
|
3621
|
-
* Time reserved after the session end time, derived from the schedule availability constraints and the time between slots. Read-only.
|
|
3622
|
-
* If the session is a recurring session, this field must be empty.
|
|
3623
|
-
*/
|
|
3624
|
-
timeReservedAfter?: number | null;
|
|
3625
|
-
/**
|
|
3626
|
-
* Additional information about the session.
|
|
3627
|
-
* Notes are not supported for recurring sessions.
|
|
3628
|
-
* @maxLength 10000
|
|
3629
|
-
*/
|
|
3630
|
-
notes?: string;
|
|
3631
|
-
/**
|
|
3632
|
-
* The number of participants booked for the session. Read-only.
|
|
3633
|
-
* Calculated as the sum of the party sizes.
|
|
3634
|
-
* @readonly
|
|
3635
|
-
*/
|
|
3636
|
-
totalNumberOfParticipants?: number;
|
|
3637
|
-
/**
|
|
3638
|
-
* *Partial list** list of participants booked for the session.
|
|
3639
|
-
* The list includes participants who have registered for this specific session, and participants who have registered for a schedule that includes this session.
|
|
3640
|
-
* If the session is a recurring session, this field must be empty.
|
|
3641
|
-
* 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).
|
|
3642
|
-
*/
|
|
3643
|
-
participants?: Participant[];
|
|
3644
|
-
/**
|
|
3645
|
-
* A list of properties for which values were inherited from the schedule.
|
|
3646
|
-
* This does not include participants that were inherited from the schedule.
|
|
3647
|
-
* @readonly
|
|
3648
|
-
*/
|
|
3649
|
-
inheritedFields?: string[];
|
|
3650
|
-
/**
|
|
3651
|
-
* __Deprecated.__
|
|
3652
|
-
* @deprecated
|
|
3653
|
-
*/
|
|
3654
|
-
externalCalendarOverrides?: ExternalCalendarOverrides;
|
|
3655
|
-
/**
|
|
3656
|
-
* Session status.
|
|
3657
|
-
* @readonly
|
|
3658
|
-
*/
|
|
3659
|
-
status?: Status;
|
|
3660
|
-
/**
|
|
3661
|
-
* Recurring interval ID. Defined when a session will be a recurring session. read-only. Optional.
|
|
3662
|
-
* For example, when creating a class service with recurring sessions, you add a recurrence rule to create recurring sessions.
|
|
3663
|
-
* This field is omitted for single sessions or instances of recurring sessions.
|
|
3664
|
-
* Specified when the session was originally generated from a schedule recurring interval.
|
|
3665
|
-
* Deprecated. Use `recurringSessionId`.
|
|
3666
|
-
* @readonly
|
|
3667
|
-
* @deprecated
|
|
3668
|
-
*/
|
|
3669
|
-
recurringIntervalId?: string | null;
|
|
3670
|
-
/**
|
|
3671
|
-
* 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.
|
|
3672
|
-
* @readonly
|
|
3673
|
-
*/
|
|
3674
|
-
recurringSessionId?: string | null;
|
|
3675
|
-
/** Session type. */
|
|
3676
|
-
type?: SessionType;
|
|
3677
|
-
/**
|
|
3678
|
-
* A conference created for the session according to the details set in the schedule's conference provider information.
|
|
3679
|
-
* If the session is a recurring session, this field is inherited from the schedule.
|
|
3680
|
-
* **Partially deprecated.** Only `hostUrl` and `guestUrl` are to be supported.
|
|
3681
|
-
* @deprecated
|
|
3682
|
-
*/
|
|
3683
|
-
calendarConference?: CalendarConference;
|
|
3684
|
-
/**
|
|
3685
|
-
* 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).
|
|
3686
|
-
* 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.
|
|
3687
|
-
* The RRULE defines a rule for repeating a session.
|
|
3688
|
-
* Supported parameters are:
|
|
3689
|
-
*
|
|
3690
|
-
* |Keyword|Description|Supported values|
|
|
3691
|
-
* |--|--|---|
|
|
3692
|
-
* |`FREQ`|The frequency at which the session is recurs. Required.|`WEEKLY`|
|
|
3693
|
-
* |`INTERVAL`|How often, in terms of `FREQ`, the session recurs. Default is 1. Optional.|
|
|
3694
|
-
* |`UNTIL`|The UTC end date and time of the recurrence. Optional.|
|
|
3695
|
-
* |`BYDAY`|Day of the week when the event should recur. Required.|One of: `MO`, `TU`, `WE`, `TH`, `FR`, `SA`, `SU`|
|
|
3696
|
-
*
|
|
3697
|
-
*
|
|
3698
|
-
* For example, a session that repeats every second week on a Monday until January 7, 2022 at 8 AM:
|
|
3699
|
-
* `"FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;UNTIL=20220107T080000Z"`
|
|
3700
|
-
*
|
|
3701
|
-
* <!--ORIGINAL COMMENTS:
|
|
3702
|
-
* `FREQ` — The frequency with which the session should be repeated (such as DAILY or WEEKLY).
|
|
3703
|
-
* Supported `WEEKLY` value is supported.
|
|
3704
|
-
* 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.
|
|
3705
|
-
* COUNT — The number of times this event should be repeated. Not yet supported.
|
|
3706
|
-
* 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.
|
|
3707
|
-
* 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'.
|
|
3708
|
-
* BYDAY - The days of the week when the event should be repeated. Currently, only a single day is supported. This parameter is mandatory.
|
|
3709
|
-
* Possible values are: MO, TU, WE, TH, FR, SA, SU
|
|
3710
|
-
* 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.
|
|
3711
|
-
* **Example**: FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;UNTIL=20200427T070000Z
|
|
3712
|
-
* ORIGINAL COMMENTS-->
|
|
3713
|
-
*/
|
|
3714
|
-
recurrence?: string | null;
|
|
3715
|
-
/**
|
|
3716
|
-
* A string representing a recurrence rule (RRULE) if the session is an instance of a recurrence pattern.
|
|
3717
|
-
* 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.
|
|
3718
|
-
* @readonly
|
|
3719
|
-
*/
|
|
3720
|
-
instanceOfRecurrence?: string | null;
|
|
3721
|
-
/**
|
|
3722
|
-
* The session version.
|
|
3723
|
-
* Composed by the schedule, session and participants versions.
|
|
3724
|
-
* @readonly
|
|
3725
|
-
*/
|
|
3726
|
-
version?: SessionVersion;
|
|
3727
|
-
}
|
|
3728
|
-
export interface CalendarDateTime {
|
|
3729
|
-
/**
|
|
3730
|
-
* 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"`.
|
|
3731
|
-
* Required if `localDateTime` is not specified.
|
|
3732
|
-
* If `localDateTime` is specified, `timestamp` is calculated as `localDateTime`, using the business's time zone.
|
|
3733
|
-
*/
|
|
3734
|
-
timestamp?: Date | null;
|
|
3735
|
-
/** An object containing the local date and time for the business's time zone. */
|
|
3736
|
-
localDateTime?: LocalDateTime;
|
|
3737
|
-
/**
|
|
3738
|
-
* The time zone. Optional. Derived from the schedule's time zone.
|
|
3739
|
-
* In case this field is associated with recurring session, this field is empty.
|
|
3740
|
-
* @readonly
|
|
3741
|
-
*/
|
|
3742
|
-
timeZone?: string | null;
|
|
3743
|
-
}
|
|
3744
|
-
export interface LocalDateTime {
|
|
3745
|
-
/** Year. 4-digit format. */
|
|
3746
|
-
year?: number | null;
|
|
3747
|
-
/**
|
|
3748
|
-
* Month number, from 1-12.
|
|
3749
|
-
* @min 1
|
|
3750
|
-
* @max 12
|
|
3751
|
-
*/
|
|
3752
|
-
monthOfYear?: number | null;
|
|
3753
|
-
/** Day of the month, from 1-31. */
|
|
3754
|
-
dayOfMonth?: number | null;
|
|
3755
|
-
/**
|
|
3756
|
-
* Hour of the day in 24-hour format, from 0-23.
|
|
3757
|
-
* @max 23
|
|
3758
|
-
*/
|
|
3759
|
-
hourOfDay?: number | null;
|
|
3760
|
-
/**
|
|
3761
|
-
* Minute, from 0-59.
|
|
3762
|
-
* @max 59
|
|
3763
|
-
*/
|
|
3764
|
-
minutesOfHour?: number | null;
|
|
3765
|
-
}
|
|
3766
|
-
export interface ExternalCalendarInfo {
|
|
3767
|
-
/** The external calendar type (e.g. Google Calendar, iCal, etc). */
|
|
3768
|
-
calendarType?: CalendarType;
|
|
3769
|
-
}
|
|
3770
|
-
export declare enum CalendarType {
|
|
3771
|
-
/** There is no information about the external calendar type. */
|
|
3772
|
-
UNDEFINED = "UNDEFINED",
|
|
3773
|
-
/** [Google Calendar](https://developers.google.com/calendar/api/guides/overview). */
|
|
3774
|
-
GOOGLE = "GOOGLE",
|
|
3775
|
-
/** Apple iCalendar. */
|
|
3776
|
-
I_CAL = "I_CAL",
|
|
3777
|
-
/** __Deprecated__. Use `MICROSOFT` instead. */
|
|
3778
|
-
OUTLOOK = "OUTLOOK",
|
|
3779
|
-
/** __Deprecated__. Use `MICROSOFT` instead. */
|
|
3780
|
-
OFFICE_365 = "OFFICE_365",
|
|
3781
|
-
/** Microsoft Calendar. For example, Office 365 calendar or Outlook calendar. */
|
|
3782
|
-
MICROSOFT = "MICROSOFT",
|
|
3783
|
-
/** A different type of external calendar, not listed here. */
|
|
3784
|
-
OTHER = "OTHER"
|
|
3785
|
-
}
|
|
3786
|
-
export declare enum Status {
|
|
3787
|
-
/** Undefined status. */
|
|
3788
|
-
UNDEFINED = "UNDEFINED",
|
|
3789
|
-
/** Session is confirmed. Default status. */
|
|
3790
|
-
CONFIRMED = "CONFIRMED",
|
|
3791
|
-
/**
|
|
3792
|
-
* Session is cancelled.
|
|
3793
|
-
* A cancelled session can be the cancellation of a recurring session that should no longer be displayed or a deleted single session.
|
|
3794
|
-
* The ListSessions returns cancelled sessions only if 'includeDelete' flag is set to true.
|
|
3795
|
-
*/
|
|
3796
|
-
CANCELLED = "CANCELLED"
|
|
3797
|
-
}
|
|
3798
|
-
export declare enum SessionType {
|
|
3799
|
-
UNDEFINED = "UNDEFINED",
|
|
3800
|
-
/**
|
|
3801
|
-
* Creates an event on the calendar for the owner of the schedule that the session belongs to.
|
|
3802
|
-
* Default type.
|
|
3803
|
-
*/
|
|
3804
|
-
EVENT = "EVENT",
|
|
3805
|
-
/** Represents a resource's available working hours. */
|
|
3806
|
-
WORKING_HOURS = "WORKING_HOURS",
|
|
3807
|
-
/** Deprecated. Please use WORKING_HOURS. */
|
|
3808
|
-
TIME_AVAILABILITY = "TIME_AVAILABILITY",
|
|
3809
|
-
/** Deprecated. Represents a resource's available hours. Please use WORKING_HOURS. */
|
|
3810
|
-
AVAILABILITY = "AVAILABILITY"
|
|
3811
|
-
}
|
|
3812
|
-
export interface SessionVersion {
|
|
3813
|
-
/** Incremental version number, which is updated on each change to the session or on changes affecting the session. */
|
|
3814
|
-
number?: string | null;
|
|
3815
|
-
}
|
|
3816
|
-
export interface ParticipantNotification {
|
|
3817
|
-
/**
|
|
3818
|
-
* Whether to send the message about the changes to the customer.
|
|
3819
|
-
*
|
|
3820
|
-
* Default: `false`
|
|
3821
|
-
*/
|
|
3822
|
-
notifyParticipants?: boolean;
|
|
3823
|
-
/** Custom message to send to the participants about the changes to the booking. */
|
|
3824
|
-
message?: string | null;
|
|
3825
|
-
}
|
|
3826
|
-
export interface ScheduleCancelled {
|
|
3827
|
-
schedule?: Schedule;
|
|
3828
|
-
/** Whether to notify participants about the change and an optional custom message */
|
|
3829
|
-
participantNotification?: ParticipantNotification;
|
|
3830
|
-
oldSchedule?: Schedule;
|
|
3831
|
-
}
|
|
3832
|
-
export interface SessionCreated {
|
|
3833
|
-
session?: Session;
|
|
3834
|
-
}
|
|
3835
|
-
export interface SessionUpdated {
|
|
3836
|
-
oldSession?: Session;
|
|
3837
|
-
newSession?: Session;
|
|
3838
|
-
/** Whether to notify participants about the change and an optional custom message */
|
|
3839
|
-
participantNotification?: ParticipantNotification;
|
|
3840
|
-
/**
|
|
3841
|
-
* Whether this notification was created as a result of an anonymization request, such as GDPR.
|
|
3842
|
-
* An anonymized participant will have the following details:
|
|
3843
|
-
* name = "deleted"
|
|
3844
|
-
* phone = "deleted"
|
|
3845
|
-
* email = "deleted@deleted.com"
|
|
3846
|
-
*/
|
|
3847
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
3848
|
-
}
|
|
3849
|
-
export interface SessionCancelled {
|
|
3850
|
-
session?: Session;
|
|
3851
|
-
/** Whether to notify participants about the change and an optional custom message */
|
|
3852
|
-
participantNotification?: ParticipantNotification;
|
|
3853
|
-
}
|
|
3854
|
-
export interface AvailabilityPolicyUpdated {
|
|
3855
|
-
availabilityPolicy?: AvailabilityPolicy;
|
|
3856
|
-
}
|
|
3857
|
-
/** Availability policy applied to all site schedules. */
|
|
3858
|
-
export interface AvailabilityPolicy {
|
|
3859
|
-
/** Specify how to split the schedule slots in intervals of minutes. */
|
|
3860
|
-
splitInterval?: SplitInterval;
|
|
3861
|
-
}
|
|
3862
|
-
export interface IntervalSplit {
|
|
3863
|
-
scheduleId?: string;
|
|
3864
|
-
intervals?: RecurringInterval[];
|
|
3865
|
-
newScheduleVersion?: number | null;
|
|
3866
|
-
oldScheduleVersion?: number | null;
|
|
3867
|
-
}
|
|
3868
|
-
export interface RecurringSessionSplit {
|
|
3869
|
-
scheduleId?: string;
|
|
3870
|
-
recurringSessions?: Session[];
|
|
3871
|
-
newScheduleVersion?: number | null;
|
|
3872
|
-
oldScheduleVersion?: number | null;
|
|
3873
|
-
}
|
|
3874
|
-
/** Schedule unassigned from user. */
|
|
3875
|
-
export interface ScheduleUnassignedFromUser {
|
|
3876
|
-
/**
|
|
3877
|
-
* The Wix user id.
|
|
3878
|
-
* @format GUID
|
|
3879
|
-
*/
|
|
3880
|
-
userId?: string | null;
|
|
3881
|
-
/** The schedule that was unassigned from the user. */
|
|
3882
|
-
schedule?: Schedule;
|
|
3883
|
-
}
|
|
3884
|
-
export interface MultipleSessionsCreated {
|
|
3885
|
-
schedulesWithSessions?: ScheduleWithSessions[];
|
|
3886
|
-
}
|
|
3887
|
-
export interface ScheduleWithSessions {
|
|
3888
|
-
schedule?: Schedule;
|
|
3889
|
-
siteProperties?: SitePropertiesOnScheduleCreation;
|
|
3890
|
-
sessions?: Session[];
|
|
3891
|
-
}
|
|
3892
|
-
export interface SitePropertiesOnScheduleCreation {
|
|
3893
|
-
/** The global time zone value. */
|
|
3894
|
-
timeZone?: string | null;
|
|
3895
|
-
}
|
|
3896
|
-
export interface MigrationEvent {
|
|
3897
|
-
migrationData?: MigrationData;
|
|
3898
|
-
}
|
|
3899
|
-
export interface MigrationData {
|
|
3900
|
-
businessId?: string | null;
|
|
3901
|
-
staffs?: StaffData[];
|
|
3902
|
-
}
|
|
3903
|
-
export interface StaffData {
|
|
3904
|
-
resourceId?: string;
|
|
3905
|
-
syncRequestEmail?: string;
|
|
3906
|
-
refreshToken?: string;
|
|
3907
|
-
}
|
|
3908
|
-
export interface ResourceNotification {
|
|
3909
|
-
/**
|
|
3910
|
-
* Updated resource entity.
|
|
3911
|
-
* 'resource.schedules' is deprecated and will not be returned. Please use 'resource.scheduleIds' instead.
|
|
3912
|
-
*/
|
|
3913
|
-
resource?: Resource;
|
|
3914
|
-
/** Event type. */
|
|
3915
|
-
event?: ResourceNotificationEvent;
|
|
3916
|
-
}
|
|
3917
|
-
export interface Resource {
|
|
3918
|
-
/**
|
|
3919
|
-
* Resource ID.
|
|
3920
|
-
* @format GUID
|
|
3921
|
-
* @readonly
|
|
3922
|
-
*/
|
|
3923
|
-
_id?: string | null;
|
|
3924
|
-
/**
|
|
3925
|
-
* Resource name.
|
|
3926
|
-
* @maxLength 1200
|
|
3927
|
-
*/
|
|
3928
|
-
name?: string | null;
|
|
3929
|
-
/**
|
|
3930
|
-
* Resource email address.
|
|
3931
|
-
* @maxLength 500
|
|
3932
|
-
*/
|
|
3933
|
-
email?: string | null;
|
|
3934
|
-
/**
|
|
3935
|
-
* Resource phone number.
|
|
3936
|
-
* @maxLength 500
|
|
3937
|
-
*/
|
|
3938
|
-
phone?: string | null;
|
|
3939
|
-
/**
|
|
3940
|
-
* Resource description.
|
|
3941
|
-
* @maxLength 500
|
|
3942
|
-
*/
|
|
3943
|
-
description?: string | null;
|
|
3944
|
-
/**
|
|
3945
|
-
* Deprecated. Please use tags.
|
|
3946
|
-
* @maxLength 500
|
|
3947
|
-
* @deprecated
|
|
3948
|
-
*/
|
|
3949
|
-
tag?: string | null;
|
|
3950
|
-
/**
|
|
3951
|
-
* Resource tags. Tags are used to identify, group, and filter the different types of resources. For example, 'staff' or 'room'.
|
|
3952
|
-
* @maxLength 200
|
|
3953
|
-
*/
|
|
3954
|
-
tags?: string[] | null;
|
|
3955
|
-
/** Resource images. */
|
|
3956
|
-
images?: string[];
|
|
3957
|
-
/**
|
|
3958
|
-
* Deprecated. Please use scheduleIds. List of the schedules owned by this resource. Min size 1.
|
|
3959
|
-
* @deprecated
|
|
3960
|
-
*/
|
|
3961
|
-
schedules?: Schedule[];
|
|
3962
|
-
/**
|
|
3963
|
-
* List of IDs of schedules owned by this resource.
|
|
3964
|
-
* @format GUID
|
|
3965
|
-
* @readonly
|
|
3966
|
-
*/
|
|
3967
|
-
scheduleIds?: string[] | null;
|
|
3968
|
-
/**
|
|
3969
|
-
* Resource status. Default: `CREATED`.
|
|
3970
|
-
* @readonly
|
|
3971
|
-
*/
|
|
3972
|
-
status?: ResourceStatus;
|
|
3973
|
-
/**
|
|
3974
|
-
* Wix user ID, if the resource is associated with the Wix user.
|
|
3975
|
-
* A staff member resource can be associated with a Wix user via assignment of a permissions role in the business manager.
|
|
3976
|
-
* @format GUID
|
|
3977
|
-
* @readonly
|
|
3978
|
-
*/
|
|
3979
|
-
wixUserId?: string | null;
|
|
3980
|
-
}
|
|
3981
|
-
export interface FocalPoint {
|
|
3982
|
-
/** X-coordinate of the focal point. */
|
|
3983
|
-
x?: number;
|
|
3984
|
-
/** Y-coordinate of the focal point. */
|
|
3985
|
-
y?: number;
|
|
3986
|
-
/** crop by height */
|
|
3987
|
-
height?: number | null;
|
|
3988
|
-
/** crop by width */
|
|
3989
|
-
width?: number | null;
|
|
3990
|
-
}
|
|
3991
3706
|
export declare enum ResourceStatus {
|
|
3992
3707
|
/** Undefined resource status. */
|
|
3993
3708
|
UNDEFINED = "UNDEFINED",
|
|
@@ -5221,7 +4936,7 @@ export interface DeleteServiceOptions {
|
|
|
5221
4936
|
* Whether to notify participants about the change and an optional
|
|
5222
4937
|
* custom message.
|
|
5223
4938
|
*/
|
|
5224
|
-
participantNotification?:
|
|
4939
|
+
participantNotification?: ParticipantNotification;
|
|
5225
4940
|
}
|
|
5226
4941
|
/**
|
|
5227
4942
|
* Deletes multiple services.
|
|
@@ -5256,7 +4971,7 @@ export interface BulkDeleteServicesOptions {
|
|
|
5256
4971
|
* Whether to notify participants about the change and an optional
|
|
5257
4972
|
* custom message.
|
|
5258
4973
|
*/
|
|
5259
|
-
participantNotification?:
|
|
4974
|
+
participantNotification?: ParticipantNotification;
|
|
5260
4975
|
}
|
|
5261
4976
|
/**
|
|
5262
4977
|
* Deletes multiple services by filter.
|
|
@@ -5295,7 +5010,7 @@ export interface BulkDeleteServicesByFilterOptions {
|
|
|
5295
5010
|
*/
|
|
5296
5011
|
preserveFutureSessionsWithParticipants?: boolean;
|
|
5297
5012
|
/** Whether to notify participants about the change and an optional custom message. */
|
|
5298
|
-
participantNotification?:
|
|
5013
|
+
participantNotification?: ParticipantNotification;
|
|
5299
5014
|
}
|
|
5300
5015
|
/**
|
|
5301
5016
|
* Creates a query to retrieve a list of `service` objects.
|
|
@@ -5804,7 +5519,7 @@ export interface SetServiceLocationsOptions {
|
|
|
5804
5519
|
* Whether to notify participants about the change of location, and an
|
|
5805
5520
|
* Optional custom message. The notification is sent only to participants of sessions that are affected by the change.
|
|
5806
5521
|
*/
|
|
5807
|
-
participantNotification?:
|
|
5522
|
+
participantNotification?: ParticipantNotification;
|
|
5808
5523
|
}
|
|
5809
5524
|
/**
|
|
5810
5525
|
* Adds a list of *pricing plan IDs*
|