@wix/auto_sdk_bookings_bookings 1.0.112 → 1.0.114
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/index.d.ts +83 -85
- package/build/cjs/index.js +211 -211
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +373 -366
- package/build/cjs/index.typings.js +193 -193
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +256 -250
- package/build/cjs/meta.js +171 -171
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +83 -85
- package/build/es/index.mjs +211 -211
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +373 -366
- package/build/es/index.typings.mjs +193 -193
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +256 -250
- package/build/es/meta.mjs +171 -171
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +83 -72
- package/build/internal/cjs/index.js +211 -211
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +377 -358
- package/build/internal/cjs/index.typings.js +193 -193
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +256 -250
- package/build/internal/cjs/meta.js +171 -171
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +83 -72
- package/build/internal/es/index.mjs +211 -211
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +377 -358
- package/build/internal/es/index.typings.mjs +193 -193
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +256 -250
- package/build/internal/es/meta.mjs +171 -171
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -884,6 +884,229 @@ interface BookingFormFilled {
|
|
|
884
884
|
*/
|
|
885
885
|
formId?: string | null;
|
|
886
886
|
}
|
|
887
|
+
interface ConfirmOrDeclineBookingRequest {
|
|
888
|
+
/**
|
|
889
|
+
* ID of the booking to confirm or decline.
|
|
890
|
+
* @format GUID
|
|
891
|
+
*/
|
|
892
|
+
bookingId: string;
|
|
893
|
+
/**
|
|
894
|
+
* Current payment status of the booking when using a custom checkout page and
|
|
895
|
+
* not the [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
896
|
+
*
|
|
897
|
+
* The booking is declined if there is a double booking conflict and you provide
|
|
898
|
+
* one of these payment statuses: `UNDEFINED`, `NOT_PAID`, `REFUNDED`, or `EXEMPT`.
|
|
899
|
+
*/
|
|
900
|
+
paymentStatus?: PaymentStatusWithLiterals;
|
|
901
|
+
}
|
|
902
|
+
interface ConfirmOrDeclineBookingResponse {
|
|
903
|
+
/** Updated booking. */
|
|
904
|
+
booking?: Booking;
|
|
905
|
+
}
|
|
906
|
+
interface BulkConfirmOrDeclineBookingRequest {
|
|
907
|
+
/**
|
|
908
|
+
* Bookings to confirm or decline.
|
|
909
|
+
* @minSize 1
|
|
910
|
+
* @maxSize 300
|
|
911
|
+
*/
|
|
912
|
+
details: BulkConfirmOrDeclineBookingRequestBookingDetails[];
|
|
913
|
+
/** Whether to return the confirmed or declined booking objects. */
|
|
914
|
+
returnEntity?: boolean;
|
|
915
|
+
}
|
|
916
|
+
interface BulkConfirmOrDeclineBookingRequestBookingDetails {
|
|
917
|
+
/**
|
|
918
|
+
* ID of the booking to confirm or decline.
|
|
919
|
+
* @format GUID
|
|
920
|
+
*/
|
|
921
|
+
bookingId?: string;
|
|
922
|
+
/**
|
|
923
|
+
* Current payment status of the booking when using a custom checkout page and
|
|
924
|
+
* not the [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
925
|
+
*
|
|
926
|
+
* The booking is declined if there is a double booking conflict and you provide
|
|
927
|
+
* one of these payment statuses: `UNDEFINED`, `NOT_PAID`, `REFUNDED`, or `EXEMPT`.
|
|
928
|
+
*/
|
|
929
|
+
paymentStatus?: PaymentStatusWithLiterals;
|
|
930
|
+
}
|
|
931
|
+
interface BulkConfirmOrDeclineBookingResponse {
|
|
932
|
+
/** List of confirmed or declined bookings, including metadata. */
|
|
933
|
+
results?: BulkBookingResult[];
|
|
934
|
+
/** Total successes and failures of the Bulk Confirm Or Decline call. */
|
|
935
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
936
|
+
}
|
|
937
|
+
interface BulkBookingResult {
|
|
938
|
+
/**
|
|
939
|
+
* Information about the booking that was created or updated.
|
|
940
|
+
* Including its ID, index in the bulk request and whether it was
|
|
941
|
+
* successfully created or updated.
|
|
942
|
+
*/
|
|
943
|
+
itemMetadata?: ItemMetadata;
|
|
944
|
+
/**
|
|
945
|
+
* Created or updated booking. Available only if you requested
|
|
946
|
+
* to return the booking entity.
|
|
947
|
+
*/
|
|
948
|
+
item?: Booking;
|
|
949
|
+
}
|
|
950
|
+
interface ItemMetadata {
|
|
951
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
952
|
+
_id?: string | null;
|
|
953
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
954
|
+
originalIndex?: number;
|
|
955
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
956
|
+
success?: boolean;
|
|
957
|
+
/** Details about the error in case of failure. */
|
|
958
|
+
error?: ApplicationError;
|
|
959
|
+
}
|
|
960
|
+
interface ApplicationError {
|
|
961
|
+
/** Error code. */
|
|
962
|
+
code?: string;
|
|
963
|
+
/** Description of the error. */
|
|
964
|
+
description?: string;
|
|
965
|
+
/** Data related to the error. */
|
|
966
|
+
data?: Record<string, any> | null;
|
|
967
|
+
}
|
|
968
|
+
interface BulkActionMetadata {
|
|
969
|
+
/** Number of items that were successfully processed. */
|
|
970
|
+
totalSuccesses?: number;
|
|
971
|
+
/** Number of items that couldn't be processed. */
|
|
972
|
+
totalFailures?: number;
|
|
973
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
974
|
+
undetailedFailures?: number;
|
|
975
|
+
}
|
|
976
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
977
|
+
createdEvent?: EntityCreatedEvent;
|
|
978
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
979
|
+
deletedEvent?: EntityDeletedEvent;
|
|
980
|
+
actionEvent?: ActionEvent;
|
|
981
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
982
|
+
_id?: string;
|
|
983
|
+
/**
|
|
984
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
985
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
986
|
+
*/
|
|
987
|
+
entityFqdn?: string;
|
|
988
|
+
/**
|
|
989
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
990
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
991
|
+
*/
|
|
992
|
+
slug?: string;
|
|
993
|
+
/** ID of the entity associated with the event. */
|
|
994
|
+
entityId?: string;
|
|
995
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
996
|
+
eventTime?: Date | null;
|
|
997
|
+
/**
|
|
998
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
999
|
+
* (for example, GDPR).
|
|
1000
|
+
*/
|
|
1001
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1002
|
+
/** If present, indicates the action that triggered the event. */
|
|
1003
|
+
originatedFrom?: string | null;
|
|
1004
|
+
/**
|
|
1005
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
1006
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
1007
|
+
*/
|
|
1008
|
+
entityEventSequence?: string | null;
|
|
1009
|
+
}
|
|
1010
|
+
/** @oneof */
|
|
1011
|
+
interface DomainEventBodyOneOf {
|
|
1012
|
+
createdEvent?: EntityCreatedEvent;
|
|
1013
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
1014
|
+
deletedEvent?: EntityDeletedEvent;
|
|
1015
|
+
actionEvent?: ActionEvent;
|
|
1016
|
+
}
|
|
1017
|
+
interface EntityCreatedEvent {
|
|
1018
|
+
entity?: string;
|
|
1019
|
+
}
|
|
1020
|
+
interface RestoreInfo {
|
|
1021
|
+
deletedDate?: Date | null;
|
|
1022
|
+
}
|
|
1023
|
+
interface EntityUpdatedEvent {
|
|
1024
|
+
/**
|
|
1025
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1026
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1027
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1028
|
+
*/
|
|
1029
|
+
currentEntity?: string;
|
|
1030
|
+
}
|
|
1031
|
+
interface EntityDeletedEvent {
|
|
1032
|
+
/** Entity that was deleted. */
|
|
1033
|
+
deletedEntity?: string | null;
|
|
1034
|
+
}
|
|
1035
|
+
interface ActionEvent {
|
|
1036
|
+
body?: string;
|
|
1037
|
+
}
|
|
1038
|
+
interface MessageEnvelope {
|
|
1039
|
+
/**
|
|
1040
|
+
* App instance ID.
|
|
1041
|
+
* @format GUID
|
|
1042
|
+
*/
|
|
1043
|
+
instanceId?: string | null;
|
|
1044
|
+
/**
|
|
1045
|
+
* Event type.
|
|
1046
|
+
* @maxLength 150
|
|
1047
|
+
*/
|
|
1048
|
+
eventType?: string;
|
|
1049
|
+
/** The identification type and identity data. */
|
|
1050
|
+
identity?: WebhooksIdentificationData;
|
|
1051
|
+
/** Stringify payload. */
|
|
1052
|
+
data?: string;
|
|
1053
|
+
}
|
|
1054
|
+
interface WebhooksIdentificationData extends WebhooksIdentificationDataIdOneOf {
|
|
1055
|
+
/**
|
|
1056
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1057
|
+
* @format GUID
|
|
1058
|
+
*/
|
|
1059
|
+
anonymousVisitorId?: string;
|
|
1060
|
+
/**
|
|
1061
|
+
* ID of a site visitor that has logged in to the site.
|
|
1062
|
+
* @format GUID
|
|
1063
|
+
*/
|
|
1064
|
+
memberId?: string;
|
|
1065
|
+
/**
|
|
1066
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1067
|
+
* @format GUID
|
|
1068
|
+
*/
|
|
1069
|
+
wixUserId?: string;
|
|
1070
|
+
/**
|
|
1071
|
+
* ID of an app.
|
|
1072
|
+
* @format GUID
|
|
1073
|
+
*/
|
|
1074
|
+
appId?: string;
|
|
1075
|
+
/** @readonly */
|
|
1076
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1077
|
+
}
|
|
1078
|
+
/** @oneof */
|
|
1079
|
+
interface WebhooksIdentificationDataIdOneOf {
|
|
1080
|
+
/**
|
|
1081
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1082
|
+
* @format GUID
|
|
1083
|
+
*/
|
|
1084
|
+
anonymousVisitorId?: string;
|
|
1085
|
+
/**
|
|
1086
|
+
* ID of a site visitor that has logged in to the site.
|
|
1087
|
+
* @format GUID
|
|
1088
|
+
*/
|
|
1089
|
+
memberId?: string;
|
|
1090
|
+
/**
|
|
1091
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1092
|
+
* @format GUID
|
|
1093
|
+
*/
|
|
1094
|
+
wixUserId?: string;
|
|
1095
|
+
/**
|
|
1096
|
+
* ID of an app.
|
|
1097
|
+
* @format GUID
|
|
1098
|
+
*/
|
|
1099
|
+
appId?: string;
|
|
1100
|
+
}
|
|
1101
|
+
declare enum WebhookIdentityType {
|
|
1102
|
+
UNKNOWN = "UNKNOWN",
|
|
1103
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1104
|
+
MEMBER = "MEMBER",
|
|
1105
|
+
WIX_USER = "WIX_USER",
|
|
1106
|
+
APP = "APP"
|
|
1107
|
+
}
|
|
1108
|
+
/** @enumType */
|
|
1109
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
887
1110
|
interface V2CreateBookingRequest extends V2CreateBookingRequestBookableItemOneOf, V2CreateBookingRequestParticipantsInfoOneOf {
|
|
888
1111
|
/**
|
|
889
1112
|
* Information about the slot to create a booking for.
|
|
@@ -1267,140 +1490,6 @@ interface V2UpdateNumberOfParticipantsResponse {
|
|
|
1267
1490
|
/** Booking with updated number of participants. */
|
|
1268
1491
|
booking?: Booking;
|
|
1269
1492
|
}
|
|
1270
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1271
|
-
createdEvent?: EntityCreatedEvent;
|
|
1272
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
1273
|
-
deletedEvent?: EntityDeletedEvent;
|
|
1274
|
-
actionEvent?: ActionEvent;
|
|
1275
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1276
|
-
_id?: string;
|
|
1277
|
-
/**
|
|
1278
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
1279
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
1280
|
-
*/
|
|
1281
|
-
entityFqdn?: string;
|
|
1282
|
-
/**
|
|
1283
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
1284
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
1285
|
-
*/
|
|
1286
|
-
slug?: string;
|
|
1287
|
-
/** ID of the entity associated with the event. */
|
|
1288
|
-
entityId?: string;
|
|
1289
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
1290
|
-
eventTime?: Date | null;
|
|
1291
|
-
/**
|
|
1292
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
1293
|
-
* (for example, GDPR).
|
|
1294
|
-
*/
|
|
1295
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
1296
|
-
/** If present, indicates the action that triggered the event. */
|
|
1297
|
-
originatedFrom?: string | null;
|
|
1298
|
-
/**
|
|
1299
|
-
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
1300
|
-
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
1301
|
-
*/
|
|
1302
|
-
entityEventSequence?: string | null;
|
|
1303
|
-
}
|
|
1304
|
-
/** @oneof */
|
|
1305
|
-
interface DomainEventBodyOneOf {
|
|
1306
|
-
createdEvent?: EntityCreatedEvent;
|
|
1307
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
1308
|
-
deletedEvent?: EntityDeletedEvent;
|
|
1309
|
-
actionEvent?: ActionEvent;
|
|
1310
|
-
}
|
|
1311
|
-
interface EntityCreatedEvent {
|
|
1312
|
-
entity?: string;
|
|
1313
|
-
}
|
|
1314
|
-
interface RestoreInfo {
|
|
1315
|
-
deletedDate?: Date | null;
|
|
1316
|
-
}
|
|
1317
|
-
interface EntityUpdatedEvent {
|
|
1318
|
-
/**
|
|
1319
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1320
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1321
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1322
|
-
*/
|
|
1323
|
-
currentEntity?: string;
|
|
1324
|
-
}
|
|
1325
|
-
interface EntityDeletedEvent {
|
|
1326
|
-
/** Entity that was deleted. */
|
|
1327
|
-
deletedEntity?: string | null;
|
|
1328
|
-
}
|
|
1329
|
-
interface ActionEvent {
|
|
1330
|
-
body?: string;
|
|
1331
|
-
}
|
|
1332
|
-
interface MessageEnvelope {
|
|
1333
|
-
/**
|
|
1334
|
-
* App instance ID.
|
|
1335
|
-
* @format GUID
|
|
1336
|
-
*/
|
|
1337
|
-
instanceId?: string | null;
|
|
1338
|
-
/**
|
|
1339
|
-
* Event type.
|
|
1340
|
-
* @maxLength 150
|
|
1341
|
-
*/
|
|
1342
|
-
eventType?: string;
|
|
1343
|
-
/** The identification type and identity data. */
|
|
1344
|
-
identity?: WebhooksIdentificationData;
|
|
1345
|
-
/** Stringify payload. */
|
|
1346
|
-
data?: string;
|
|
1347
|
-
}
|
|
1348
|
-
interface WebhooksIdentificationData extends WebhooksIdentificationDataIdOneOf {
|
|
1349
|
-
/**
|
|
1350
|
-
* ID of a site visitor that has not logged in to the site.
|
|
1351
|
-
* @format GUID
|
|
1352
|
-
*/
|
|
1353
|
-
anonymousVisitorId?: string;
|
|
1354
|
-
/**
|
|
1355
|
-
* ID of a site visitor that has logged in to the site.
|
|
1356
|
-
* @format GUID
|
|
1357
|
-
*/
|
|
1358
|
-
memberId?: string;
|
|
1359
|
-
/**
|
|
1360
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
1361
|
-
* @format GUID
|
|
1362
|
-
*/
|
|
1363
|
-
wixUserId?: string;
|
|
1364
|
-
/**
|
|
1365
|
-
* ID of an app.
|
|
1366
|
-
* @format GUID
|
|
1367
|
-
*/
|
|
1368
|
-
appId?: string;
|
|
1369
|
-
/** @readonly */
|
|
1370
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1371
|
-
}
|
|
1372
|
-
/** @oneof */
|
|
1373
|
-
interface WebhooksIdentificationDataIdOneOf {
|
|
1374
|
-
/**
|
|
1375
|
-
* ID of a site visitor that has not logged in to the site.
|
|
1376
|
-
* @format GUID
|
|
1377
|
-
*/
|
|
1378
|
-
anonymousVisitorId?: string;
|
|
1379
|
-
/**
|
|
1380
|
-
* ID of a site visitor that has logged in to the site.
|
|
1381
|
-
* @format GUID
|
|
1382
|
-
*/
|
|
1383
|
-
memberId?: string;
|
|
1384
|
-
/**
|
|
1385
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
1386
|
-
* @format GUID
|
|
1387
|
-
*/
|
|
1388
|
-
wixUserId?: string;
|
|
1389
|
-
/**
|
|
1390
|
-
* ID of an app.
|
|
1391
|
-
* @format GUID
|
|
1392
|
-
*/
|
|
1393
|
-
appId?: string;
|
|
1394
|
-
}
|
|
1395
|
-
declare enum WebhookIdentityType {
|
|
1396
|
-
UNKNOWN = "UNKNOWN",
|
|
1397
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1398
|
-
MEMBER = "MEMBER",
|
|
1399
|
-
WIX_USER = "WIX_USER",
|
|
1400
|
-
APP = "APP"
|
|
1401
|
-
}
|
|
1402
|
-
/** @enumType */
|
|
1403
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1404
1493
|
interface CreateMultiServiceBookingRequest {
|
|
1405
1494
|
/**
|
|
1406
1495
|
* Between 2 to 8 new single-service booking specifications to create and combine in a multi-service booking.
|
|
@@ -1627,10 +1716,12 @@ interface RescheduleBookingInfo extends RescheduleBookingInfoParticipantsInfoOne
|
|
|
1627
1716
|
*/
|
|
1628
1717
|
revision?: string | null;
|
|
1629
1718
|
/**
|
|
1630
|
-
* List of [add-ons](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction)
|
|
1631
|
-
*
|
|
1719
|
+
* List of [add-ons](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction) added to the booking.
|
|
1720
|
+
*
|
|
1721
|
+
* To replace the booking's the list of booked add-ons, all of these conditions must be met:
|
|
1632
1722
|
* - The booking must have been created with `flowControlSettings.allowAddOnChanges` set to `true`.
|
|
1633
|
-
* - You must have `BOOKINGS.MANAGE_ADDONS` permissions
|
|
1723
|
+
* - You must have `BOOKINGS.MANAGE_ADDONS` permissions.
|
|
1724
|
+
* - For bookings paid via an [eCommerce checkout](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/purchase-flow/checkout/introduction): The related [eCommerce order](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/draft-orders/introduction) must be in a draftable state to correctly adjust the price when modifying add-ons. You can call [Get Order Draftability Status](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/draft-orders/get-order-draftability-status), specifying the order ID to check if it's draftable. If the order isn't draftable, Reschedule Booking still succeeds, but the order's `priceSummary` isn't updated.
|
|
1634
1725
|
* @maxSize 21
|
|
1635
1726
|
*/
|
|
1636
1727
|
bookedAddOns?: BookedAddOn[];
|
|
@@ -2121,24 +2212,6 @@ interface BulkCalculateAllowedActionsResult {
|
|
|
2121
2212
|
/** Booking entity. */
|
|
2122
2213
|
item?: AllowedActions;
|
|
2123
2214
|
}
|
|
2124
|
-
interface ItemMetadata {
|
|
2125
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
2126
|
-
_id?: string | null;
|
|
2127
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
2128
|
-
originalIndex?: number;
|
|
2129
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
2130
|
-
success?: boolean;
|
|
2131
|
-
/** Details about the error in case of failure. */
|
|
2132
|
-
error?: ApplicationError;
|
|
2133
|
-
}
|
|
2134
|
-
interface ApplicationError {
|
|
2135
|
-
/** Error code. */
|
|
2136
|
-
code?: string;
|
|
2137
|
-
/** Description of the error. */
|
|
2138
|
-
description?: string;
|
|
2139
|
-
/** Data related to the error. */
|
|
2140
|
-
data?: Record<string, any> | null;
|
|
2141
|
-
}
|
|
2142
2215
|
/** Possible actions allowed for the booking. */
|
|
2143
2216
|
interface AllowedActions {
|
|
2144
2217
|
/** Whether canceling the booking is allowed. */
|
|
@@ -2146,14 +2219,6 @@ interface AllowedActions {
|
|
|
2146
2219
|
/** Whether rescheduling the booking is allowed. */
|
|
2147
2220
|
reschedule?: boolean;
|
|
2148
2221
|
}
|
|
2149
|
-
interface BulkActionMetadata {
|
|
2150
|
-
/** Number of items that were successfully processed. */
|
|
2151
|
-
totalSuccesses?: number;
|
|
2152
|
-
/** Number of items that couldn't be processed. */
|
|
2153
|
-
totalFailures?: number;
|
|
2154
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
2155
|
-
undetailedFailures?: number;
|
|
2156
|
-
}
|
|
2157
2222
|
interface GetMultiServiceBookingRequest {
|
|
2158
2223
|
/**
|
|
2159
2224
|
* ID of the multi-service booking.
|
|
@@ -2197,101 +2262,38 @@ interface BookingIdAndRevision {
|
|
|
2197
2262
|
* ID of the single-service booking.
|
|
2198
2263
|
* @format GUID
|
|
2199
2264
|
*/
|
|
2200
|
-
bookingId?: string | null;
|
|
2201
|
-
/**
|
|
2202
|
-
* Revision number, which increments by 1 each time the booking is updated.
|
|
2203
|
-
* To prevent conflicting changes, the current revision must be specified when managing the booking.
|
|
2204
|
-
*/
|
|
2205
|
-
revision?: string | null;
|
|
2206
|
-
}
|
|
2207
|
-
interface AddBookingsToMultiServiceBookingResponse {
|
|
2208
|
-
/** Single-service bookings that were added to the multi-service booking. */
|
|
2209
|
-
bookings?: BookingResult[];
|
|
2210
|
-
}
|
|
2211
|
-
interface RemoveBookingsFromMultiServiceBookingRequest {
|
|
2212
|
-
/**
|
|
2213
|
-
* ID of the multi-service booking.
|
|
2214
|
-
* @format GUID
|
|
2215
|
-
*/
|
|
2216
|
-
multiServiceBookingId: string | null;
|
|
2217
|
-
/**
|
|
2218
|
-
* List of single-service booking IDs and their revision.
|
|
2219
|
-
* @maxSize 8
|
|
2220
|
-
*/
|
|
2221
|
-
bookings?: BookingIdAndRevision[];
|
|
2222
|
-
/**
|
|
2223
|
-
* Whether to return the single-service bookings.
|
|
2224
|
-
*
|
|
2225
|
-
* Default: `false`
|
|
2226
|
-
*/
|
|
2227
|
-
returnFullEntity?: boolean;
|
|
2228
|
-
}
|
|
2229
|
-
interface RemoveBookingsFromMultiServiceBookingResponse {
|
|
2230
|
-
/** Single-service bookings that were removed from the multi-service booking. */
|
|
2231
|
-
bookings?: BookingResult[];
|
|
2232
|
-
}
|
|
2233
|
-
interface ConfirmOrDeclineBookingRequest {
|
|
2234
|
-
/**
|
|
2235
|
-
* ID of the booking to confirm or decline.
|
|
2236
|
-
* @format GUID
|
|
2237
|
-
*/
|
|
2238
|
-
bookingId: string;
|
|
2239
|
-
/**
|
|
2240
|
-
* Current payment status of the booking when using a custom checkout page and
|
|
2241
|
-
* not the [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
2242
|
-
*
|
|
2243
|
-
* The booking is declined if there is a double booking conflict and you provide
|
|
2244
|
-
* one of these payment statuses: `UNDEFINED`, `NOT_PAID`, `REFUNDED`, or `EXEMPT`.
|
|
2245
|
-
*/
|
|
2246
|
-
paymentStatus?: PaymentStatusWithLiterals;
|
|
2247
|
-
}
|
|
2248
|
-
interface ConfirmOrDeclineBookingResponse {
|
|
2249
|
-
/** Updated booking. */
|
|
2250
|
-
booking?: Booking;
|
|
2251
|
-
}
|
|
2252
|
-
interface BulkConfirmOrDeclineBookingRequest {
|
|
2253
|
-
/**
|
|
2254
|
-
* Bookings to confirm or decline.
|
|
2255
|
-
* @minSize 1
|
|
2256
|
-
* @maxSize 300
|
|
2257
|
-
*/
|
|
2258
|
-
details: BulkConfirmOrDeclineBookingRequestBookingDetails[];
|
|
2259
|
-
/** Whether to return the confirmed or declined booking objects. */
|
|
2260
|
-
returnEntity?: boolean;
|
|
2261
|
-
}
|
|
2262
|
-
interface BulkConfirmOrDeclineBookingRequestBookingDetails {
|
|
2263
|
-
/**
|
|
2264
|
-
* ID of the booking to confirm or decline.
|
|
2265
|
-
* @format GUID
|
|
2266
|
-
*/
|
|
2267
|
-
bookingId?: string;
|
|
2268
|
-
/**
|
|
2269
|
-
* Current payment status of the booking when using a custom checkout page and
|
|
2270
|
-
* not the [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
2271
|
-
*
|
|
2272
|
-
* The booking is declined if there is a double booking conflict and you provide
|
|
2273
|
-
* one of these payment statuses: `UNDEFINED`, `NOT_PAID`, `REFUNDED`, or `EXEMPT`.
|
|
2265
|
+
bookingId?: string | null;
|
|
2266
|
+
/**
|
|
2267
|
+
* Revision number, which increments by 1 each time the booking is updated.
|
|
2268
|
+
* To prevent conflicting changes, the current revision must be specified when managing the booking.
|
|
2274
2269
|
*/
|
|
2275
|
-
|
|
2270
|
+
revision?: string | null;
|
|
2276
2271
|
}
|
|
2277
|
-
interface
|
|
2278
|
-
/**
|
|
2279
|
-
|
|
2280
|
-
/** Total successes and failures of the Bulk Confirm Or Decline call. */
|
|
2281
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
2272
|
+
interface AddBookingsToMultiServiceBookingResponse {
|
|
2273
|
+
/** Single-service bookings that were added to the multi-service booking. */
|
|
2274
|
+
bookings?: BookingResult[];
|
|
2282
2275
|
}
|
|
2283
|
-
interface
|
|
2276
|
+
interface RemoveBookingsFromMultiServiceBookingRequest {
|
|
2284
2277
|
/**
|
|
2285
|
-
*
|
|
2286
|
-
*
|
|
2287
|
-
* successfully created or updated.
|
|
2278
|
+
* ID of the multi-service booking.
|
|
2279
|
+
* @format GUID
|
|
2288
2280
|
*/
|
|
2289
|
-
|
|
2281
|
+
multiServiceBookingId: string | null;
|
|
2290
2282
|
/**
|
|
2291
|
-
*
|
|
2292
|
-
*
|
|
2283
|
+
* List of single-service booking IDs and their revision.
|
|
2284
|
+
* @maxSize 8
|
|
2293
2285
|
*/
|
|
2294
|
-
|
|
2286
|
+
bookings?: BookingIdAndRevision[];
|
|
2287
|
+
/**
|
|
2288
|
+
* Whether to return the single-service bookings.
|
|
2289
|
+
*
|
|
2290
|
+
* Default: `false`
|
|
2291
|
+
*/
|
|
2292
|
+
returnFullEntity?: boolean;
|
|
2293
|
+
}
|
|
2294
|
+
interface RemoveBookingsFromMultiServiceBookingResponse {
|
|
2295
|
+
/** Single-service bookings that were removed from the multi-service booking. */
|
|
2296
|
+
bookings?: BookingResult[];
|
|
2295
2297
|
}
|
|
2296
2298
|
interface BookingChanged {
|
|
2297
2299
|
/** The booking before the changes. */
|
|
@@ -2445,7 +2447,11 @@ interface RescheduleBookingRequest extends RescheduleBookingRequestParticipantsI
|
|
|
2445
2447
|
flowControlSettings?: RescheduleBookingFlowControlSettings;
|
|
2446
2448
|
/**
|
|
2447
2449
|
* List of [add-ons](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction) added to the booking.
|
|
2448
|
-
*
|
|
2450
|
+
*
|
|
2451
|
+
* To replace the booking's the list of booked add-ons, all of these conditions must be met:
|
|
2452
|
+
* - The booking must have been created with `flowControlSettings.allowAddOnChanges` set to `true`.
|
|
2453
|
+
* - You must have `BOOKINGS.MANAGE_ADDONS` permissions.
|
|
2454
|
+
* - For bookings paid via an [eCommerce checkout](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/purchase-flow/checkout/introduction): The related [eCommerce order](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/draft-orders/introduction) must be in a draftable state to correctly adjust the price when modifying add-ons. You can call [Get Order Draftability Status](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/draft-orders/get-order-draftability-status), specifying the order ID to check if it's draftable. If the order isn't draftable, Reschedule Booking still succeeds, but the order's `priceSummary` isn't updated.
|
|
2449
2455
|
* @maxSize 21
|
|
2450
2456
|
*/
|
|
2451
2457
|
bookedAddOns?: BookedAddOn[];
|
|
@@ -3206,6 +3212,22 @@ interface GetSchedulingUrlResponse {
|
|
|
3206
3212
|
schedulingUrl?: string | null;
|
|
3207
3213
|
}
|
|
3208
3214
|
/** @docsIgnore */
|
|
3215
|
+
type ConfirmOrDeclineBookingApplicationErrors = {
|
|
3216
|
+
code?: 'INVALID_BOOKING_STATUS';
|
|
3217
|
+
description?: string;
|
|
3218
|
+
data?: Record<string, any>;
|
|
3219
|
+
} | {
|
|
3220
|
+
code?: 'BOOKING_NOT_FOUND';
|
|
3221
|
+
description?: string;
|
|
3222
|
+
data?: Record<string, any>;
|
|
3223
|
+
};
|
|
3224
|
+
/** @docsIgnore */
|
|
3225
|
+
type BulkConfirmOrDeclineBookingApplicationErrors = {
|
|
3226
|
+
code?: 'DUPLICATED_BOOKINGS';
|
|
3227
|
+
description?: string;
|
|
3228
|
+
data?: Record<string, any>;
|
|
3229
|
+
};
|
|
3230
|
+
/** @docsIgnore */
|
|
3209
3231
|
type CreateMultiServiceBookingApplicationErrors = {
|
|
3210
3232
|
code?: 'VALIDATION_FAILURE';
|
|
3211
3233
|
description?: string;
|
|
@@ -3476,22 +3498,6 @@ type RemoveBookingsFromMultiServiceBookingApplicationErrors = {
|
|
|
3476
3498
|
data?: Record<string, any>;
|
|
3477
3499
|
};
|
|
3478
3500
|
/** @docsIgnore */
|
|
3479
|
-
type ConfirmOrDeclineBookingApplicationErrors = {
|
|
3480
|
-
code?: 'INVALID_BOOKING_STATUS';
|
|
3481
|
-
description?: string;
|
|
3482
|
-
data?: Record<string, any>;
|
|
3483
|
-
} | {
|
|
3484
|
-
code?: 'BOOKING_NOT_FOUND';
|
|
3485
|
-
description?: string;
|
|
3486
|
-
data?: Record<string, any>;
|
|
3487
|
-
};
|
|
3488
|
-
/** @docsIgnore */
|
|
3489
|
-
type BulkConfirmOrDeclineBookingApplicationErrors = {
|
|
3490
|
-
code?: 'DUPLICATED_BOOKINGS';
|
|
3491
|
-
description?: string;
|
|
3492
|
-
data?: Record<string, any>;
|
|
3493
|
-
};
|
|
3494
|
-
/** @docsIgnore */
|
|
3495
3501
|
type CreateBookingApplicationErrors = {
|
|
3496
3502
|
code?: 'SESSION_NOT_FOUND';
|
|
3497
3503
|
description?: string;
|
|
@@ -4012,6 +4018,94 @@ interface BookingNumberOfParticipantsUpdatedEnvelope {
|
|
|
4012
4018
|
* @slug number_of_participants_updated
|
|
4013
4019
|
*/
|
|
4014
4020
|
declare function onBookingNumberOfParticipantsUpdated(handler: (event: BookingNumberOfParticipantsUpdatedEnvelope) => void | Promise<void>): void;
|
|
4021
|
+
/**
|
|
4022
|
+
* Updates the booking `status` to `CONFIRMED`, `PENDING`, or `DECLINED` based
|
|
4023
|
+
* on the `paymentStatus` you provide, double booking conflicts, and whether
|
|
4024
|
+
* the service requires business approval.
|
|
4025
|
+
*
|
|
4026
|
+
* ### eCommerce checkout restriction
|
|
4027
|
+
*
|
|
4028
|
+
* Call this method only when using a custom checkout page.
|
|
4029
|
+
* Don't call it when using a [Wix eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
4030
|
+
* In such cases, Wix Bookings automatically updates the booking status based on the `paymentStatus` of the corresponding [Wix eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction).
|
|
4031
|
+
*
|
|
4032
|
+
* ### When to call Confirm Booking or Decline Booking instead
|
|
4033
|
+
*
|
|
4034
|
+
* This method has specific limitations based on payment status and double booking conflicts.
|
|
4035
|
+
* Use the alternative methods in these scenarios:
|
|
4036
|
+
* + **To force confirm double-booked free bookings:** Call [Confirm Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-booking).
|
|
4037
|
+
* Confirm Or Decline Booking can't confirm double-booked free bookings.
|
|
4038
|
+
* + **To decline bookings without double booking conflicts:** Call [Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/decline-booking).
|
|
4039
|
+
* Confirm Or Decline Booking only declines bookings when both a double booking conflict exists and payment status is unpaid.
|
|
4040
|
+
*
|
|
4041
|
+
* ### New booking status
|
|
4042
|
+
*
|
|
4043
|
+
* The booking `status` is set to `DECLINED` if both of the following conditions
|
|
4044
|
+
* are met:
|
|
4045
|
+
* + You provide `UNDEFINED`, `NOT_PAID`, `REFUNDED`, or `EXEMPT` as payment status.
|
|
4046
|
+
* + There is a double booking conflict.
|
|
4047
|
+
*
|
|
4048
|
+
* If only one or none of these conditions is met, `status` is set to `PENDING`
|
|
4049
|
+
* or `CONFIRMED` depending on whether the service requires business approval.
|
|
4050
|
+
*
|
|
4051
|
+
* ### Double bookings
|
|
4052
|
+
*
|
|
4053
|
+
* If there is a double booking conflict, but the booking has already been at least
|
|
4054
|
+
* partially paid, the method still marks the booking as `PENDING` or `CONFIRMED`.
|
|
4055
|
+
* Then, it also sets `doubleBooked` to `true`.
|
|
4056
|
+
*
|
|
4057
|
+
* ### Admin overwrites
|
|
4058
|
+
*
|
|
4059
|
+
* There are small but important differences in confirmation behavior if the
|
|
4060
|
+
* booking was created with special `flowControlSettings`:
|
|
4061
|
+
* + If the booking's `flowControlSettings.skipAvailabilityValidation` was set to
|
|
4062
|
+
* `true`, the booking is never declined regardless of double booking conflicts.
|
|
4063
|
+
* Instead, it's marked `CONFIRMED` or `PENDING`, depending on whether the
|
|
4064
|
+
* service requires business approval.
|
|
4065
|
+
* + If the booking's `flowControlSettings.skipBusinessConfirmation` was set to
|
|
4066
|
+
* `true`, the booking skips `PENDING` status and is marked `CONFIRMED`
|
|
4067
|
+
* immediately.
|
|
4068
|
+
* @param bookingId - ID of the booking to confirm or decline.
|
|
4069
|
+
* @public
|
|
4070
|
+
* @requiredField bookingId
|
|
4071
|
+
* @permissionId BOOKINGS.BOOKING_CONFIRM_OR_DECLINE
|
|
4072
|
+
* @applicableIdentity APP
|
|
4073
|
+
* @fqn com.wixpress.bookings.confirmator.v2.Confirmator.ConfirmOrDeclineBooking
|
|
4074
|
+
*/
|
|
4075
|
+
declare function confirmOrDeclineBooking(bookingId: string, options?: ConfirmOrDeclineBookingOptions): Promise<NonNullablePaths<ConfirmOrDeclineBookingResponse, `booking.totalParticipants` | `booking.participantsChoices.serviceChoices` | `booking.bookedEntity.slot.serviceId` | `booking.bookedEntity.slot.scheduleId` | `booking.bookedEntity.slot.resource._id` | `booking.bookedEntity.slot.location.locationType` | `booking.bookedEntity.slot.resourceSelections` | `booking.bookedEntity.slot.resourceSelections.${number}.selectionMethod` | `booking.bookedEntity.schedule.scheduleId` | `booking.bookedEntity.tags` | `booking.contactDetails.fullAddress.streetAddress.number` | `booking.contactDetails.fullAddress.streetAddress.name` | `booking.contactDetails.fullAddress.streetAddress.apt` | `booking.contactDetails.fullAddress.subdivisions` | `booking.contactDetails.fullAddress.subdivisions.${number}.code` | `booking.contactDetails.fullAddress.subdivisions.${number}.name` | `booking.additionalFields` | `booking.additionalFields.${number}._id` | `booking.additionalFields.${number}.valueType` | `booking.status` | `booking.paymentStatus` | `booking.selectedPaymentOption` | `booking.createdBy.anonymousVisitorId` | `booking.createdBy.memberId` | `booking.createdBy.wixUserId` | `booking.createdBy.appId` | `booking.bookedAddOns` | `booking.bookedAddOns.${number}._id` | `booking.bookedAddOns.${number}.groupId`, 7> & {
|
|
4076
|
+
__applicationErrorsType?: ConfirmOrDeclineBookingApplicationErrors;
|
|
4077
|
+
}>;
|
|
4078
|
+
interface ConfirmOrDeclineBookingOptions {
|
|
4079
|
+
/**
|
|
4080
|
+
* Current payment status of the booking when using a custom checkout page and
|
|
4081
|
+
* not the [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
4082
|
+
*
|
|
4083
|
+
* The booking is declined if there is a double booking conflict and you provide
|
|
4084
|
+
* one of these payment statuses: `UNDEFINED`, `NOT_PAID`, `REFUNDED`, or `EXEMPT`.
|
|
4085
|
+
*/
|
|
4086
|
+
paymentStatus?: PaymentStatusWithLiterals;
|
|
4087
|
+
}
|
|
4088
|
+
/**
|
|
4089
|
+
* Confirms or declines up to 300 bookings.
|
|
4090
|
+
*
|
|
4091
|
+
*
|
|
4092
|
+
* See [Confirm Or Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking)
|
|
4093
|
+
* for details about when a booking is confirmed or declined.
|
|
4094
|
+
* @param details - Bookings to confirm or decline.
|
|
4095
|
+
* @public
|
|
4096
|
+
* @requiredField details
|
|
4097
|
+
* @requiredField details.bookingId
|
|
4098
|
+
* @permissionId BOOKINGS.BOOKING_CONFIRM_OR_DECLINE
|
|
4099
|
+
* @applicableIdentity APP
|
|
4100
|
+
* @fqn com.wixpress.bookings.confirmator.v2.Confirmator.BulkConfirmOrDeclineBooking
|
|
4101
|
+
*/
|
|
4102
|
+
declare function bulkConfirmOrDeclineBooking(details: NonNullablePaths<BulkConfirmOrDeclineBookingRequestBookingDetails, `bookingId`, 2>[], options?: BulkConfirmOrDeclineBookingOptions): Promise<NonNullablePaths<BulkConfirmOrDeclineBookingResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.totalParticipants` | `results.${number}.item.status` | `results.${number}.item.paymentStatus` | `results.${number}.item.selectedPaymentOption` | `results.${number}.item.createdBy.anonymousVisitorId` | `results.${number}.item.createdBy.memberId` | `results.${number}.item.createdBy.wixUserId` | `results.${number}.item.createdBy.appId` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6> & {
|
|
4103
|
+
__applicationErrorsType?: BulkConfirmOrDeclineBookingApplicationErrors;
|
|
4104
|
+
}>;
|
|
4105
|
+
interface BulkConfirmOrDeclineBookingOptions {
|
|
4106
|
+
/** Whether to return the confirmed or declined booking objects. */
|
|
4107
|
+
returnEntity?: boolean;
|
|
4108
|
+
}
|
|
4015
4109
|
/**
|
|
4016
4110
|
* Creates a multi-service booking and all included single-service bookings simultaneously.
|
|
4017
4111
|
*
|
|
@@ -4475,94 +4569,6 @@ interface RemoveBookingsFromMultiServiceBookingOptions {
|
|
|
4475
4569
|
*/
|
|
4476
4570
|
returnFullEntity?: boolean;
|
|
4477
4571
|
}
|
|
4478
|
-
/**
|
|
4479
|
-
* Updates the booking `status` to `CONFIRMED`, `PENDING`, or `DECLINED` based
|
|
4480
|
-
* on the `paymentStatus` you provide, double booking conflicts, and whether
|
|
4481
|
-
* the service requires business approval.
|
|
4482
|
-
*
|
|
4483
|
-
* ### eCommerce checkout restriction
|
|
4484
|
-
*
|
|
4485
|
-
* Call this method only when using a custom checkout page.
|
|
4486
|
-
* Don't call it when using a [Wix eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
4487
|
-
* In such cases, Wix Bookings automatically updates the booking status based on the `paymentStatus` of the corresponding [Wix eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction).
|
|
4488
|
-
*
|
|
4489
|
-
* ### When to call Confirm Booking or Decline Booking instead
|
|
4490
|
-
*
|
|
4491
|
-
* This method has specific limitations based on payment status and double booking conflicts.
|
|
4492
|
-
* Use the alternative methods in these scenarios:
|
|
4493
|
-
* + **To force confirm double-booked free bookings:** Call [Confirm Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-booking).
|
|
4494
|
-
* Confirm Or Decline Booking can't confirm double-booked free bookings.
|
|
4495
|
-
* + **To decline bookings without double booking conflicts:** Call [Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/decline-booking).
|
|
4496
|
-
* Confirm Or Decline Booking only declines bookings when both a double booking conflict exists and payment status is unpaid.
|
|
4497
|
-
*
|
|
4498
|
-
* ### New booking status
|
|
4499
|
-
*
|
|
4500
|
-
* The booking `status` is set to `DECLINED` if both of the following conditions
|
|
4501
|
-
* are met:
|
|
4502
|
-
* + You provide `UNDEFINED`, `NOT_PAID`, `REFUNDED`, or `EXEMPT` as payment status.
|
|
4503
|
-
* + There is a double booking conflict.
|
|
4504
|
-
*
|
|
4505
|
-
* If only one or none of these conditions is met, `status` is set to `PENDING`
|
|
4506
|
-
* or `CONFIRMED` depending on whether the service requires business approval.
|
|
4507
|
-
*
|
|
4508
|
-
* ### Double bookings
|
|
4509
|
-
*
|
|
4510
|
-
* If there is a double booking conflict, but the booking has already been at least
|
|
4511
|
-
* partially paid, the method still marks the booking as `PENDING` or `CONFIRMED`.
|
|
4512
|
-
* Then, it also sets `doubleBooked` to `true`.
|
|
4513
|
-
*
|
|
4514
|
-
* ### Admin overwrites
|
|
4515
|
-
*
|
|
4516
|
-
* There are small but important differences in confirmation behavior if the
|
|
4517
|
-
* booking was created with special `flowControlSettings`:
|
|
4518
|
-
* + If the booking's `flowControlSettings.skipAvailabilityValidation` was set to
|
|
4519
|
-
* `true`, the booking is never declined regardless of double booking conflicts.
|
|
4520
|
-
* Instead, it's marked `CONFIRMED` or `PENDING`, depending on whether the
|
|
4521
|
-
* service requires business approval.
|
|
4522
|
-
* + If the booking's `flowControlSettings.skipBusinessConfirmation` was set to
|
|
4523
|
-
* `true`, the booking skips `PENDING` status and is marked `CONFIRMED`
|
|
4524
|
-
* immediately.
|
|
4525
|
-
* @param bookingId - ID of the booking to confirm or decline.
|
|
4526
|
-
* @public
|
|
4527
|
-
* @requiredField bookingId
|
|
4528
|
-
* @permissionId BOOKINGS.BOOKING_CONFIRM_OR_DECLINE
|
|
4529
|
-
* @applicableIdentity APP
|
|
4530
|
-
* @fqn com.wixpress.bookings.confirmator.v2.Confirmator.ConfirmOrDeclineBooking
|
|
4531
|
-
*/
|
|
4532
|
-
declare function confirmOrDeclineBooking(bookingId: string, options?: ConfirmOrDeclineBookingOptions): Promise<NonNullablePaths<ConfirmOrDeclineBookingResponse, `booking.totalParticipants` | `booking.participantsChoices.serviceChoices` | `booking.bookedEntity.slot.serviceId` | `booking.bookedEntity.slot.scheduleId` | `booking.bookedEntity.slot.resource._id` | `booking.bookedEntity.slot.location.locationType` | `booking.bookedEntity.slot.resourceSelections` | `booking.bookedEntity.slot.resourceSelections.${number}.selectionMethod` | `booking.bookedEntity.schedule.scheduleId` | `booking.bookedEntity.tags` | `booking.contactDetails.fullAddress.streetAddress.number` | `booking.contactDetails.fullAddress.streetAddress.name` | `booking.contactDetails.fullAddress.streetAddress.apt` | `booking.contactDetails.fullAddress.subdivisions` | `booking.contactDetails.fullAddress.subdivisions.${number}.code` | `booking.contactDetails.fullAddress.subdivisions.${number}.name` | `booking.additionalFields` | `booking.additionalFields.${number}._id` | `booking.additionalFields.${number}.valueType` | `booking.status` | `booking.paymentStatus` | `booking.selectedPaymentOption` | `booking.createdBy.anonymousVisitorId` | `booking.createdBy.memberId` | `booking.createdBy.wixUserId` | `booking.createdBy.appId` | `booking.bookedAddOns` | `booking.bookedAddOns.${number}._id` | `booking.bookedAddOns.${number}.groupId`, 7> & {
|
|
4533
|
-
__applicationErrorsType?: ConfirmOrDeclineBookingApplicationErrors;
|
|
4534
|
-
}>;
|
|
4535
|
-
interface ConfirmOrDeclineBookingOptions {
|
|
4536
|
-
/**
|
|
4537
|
-
* Current payment status of the booking when using a custom checkout page and
|
|
4538
|
-
* not the [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
4539
|
-
*
|
|
4540
|
-
* The booking is declined if there is a double booking conflict and you provide
|
|
4541
|
-
* one of these payment statuses: `UNDEFINED`, `NOT_PAID`, `REFUNDED`, or `EXEMPT`.
|
|
4542
|
-
*/
|
|
4543
|
-
paymentStatus?: PaymentStatusWithLiterals;
|
|
4544
|
-
}
|
|
4545
|
-
/**
|
|
4546
|
-
* Confirms or declines up to 300 bookings.
|
|
4547
|
-
*
|
|
4548
|
-
*
|
|
4549
|
-
* See [Confirm Or Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings/bookings-writer-v2/confirm-or-decline-booking)
|
|
4550
|
-
* for details about when a booking is confirmed or declined.
|
|
4551
|
-
* @param details - Bookings to confirm or decline.
|
|
4552
|
-
* @public
|
|
4553
|
-
* @requiredField details
|
|
4554
|
-
* @requiredField details.bookingId
|
|
4555
|
-
* @permissionId BOOKINGS.BOOKING_CONFIRM_OR_DECLINE
|
|
4556
|
-
* @applicableIdentity APP
|
|
4557
|
-
* @fqn com.wixpress.bookings.confirmator.v2.Confirmator.BulkConfirmOrDeclineBooking
|
|
4558
|
-
*/
|
|
4559
|
-
declare function bulkConfirmOrDeclineBooking(details: NonNullablePaths<BulkConfirmOrDeclineBookingRequestBookingDetails, `bookingId`, 2>[], options?: BulkConfirmOrDeclineBookingOptions): Promise<NonNullablePaths<BulkConfirmOrDeclineBookingResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.totalParticipants` | `results.${number}.item.status` | `results.${number}.item.paymentStatus` | `results.${number}.item.selectedPaymentOption` | `results.${number}.item.createdBy.anonymousVisitorId` | `results.${number}.item.createdBy.memberId` | `results.${number}.item.createdBy.wixUserId` | `results.${number}.item.createdBy.appId` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6> & {
|
|
4560
|
-
__applicationErrorsType?: BulkConfirmOrDeclineBookingApplicationErrors;
|
|
4561
|
-
}>;
|
|
4562
|
-
interface BulkConfirmOrDeclineBookingOptions {
|
|
4563
|
-
/** Whether to return the confirmed or declined booking objects. */
|
|
4564
|
-
returnEntity?: boolean;
|
|
4565
|
-
}
|
|
4566
4572
|
/**
|
|
4567
4573
|
* Creates a booking.
|
|
4568
4574
|
*
|
|
@@ -4777,6 +4783,15 @@ interface BulkCreateBookingOptions {
|
|
|
4777
4783
|
* to avoid failed Reschedule Booking calls due to unavailability. Specify
|
|
4778
4784
|
* only `slot.eventId` instead of the entire `slot` object.
|
|
4779
4785
|
*
|
|
4786
|
+
* ### Add-ons
|
|
4787
|
+
*
|
|
4788
|
+
* You can call Reschedule Booking to replace the list of [add-ons](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction) associated with the booking.
|
|
4789
|
+
*
|
|
4790
|
+
* To do so, all of these conditions must be met:
|
|
4791
|
+
* - The booking must have been created with `flowControlSettings.allowAddOnChanges` set to `true`.
|
|
4792
|
+
* - You must have `BOOKINGS.MANAGE_ADDONS` permissions.
|
|
4793
|
+
* - For bookings paid via an [eCommerce checkout](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/purchase-flow/checkout/introduction): The related [eCommerce order](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/draft-orders/introduction) must be in a draftable state to correctly adjust the price when modifying add-ons. You can call [Get Order Draftability Status](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/draft-orders/get-order-draftability-status), specifying the order ID to check if it's draftable. If the order isn't draftable, Reschedule Booking still succeeds, but the order's `priceSummary` isn't updated.
|
|
4794
|
+
*
|
|
4780
4795
|
* ### Notify customers
|
|
4781
4796
|
*
|
|
4782
4797
|
* You can specify a `participantNotification.message` for the customer. To send
|
|
@@ -4855,7 +4870,11 @@ interface RescheduleBookingOptions extends RescheduleBookingOptionsParticipantsI
|
|
|
4855
4870
|
participantsChoices?: ParticipantChoices;
|
|
4856
4871
|
/**
|
|
4857
4872
|
* List of [add-ons](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction) added to the booking.
|
|
4858
|
-
*
|
|
4873
|
+
*
|
|
4874
|
+
* To replace the booking's the list of booked add-ons, all of these conditions must be met:
|
|
4875
|
+
* - The booking must have been created with `flowControlSettings.allowAddOnChanges` set to `true`.
|
|
4876
|
+
* - You must have `BOOKINGS.MANAGE_ADDONS` permissions.
|
|
4877
|
+
* - For bookings paid via an [eCommerce checkout](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/purchase-flow/checkout/introduction): The related [eCommerce order](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/draft-orders/introduction) must be in a draftable state to correctly adjust the price when modifying add-ons. You can call [Get Order Draftability Status](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/draft-orders/get-order-draftability-status), specifying the order ID to check if it's draftable. If the order isn't draftable, Reschedule Booking still succeeds, but the order's `priceSummary` isn't updated.
|
|
4859
4878
|
* @maxSize 21
|
|
4860
4879
|
*/
|
|
4861
4880
|
bookedAddOns?: BookedAddOn[];
|
|
@@ -5392,7 +5411,7 @@ declare function getBookingAnonymously(token: string): Promise<NonNullablePaths<
|
|
|
5392
5411
|
* Get scheduling URL for a service
|
|
5393
5412
|
* The scheduling URL can be shared with customers to allow them to book a service.
|
|
5394
5413
|
* @param serviceId - ID of the service for which to get the scheduling URL.
|
|
5395
|
-
* @
|
|
5414
|
+
* @internal
|
|
5396
5415
|
* @documentationMaturity preview
|
|
5397
5416
|
* @requiredField serviceId
|
|
5398
5417
|
* @permissionId BOOKINGS.ANONYMOUS_BOOKING_ACTIONS_READ
|