@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
|
@@ -1160,7 +1160,7 @@ export interface Settings {
|
|
|
1160
1160
|
*/
|
|
1161
1161
|
keywords?: Keyword[];
|
|
1162
1162
|
}
|
|
1163
|
-
export interface
|
|
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
|
|
1211
|
-
/**
|
|
1212
|
-
|
|
1210
|
+
export interface CreateAddOnGroupRequest {
|
|
1211
|
+
/** AddOnGroup to create. */
|
|
1212
|
+
addOnGroup?: AddOnGroup;
|
|
1213
1213
|
/**
|
|
1214
|
-
* ID of the service to create the
|
|
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
|
|
1220
|
-
/** Created
|
|
1221
|
-
|
|
1219
|
+
export interface CreateAddOnGroupResponse {
|
|
1220
|
+
/** Created AddOnGroup. */
|
|
1221
|
+
addOnGroup?: AddOnGroup;
|
|
1222
1222
|
}
|
|
1223
|
-
export interface
|
|
1223
|
+
export interface DeleteAddOnGroupRequest {
|
|
1224
1224
|
/**
|
|
1225
|
-
* ID of the
|
|
1225
|
+
* ID of the AddOnGroup to delete.
|
|
1226
1226
|
* @format GUID
|
|
1227
1227
|
*/
|
|
1228
|
-
|
|
1228
|
+
addOnGroupId?: string | null;
|
|
1229
1229
|
}
|
|
1230
|
-
export interface
|
|
1230
|
+
export interface DeleteAddOnGroupResponse {
|
|
1231
1231
|
}
|
|
1232
|
-
export interface
|
|
1233
|
-
/**
|
|
1234
|
-
|
|
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
|
|
1239
|
-
/** Updated
|
|
1240
|
-
|
|
1238
|
+
export interface UpdateAddOnGroupResponse {
|
|
1239
|
+
/** Updated AddOnGroup */
|
|
1240
|
+
addOnGroup?: AddOnGroup;
|
|
1241
1241
|
}
|
|
1242
|
-
export interface
|
|
1242
|
+
export interface ListAddOnGroupsByServiceIdRequest {
|
|
1243
1243
|
/**
|
|
1244
|
-
* ID of the service to retrieve
|
|
1244
|
+
* ID of the service to retrieve AddOnGroups for.
|
|
1245
1245
|
* @format GUID
|
|
1246
1246
|
*/
|
|
1247
1247
|
serviceId?: string | null;
|
|
@@ -1252,14 +1252,18 @@ export interface ListAddOnsGroupsByServiceIdRequest {
|
|
|
1252
1252
|
*/
|
|
1253
1253
|
groupIds?: string[] | null;
|
|
1254
1254
|
}
|
|
1255
|
-
export interface
|
|
1255
|
+
export interface ListAddOnGroupsByServiceIdResponse {
|
|
1256
1256
|
/**
|
|
1257
1257
|
* List of group IDs and their linked AddOns.
|
|
1258
1258
|
* @maxSize 3
|
|
1259
1259
|
*/
|
|
1260
|
-
|
|
1260
|
+
addOnGroupsDetails?: AddOnGroupDetail[];
|
|
1261
1261
|
}
|
|
1262
|
-
export interface AddOn {
|
|
1262
|
+
export interface AddOn extends AddOnAddOnInfoOneOf {
|
|
1263
|
+
/** The AddOn description. */
|
|
1264
|
+
durationInMinutes?: number;
|
|
1265
|
+
/** The AddOn max quantity. */
|
|
1266
|
+
maxQuantity?: number;
|
|
1263
1267
|
/**
|
|
1264
1268
|
* The AddOn ID.
|
|
1265
1269
|
* @format GUID
|
|
@@ -1270,18 +1274,20 @@ export interface AddOn {
|
|
|
1270
1274
|
* @maxLength 100
|
|
1271
1275
|
*/
|
|
1272
1276
|
name?: string | null;
|
|
1273
|
-
/** The AddOn description. */
|
|
1274
|
-
durationInMinutes?: number | null;
|
|
1275
1277
|
/**
|
|
1276
1278
|
* The AddOn price.
|
|
1277
|
-
* @readonly
|
|
1278
1279
|
* @maxLength 100
|
|
1279
1280
|
*/
|
|
1280
1281
|
formattedAmount?: string | null;
|
|
1282
|
+
}
|
|
1283
|
+
/** @oneof */
|
|
1284
|
+
export interface AddOnAddOnInfoOneOf {
|
|
1285
|
+
/** The AddOn description. */
|
|
1286
|
+
durationInMinutes?: number;
|
|
1281
1287
|
/** The AddOn max quantity. */
|
|
1282
|
-
maxQuantity?: number
|
|
1288
|
+
maxQuantity?: number;
|
|
1283
1289
|
}
|
|
1284
|
-
export interface
|
|
1290
|
+
export interface AddOnGroupDetail {
|
|
1285
1291
|
/**
|
|
1286
1292
|
* The group ID.
|
|
1287
1293
|
* @format GUID
|
|
@@ -1504,6 +1510,139 @@ export declare enum WebhookIdentityType {
|
|
|
1504
1510
|
WIX_USER = "WIX_USER",
|
|
1505
1511
|
APP = "APP"
|
|
1506
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
|
+
}
|
|
1507
1646
|
/**
|
|
1508
1647
|
* Message for reindexing search data to a given search schema. Support both upsert and delete flows as well as
|
|
1509
1648
|
* performs context manipulation with adding tenant, provided in message to callscope.
|
|
@@ -1768,9 +1907,9 @@ export interface DeleteServiceRequest {
|
|
|
1768
1907
|
* Whether to notify participants about the change and an optional
|
|
1769
1908
|
* custom message.
|
|
1770
1909
|
*/
|
|
1771
|
-
participantNotification?:
|
|
1910
|
+
participantNotification?: ParticipantNotification;
|
|
1772
1911
|
}
|
|
1773
|
-
export interface
|
|
1912
|
+
export interface ParticipantNotification {
|
|
1774
1913
|
/**
|
|
1775
1914
|
* Whether to send the message about the changes to the customer.
|
|
1776
1915
|
*
|
|
@@ -1802,7 +1941,7 @@ export interface BulkDeleteServicesRequest {
|
|
|
1802
1941
|
* Whether to notify participants about the change and an optional
|
|
1803
1942
|
* custom message.
|
|
1804
1943
|
*/
|
|
1805
|
-
participantNotification?:
|
|
1944
|
+
participantNotification?: ParticipantNotification;
|
|
1806
1945
|
}
|
|
1807
1946
|
export interface BulkDeleteServicesResponse {
|
|
1808
1947
|
/** The result of each service removal. */
|
|
@@ -1820,7 +1959,7 @@ export interface BulkDeleteServicesByFilterRequest {
|
|
|
1820
1959
|
*/
|
|
1821
1960
|
preserveFutureSessionsWithParticipants?: boolean;
|
|
1822
1961
|
/** Whether to notify participants about the change and an optional custom message. */
|
|
1823
|
-
participantNotification?:
|
|
1962
|
+
participantNotification?: ParticipantNotification;
|
|
1824
1963
|
}
|
|
1825
1964
|
export interface BulkDeleteServicesByFilterResponse {
|
|
1826
1965
|
/**
|
|
@@ -2683,7 +2822,7 @@ export interface SetServiceLocationsRequest {
|
|
|
2683
2822
|
* Whether to notify participants about the change of location, and an
|
|
2684
2823
|
* Optional custom message. The notification is sent only to participants of sessions that are affected by the change.
|
|
2685
2824
|
*/
|
|
2686
|
-
participantNotification?:
|
|
2825
|
+
participantNotification?: ParticipantNotification;
|
|
2687
2826
|
}
|
|
2688
2827
|
export interface RemovedLocationSessionsAction extends RemovedLocationSessionsActionActionOptionsOneOf {
|
|
2689
2828
|
/**
|
|
@@ -2874,11 +3013,11 @@ export interface Category {
|
|
|
2874
3013
|
* Default: `CREATED`
|
|
2875
3014
|
* @readonly
|
|
2876
3015
|
*/
|
|
2877
|
-
status?:
|
|
3016
|
+
status?: Status;
|
|
2878
3017
|
/** Sort order of the category in the live site and dashboard. */
|
|
2879
3018
|
sortOrder?: number | null;
|
|
2880
3019
|
}
|
|
2881
|
-
export declare enum
|
|
3020
|
+
export declare enum Status {
|
|
2882
3021
|
/** The category was created. */
|
|
2883
3022
|
CREATED = "CREATED",
|
|
2884
3023
|
/** The category was deleted. */
|
|
@@ -2894,122 +3033,181 @@ export declare enum CategoryNotificationEvent {
|
|
|
2894
3033
|
}
|
|
2895
3034
|
export interface Empty {
|
|
2896
3035
|
}
|
|
2897
|
-
export interface
|
|
2898
|
-
scheduleCreated?: ScheduleCreated;
|
|
2899
|
-
scheduleUpdated?: ScheduleUpdated;
|
|
2900
|
-
scheduleCancelled?: ScheduleCancelled;
|
|
2901
|
-
sessionCreated?: SessionCreated;
|
|
2902
|
-
sessionUpdated?: SessionUpdated;
|
|
2903
|
-
sessionCancelled?: SessionCancelled;
|
|
2904
|
-
availabilityPolicyUpdated?: AvailabilityPolicyUpdated;
|
|
2905
|
-
/** @deprecated */
|
|
2906
|
-
intervalSplit?: IntervalSplit;
|
|
2907
|
-
recurringSessionSplit?: RecurringSessionSplit;
|
|
2908
|
-
/**
|
|
2909
|
-
* Inspect `schedule.scheduleOwnerUserId` on `scheduleUpdated` instead.
|
|
2910
|
-
* @deprecated
|
|
2911
|
-
*/
|
|
2912
|
-
scheduleUnassignedFromUser?: ScheduleUnassignedFromUser;
|
|
2913
|
-
preserveFutureSessionsWithParticipants?: boolean | null;
|
|
3036
|
+
export interface ResourceNotification {
|
|
2914
3037
|
/**
|
|
2915
|
-
*
|
|
2916
|
-
*
|
|
2917
|
-
*/
|
|
2918
|
-
notifyParticipants?: boolean;
|
|
2919
|
-
/** site properties. Optional. Given in create schedule notification. */
|
|
2920
|
-
siteProperties?: SitePropertiesOnScheduleCreation;
|
|
2921
|
-
instanceId?: string;
|
|
2922
|
-
}
|
|
2923
|
-
/** @oneof */
|
|
2924
|
-
export interface ScheduleNotificationEventOneOf {
|
|
2925
|
-
scheduleCreated?: ScheduleCreated;
|
|
2926
|
-
scheduleUpdated?: ScheduleUpdated;
|
|
2927
|
-
scheduleCancelled?: ScheduleCancelled;
|
|
2928
|
-
sessionCreated?: SessionCreated;
|
|
2929
|
-
sessionUpdated?: SessionUpdated;
|
|
2930
|
-
sessionCancelled?: SessionCancelled;
|
|
2931
|
-
availabilityPolicyUpdated?: AvailabilityPolicyUpdated;
|
|
2932
|
-
/** @deprecated */
|
|
2933
|
-
intervalSplit?: IntervalSplit;
|
|
2934
|
-
recurringSessionSplit?: RecurringSessionSplit;
|
|
2935
|
-
/**
|
|
2936
|
-
* Inspect `schedule.scheduleOwnerUserId` on `scheduleUpdated` instead.
|
|
2937
|
-
* @deprecated
|
|
3038
|
+
* Updated resource entity.
|
|
3039
|
+
* 'resource.schedules' is deprecated and will not be returned. Please use 'resource.scheduleIds' instead.
|
|
2938
3040
|
*/
|
|
2939
|
-
|
|
2940
|
-
|
|
2941
|
-
|
|
2942
|
-
schedule?: Schedule;
|
|
3041
|
+
resource?: Resource;
|
|
3042
|
+
/** Event type. */
|
|
3043
|
+
event?: ResourceNotificationEvent;
|
|
2943
3044
|
}
|
|
2944
|
-
export interface
|
|
2945
|
-
/** Schedule ID. */
|
|
2946
|
-
id?: string;
|
|
2947
|
-
/** ID of the schedule's owner entity. This may be a resource ID or a service ID. */
|
|
2948
|
-
scheduleOwnerId?: string | null;
|
|
3045
|
+
export interface Resource {
|
|
2949
3046
|
/**
|
|
2950
|
-
*
|
|
2951
|
-
*
|
|
3047
|
+
* Resource ID.
|
|
3048
|
+
* @format GUID
|
|
2952
3049
|
* @readonly
|
|
2953
3050
|
*/
|
|
2954
|
-
|
|
3051
|
+
id?: string | null;
|
|
2955
3052
|
/**
|
|
2956
|
-
*
|
|
2957
|
-
* @
|
|
3053
|
+
* Resource name.
|
|
3054
|
+
* @maxLength 1200
|
|
2958
3055
|
*/
|
|
2959
|
-
|
|
3056
|
+
name?: string | null;
|
|
2960
3057
|
/**
|
|
2961
|
-
*
|
|
2962
|
-
* @maxLength
|
|
3058
|
+
* Resource email address.
|
|
3059
|
+
* @maxLength 500
|
|
2963
3060
|
*/
|
|
2964
|
-
|
|
3061
|
+
email?: string | null;
|
|
2965
3062
|
/**
|
|
2966
|
-
*
|
|
2967
|
-
*
|
|
2968
|
-
* 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.
|
|
2969
|
-
* @deprecated
|
|
3063
|
+
* Resource phone number.
|
|
3064
|
+
* @maxLength 500
|
|
2970
3065
|
*/
|
|
2971
|
-
|
|
2972
|
-
/** Default location for the schedule's sessions. */
|
|
2973
|
-
location?: Location;
|
|
3066
|
+
phone?: string | null;
|
|
2974
3067
|
/**
|
|
2975
|
-
*
|
|
2976
|
-
*
|
|
2977
|
-
* @min 1
|
|
2978
|
-
* @max 1000
|
|
3068
|
+
* Resource description.
|
|
3069
|
+
* @maxLength 500
|
|
2979
3070
|
*/
|
|
2980
|
-
|
|
3071
|
+
description?: string | null;
|
|
2981
3072
|
/**
|
|
2982
|
-
* Deprecated. Please use
|
|
3073
|
+
* Deprecated. Please use tags.
|
|
3074
|
+
* @maxLength 500
|
|
2983
3075
|
* @deprecated
|
|
2984
3076
|
*/
|
|
2985
|
-
|
|
3077
|
+
tag?: string | null;
|
|
2986
3078
|
/**
|
|
2987
|
-
*
|
|
2988
|
-
* @
|
|
3079
|
+
* Resource tags. Tags are used to identify, group, and filter the different types of resources. For example, 'staff' or 'room'.
|
|
3080
|
+
* @maxLength 200
|
|
2989
3081
|
*/
|
|
2990
|
-
|
|
3082
|
+
tags?: string[] | null;
|
|
3083
|
+
/** Resource images. */
|
|
3084
|
+
images?: CommonImage[];
|
|
2991
3085
|
/**
|
|
2992
|
-
*
|
|
2993
|
-
* @
|
|
3086
|
+
* Deprecated. Please use scheduleIds. List of the schedules owned by this resource. Min size 1.
|
|
3087
|
+
* @deprecated
|
|
2994
3088
|
*/
|
|
2995
|
-
|
|
3089
|
+
schedules?: Schedule[];
|
|
2996
3090
|
/**
|
|
2997
|
-
*
|
|
2998
|
-
*
|
|
2999
|
-
* 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
|
|
3000
3093
|
* @readonly
|
|
3001
3094
|
*/
|
|
3002
|
-
|
|
3003
|
-
/**
|
|
3004
|
-
* __Deprecated.__
|
|
3005
|
-
* @deprecated
|
|
3006
|
-
*/
|
|
3007
|
-
externalCalendarOverrides?: ExternalCalendarOverrides;
|
|
3095
|
+
scheduleIds?: string[] | null;
|
|
3008
3096
|
/**
|
|
3009
|
-
*
|
|
3097
|
+
* Resource status. Default: `CREATED`.
|
|
3010
3098
|
* @readonly
|
|
3011
3099
|
*/
|
|
3012
|
-
status?:
|
|
3100
|
+
status?: ResourceStatus;
|
|
3101
|
+
/**
|
|
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;
|
|
3013
3211
|
/**
|
|
3014
3212
|
* Schedule creation date.
|
|
3015
3213
|
* @readonly
|
|
@@ -3574,489 +3772,6 @@ export declare enum ConferenceType {
|
|
|
3574
3772
|
/** User-defined meeting. */
|
|
3575
3773
|
CUSTOM = "CUSTOM"
|
|
3576
3774
|
}
|
|
3577
|
-
export interface ScheduleUpdated {
|
|
3578
|
-
/** The old schedule before the update. */
|
|
3579
|
-
oldSchedule?: Schedule;
|
|
3580
|
-
/** The new schedule after the update. */
|
|
3581
|
-
newSchedule?: Schedule;
|
|
3582
|
-
/**
|
|
3583
|
-
* Recurring sessions updated event. If this field is given, the reason for the schedule updated event was
|
|
3584
|
-
* updating at least one of the given schedule's recurring sessions.
|
|
3585
|
-
* This event is triggered by create/update/delete recurring session apis.
|
|
3586
|
-
*/
|
|
3587
|
-
recurringSessions?: RecurringSessionsUpdated;
|
|
3588
|
-
/** Whether to notify participants about the change and an optional custom message */
|
|
3589
|
-
participantNotification?: ParticipantNotification;
|
|
3590
|
-
/**
|
|
3591
|
-
* Whether this notification was created as a result of an anonymization request, such as GDPR.
|
|
3592
|
-
* An anonymized participant will have the following details:
|
|
3593
|
-
* name = "deleted"
|
|
3594
|
-
* phone = "deleted"
|
|
3595
|
-
* email = "deleted@deleted.com"
|
|
3596
|
-
*/
|
|
3597
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
3598
|
-
}
|
|
3599
|
-
export interface RecurringSessionsUpdated {
|
|
3600
|
-
/** Old schedule's recurring session list. */
|
|
3601
|
-
oldRecurringSessions?: Session[];
|
|
3602
|
-
/** New schedule's recurring session list. */
|
|
3603
|
-
newRecurringSessions?: Session[];
|
|
3604
|
-
}
|
|
3605
|
-
export interface Session {
|
|
3606
|
-
/**
|
|
3607
|
-
* Session ID.
|
|
3608
|
-
* @readonly
|
|
3609
|
-
*/
|
|
3610
|
-
id?: string | null;
|
|
3611
|
-
/**
|
|
3612
|
-
* ID of the schedule that the session belongs to.
|
|
3613
|
-
* @immutable
|
|
3614
|
-
*/
|
|
3615
|
-
scheduleId?: string;
|
|
3616
|
-
/**
|
|
3617
|
-
* ID of the resource or service that the session's schedule belongs to.
|
|
3618
|
-
* @readonly
|
|
3619
|
-
*/
|
|
3620
|
-
scheduleOwnerId?: string | null;
|
|
3621
|
-
/** Original start date and time of the session in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)) format. */
|
|
3622
|
-
originalStart?: Date | null;
|
|
3623
|
-
/** An object specifying the start date and time of the session. If the session is a recurring session, `start` must contain a `localDateTime`. */
|
|
3624
|
-
start?: CalendarDateTime;
|
|
3625
|
-
/**
|
|
3626
|
-
* 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`.
|
|
3627
|
-
* If the session is a recurring session, `end` must contain a `localDateTime`.
|
|
3628
|
-
*/
|
|
3629
|
-
end?: CalendarDateTime;
|
|
3630
|
-
/**
|
|
3631
|
-
* 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.
|
|
3632
|
-
* The array is inherited from the schedule and can be overridden even if the session is a recurring session.
|
|
3633
|
-
*/
|
|
3634
|
-
affectedSchedules?: LinkedSchedule[];
|
|
3635
|
-
/**
|
|
3636
|
-
* Session title.
|
|
3637
|
-
* The value is inherited from the schedule and can be overridden unless the session is a recurring session.
|
|
3638
|
-
* @maxLength 6000
|
|
3639
|
-
*/
|
|
3640
|
-
title?: string | null;
|
|
3641
|
-
/**
|
|
3642
|
-
* __Deprecated.__
|
|
3643
|
-
* Tags for the session.
|
|
3644
|
-
* The value is inherited from the schedule and can be overridden unless the session is a recurring session.
|
|
3645
|
-
* @maxLength 200
|
|
3646
|
-
* @deprecated
|
|
3647
|
-
*/
|
|
3648
|
-
tags?: string[] | null;
|
|
3649
|
-
/**
|
|
3650
|
-
* An object describing the location where the session takes place.
|
|
3651
|
-
* Defaults to the schedule location.
|
|
3652
|
-
* 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`.
|
|
3653
|
-
*/
|
|
3654
|
-
location?: Location;
|
|
3655
|
-
/**
|
|
3656
|
-
* Maximum number of participants that can be added to the session. Defaults to the schedule capacity.
|
|
3657
|
-
* The value is inherited from the schedule and can be overridden unless the session is a recurring session.
|
|
3658
|
-
* @max 1000
|
|
3659
|
-
*/
|
|
3660
|
-
capacity?: number | null;
|
|
3661
|
-
/**
|
|
3662
|
-
* Deprecated. Please use the [Booking Services V2](https://dev.wix.com/api/rest/wix-bookings/services-v2) payment instead.
|
|
3663
|
-
* @deprecated
|
|
3664
|
-
*/
|
|
3665
|
-
rate?: Rate;
|
|
3666
|
-
/**
|
|
3667
|
-
* Time reserved after the session end time, derived from the schedule availability constraints and the time between slots. Read-only.
|
|
3668
|
-
* If the session is a recurring session, this field must be empty.
|
|
3669
|
-
*/
|
|
3670
|
-
timeReservedAfter?: number | null;
|
|
3671
|
-
/**
|
|
3672
|
-
* Additional information about the session.
|
|
3673
|
-
* Notes are not supported for recurring sessions.
|
|
3674
|
-
* @maxLength 10000
|
|
3675
|
-
*/
|
|
3676
|
-
notes?: string;
|
|
3677
|
-
/**
|
|
3678
|
-
* The number of participants booked for the session. Read-only.
|
|
3679
|
-
* Calculated as the sum of the party sizes.
|
|
3680
|
-
* @readonly
|
|
3681
|
-
*/
|
|
3682
|
-
totalNumberOfParticipants?: number;
|
|
3683
|
-
/**
|
|
3684
|
-
* *Partial list** list of participants booked for the session.
|
|
3685
|
-
* The list includes participants who have registered for this specific session, and participants who have registered for a schedule that includes this session.
|
|
3686
|
-
* If the session is a recurring session, this field must be empty.
|
|
3687
|
-
* 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).
|
|
3688
|
-
*/
|
|
3689
|
-
participants?: Participant[];
|
|
3690
|
-
/**
|
|
3691
|
-
* A list of properties for which values were inherited from the schedule.
|
|
3692
|
-
* This does not include participants that were inherited from the schedule.
|
|
3693
|
-
* @readonly
|
|
3694
|
-
*/
|
|
3695
|
-
inheritedFields?: string[];
|
|
3696
|
-
/**
|
|
3697
|
-
* __Deprecated.__
|
|
3698
|
-
* @deprecated
|
|
3699
|
-
*/
|
|
3700
|
-
externalCalendarOverrides?: ExternalCalendarOverrides;
|
|
3701
|
-
/**
|
|
3702
|
-
* Session status.
|
|
3703
|
-
* @readonly
|
|
3704
|
-
*/
|
|
3705
|
-
status?: Status;
|
|
3706
|
-
/**
|
|
3707
|
-
* Recurring interval ID. Defined when a session will be a recurring session. read-only. Optional.
|
|
3708
|
-
* For example, when creating a class service with recurring sessions, you add a recurrence rule to create recurring sessions.
|
|
3709
|
-
* This field is omitted for single sessions or instances of recurring sessions.
|
|
3710
|
-
* Specified when the session was originally generated from a schedule recurring interval.
|
|
3711
|
-
* Deprecated. Use `recurringSessionId`.
|
|
3712
|
-
* @readonly
|
|
3713
|
-
* @deprecated
|
|
3714
|
-
*/
|
|
3715
|
-
recurringIntervalId?: string | null;
|
|
3716
|
-
/**
|
|
3717
|
-
* 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.
|
|
3718
|
-
* @readonly
|
|
3719
|
-
*/
|
|
3720
|
-
recurringSessionId?: string | null;
|
|
3721
|
-
/** Session type. */
|
|
3722
|
-
type?: SessionType;
|
|
3723
|
-
/**
|
|
3724
|
-
* A conference created for the session according to the details set in the schedule's conference provider information.
|
|
3725
|
-
* If the session is a recurring session, this field is inherited from the schedule.
|
|
3726
|
-
* **Partially deprecated.** Only `hostUrl` and `guestUrl` are to be supported.
|
|
3727
|
-
* @deprecated
|
|
3728
|
-
*/
|
|
3729
|
-
calendarConference?: CalendarConference;
|
|
3730
|
-
/**
|
|
3731
|
-
* 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).
|
|
3732
|
-
* 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.
|
|
3733
|
-
* The RRULE defines a rule for repeating a session.
|
|
3734
|
-
* Supported parameters are:
|
|
3735
|
-
*
|
|
3736
|
-
* |Keyword|Description|Supported values|
|
|
3737
|
-
* |--|--|---|
|
|
3738
|
-
* |`FREQ`|The frequency at which the session is recurs. Required.|`WEEKLY`|
|
|
3739
|
-
* |`INTERVAL`|How often, in terms of `FREQ`, the session recurs. Default is 1. Optional.|
|
|
3740
|
-
* |`UNTIL`|The UTC end date and time of the recurrence. Optional.|
|
|
3741
|
-
* |`BYDAY`|Day of the week when the event should recur. Required.|One of: `MO`, `TU`, `WE`, `TH`, `FR`, `SA`, `SU`|
|
|
3742
|
-
*
|
|
3743
|
-
*
|
|
3744
|
-
* For example, a session that repeats every second week on a Monday until January 7, 2022 at 8 AM:
|
|
3745
|
-
* `"FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;UNTIL=20220107T080000Z"`
|
|
3746
|
-
*
|
|
3747
|
-
* <!--ORIGINAL COMMENTS:
|
|
3748
|
-
* `FREQ` — The frequency with which the session should be repeated (such as DAILY or WEEKLY).
|
|
3749
|
-
* Supported `WEEKLY` value is supported.
|
|
3750
|
-
* 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.
|
|
3751
|
-
* COUNT — The number of times this event should be repeated. Not yet supported.
|
|
3752
|
-
* 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.
|
|
3753
|
-
* 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'.
|
|
3754
|
-
* BYDAY - The days of the week when the event should be repeated. Currently, only a single day is supported. This parameter is mandatory.
|
|
3755
|
-
* Possible values are: MO, TU, WE, TH, FR, SA, SU
|
|
3756
|
-
* 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.
|
|
3757
|
-
* **Example**: FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;UNTIL=20200427T070000Z
|
|
3758
|
-
* ORIGINAL COMMENTS-->
|
|
3759
|
-
*/
|
|
3760
|
-
recurrence?: string | null;
|
|
3761
|
-
/**
|
|
3762
|
-
* A string representing a recurrence rule (RRULE) if the session is an instance of a recurrence pattern.
|
|
3763
|
-
* 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.
|
|
3764
|
-
* @readonly
|
|
3765
|
-
*/
|
|
3766
|
-
instanceOfRecurrence?: string | null;
|
|
3767
|
-
/**
|
|
3768
|
-
* The session version.
|
|
3769
|
-
* Composed by the schedule, session and participants versions.
|
|
3770
|
-
* @readonly
|
|
3771
|
-
*/
|
|
3772
|
-
version?: SessionVersion;
|
|
3773
|
-
}
|
|
3774
|
-
export interface CalendarDateTime {
|
|
3775
|
-
/**
|
|
3776
|
-
* 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"`.
|
|
3777
|
-
* Required if `localDateTime` is not specified.
|
|
3778
|
-
* If `localDateTime` is specified, `timestamp` is calculated as `localDateTime`, using the business's time zone.
|
|
3779
|
-
*/
|
|
3780
|
-
timestamp?: Date | null;
|
|
3781
|
-
/** An object containing the local date and time for the business's time zone. */
|
|
3782
|
-
localDateTime?: LocalDateTime;
|
|
3783
|
-
/**
|
|
3784
|
-
* The time zone. Optional. Derived from the schedule's time zone.
|
|
3785
|
-
* In case this field is associated with recurring session, this field is empty.
|
|
3786
|
-
* @readonly
|
|
3787
|
-
*/
|
|
3788
|
-
timeZone?: string | null;
|
|
3789
|
-
}
|
|
3790
|
-
export interface LocalDateTime {
|
|
3791
|
-
/** Year. 4-digit format. */
|
|
3792
|
-
year?: number | null;
|
|
3793
|
-
/**
|
|
3794
|
-
* Month number, from 1-12.
|
|
3795
|
-
* @min 1
|
|
3796
|
-
* @max 12
|
|
3797
|
-
*/
|
|
3798
|
-
monthOfYear?: number | null;
|
|
3799
|
-
/** Day of the month, from 1-31. */
|
|
3800
|
-
dayOfMonth?: number | null;
|
|
3801
|
-
/**
|
|
3802
|
-
* Hour of the day in 24-hour format, from 0-23.
|
|
3803
|
-
* @max 23
|
|
3804
|
-
*/
|
|
3805
|
-
hourOfDay?: number | null;
|
|
3806
|
-
/**
|
|
3807
|
-
* Minute, from 0-59.
|
|
3808
|
-
* @max 59
|
|
3809
|
-
*/
|
|
3810
|
-
minutesOfHour?: number | null;
|
|
3811
|
-
}
|
|
3812
|
-
export interface ExternalCalendarInfo {
|
|
3813
|
-
/** The external calendar type (e.g. Google Calendar, iCal, etc). */
|
|
3814
|
-
calendarType?: CalendarType;
|
|
3815
|
-
}
|
|
3816
|
-
export declare enum CalendarType {
|
|
3817
|
-
/** There is no information about the external calendar type. */
|
|
3818
|
-
UNDEFINED = "UNDEFINED",
|
|
3819
|
-
/** [Google Calendar](https://developers.google.com/calendar/api/guides/overview). */
|
|
3820
|
-
GOOGLE = "GOOGLE",
|
|
3821
|
-
/** Apple iCalendar. */
|
|
3822
|
-
I_CAL = "I_CAL",
|
|
3823
|
-
/** __Deprecated__. Use `MICROSOFT` instead. */
|
|
3824
|
-
OUTLOOK = "OUTLOOK",
|
|
3825
|
-
/** __Deprecated__. Use `MICROSOFT` instead. */
|
|
3826
|
-
OFFICE_365 = "OFFICE_365",
|
|
3827
|
-
/** Microsoft Calendar. For example, Office 365 calendar or Outlook calendar. */
|
|
3828
|
-
MICROSOFT = "MICROSOFT",
|
|
3829
|
-
/** A different type of external calendar, not listed here. */
|
|
3830
|
-
OTHER = "OTHER"
|
|
3831
|
-
}
|
|
3832
|
-
export declare enum Status {
|
|
3833
|
-
/** Undefined status. */
|
|
3834
|
-
UNDEFINED = "UNDEFINED",
|
|
3835
|
-
/** Session is confirmed. Default status. */
|
|
3836
|
-
CONFIRMED = "CONFIRMED",
|
|
3837
|
-
/**
|
|
3838
|
-
* Session is cancelled.
|
|
3839
|
-
* A cancelled session can be the cancellation of a recurring session that should no longer be displayed or a deleted single session.
|
|
3840
|
-
* The ListSessions returns cancelled sessions only if 'includeDelete' flag is set to true.
|
|
3841
|
-
*/
|
|
3842
|
-
CANCELLED = "CANCELLED"
|
|
3843
|
-
}
|
|
3844
|
-
export declare enum SessionType {
|
|
3845
|
-
UNDEFINED = "UNDEFINED",
|
|
3846
|
-
/**
|
|
3847
|
-
* Creates an event on the calendar for the owner of the schedule that the session belongs to.
|
|
3848
|
-
* Default type.
|
|
3849
|
-
*/
|
|
3850
|
-
EVENT = "EVENT",
|
|
3851
|
-
/** Represents a resource's available working hours. */
|
|
3852
|
-
WORKING_HOURS = "WORKING_HOURS",
|
|
3853
|
-
/** Deprecated. Please use WORKING_HOURS. */
|
|
3854
|
-
TIME_AVAILABILITY = "TIME_AVAILABILITY",
|
|
3855
|
-
/** Deprecated. Represents a resource's available hours. Please use WORKING_HOURS. */
|
|
3856
|
-
AVAILABILITY = "AVAILABILITY"
|
|
3857
|
-
}
|
|
3858
|
-
export interface SessionVersion {
|
|
3859
|
-
/** Incremental version number, which is updated on each change to the session or on changes affecting the session. */
|
|
3860
|
-
number?: string | null;
|
|
3861
|
-
}
|
|
3862
|
-
export interface ParticipantNotification {
|
|
3863
|
-
/**
|
|
3864
|
-
* Whether to send the message about the changes to the customer.
|
|
3865
|
-
*
|
|
3866
|
-
* Default: `false`
|
|
3867
|
-
*/
|
|
3868
|
-
notifyParticipants?: boolean;
|
|
3869
|
-
/** Custom message to send to the participants about the changes to the booking. */
|
|
3870
|
-
message?: string | null;
|
|
3871
|
-
}
|
|
3872
|
-
export interface ScheduleCancelled {
|
|
3873
|
-
schedule?: Schedule;
|
|
3874
|
-
/** Whether to notify participants about the change and an optional custom message */
|
|
3875
|
-
participantNotification?: ParticipantNotification;
|
|
3876
|
-
oldSchedule?: Schedule;
|
|
3877
|
-
}
|
|
3878
|
-
export interface SessionCreated {
|
|
3879
|
-
session?: Session;
|
|
3880
|
-
}
|
|
3881
|
-
export interface SessionUpdated {
|
|
3882
|
-
oldSession?: Session;
|
|
3883
|
-
newSession?: Session;
|
|
3884
|
-
/** Whether to notify participants about the change and an optional custom message */
|
|
3885
|
-
participantNotification?: ParticipantNotification;
|
|
3886
|
-
/**
|
|
3887
|
-
* Whether this notification was created as a result of an anonymization request, such as GDPR.
|
|
3888
|
-
* An anonymized participant will have the following details:
|
|
3889
|
-
* name = "deleted"
|
|
3890
|
-
* phone = "deleted"
|
|
3891
|
-
* email = "deleted@deleted.com"
|
|
3892
|
-
*/
|
|
3893
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
3894
|
-
}
|
|
3895
|
-
export interface SessionCancelled {
|
|
3896
|
-
session?: Session;
|
|
3897
|
-
/** Whether to notify participants about the change and an optional custom message */
|
|
3898
|
-
participantNotification?: ParticipantNotification;
|
|
3899
|
-
}
|
|
3900
|
-
export interface AvailabilityPolicyUpdated {
|
|
3901
|
-
availabilityPolicy?: AvailabilityPolicy;
|
|
3902
|
-
}
|
|
3903
|
-
/** Availability policy applied to all site schedules. */
|
|
3904
|
-
export interface AvailabilityPolicy {
|
|
3905
|
-
/** Specify how to split the schedule slots in intervals of minutes. */
|
|
3906
|
-
splitInterval?: SplitInterval;
|
|
3907
|
-
}
|
|
3908
|
-
export interface IntervalSplit {
|
|
3909
|
-
scheduleId?: string;
|
|
3910
|
-
intervals?: RecurringInterval[];
|
|
3911
|
-
newScheduleVersion?: number | null;
|
|
3912
|
-
oldScheduleVersion?: number | null;
|
|
3913
|
-
}
|
|
3914
|
-
export interface RecurringSessionSplit {
|
|
3915
|
-
scheduleId?: string;
|
|
3916
|
-
recurringSessions?: Session[];
|
|
3917
|
-
newScheduleVersion?: number | null;
|
|
3918
|
-
oldScheduleVersion?: number | null;
|
|
3919
|
-
}
|
|
3920
|
-
/** Schedule unassigned from user. */
|
|
3921
|
-
export interface ScheduleUnassignedFromUser {
|
|
3922
|
-
/**
|
|
3923
|
-
* The Wix user id.
|
|
3924
|
-
* @format GUID
|
|
3925
|
-
*/
|
|
3926
|
-
userId?: string | null;
|
|
3927
|
-
/** The schedule that was unassigned from the user. */
|
|
3928
|
-
schedule?: Schedule;
|
|
3929
|
-
}
|
|
3930
|
-
export interface MultipleSessionsCreated {
|
|
3931
|
-
schedulesWithSessions?: ScheduleWithSessions[];
|
|
3932
|
-
}
|
|
3933
|
-
export interface ScheduleWithSessions {
|
|
3934
|
-
schedule?: Schedule;
|
|
3935
|
-
siteProperties?: SitePropertiesOnScheduleCreation;
|
|
3936
|
-
sessions?: Session[];
|
|
3937
|
-
}
|
|
3938
|
-
export interface SitePropertiesOnScheduleCreation {
|
|
3939
|
-
/** The global time zone value. */
|
|
3940
|
-
timeZone?: string | null;
|
|
3941
|
-
}
|
|
3942
|
-
export interface MigrationEvent {
|
|
3943
|
-
migrationData?: MigrationData;
|
|
3944
|
-
}
|
|
3945
|
-
export interface MigrationData {
|
|
3946
|
-
businessId?: string | null;
|
|
3947
|
-
staffs?: StaffData[];
|
|
3948
|
-
}
|
|
3949
|
-
export interface StaffData {
|
|
3950
|
-
resourceId?: string;
|
|
3951
|
-
syncRequestEmail?: string;
|
|
3952
|
-
refreshToken?: string;
|
|
3953
|
-
}
|
|
3954
|
-
export interface ResourceNotification {
|
|
3955
|
-
/**
|
|
3956
|
-
* Updated resource entity.
|
|
3957
|
-
* 'resource.schedules' is deprecated and will not be returned. Please use 'resource.scheduleIds' instead.
|
|
3958
|
-
*/
|
|
3959
|
-
resource?: Resource;
|
|
3960
|
-
/** Event type. */
|
|
3961
|
-
event?: ResourceNotificationEvent;
|
|
3962
|
-
}
|
|
3963
|
-
export interface Resource {
|
|
3964
|
-
/**
|
|
3965
|
-
* Resource ID.
|
|
3966
|
-
* @format GUID
|
|
3967
|
-
* @readonly
|
|
3968
|
-
*/
|
|
3969
|
-
id?: string | null;
|
|
3970
|
-
/**
|
|
3971
|
-
* Resource name.
|
|
3972
|
-
* @maxLength 1200
|
|
3973
|
-
*/
|
|
3974
|
-
name?: string | null;
|
|
3975
|
-
/**
|
|
3976
|
-
* Resource email address.
|
|
3977
|
-
* @maxLength 500
|
|
3978
|
-
*/
|
|
3979
|
-
email?: string | null;
|
|
3980
|
-
/**
|
|
3981
|
-
* Resource phone number.
|
|
3982
|
-
* @maxLength 500
|
|
3983
|
-
*/
|
|
3984
|
-
phone?: string | null;
|
|
3985
|
-
/**
|
|
3986
|
-
* Resource description.
|
|
3987
|
-
* @maxLength 500
|
|
3988
|
-
*/
|
|
3989
|
-
description?: string | null;
|
|
3990
|
-
/**
|
|
3991
|
-
* Deprecated. Please use tags.
|
|
3992
|
-
* @maxLength 500
|
|
3993
|
-
* @deprecated
|
|
3994
|
-
*/
|
|
3995
|
-
tag?: string | null;
|
|
3996
|
-
/**
|
|
3997
|
-
* Resource tags. Tags are used to identify, group, and filter the different types of resources. For example, 'staff' or 'room'.
|
|
3998
|
-
* @maxLength 200
|
|
3999
|
-
*/
|
|
4000
|
-
tags?: string[] | null;
|
|
4001
|
-
/** Resource images. */
|
|
4002
|
-
images?: CommonImage[];
|
|
4003
|
-
/**
|
|
4004
|
-
* Deprecated. Please use scheduleIds. List of the schedules owned by this resource. Min size 1.
|
|
4005
|
-
* @deprecated
|
|
4006
|
-
*/
|
|
4007
|
-
schedules?: Schedule[];
|
|
4008
|
-
/**
|
|
4009
|
-
* List of IDs of schedules owned by this resource.
|
|
4010
|
-
* @format GUID
|
|
4011
|
-
* @readonly
|
|
4012
|
-
*/
|
|
4013
|
-
scheduleIds?: string[] | null;
|
|
4014
|
-
/**
|
|
4015
|
-
* Resource status. Default: `CREATED`.
|
|
4016
|
-
* @readonly
|
|
4017
|
-
*/
|
|
4018
|
-
status?: ResourceStatus;
|
|
4019
|
-
/**
|
|
4020
|
-
* Wix user ID, if the resource is associated with the Wix user.
|
|
4021
|
-
* A staff member resource can be associated with a Wix user via assignment of a permissions role in the business manager.
|
|
4022
|
-
* @format GUID
|
|
4023
|
-
* @readonly
|
|
4024
|
-
*/
|
|
4025
|
-
wixUserId?: string | null;
|
|
4026
|
-
}
|
|
4027
|
-
export interface CommonImage {
|
|
4028
|
-
/** WixMedia image ID. */
|
|
4029
|
-
id?: string;
|
|
4030
|
-
/** Image URL. */
|
|
4031
|
-
url?: string;
|
|
4032
|
-
/**
|
|
4033
|
-
* Original image height.
|
|
4034
|
-
* @readonly
|
|
4035
|
-
*/
|
|
4036
|
-
height?: number;
|
|
4037
|
-
/**
|
|
4038
|
-
* Original image width.
|
|
4039
|
-
* @readonly
|
|
4040
|
-
*/
|
|
4041
|
-
width?: number;
|
|
4042
|
-
/** Image alt text. */
|
|
4043
|
-
altText?: string | null;
|
|
4044
|
-
/**
|
|
4045
|
-
* Image filename.
|
|
4046
|
-
* @readonly
|
|
4047
|
-
*/
|
|
4048
|
-
filename?: string | null;
|
|
4049
|
-
}
|
|
4050
|
-
export interface FocalPoint {
|
|
4051
|
-
/** X-coordinate of the focal point. */
|
|
4052
|
-
x?: number;
|
|
4053
|
-
/** Y-coordinate of the focal point. */
|
|
4054
|
-
y?: number;
|
|
4055
|
-
/** crop by height */
|
|
4056
|
-
height?: number | null;
|
|
4057
|
-
/** crop by width */
|
|
4058
|
-
width?: number | null;
|
|
4059
|
-
}
|
|
4060
3775
|
export declare enum ResourceStatus {
|
|
4061
3776
|
/** Undefined resource status. */
|
|
4062
3777
|
UNDEFINED = "UNDEFINED",
|