@wix/bookings 1.0.270 → 1.0.272
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-calendar-v1-session.http.d.ts +1 -71
- package/build/cjs/src/bookings-calendar-v1-session.http.js +1 -273
- package/build/cjs/src/bookings-calendar-v1-session.http.js.map +1 -1
- package/build/cjs/src/bookings-calendar-v1-session.meta.d.ts +0 -7
- package/build/cjs/src/bookings-calendar-v1-session.meta.js +1 -58
- package/build/cjs/src/bookings-calendar-v1-session.meta.js.map +1 -1
- package/build/cjs/src/bookings-calendar-v1-session.public.d.ts +3 -100
- package/build/cjs/src/bookings-calendar-v1-session.public.js +1 -19
- package/build/cjs/src/bookings-calendar-v1-session.public.js.map +1 -1
- package/build/cjs/src/bookings-calendar-v1-session.types.d.ts +5 -183
- package/build/cjs/src/bookings-calendar-v1-session.types.js.map +1 -1
- package/build/cjs/src/bookings-calendar-v1-session.universal.d.ts +5 -370
- package/build/cjs/src/bookings-calendar-v1-session.universal.js +1 -241
- package/build/cjs/src/bookings-calendar-v1-session.universal.js.map +1 -1
- package/build/cjs/src/bookings-calendar-v2-external-calendar.types.d.ts +0 -8
- package/build/cjs/src/bookings-calendar-v2-external-calendar.types.js.map +1 -1
- package/build/cjs/src/bookings-calendar-v2-external-calendar.universal.d.ts +0 -8
- package/build/cjs/src/bookings-calendar-v2-external-calendar.universal.js.map +1 -1
- package/build/cjs/src/bookings-calendar-v2-session-view.types.d.ts +0 -8
- package/build/cjs/src/bookings-calendar-v2-session-view.types.js.map +1 -1
- package/build/cjs/src/bookings-calendar-v2-session-view.universal.d.ts +0 -8
- package/build/cjs/src/bookings-calendar-v2-session-view.universal.js.map +1 -1
- package/build/cjs/src/bookings-catalog-v1-service-options-and-variants.types.d.ts +0 -8
- package/build/cjs/src/bookings-catalog-v1-service-options-and-variants.types.js.map +1 -1
- package/build/cjs/src/bookings-catalog-v1-service-options-and-variants.universal.d.ts +7 -8
- package/build/cjs/src/bookings-catalog-v1-service-options-and-variants.universal.js +7 -0
- package/build/cjs/src/bookings-catalog-v1-service-options-and-variants.universal.js.map +1 -1
- package/build/cjs/src/bookings-services-v2-service.types.d.ts +0 -8
- package/build/cjs/src/bookings-services-v2-service.types.js.map +1 -1
- package/build/cjs/src/bookings-services-v2-service.universal.d.ts +0 -8
- package/build/cjs/src/bookings-services-v2-service.universal.js.map +1 -1
- package/build/es/src/bookings-calendar-v1-session.http.d.ts +1 -71
- package/build/es/src/bookings-calendar-v1-session.http.js +0 -269
- package/build/es/src/bookings-calendar-v1-session.http.js.map +1 -1
- package/build/es/src/bookings-calendar-v1-session.meta.d.ts +0 -7
- package/build/es/src/bookings-calendar-v1-session.meta.js +0 -54
- package/build/es/src/bookings-calendar-v1-session.meta.js.map +1 -1
- package/build/es/src/bookings-calendar-v1-session.public.d.ts +3 -100
- package/build/es/src/bookings-calendar-v1-session.public.js +1 -16
- package/build/es/src/bookings-calendar-v1-session.public.js.map +1 -1
- package/build/es/src/bookings-calendar-v1-session.types.d.ts +5 -183
- package/build/es/src/bookings-calendar-v1-session.types.js.map +1 -1
- package/build/es/src/bookings-calendar-v1-session.universal.d.ts +5 -370
- package/build/es/src/bookings-calendar-v1-session.universal.js +0 -237
- package/build/es/src/bookings-calendar-v1-session.universal.js.map +1 -1
- package/build/es/src/bookings-calendar-v2-external-calendar.types.d.ts +0 -8
- package/build/es/src/bookings-calendar-v2-external-calendar.types.js.map +1 -1
- package/build/es/src/bookings-calendar-v2-external-calendar.universal.d.ts +0 -8
- package/build/es/src/bookings-calendar-v2-external-calendar.universal.js.map +1 -1
- package/build/es/src/bookings-calendar-v2-session-view.types.d.ts +0 -8
- package/build/es/src/bookings-calendar-v2-session-view.types.js.map +1 -1
- package/build/es/src/bookings-calendar-v2-session-view.universal.d.ts +0 -8
- package/build/es/src/bookings-calendar-v2-session-view.universal.js.map +1 -1
- package/build/es/src/bookings-catalog-v1-service-options-and-variants.types.d.ts +0 -8
- package/build/es/src/bookings-catalog-v1-service-options-and-variants.types.js.map +1 -1
- package/build/es/src/bookings-catalog-v1-service-options-and-variants.universal.d.ts +7 -8
- package/build/es/src/bookings-catalog-v1-service-options-and-variants.universal.js +7 -0
- package/build/es/src/bookings-catalog-v1-service-options-and-variants.universal.js.map +1 -1
- package/build/es/src/bookings-services-v2-service.types.d.ts +0 -8
- package/build/es/src/bookings-services-v2-service.types.js.map +1 -1
- package/build/es/src/bookings-services-v2-service.universal.d.ts +0 -8
- package/build/es/src/bookings-services-v2-service.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -1,26 +1,8 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.CacheInfoStatus = exports.SessionTypeFilter = exports.ConferenceType = exports.SessionType = exports.Status = exports.CalendarType = exports.ApprovalStatus = exports.DayOfWeek = exports.LocationsLocationType = exports.LocationStatus = exports.LocationType = exports.Transparency = exports.listSessions = exports.getSession = exports.querySessions = exports.
|
|
3
|
+
exports.CacheInfoStatus = exports.SessionTypeFilter = exports.ConferenceType = exports.SessionType = exports.Status = exports.CalendarType = exports.ApprovalStatus = exports.DayOfWeek = exports.LocationsLocationType = exports.LocationStatus = exports.LocationType = exports.Transparency = exports.listSessions = exports.getSession = exports.querySessions = exports.__metadata = void 0;
|
|
4
4
|
const bookings_calendar_v1_session_universal_1 = require("./bookings-calendar-v1-session.universal");
|
|
5
5
|
exports.__metadata = { PACKAGE_NAME: '@wix/bookings' };
|
|
6
|
-
function createSession(httpClient) {
|
|
7
|
-
return (session) => (0, bookings_calendar_v1_session_universal_1.createSession)(session,
|
|
8
|
-
// @ts-ignore
|
|
9
|
-
{ httpClient });
|
|
10
|
-
}
|
|
11
|
-
exports.createSession = createSession;
|
|
12
|
-
function updateSession(httpClient) {
|
|
13
|
-
return (_id, session, options) => (0, bookings_calendar_v1_session_universal_1.updateSession)(_id, session, options,
|
|
14
|
-
// @ts-ignore
|
|
15
|
-
{ httpClient });
|
|
16
|
-
}
|
|
17
|
-
exports.updateSession = updateSession;
|
|
18
|
-
function deleteSession(httpClient) {
|
|
19
|
-
return (sessionId, options) => (0, bookings_calendar_v1_session_universal_1.deleteSession)(sessionId, options,
|
|
20
|
-
// @ts-ignore
|
|
21
|
-
{ httpClient });
|
|
22
|
-
}
|
|
23
|
-
exports.deleteSession = deleteSession;
|
|
24
6
|
function querySessions(httpClient) {
|
|
25
7
|
return (fromDate, toDate, options) => (0, bookings_calendar_v1_session_universal_1.querySessions)(fromDate, toDate, options,
|
|
26
8
|
// @ts-ignore
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"bookings-calendar-v1-session.public.js","sourceRoot":"","sources":["../../../src/bookings-calendar-v1-session.public.ts"],"names":[],"mappings":";;;AACA,
|
|
1
|
+
{"version":3,"file":"bookings-calendar-v1-session.public.js","sourceRoot":"","sources":["../../../src/bookings-calendar-v1-session.public.ts"],"names":[],"mappings":";;;AACA,qGAOkD;AAErC,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC;AAE5D,SAAgB,aAAa,CAAC,UAAsB;IAClD,OAAO,CAAC,QAAc,EAAE,MAAY,EAAE,OAA8B,EAAE,EAAE,CACtE,IAAA,sDAAsB,EACpB,QAAQ,EACR,MAAM,EACN,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,sCASC;AAED,SAAgB,UAAU,CAAC,UAAsB;IAC/C,OAAO,CAAC,GAAkB,EAAE,OAA2B,EAAE,EAAE,CACzD,IAAA,mDAAmB,EACjB,GAAG,EACH,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,gCAQC;AAED,SAAgB,YAAY,CAAC,UAAsB;IACjD,OAAO,CAAC,GAAoB,EAAE,OAA6B,EAAE,EAAE,CAC7D,IAAA,qDAAqB,EACnB,GAAG,EACH,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,oCAQC;AAED,mGAakD;AAZhD,sIAAA,YAAY,OAAA;AACZ,sIAAA,YAAY,OAAA;AACZ,wIAAA,cAAc,OAAA;AACd,+IAAA,qBAAqB,OAAA;AACrB,mIAAA,SAAS,OAAA;AACT,wIAAA,cAAc,OAAA;AACd,sIAAA,YAAY,OAAA;AACZ,gIAAA,MAAM,OAAA;AACN,qIAAA,WAAW,OAAA;AACX,wIAAA,cAAc,OAAA;AACd,2IAAA,iBAAiB,OAAA;AACjB,yIAAA,eAAe,OAAA"}
|
|
@@ -595,7 +595,7 @@ export interface Version {
|
|
|
595
595
|
}
|
|
596
596
|
export interface CreateSessionRequest {
|
|
597
597
|
/** The session to create. */
|
|
598
|
-
session
|
|
598
|
+
session?: Session;
|
|
599
599
|
}
|
|
600
600
|
export interface CreateSessionResponse {
|
|
601
601
|
/** The created session. */
|
|
@@ -603,7 +603,9 @@ export interface CreateSessionResponse {
|
|
|
603
603
|
}
|
|
604
604
|
export interface UpdateSessionRequest {
|
|
605
605
|
/** The session to update. */
|
|
606
|
-
session
|
|
606
|
+
session?: Session;
|
|
607
|
+
/** Field mask of fields to update. */
|
|
608
|
+
fieldmask?: string[];
|
|
607
609
|
/** Whether to notify participants about the change, and an optional custom message. */
|
|
608
610
|
participantNotification?: ParticipantNotification;
|
|
609
611
|
}
|
|
@@ -623,7 +625,7 @@ export interface UpdateSessionResponse {
|
|
|
623
625
|
}
|
|
624
626
|
export interface DeleteSessionRequest {
|
|
625
627
|
/** The ID of the session to delete. */
|
|
626
|
-
sessionId
|
|
628
|
+
sessionId?: string | null;
|
|
627
629
|
/** Whether to notify participants about the change, and an optional custom message. */
|
|
628
630
|
participantNotification?: ParticipantNotification;
|
|
629
631
|
}
|
|
@@ -982,186 +984,6 @@ export interface ReplayCompleted {
|
|
|
982
984
|
/** The (minimum) number of sessions that were replayed. */
|
|
983
985
|
totalSessions?: number | null;
|
|
984
986
|
}
|
|
985
|
-
export interface CreateSessionResponseNonNullableFields {
|
|
986
|
-
session?: {
|
|
987
|
-
scheduleId: string;
|
|
988
|
-
affectedSchedules: {
|
|
989
|
-
scheduleId: string;
|
|
990
|
-
transparency: Transparency;
|
|
991
|
-
scheduleOwnerId: string;
|
|
992
|
-
}[];
|
|
993
|
-
location?: {
|
|
994
|
-
locationType: LocationType;
|
|
995
|
-
customAddress?: {
|
|
996
|
-
streetAddress?: {
|
|
997
|
-
number: string;
|
|
998
|
-
name: string;
|
|
999
|
-
apt: string;
|
|
1000
|
-
};
|
|
1001
|
-
subdivisions: {
|
|
1002
|
-
code: string;
|
|
1003
|
-
name: string;
|
|
1004
|
-
}[];
|
|
1005
|
-
};
|
|
1006
|
-
businessLocation?: {
|
|
1007
|
-
name: string;
|
|
1008
|
-
default: boolean;
|
|
1009
|
-
status: LocationStatus;
|
|
1010
|
-
locationType: LocationsLocationType;
|
|
1011
|
-
address?: {
|
|
1012
|
-
streetAddress?: {
|
|
1013
|
-
number: string;
|
|
1014
|
-
name: string;
|
|
1015
|
-
apt: string;
|
|
1016
|
-
};
|
|
1017
|
-
};
|
|
1018
|
-
businessSchedule?: {
|
|
1019
|
-
periods: {
|
|
1020
|
-
openDay: DayOfWeek;
|
|
1021
|
-
openTime: string;
|
|
1022
|
-
closeDay: DayOfWeek;
|
|
1023
|
-
closeTime: string;
|
|
1024
|
-
}[];
|
|
1025
|
-
specialHourPeriod: {
|
|
1026
|
-
startDate: string;
|
|
1027
|
-
endDate: string;
|
|
1028
|
-
isClosed: boolean;
|
|
1029
|
-
comment: string;
|
|
1030
|
-
}[];
|
|
1031
|
-
};
|
|
1032
|
-
archived: boolean;
|
|
1033
|
-
};
|
|
1034
|
-
};
|
|
1035
|
-
rate?: {
|
|
1036
|
-
labeledPriceOptions?: {
|
|
1037
|
-
amount: string;
|
|
1038
|
-
currency: string;
|
|
1039
|
-
downPayAmount: string;
|
|
1040
|
-
};
|
|
1041
|
-
defaultVariedPrice?: {
|
|
1042
|
-
amount: string;
|
|
1043
|
-
currency: string;
|
|
1044
|
-
downPayAmount: string;
|
|
1045
|
-
};
|
|
1046
|
-
};
|
|
1047
|
-
notes: string;
|
|
1048
|
-
totalNumberOfParticipants: number;
|
|
1049
|
-
participants: {
|
|
1050
|
-
id: string;
|
|
1051
|
-
partySize: number;
|
|
1052
|
-
approvalStatus: ApprovalStatus;
|
|
1053
|
-
inherited: boolean;
|
|
1054
|
-
}[];
|
|
1055
|
-
inheritedFields: string[];
|
|
1056
|
-
externalCalendarInfo?: {
|
|
1057
|
-
calendarType: CalendarType;
|
|
1058
|
-
};
|
|
1059
|
-
status: Status;
|
|
1060
|
-
type: SessionType;
|
|
1061
|
-
calendarConference?: {
|
|
1062
|
-
id: string;
|
|
1063
|
-
externalId: string;
|
|
1064
|
-
providerId: string;
|
|
1065
|
-
hostUrl: string;
|
|
1066
|
-
guestUrl: string;
|
|
1067
|
-
conferenceType: ConferenceType;
|
|
1068
|
-
};
|
|
1069
|
-
version?: {
|
|
1070
|
-
scheduleVersion: number;
|
|
1071
|
-
sessionVersion: number;
|
|
1072
|
-
};
|
|
1073
|
-
};
|
|
1074
|
-
}
|
|
1075
|
-
export interface UpdateSessionResponseNonNullableFields {
|
|
1076
|
-
session?: {
|
|
1077
|
-
scheduleId: string;
|
|
1078
|
-
affectedSchedules: {
|
|
1079
|
-
scheduleId: string;
|
|
1080
|
-
transparency: Transparency;
|
|
1081
|
-
scheduleOwnerId: string;
|
|
1082
|
-
}[];
|
|
1083
|
-
location?: {
|
|
1084
|
-
locationType: LocationType;
|
|
1085
|
-
customAddress?: {
|
|
1086
|
-
streetAddress?: {
|
|
1087
|
-
number: string;
|
|
1088
|
-
name: string;
|
|
1089
|
-
apt: string;
|
|
1090
|
-
};
|
|
1091
|
-
subdivisions: {
|
|
1092
|
-
code: string;
|
|
1093
|
-
name: string;
|
|
1094
|
-
}[];
|
|
1095
|
-
};
|
|
1096
|
-
businessLocation?: {
|
|
1097
|
-
name: string;
|
|
1098
|
-
default: boolean;
|
|
1099
|
-
status: LocationStatus;
|
|
1100
|
-
locationType: LocationsLocationType;
|
|
1101
|
-
address?: {
|
|
1102
|
-
streetAddress?: {
|
|
1103
|
-
number: string;
|
|
1104
|
-
name: string;
|
|
1105
|
-
apt: string;
|
|
1106
|
-
};
|
|
1107
|
-
};
|
|
1108
|
-
businessSchedule?: {
|
|
1109
|
-
periods: {
|
|
1110
|
-
openDay: DayOfWeek;
|
|
1111
|
-
openTime: string;
|
|
1112
|
-
closeDay: DayOfWeek;
|
|
1113
|
-
closeTime: string;
|
|
1114
|
-
}[];
|
|
1115
|
-
specialHourPeriod: {
|
|
1116
|
-
startDate: string;
|
|
1117
|
-
endDate: string;
|
|
1118
|
-
isClosed: boolean;
|
|
1119
|
-
comment: string;
|
|
1120
|
-
}[];
|
|
1121
|
-
};
|
|
1122
|
-
archived: boolean;
|
|
1123
|
-
};
|
|
1124
|
-
};
|
|
1125
|
-
rate?: {
|
|
1126
|
-
labeledPriceOptions?: {
|
|
1127
|
-
amount: string;
|
|
1128
|
-
currency: string;
|
|
1129
|
-
downPayAmount: string;
|
|
1130
|
-
};
|
|
1131
|
-
defaultVariedPrice?: {
|
|
1132
|
-
amount: string;
|
|
1133
|
-
currency: string;
|
|
1134
|
-
downPayAmount: string;
|
|
1135
|
-
};
|
|
1136
|
-
};
|
|
1137
|
-
notes: string;
|
|
1138
|
-
totalNumberOfParticipants: number;
|
|
1139
|
-
participants: {
|
|
1140
|
-
id: string;
|
|
1141
|
-
partySize: number;
|
|
1142
|
-
approvalStatus: ApprovalStatus;
|
|
1143
|
-
inherited: boolean;
|
|
1144
|
-
}[];
|
|
1145
|
-
inheritedFields: string[];
|
|
1146
|
-
externalCalendarInfo?: {
|
|
1147
|
-
calendarType: CalendarType;
|
|
1148
|
-
};
|
|
1149
|
-
status: Status;
|
|
1150
|
-
type: SessionType;
|
|
1151
|
-
calendarConference?: {
|
|
1152
|
-
id: string;
|
|
1153
|
-
externalId: string;
|
|
1154
|
-
providerId: string;
|
|
1155
|
-
hostUrl: string;
|
|
1156
|
-
guestUrl: string;
|
|
1157
|
-
conferenceType: ConferenceType;
|
|
1158
|
-
};
|
|
1159
|
-
version?: {
|
|
1160
|
-
scheduleVersion: number;
|
|
1161
|
-
sessionVersion: number;
|
|
1162
|
-
};
|
|
1163
|
-
};
|
|
1164
|
-
}
|
|
1165
987
|
export interface QuerySessionsResponseNonNullableFields {
|
|
1166
988
|
sessions: {
|
|
1167
989
|
scheduleId: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"bookings-calendar-v1-session.types.js","sourceRoot":"","sources":["../../../src/bookings-calendar-v1-session.types.ts"],"names":[],"mappings":";;;AA4NA,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,gEAAgE;IAChE,6BAAa,CAAA;IACb,kFAAkF;IAClF,6BAAa,CAAA;AACf,CAAC,EANW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAMvB;AAiBD,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,iDAAiC,CAAA;IACjC,6CAA6B,CAAA;IAC7B,iCAAiB,CAAA;AACnB,CAAC,EALW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAKvB;AAsHD,qBAAqB;AACrB,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,mCAAiB,CAAA;IACjB,uCAAqB,CAAA;AACvB,CAAC,EAHW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAGzB;AAED,qBAAqB;AACrB,IAAY,qBAMX;AAND,WAAY,qBAAqB;IAC/B,4CAAmB,CAAA;IACnB,0CAAiB,CAAA;IACjB,4CAAmB,CAAA;IACnB,gDAAuB,CAAA;IACvB,sDAA6B,CAAA;AAC/B,CAAC,EANW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAMhC;AAmED,uCAAuC;AACvC,IAAY,SAQX;AARD,WAAY,SAAS;IACnB,8BAAiB,CAAA;IACjB,gCAAmB,CAAA;IACnB,oCAAuB,CAAA;IACvB,kCAAqB,CAAA;IACrB,8BAAiB,CAAA;IACjB,kCAAqB,CAAA;IACrB,8BAAiB,CAAA;AACnB,CAAC,EARW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAQpB;AAuED,IAAY,cASX;AATD,WAAY,cAAc;IACxB,eAAe;IACf,yCAAuB,CAAA;IACvB,iCAAiC;IACjC,qCAAmB,CAAA;IACnB,gCAAgC;IAChC,uCAAqB,CAAA;IACrB,gCAAgC;IAChC,uCAAqB,CAAA;AACvB,CAAC,EATW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QASzB;AAOD,IAAY,YAUX;AAVD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,iCAAiB,CAAA;IACjB,+BAAe,CAAA;IACf,+BAA+B;IAC/B,mCAAmB,CAAA;IACnB,+BAA+B;IAC/B,yCAAyB,CAAA;IACzB,uCAAuB,CAAA;IACvB,+BAAe,CAAA;AACjB,CAAC,EAVW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAUvB;AASD,IAAY,MAUX;AAVD,WAAY,MAAM;IAChB,iCAAuB,CAAA;IACvB,gDAAgD;IAChD,iCAAuB,CAAA;IACvB;;;;OAIG;IACH,iCAAuB,CAAA;AACzB,CAAC,EAVW,MAAM,GAAN,cAAM,KAAN,cAAM,QAUjB;AAED,IAAY,WAaX;AAbD,WAAY,WAAW;IACrB,sCAAuB,CAAA;IACvB;;;OAGG;IACH,8BAAe,CAAA;IACf,mEAAmE;IACnE,8CAA+B,CAAA;IAC/B,2CAA2C;IAC3C,sDAAuC,CAAA;IACvC,gGAAgG;IAChG,4CAA6B,CAAA;AAC/B,CAAC,EAbW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAatB;AA8BD,IAAY,cAMX;AAND,WAAY,cAAc;IACxB,yCAAuB,CAAA;IACvB,oCAAoC;IACpC,qEAAmD,CAAA;IACnD,4BAA4B;IAC5B,mCAAiB,CAAA;AACnB,CAAC,EANW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAMzB;
|
|
1
|
+
{"version":3,"file":"bookings-calendar-v1-session.types.js","sourceRoot":"","sources":["../../../src/bookings-calendar-v1-session.types.ts"],"names":[],"mappings":";;;AA4NA,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,gEAAgE;IAChE,6BAAa,CAAA;IACb,kFAAkF;IAClF,6BAAa,CAAA;AACf,CAAC,EANW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAMvB;AAiBD,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,iDAAiC,CAAA;IACjC,6CAA6B,CAAA;IAC7B,iCAAiB,CAAA;AACnB,CAAC,EALW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAKvB;AAsHD,qBAAqB;AACrB,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,mCAAiB,CAAA;IACjB,uCAAqB,CAAA;AACvB,CAAC,EAHW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAGzB;AAED,qBAAqB;AACrB,IAAY,qBAMX;AAND,WAAY,qBAAqB;IAC/B,4CAAmB,CAAA;IACnB,0CAAiB,CAAA;IACjB,4CAAmB,CAAA;IACnB,gDAAuB,CAAA;IACvB,sDAA6B,CAAA;AAC/B,CAAC,EANW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAMhC;AAmED,uCAAuC;AACvC,IAAY,SAQX;AARD,WAAY,SAAS;IACnB,8BAAiB,CAAA;IACjB,gCAAmB,CAAA;IACnB,oCAAuB,CAAA;IACvB,kCAAqB,CAAA;IACrB,8BAAiB,CAAA;IACjB,kCAAqB,CAAA;IACrB,8BAAiB,CAAA;AACnB,CAAC,EARW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAQpB;AAuED,IAAY,cASX;AATD,WAAY,cAAc;IACxB,eAAe;IACf,yCAAuB,CAAA;IACvB,iCAAiC;IACjC,qCAAmB,CAAA;IACnB,gCAAgC;IAChC,uCAAqB,CAAA;IACrB,gCAAgC;IAChC,uCAAqB,CAAA;AACvB,CAAC,EATW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QASzB;AAOD,IAAY,YAUX;AAVD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,iCAAiB,CAAA;IACjB,+BAAe,CAAA;IACf,+BAA+B;IAC/B,mCAAmB,CAAA;IACnB,+BAA+B;IAC/B,yCAAyB,CAAA;IACzB,uCAAuB,CAAA;IACvB,+BAAe,CAAA;AACjB,CAAC,EAVW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAUvB;AASD,IAAY,MAUX;AAVD,WAAY,MAAM;IAChB,iCAAuB,CAAA;IACvB,gDAAgD;IAChD,iCAAuB,CAAA;IACvB;;;;OAIG;IACH,iCAAuB,CAAA;AACzB,CAAC,EAVW,MAAM,GAAN,cAAM,KAAN,cAAM,QAUjB;AAED,IAAY,WAaX;AAbD,WAAY,WAAW;IACrB,sCAAuB,CAAA;IACvB;;;OAGG;IACH,8BAAe,CAAA;IACf,mEAAmE;IACnE,8CAA+B,CAAA;IAC/B,2CAA2C;IAC3C,sDAAuC,CAAA;IACvC,gGAAgG;IAChG,4CAA6B,CAAA;AAC/B,CAAC,EAbW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAatB;AA8BD,IAAY,cAMX;AAND,WAAY,cAAc;IACxB,yCAAuB,CAAA;IACvB,oCAAoC;IACpC,qEAAmD,CAAA;IACnD,4BAA4B;IAC5B,mCAAiB,CAAA;AACnB,CAAC,EANW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAMzB;AAsJD,IAAY,iBAQX;AARD,WAAY,iBAAiB;IAC3B,kEAA6C,CAAA;IAC7C,4DAA4D;IAC5D,oCAAe,CAAA;IACf,+CAA+C;IAC/C,oDAA+B,CAAA;IAC/B,mCAAmC;IACnC,gCAAW,CAAA;AACb,CAAC,EARW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAQ5B;AAiLD,IAAY,eAKX;AALD,WAAY,eAAe;IACzB,0CAAuB,CAAA;IACvB,wCAAqB,CAAA;IACrB,8CAA2B,CAAA;IAC3B,oCAAiB,CAAA;AACnB,CAAC,EALW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAK1B"}
|
|
@@ -590,7 +590,7 @@ export interface Version {
|
|
|
590
590
|
}
|
|
591
591
|
export interface CreateSessionRequest {
|
|
592
592
|
/** The session to create. */
|
|
593
|
-
session
|
|
593
|
+
session?: Session;
|
|
594
594
|
}
|
|
595
595
|
export interface CreateSessionResponse {
|
|
596
596
|
/** The created session. */
|
|
@@ -598,7 +598,9 @@ export interface CreateSessionResponse {
|
|
|
598
598
|
}
|
|
599
599
|
export interface UpdateSessionRequest {
|
|
600
600
|
/** The session to update. */
|
|
601
|
-
session
|
|
601
|
+
session?: Session;
|
|
602
|
+
/** Field mask of fields to update. */
|
|
603
|
+
fieldmask?: string[];
|
|
602
604
|
/** Whether to notify participants about the change, and an optional custom message. */
|
|
603
605
|
participantNotification?: ParticipantNotification;
|
|
604
606
|
}
|
|
@@ -618,7 +620,7 @@ export interface UpdateSessionResponse {
|
|
|
618
620
|
}
|
|
619
621
|
export interface DeleteSessionRequest {
|
|
620
622
|
/** The ID of the session to delete. */
|
|
621
|
-
sessionId
|
|
623
|
+
sessionId?: string | null;
|
|
622
624
|
/** Whether to notify participants about the change, and an optional custom message. */
|
|
623
625
|
participantNotification?: ParticipantNotification;
|
|
624
626
|
}
|
|
@@ -977,106 +979,6 @@ export interface ReplayCompleted {
|
|
|
977
979
|
/** The (minimum) number of sessions that were replayed. */
|
|
978
980
|
totalSessions?: number | null;
|
|
979
981
|
}
|
|
980
|
-
export interface CreateSessionResponseNonNullableFields {
|
|
981
|
-
session?: {
|
|
982
|
-
scheduleId: string;
|
|
983
|
-
affectedSchedules: {
|
|
984
|
-
scheduleId: string;
|
|
985
|
-
transparency: Transparency;
|
|
986
|
-
scheduleOwnerId: string;
|
|
987
|
-
}[];
|
|
988
|
-
location?: {
|
|
989
|
-
locationType: LocationType;
|
|
990
|
-
customAddress?: {
|
|
991
|
-
streetAddress?: {
|
|
992
|
-
number: string;
|
|
993
|
-
name: string;
|
|
994
|
-
apt: string;
|
|
995
|
-
};
|
|
996
|
-
subdivisions: {
|
|
997
|
-
code: string;
|
|
998
|
-
name: string;
|
|
999
|
-
}[];
|
|
1000
|
-
};
|
|
1001
|
-
};
|
|
1002
|
-
rate?: {
|
|
1003
|
-
labeledPriceOptions?: {
|
|
1004
|
-
amount: string;
|
|
1005
|
-
currency: string;
|
|
1006
|
-
downPayAmount: string;
|
|
1007
|
-
};
|
|
1008
|
-
};
|
|
1009
|
-
notes: string;
|
|
1010
|
-
totalNumberOfParticipants: number;
|
|
1011
|
-
participants: {
|
|
1012
|
-
_id: string;
|
|
1013
|
-
partySize: number;
|
|
1014
|
-
approvalStatus: ApprovalStatus;
|
|
1015
|
-
inherited: boolean;
|
|
1016
|
-
}[];
|
|
1017
|
-
inheritedFields: string[];
|
|
1018
|
-
status: Status;
|
|
1019
|
-
type: SessionType;
|
|
1020
|
-
calendarConference?: {
|
|
1021
|
-
_id: string;
|
|
1022
|
-
externalId: string;
|
|
1023
|
-
providerId: string;
|
|
1024
|
-
hostUrl: string;
|
|
1025
|
-
guestUrl: string;
|
|
1026
|
-
conferenceType: ConferenceType;
|
|
1027
|
-
};
|
|
1028
|
-
};
|
|
1029
|
-
}
|
|
1030
|
-
export interface UpdateSessionResponseNonNullableFields {
|
|
1031
|
-
session?: {
|
|
1032
|
-
scheduleId: string;
|
|
1033
|
-
affectedSchedules: {
|
|
1034
|
-
scheduleId: string;
|
|
1035
|
-
transparency: Transparency;
|
|
1036
|
-
scheduleOwnerId: string;
|
|
1037
|
-
}[];
|
|
1038
|
-
location?: {
|
|
1039
|
-
locationType: LocationType;
|
|
1040
|
-
customAddress?: {
|
|
1041
|
-
streetAddress?: {
|
|
1042
|
-
number: string;
|
|
1043
|
-
name: string;
|
|
1044
|
-
apt: string;
|
|
1045
|
-
};
|
|
1046
|
-
subdivisions: {
|
|
1047
|
-
code: string;
|
|
1048
|
-
name: string;
|
|
1049
|
-
}[];
|
|
1050
|
-
};
|
|
1051
|
-
};
|
|
1052
|
-
rate?: {
|
|
1053
|
-
labeledPriceOptions?: {
|
|
1054
|
-
amount: string;
|
|
1055
|
-
currency: string;
|
|
1056
|
-
downPayAmount: string;
|
|
1057
|
-
};
|
|
1058
|
-
};
|
|
1059
|
-
notes: string;
|
|
1060
|
-
totalNumberOfParticipants: number;
|
|
1061
|
-
participants: {
|
|
1062
|
-
_id: string;
|
|
1063
|
-
partySize: number;
|
|
1064
|
-
approvalStatus: ApprovalStatus;
|
|
1065
|
-
inherited: boolean;
|
|
1066
|
-
}[];
|
|
1067
|
-
inheritedFields: string[];
|
|
1068
|
-
status: Status;
|
|
1069
|
-
type: SessionType;
|
|
1070
|
-
calendarConference?: {
|
|
1071
|
-
_id: string;
|
|
1072
|
-
externalId: string;
|
|
1073
|
-
providerId: string;
|
|
1074
|
-
hostUrl: string;
|
|
1075
|
-
guestUrl: string;
|
|
1076
|
-
conferenceType: ConferenceType;
|
|
1077
|
-
};
|
|
1078
|
-
};
|
|
1079
|
-
}
|
|
1080
982
|
export interface QuerySessionsResponseNonNullableFields {
|
|
1081
983
|
sessions: {
|
|
1082
984
|
scheduleId: string;
|
|
@@ -1227,273 +1129,6 @@ export interface ListSessionsResponseNonNullableFields {
|
|
|
1227
1129
|
};
|
|
1228
1130
|
}[];
|
|
1229
1131
|
}
|
|
1230
|
-
/**
|
|
1231
|
-
* Creates a session.
|
|
1232
|
-
*
|
|
1233
|
-
*
|
|
1234
|
-
* The `createSession()` function returns a Promise that resolves when a session is created.
|
|
1235
|
-
*
|
|
1236
|
-
*
|
|
1237
|
-
* A session's `type` is one of the following:
|
|
1238
|
-
* + `EVENT`: Reserved period of time on any schedule. For example, an appointment, class, or course. Events are visible in the Dashboard in the Bookings app's [Booking Calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-bookings-calendar) page. Set `type` to `EVENT` when creating sessions that reserve time on a service's schedule, or when creating a blocked time for a resource.
|
|
1239
|
-
* + `WORKING_HOURS`: Placeholder for available time on a resource’s schedule. Set `type` to `WORKING_HOURS` when creating sessions for resource availability.
|
|
1240
|
-
*
|
|
1241
|
-
* Sessions belong to a schedule. Schedules are owned by a resource or a service.
|
|
1242
|
-
*
|
|
1243
|
-
* A session may be an individual session or a recurring session.
|
|
1244
|
-
* An individual session has a discrete start and end date, while a recurring session defines a series of repeating sessions. An instance of a recurring session is a specific session in a series of repeating sessions, generated according to the recurrence rule.
|
|
1245
|
-
*
|
|
1246
|
-
* The `start` and `end` properties set the time and duration of the session. For non-recurring sessions, you can use either the `timestamp` or `localDateTime` properties.
|
|
1247
|
-
* For recurring sessions, use the `localDateTime` property only.
|
|
1248
|
-
*
|
|
1249
|
-
* For recurring sessions, the `start` property sets the date and time of the first recurring session, subject to the recurrence rule. For example, if you set the `start` to Saturday, May 1 and your recurrence rule says every second Monday, then the first session will only be on Monday, May 10.
|
|
1250
|
-
*
|
|
1251
|
-
* The `year`, `monthOfYear` and `dayOfMonth` properties in the `end` property are used with the `hourOfDay` and `minutesOfHour` properties to set the duration of each session relative to the `start`.
|
|
1252
|
-
*
|
|
1253
|
-
* The `UNTIL` keyword in the `recurrence` property sets the date for the last recurring session.
|
|
1254
|
-
*
|
|
1255
|
-
* You can create a session that blocks hours on the resource's calendar, making the resource unavailable, by creating a non-recurring session of type `"EVENT"`, and add `"Blocked"` to the `tags` array.
|
|
1256
|
-
*
|
|
1257
|
-
* >**Notes:**
|
|
1258
|
-
* > + For properties where there is no explicit timezone information, the timezone used is the business’s timezone.
|
|
1259
|
-
* > + This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
1260
|
-
* @param session - The session to create.
|
|
1261
|
-
* @public
|
|
1262
|
-
* @documentationMaturity preview
|
|
1263
|
-
* @requiredField session
|
|
1264
|
-
* @requiredField session.end
|
|
1265
|
-
* @requiredField session.scheduleId
|
|
1266
|
-
* @requiredField session.start
|
|
1267
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1268
|
-
* @applicableIdentity APP
|
|
1269
|
-
* @returns The created session.
|
|
1270
|
-
*/
|
|
1271
|
-
export declare function createSession(session: Session): Promise<Session & NonNullable<CreateSessionResponseNonNullableFields>['session']>;
|
|
1272
|
-
/**
|
|
1273
|
-
* Updates a session.
|
|
1274
|
-
*
|
|
1275
|
-
*
|
|
1276
|
-
* The `updateSession()` function updates a session and returns a Promise that resolves to the updated session.
|
|
1277
|
-
*
|
|
1278
|
-
* When you update a recurring session, only the future instances of the recurrence will be updated. Changing an individual instance's `start` or `end` time will change the way updates to `start` and `end` on the recurring session pattern definition affect the session instance:
|
|
1279
|
-
* |Change made to the instance | Effect of changes made to the recurrence
|
|
1280
|
-
* |--|--|
|
|
1281
|
-
* |Instance `start` time changed.|Changes to the recurring session's `start` or `end` time will not update the instance.|
|
|
1282
|
-
* |Instance `end` time changed, changing the session's duration| Changes made to the recurring session's start time will be updated on the instance while keeping the new duration, but changes to the recurring session's `end` time not be updated on the instance.
|
|
1283
|
-
* |Updating a changed `start` time for an instance back to the recurring session's value.|Future changes to the recurring session `start` and `end` times will update the instance's `starts` and `end` time.
|
|
1284
|
-
*
|
|
1285
|
-
* Changes to properties on the recurring session, other than `start` and `end`, are always updated on the recurrence instance.
|
|
1286
|
-
*
|
|
1287
|
-
* Use the `options.participantNotification` object to notify participants if the session has been booked.
|
|
1288
|
-
*
|
|
1289
|
-
* >**Notes:**
|
|
1290
|
-
* > + Where there is no explicit timezone information, the timezone used is the business’s timezone.
|
|
1291
|
-
* > + This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
1292
|
-
* @param _id - Session ID.
|
|
1293
|
-
* @public
|
|
1294
|
-
* @documentationMaturity preview
|
|
1295
|
-
* @requiredField _id
|
|
1296
|
-
* @requiredField session
|
|
1297
|
-
* @param options - Options to use when updating a session.
|
|
1298
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1299
|
-
* @applicableIdentity APP
|
|
1300
|
-
* @returns The updated session.
|
|
1301
|
-
*/
|
|
1302
|
-
export declare function updateSession(_id: string | null, session: UpdateSession, options?: UpdateSessionOptions): Promise<Session & NonNullable<UpdateSessionResponseNonNullableFields>['session']>;
|
|
1303
|
-
export interface UpdateSession {
|
|
1304
|
-
/**
|
|
1305
|
-
* Session ID.
|
|
1306
|
-
* @readonly
|
|
1307
|
-
*/
|
|
1308
|
-
_id?: string | null;
|
|
1309
|
-
/** ID of the schedule that the session belongs to. */
|
|
1310
|
-
scheduleId?: string;
|
|
1311
|
-
/**
|
|
1312
|
-
* ID of the resource or service that the session's schedule belongs to.
|
|
1313
|
-
* @readonly
|
|
1314
|
-
*/
|
|
1315
|
-
scheduleOwnerId?: string | null;
|
|
1316
|
-
/** Original start date and time of the session in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)) format. */
|
|
1317
|
-
originalStart?: Date;
|
|
1318
|
-
/** An object specifying the start date and time of the session. If the session is a recurring session, `start` must contain a `localDateTime`. */
|
|
1319
|
-
start?: CalendarDateTime;
|
|
1320
|
-
/**
|
|
1321
|
-
* 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`.
|
|
1322
|
-
* If the session is a recurring session, `end` must contain a `localDateTime`.
|
|
1323
|
-
*/
|
|
1324
|
-
end?: CalendarDateTime;
|
|
1325
|
-
/**
|
|
1326
|
-
* 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.
|
|
1327
|
-
* The array is inherited from the schedule and can be overridden even if the session is a recurring session.
|
|
1328
|
-
*/
|
|
1329
|
-
affectedSchedules?: LinkedSchedule[];
|
|
1330
|
-
/**
|
|
1331
|
-
* Session title.
|
|
1332
|
-
* The value is inherited from the schedule and can be overridden unless the session is a recurring session.
|
|
1333
|
-
*/
|
|
1334
|
-
title?: string | null;
|
|
1335
|
-
/**
|
|
1336
|
-
* __Deprecated.__
|
|
1337
|
-
* Tags for the session.
|
|
1338
|
-
* The value is inherited from the schedule and can be overridden unless the session is a recurring session.
|
|
1339
|
-
*/
|
|
1340
|
-
tags?: string[] | null;
|
|
1341
|
-
/**
|
|
1342
|
-
* An object describing the location where the session takes place.
|
|
1343
|
-
* Defaults to the schedule location.
|
|
1344
|
-
* 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`.
|
|
1345
|
-
*/
|
|
1346
|
-
location?: Location;
|
|
1347
|
-
/**
|
|
1348
|
-
* Maximum number of participants that can be added to the session. Defaults to the schedule capacity.
|
|
1349
|
-
* The value is inherited from the schedule and can be overridden unless the session is a recurring session.
|
|
1350
|
-
*/
|
|
1351
|
-
capacity?: number | null;
|
|
1352
|
-
/** Deprecated. Please use the [Booking Services V2](https://dev.wix.com/api/rest/wix-bookings/services-v2) payment instead. */
|
|
1353
|
-
rate?: Rate;
|
|
1354
|
-
/**
|
|
1355
|
-
* Time reserved after the session end time, derived from the schedule availability constraints and the time between slots. Read-only.
|
|
1356
|
-
* If the session is a recurring session, this field must be empty.
|
|
1357
|
-
*/
|
|
1358
|
-
timeReservedAfter?: number | null;
|
|
1359
|
-
/**
|
|
1360
|
-
* Additional information about the session.
|
|
1361
|
-
* Notes are not supported for recurring sessions.
|
|
1362
|
-
*/
|
|
1363
|
-
notes?: string;
|
|
1364
|
-
/**
|
|
1365
|
-
* The number of participants booked for the session. Read-only.
|
|
1366
|
-
* Calculated as the sum of the party sizes.
|
|
1367
|
-
* @readonly
|
|
1368
|
-
*/
|
|
1369
|
-
totalNumberOfParticipants?: number;
|
|
1370
|
-
/**
|
|
1371
|
-
* *Partial list** list of participants booked for the session.
|
|
1372
|
-
* The list includes participants who have registered for this specific session, and participants who have registered for a schedule that includes this session.
|
|
1373
|
-
* If the session is a recurring session, this field must be empty.
|
|
1374
|
-
* 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).
|
|
1375
|
-
*/
|
|
1376
|
-
participants?: Participant[];
|
|
1377
|
-
/**
|
|
1378
|
-
* A list of properties for which values were inherited from the schedule.
|
|
1379
|
-
* This does not include participants that were inherited from the schedule.
|
|
1380
|
-
* @readonly
|
|
1381
|
-
*/
|
|
1382
|
-
inheritedFields?: string[];
|
|
1383
|
-
/** __Deprecated.__ */
|
|
1384
|
-
externalCalendarOverrides?: ExternalCalendarOverrides;
|
|
1385
|
-
/**
|
|
1386
|
-
* Session status.
|
|
1387
|
-
*
|
|
1388
|
-
* Supported values:
|
|
1389
|
-
* - `CONFIRMED`: Default value.
|
|
1390
|
-
* - `CANCELLED`: The session was deleted.
|
|
1391
|
-
* @readonly
|
|
1392
|
-
*/
|
|
1393
|
-
status?: Status;
|
|
1394
|
-
/**
|
|
1395
|
-
* Recurring interval ID. Defined when a session will be a recurring session. read-only. Optional.
|
|
1396
|
-
* For exmaple, when creating a class service with recurring sessions, you add a recurrence rule to create recurring sessions.
|
|
1397
|
-
* This field is omitted for single sessions or instances of recurring sessions.
|
|
1398
|
-
* Specified when the session was originally generated from a schedule recurring interval.
|
|
1399
|
-
* Deprecated. Use `recurringSessionId`.
|
|
1400
|
-
* @readonly
|
|
1401
|
-
*/
|
|
1402
|
-
recurringIntervalId?: string | null;
|
|
1403
|
-
/**
|
|
1404
|
-
* 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.
|
|
1405
|
-
* @readonly
|
|
1406
|
-
*/
|
|
1407
|
-
recurringSessionId?: string | null;
|
|
1408
|
-
/**
|
|
1409
|
-
* Session type.
|
|
1410
|
-
*
|
|
1411
|
-
* Supported values:
|
|
1412
|
-
* - `EVENT`: Reserved period of time on the schedule. For example, an appointment, class, course, or blocked time. Events are visible in the Dashboard in the Bookings app's [Booking Calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-bookings-calendar) page.
|
|
1413
|
-
* - `WORKING_HOURS`: Placeholder for available time on a resource’s schedule.
|
|
1414
|
-
*/
|
|
1415
|
-
type?: SessionType;
|
|
1416
|
-
/**
|
|
1417
|
-
* A conference created for the session according to the details set in the schedule's conference provider information.
|
|
1418
|
-
* If the session is a recurring session, this field is inherited from the schedule.
|
|
1419
|
-
* **Partially deprecated.** Only `hostUrl` and `guestUrl` are to be supported.
|
|
1420
|
-
*/
|
|
1421
|
-
calendarConference?: CalendarConference;
|
|
1422
|
-
/**
|
|
1423
|
-
* 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).
|
|
1424
|
-
* 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.
|
|
1425
|
-
* The RRULE defines a rule for repeating a session.
|
|
1426
|
-
* Supported parameters are:
|
|
1427
|
-
*
|
|
1428
|
-
* |Keyword|Description|Supported values|
|
|
1429
|
-
* |--|--|---|
|
|
1430
|
-
* |`FREQ`|The frequency at which the session is recurs. Required.|`WEEKLY`|
|
|
1431
|
-
* |`INTERVAL`|How often, in terms of `FREQ`, the session recurs. Default is 1. Optional.|
|
|
1432
|
-
* |`UNTIL`|The UTC end date and time of the recurrence. Optional.|
|
|
1433
|
-
* |`BYDAY`|Day of the week when the event should recur. Required.|One of: `MO`, `TU`, `WE`, `TH`, `FR`, `SA`, `SU`|
|
|
1434
|
-
*
|
|
1435
|
-
*
|
|
1436
|
-
* For example, a session that repeats every second week on a Monday until January 7, 2022 at 8 AM:
|
|
1437
|
-
* `"FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;UNTIL=20220107T080000Z"`
|
|
1438
|
-
*
|
|
1439
|
-
* <!--ORIGINAL COMMENTS:
|
|
1440
|
-
* `FREQ` — The frequency with which the session should be repeated (such as DAILY or WEEKLY).
|
|
1441
|
-
* Supported `WEEKLY` value is supported.
|
|
1442
|
-
* 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.
|
|
1443
|
-
* COUNT — The number of times this event should be repeated. Not yet supported.
|
|
1444
|
-
* 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.
|
|
1445
|
-
* 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'.
|
|
1446
|
-
* BYDAY - The days of the week when the event should be repeated. Currently, only a single day is supported. This parameter is mandatory.
|
|
1447
|
-
* Possible values are: MO, TU, WE, TH, FR, SA, SU
|
|
1448
|
-
* 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.
|
|
1449
|
-
* **Example**: FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;UNTIL=20200427T070000Z
|
|
1450
|
-
* ORIGINAL COMMENTS-->
|
|
1451
|
-
*/
|
|
1452
|
-
recurrence?: string | null;
|
|
1453
|
-
/**
|
|
1454
|
-
* A string representing a recurrence rule (RRULE) if the session is an instance of a recurrence pattern.
|
|
1455
|
-
* 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.
|
|
1456
|
-
* @readonly
|
|
1457
|
-
*/
|
|
1458
|
-
instanceOfRecurrence?: string | null;
|
|
1459
|
-
/**
|
|
1460
|
-
* The session version.
|
|
1461
|
-
* Composed by the schedule, session and participants versions.
|
|
1462
|
-
* @readonly
|
|
1463
|
-
*/
|
|
1464
|
-
version?: Version;
|
|
1465
|
-
}
|
|
1466
|
-
export interface UpdateSessionOptions {
|
|
1467
|
-
/** Whether to notify participants about the change, and an optional custom message. */
|
|
1468
|
-
participantNotification?: ParticipantNotification;
|
|
1469
|
-
}
|
|
1470
|
-
/**
|
|
1471
|
-
* Deletes a session.
|
|
1472
|
-
*
|
|
1473
|
-
*
|
|
1474
|
-
* The `deleteSession()` function returns a Promise that resolves when the session has been deleted.
|
|
1475
|
-
*
|
|
1476
|
-
* Use the `options.participantNotification` property to send an email notification to the participants when the session is deleted.
|
|
1477
|
-
*
|
|
1478
|
-
* When deleting a session of type `EVENT` where a booking exists, the booking's status is updated to `CANCELED`.
|
|
1479
|
-
*
|
|
1480
|
-
* To delete a set of recurring sessions, specify the session's `recurringSessionId` in the `sessionId` parameter.
|
|
1481
|
-
* When deleting a recurrence, only future instances of the recurrence are deleted.
|
|
1482
|
-
*
|
|
1483
|
-
* >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
|
|
1484
|
-
* @param sessionId - The ID of the session to delete.
|
|
1485
|
-
* @public
|
|
1486
|
-
* @documentationMaturity preview
|
|
1487
|
-
* @requiredField sessionId
|
|
1488
|
-
* @param options - Options to use when deleting a session.
|
|
1489
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
1490
|
-
* @applicableIdentity APP
|
|
1491
|
-
*/
|
|
1492
|
-
export declare function deleteSession(sessionId: string | null, options?: DeleteSessionOptions): Promise<void>;
|
|
1493
|
-
export interface DeleteSessionOptions {
|
|
1494
|
-
/** Whether to notify participants about the change, and an optional custom message. */
|
|
1495
|
-
participantNotification?: ParticipantNotification;
|
|
1496
|
-
}
|
|
1497
1132
|
/**
|
|
1498
1133
|
* Retrieves a list of sessions, given the provided time range, filtering, and paging.
|
|
1499
1134
|
*
|