@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
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { CreateMultiServiceBookingRequest as CreateMultiServiceBookingRequest$1, CreateMultiServiceBookingResponse as CreateMultiServiceBookingResponse$1, RescheduleMultiServiceBookingRequest as RescheduleMultiServiceBookingRequest$1, RescheduleMultiServiceBookingResponse as RescheduleMultiServiceBookingResponse$1, GetMultiServiceBookingAvailabilityRequest as GetMultiServiceBookingAvailabilityRequest$1, GetMultiServiceBookingAvailabilityResponse as GetMultiServiceBookingAvailabilityResponse$1, CancelMultiServiceBookingRequest as CancelMultiServiceBookingRequest$1, CancelMultiServiceBookingResponse as CancelMultiServiceBookingResponse$1, MarkMultiServiceBookingAsPendingRequest as MarkMultiServiceBookingAsPendingRequest$1, MarkMultiServiceBookingAsPendingResponse as MarkMultiServiceBookingAsPendingResponse$1, ConfirmMultiServiceBookingRequest as ConfirmMultiServiceBookingRequest$1, ConfirmMultiServiceBookingResponse as ConfirmMultiServiceBookingResponse$1, DeclineMultiServiceBookingRequest as DeclineMultiServiceBookingRequest$1, DeclineMultiServiceBookingResponse as DeclineMultiServiceBookingResponse$1, BulkGetMultiServiceBookingAllowedActionsRequest as BulkGetMultiServiceBookingAllowedActionsRequest$1, BulkGetMultiServiceBookingAllowedActionsResponse as BulkGetMultiServiceBookingAllowedActionsResponse$1, GetMultiServiceBookingRequest as GetMultiServiceBookingRequest$1, GetMultiServiceBookingResponse as GetMultiServiceBookingResponse$1, AddBookingsToMultiServiceBookingRequest as AddBookingsToMultiServiceBookingRequest$1, AddBookingsToMultiServiceBookingResponse as AddBookingsToMultiServiceBookingResponse$1, RemoveBookingsFromMultiServiceBookingRequest as RemoveBookingsFromMultiServiceBookingRequest$1, RemoveBookingsFromMultiServiceBookingResponse as RemoveBookingsFromMultiServiceBookingResponse$1,
|
|
1
|
+
import { ConfirmOrDeclineBookingRequest as ConfirmOrDeclineBookingRequest$1, ConfirmOrDeclineBookingResponse as ConfirmOrDeclineBookingResponse$1, BulkConfirmOrDeclineBookingRequest as BulkConfirmOrDeclineBookingRequest$1, BulkConfirmOrDeclineBookingResponse as BulkConfirmOrDeclineBookingResponse$1, CreateMultiServiceBookingRequest as CreateMultiServiceBookingRequest$1, CreateMultiServiceBookingResponse as CreateMultiServiceBookingResponse$1, RescheduleMultiServiceBookingRequest as RescheduleMultiServiceBookingRequest$1, RescheduleMultiServiceBookingResponse as RescheduleMultiServiceBookingResponse$1, GetMultiServiceBookingAvailabilityRequest as GetMultiServiceBookingAvailabilityRequest$1, GetMultiServiceBookingAvailabilityResponse as GetMultiServiceBookingAvailabilityResponse$1, CancelMultiServiceBookingRequest as CancelMultiServiceBookingRequest$1, CancelMultiServiceBookingResponse as CancelMultiServiceBookingResponse$1, MarkMultiServiceBookingAsPendingRequest as MarkMultiServiceBookingAsPendingRequest$1, MarkMultiServiceBookingAsPendingResponse as MarkMultiServiceBookingAsPendingResponse$1, ConfirmMultiServiceBookingRequest as ConfirmMultiServiceBookingRequest$1, ConfirmMultiServiceBookingResponse as ConfirmMultiServiceBookingResponse$1, DeclineMultiServiceBookingRequest as DeclineMultiServiceBookingRequest$1, DeclineMultiServiceBookingResponse as DeclineMultiServiceBookingResponse$1, BulkGetMultiServiceBookingAllowedActionsRequest as BulkGetMultiServiceBookingAllowedActionsRequest$1, BulkGetMultiServiceBookingAllowedActionsResponse as BulkGetMultiServiceBookingAllowedActionsResponse$1, GetMultiServiceBookingRequest as GetMultiServiceBookingRequest$1, GetMultiServiceBookingResponse as GetMultiServiceBookingResponse$1, AddBookingsToMultiServiceBookingRequest as AddBookingsToMultiServiceBookingRequest$1, AddBookingsToMultiServiceBookingResponse as AddBookingsToMultiServiceBookingResponse$1, RemoveBookingsFromMultiServiceBookingRequest as RemoveBookingsFromMultiServiceBookingRequest$1, RemoveBookingsFromMultiServiceBookingResponse as RemoveBookingsFromMultiServiceBookingResponse$1, CreateBookingRequest as CreateBookingRequest$1, CreateBookingResponse as CreateBookingResponse$1, BulkCreateBookingRequest as BulkCreateBookingRequest$1, BulkCreateBookingResponse as BulkCreateBookingResponse$1, RescheduleBookingRequest as RescheduleBookingRequest$1, RescheduleBookingResponse as RescheduleBookingResponse$1, ConfirmBookingRequest as ConfirmBookingRequest$1, ConfirmBookingResponse as ConfirmBookingResponse$1, SetBookingSubmissionIdRequest as SetBookingSubmissionIdRequest$1, SetBookingSubmissionIdResponse as SetBookingSubmissionIdResponse$1, UpdateExtendedFieldsRequest as UpdateExtendedFieldsRequest$1, UpdateExtendedFieldsResponse as UpdateExtendedFieldsResponse$1, DeclineBookingRequest as DeclineBookingRequest$1, DeclineBookingResponse as DeclineBookingResponse$1, CancelBookingRequest as CancelBookingRequest$1, CancelBookingResponse as CancelBookingResponse$1, UpdateNumberOfParticipantsRequest as UpdateNumberOfParticipantsRequest$1, UpdateNumberOfParticipantsResponse as UpdateNumberOfParticipantsResponse$1, BulkCalculateAllowedActionsRequest as BulkCalculateAllowedActionsRequest$1, BulkCalculateAllowedActionsResponse as BulkCalculateAllowedActionsResponse$1, MarkBookingAsPendingRequest as MarkBookingAsPendingRequest$1, MarkBookingAsPendingResponse as MarkBookingAsPendingResponse$1, GetAnonymousActionDetailsRequest as GetAnonymousActionDetailsRequest$1, GetAnonymousActionDetailsResponse as GetAnonymousActionDetailsResponse$1, CancelBookingAnonymouslyRequest as CancelBookingAnonymouslyRequest$1, CancelBookingAnonymouslyResponse as CancelBookingAnonymouslyResponse$1, RescheduleBookingAnonymouslyRequest as RescheduleBookingAnonymouslyRequest$1, RescheduleBookingAnonymouslyResponse as RescheduleBookingAnonymouslyResponse$1, GetBookingAnonymouslyRequest as GetBookingAnonymouslyRequest$1, GetBookingAnonymouslyResponse as GetBookingAnonymouslyResponse$1, GetSchedulingUrlRequest as GetSchedulingUrlRequest$1, GetSchedulingUrlResponse as GetSchedulingUrlResponse$1 } from './index.typings.mjs';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
/** An entity representing a scheduled appointment, class session, or course. */
|
|
@@ -885,6 +885,231 @@ interface BookingFormFilled {
|
|
|
885
885
|
*/
|
|
886
886
|
formId?: string | null;
|
|
887
887
|
}
|
|
888
|
+
interface ConfirmOrDeclineBookingRequest {
|
|
889
|
+
/**
|
|
890
|
+
* ID of the booking to confirm or decline.
|
|
891
|
+
* @format GUID
|
|
892
|
+
*/
|
|
893
|
+
bookingId: string;
|
|
894
|
+
/**
|
|
895
|
+
* Current payment status of the booking when using a custom checkout page and
|
|
896
|
+
* not the [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
897
|
+
*
|
|
898
|
+
* The booking is declined if there is a double booking conflict and you provide
|
|
899
|
+
* one of these payment statuses: `UNDEFINED`, `NOT_PAID`, `REFUNDED`, or `EXEMPT`.
|
|
900
|
+
*/
|
|
901
|
+
paymentStatus?: PaymentStatusWithLiterals;
|
|
902
|
+
}
|
|
903
|
+
interface ConfirmOrDeclineBookingResponse {
|
|
904
|
+
/** Updated booking. */
|
|
905
|
+
booking?: Booking;
|
|
906
|
+
}
|
|
907
|
+
interface BulkConfirmOrDeclineBookingRequest {
|
|
908
|
+
/**
|
|
909
|
+
* Bookings to confirm or decline.
|
|
910
|
+
* @minSize 1
|
|
911
|
+
* @maxSize 300
|
|
912
|
+
*/
|
|
913
|
+
details: BulkConfirmOrDeclineBookingRequestBookingDetails[];
|
|
914
|
+
/** Whether to return the confirmed or declined booking objects. */
|
|
915
|
+
returnEntity?: boolean;
|
|
916
|
+
}
|
|
917
|
+
interface BulkConfirmOrDeclineBookingRequestBookingDetails {
|
|
918
|
+
/**
|
|
919
|
+
* ID of the booking to confirm or decline.
|
|
920
|
+
* @format GUID
|
|
921
|
+
*/
|
|
922
|
+
bookingId?: string;
|
|
923
|
+
/**
|
|
924
|
+
* Current payment status of the booking when using a custom checkout page and
|
|
925
|
+
* not the [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
926
|
+
*
|
|
927
|
+
* The booking is declined if there is a double booking conflict and you provide
|
|
928
|
+
* one of these payment statuses: `UNDEFINED`, `NOT_PAID`, `REFUNDED`, or `EXEMPT`.
|
|
929
|
+
*/
|
|
930
|
+
paymentStatus?: PaymentStatusWithLiterals;
|
|
931
|
+
}
|
|
932
|
+
interface BulkConfirmOrDeclineBookingResponse {
|
|
933
|
+
/** List of confirmed or declined bookings, including metadata. */
|
|
934
|
+
results?: BulkBookingResult[];
|
|
935
|
+
/** Total successes and failures of the Bulk Confirm Or Decline call. */
|
|
936
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
937
|
+
}
|
|
938
|
+
interface BulkBookingResult {
|
|
939
|
+
/**
|
|
940
|
+
* Information about the booking that was created or updated.
|
|
941
|
+
* Including its ID, index in the bulk request and whether it was
|
|
942
|
+
* successfully created or updated.
|
|
943
|
+
*/
|
|
944
|
+
itemMetadata?: ItemMetadata;
|
|
945
|
+
/**
|
|
946
|
+
* Created or updated booking. Available only if you requested
|
|
947
|
+
* to return the booking entity.
|
|
948
|
+
*/
|
|
949
|
+
item?: Booking;
|
|
950
|
+
}
|
|
951
|
+
interface ItemMetadata {
|
|
952
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
953
|
+
id?: string | null;
|
|
954
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
955
|
+
originalIndex?: number;
|
|
956
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
957
|
+
success?: boolean;
|
|
958
|
+
/** Details about the error in case of failure. */
|
|
959
|
+
error?: ApplicationError;
|
|
960
|
+
}
|
|
961
|
+
interface ApplicationError {
|
|
962
|
+
/** Error code. */
|
|
963
|
+
code?: string;
|
|
964
|
+
/** Description of the error. */
|
|
965
|
+
description?: string;
|
|
966
|
+
/** Data related to the error. */
|
|
967
|
+
data?: Record<string, any> | null;
|
|
968
|
+
}
|
|
969
|
+
interface BulkActionMetadata {
|
|
970
|
+
/** Number of items that were successfully processed. */
|
|
971
|
+
totalSuccesses?: number;
|
|
972
|
+
/** Number of items that couldn't be processed. */
|
|
973
|
+
totalFailures?: number;
|
|
974
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
975
|
+
undetailedFailures?: number;
|
|
976
|
+
}
|
|
977
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
978
|
+
createdEvent?: EntityCreatedEvent;
|
|
979
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
980
|
+
deletedEvent?: EntityDeletedEvent;
|
|
981
|
+
actionEvent?: ActionEvent;
|
|
982
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
983
|
+
id?: string;
|
|
984
|
+
/**
|
|
985
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
986
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
987
|
+
*/
|
|
988
|
+
entityFqdn?: string;
|
|
989
|
+
/**
|
|
990
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
991
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
992
|
+
*/
|
|
993
|
+
slug?: string;
|
|
994
|
+
/** ID of the entity associated with the event. */
|
|
995
|
+
entityId?: string;
|
|
996
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
997
|
+
eventTime?: Date | null;
|
|
998
|
+
/**
|
|
999
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1000
|
+
* (for example, GDPR).
|
|
1001
|
+
*/
|
|
1002
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1003
|
+
/** If present, indicates the action that triggered the event. */
|
|
1004
|
+
originatedFrom?: string | null;
|
|
1005
|
+
/**
|
|
1006
|
+
* 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.
|
|
1007
|
+
* 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.
|
|
1008
|
+
*/
|
|
1009
|
+
entityEventSequence?: string | null;
|
|
1010
|
+
}
|
|
1011
|
+
/** @oneof */
|
|
1012
|
+
interface DomainEventBodyOneOf {
|
|
1013
|
+
createdEvent?: EntityCreatedEvent;
|
|
1014
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
1015
|
+
deletedEvent?: EntityDeletedEvent;
|
|
1016
|
+
actionEvent?: ActionEvent;
|
|
1017
|
+
}
|
|
1018
|
+
interface EntityCreatedEvent {
|
|
1019
|
+
entityAsJson?: string;
|
|
1020
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
1021
|
+
restoreInfo?: RestoreInfo;
|
|
1022
|
+
}
|
|
1023
|
+
interface RestoreInfo {
|
|
1024
|
+
deletedDate?: Date | null;
|
|
1025
|
+
}
|
|
1026
|
+
interface EntityUpdatedEvent {
|
|
1027
|
+
/**
|
|
1028
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1029
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1030
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1031
|
+
*/
|
|
1032
|
+
currentEntityAsJson?: string;
|
|
1033
|
+
}
|
|
1034
|
+
interface EntityDeletedEvent {
|
|
1035
|
+
/** Entity that was deleted. */
|
|
1036
|
+
deletedEntityAsJson?: string | null;
|
|
1037
|
+
}
|
|
1038
|
+
interface ActionEvent {
|
|
1039
|
+
bodyAsJson?: string;
|
|
1040
|
+
}
|
|
1041
|
+
interface MessageEnvelope {
|
|
1042
|
+
/**
|
|
1043
|
+
* App instance ID.
|
|
1044
|
+
* @format GUID
|
|
1045
|
+
*/
|
|
1046
|
+
instanceId?: string | null;
|
|
1047
|
+
/**
|
|
1048
|
+
* Event type.
|
|
1049
|
+
* @maxLength 150
|
|
1050
|
+
*/
|
|
1051
|
+
eventType?: string;
|
|
1052
|
+
/** The identification type and identity data. */
|
|
1053
|
+
identity?: WebhooksIdentificationData;
|
|
1054
|
+
/** Stringify payload. */
|
|
1055
|
+
data?: string;
|
|
1056
|
+
}
|
|
1057
|
+
interface WebhooksIdentificationData extends WebhooksIdentificationDataIdOneOf {
|
|
1058
|
+
/**
|
|
1059
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1060
|
+
* @format GUID
|
|
1061
|
+
*/
|
|
1062
|
+
anonymousVisitorId?: string;
|
|
1063
|
+
/**
|
|
1064
|
+
* ID of a site visitor that has logged in to the site.
|
|
1065
|
+
* @format GUID
|
|
1066
|
+
*/
|
|
1067
|
+
memberId?: string;
|
|
1068
|
+
/**
|
|
1069
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1070
|
+
* @format GUID
|
|
1071
|
+
*/
|
|
1072
|
+
wixUserId?: string;
|
|
1073
|
+
/**
|
|
1074
|
+
* ID of an app.
|
|
1075
|
+
* @format GUID
|
|
1076
|
+
*/
|
|
1077
|
+
appId?: string;
|
|
1078
|
+
/** @readonly */
|
|
1079
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1080
|
+
}
|
|
1081
|
+
/** @oneof */
|
|
1082
|
+
interface WebhooksIdentificationDataIdOneOf {
|
|
1083
|
+
/**
|
|
1084
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1085
|
+
* @format GUID
|
|
1086
|
+
*/
|
|
1087
|
+
anonymousVisitorId?: string;
|
|
1088
|
+
/**
|
|
1089
|
+
* ID of a site visitor that has logged in to the site.
|
|
1090
|
+
* @format GUID
|
|
1091
|
+
*/
|
|
1092
|
+
memberId?: string;
|
|
1093
|
+
/**
|
|
1094
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1095
|
+
* @format GUID
|
|
1096
|
+
*/
|
|
1097
|
+
wixUserId?: string;
|
|
1098
|
+
/**
|
|
1099
|
+
* ID of an app.
|
|
1100
|
+
* @format GUID
|
|
1101
|
+
*/
|
|
1102
|
+
appId?: string;
|
|
1103
|
+
}
|
|
1104
|
+
declare enum WebhookIdentityType {
|
|
1105
|
+
UNKNOWN = "UNKNOWN",
|
|
1106
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1107
|
+
MEMBER = "MEMBER",
|
|
1108
|
+
WIX_USER = "WIX_USER",
|
|
1109
|
+
APP = "APP"
|
|
1110
|
+
}
|
|
1111
|
+
/** @enumType */
|
|
1112
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
888
1113
|
interface V2CreateBookingRequest extends V2CreateBookingRequestBookableItemOneOf, V2CreateBookingRequestParticipantsInfoOneOf {
|
|
889
1114
|
/**
|
|
890
1115
|
* Information about the slot to create a booking for.
|
|
@@ -1268,142 +1493,6 @@ interface V2UpdateNumberOfParticipantsResponse {
|
|
|
1268
1493
|
/** Booking with updated number of participants. */
|
|
1269
1494
|
booking?: Booking;
|
|
1270
1495
|
}
|
|
1271
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1272
|
-
createdEvent?: EntityCreatedEvent;
|
|
1273
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
1274
|
-
deletedEvent?: EntityDeletedEvent;
|
|
1275
|
-
actionEvent?: ActionEvent;
|
|
1276
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1277
|
-
id?: string;
|
|
1278
|
-
/**
|
|
1279
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
1280
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
1281
|
-
*/
|
|
1282
|
-
entityFqdn?: string;
|
|
1283
|
-
/**
|
|
1284
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
1285
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
1286
|
-
*/
|
|
1287
|
-
slug?: string;
|
|
1288
|
-
/** ID of the entity associated with the event. */
|
|
1289
|
-
entityId?: string;
|
|
1290
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
1291
|
-
eventTime?: Date | null;
|
|
1292
|
-
/**
|
|
1293
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
1294
|
-
* (for example, GDPR).
|
|
1295
|
-
*/
|
|
1296
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
1297
|
-
/** If present, indicates the action that triggered the event. */
|
|
1298
|
-
originatedFrom?: string | null;
|
|
1299
|
-
/**
|
|
1300
|
-
* 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.
|
|
1301
|
-
* 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.
|
|
1302
|
-
*/
|
|
1303
|
-
entityEventSequence?: string | null;
|
|
1304
|
-
}
|
|
1305
|
-
/** @oneof */
|
|
1306
|
-
interface DomainEventBodyOneOf {
|
|
1307
|
-
createdEvent?: EntityCreatedEvent;
|
|
1308
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
1309
|
-
deletedEvent?: EntityDeletedEvent;
|
|
1310
|
-
actionEvent?: ActionEvent;
|
|
1311
|
-
}
|
|
1312
|
-
interface EntityCreatedEvent {
|
|
1313
|
-
entityAsJson?: string;
|
|
1314
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
1315
|
-
restoreInfo?: RestoreInfo;
|
|
1316
|
-
}
|
|
1317
|
-
interface RestoreInfo {
|
|
1318
|
-
deletedDate?: Date | null;
|
|
1319
|
-
}
|
|
1320
|
-
interface EntityUpdatedEvent {
|
|
1321
|
-
/**
|
|
1322
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1323
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1324
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1325
|
-
*/
|
|
1326
|
-
currentEntityAsJson?: string;
|
|
1327
|
-
}
|
|
1328
|
-
interface EntityDeletedEvent {
|
|
1329
|
-
/** Entity that was deleted. */
|
|
1330
|
-
deletedEntityAsJson?: string | null;
|
|
1331
|
-
}
|
|
1332
|
-
interface ActionEvent {
|
|
1333
|
-
bodyAsJson?: string;
|
|
1334
|
-
}
|
|
1335
|
-
interface MessageEnvelope {
|
|
1336
|
-
/**
|
|
1337
|
-
* App instance ID.
|
|
1338
|
-
* @format GUID
|
|
1339
|
-
*/
|
|
1340
|
-
instanceId?: string | null;
|
|
1341
|
-
/**
|
|
1342
|
-
* Event type.
|
|
1343
|
-
* @maxLength 150
|
|
1344
|
-
*/
|
|
1345
|
-
eventType?: string;
|
|
1346
|
-
/** The identification type and identity data. */
|
|
1347
|
-
identity?: WebhooksIdentificationData;
|
|
1348
|
-
/** Stringify payload. */
|
|
1349
|
-
data?: string;
|
|
1350
|
-
}
|
|
1351
|
-
interface WebhooksIdentificationData extends WebhooksIdentificationDataIdOneOf {
|
|
1352
|
-
/**
|
|
1353
|
-
* ID of a site visitor that has not logged in to the site.
|
|
1354
|
-
* @format GUID
|
|
1355
|
-
*/
|
|
1356
|
-
anonymousVisitorId?: string;
|
|
1357
|
-
/**
|
|
1358
|
-
* ID of a site visitor that has logged in to the site.
|
|
1359
|
-
* @format GUID
|
|
1360
|
-
*/
|
|
1361
|
-
memberId?: string;
|
|
1362
|
-
/**
|
|
1363
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
1364
|
-
* @format GUID
|
|
1365
|
-
*/
|
|
1366
|
-
wixUserId?: string;
|
|
1367
|
-
/**
|
|
1368
|
-
* ID of an app.
|
|
1369
|
-
* @format GUID
|
|
1370
|
-
*/
|
|
1371
|
-
appId?: string;
|
|
1372
|
-
/** @readonly */
|
|
1373
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1374
|
-
}
|
|
1375
|
-
/** @oneof */
|
|
1376
|
-
interface WebhooksIdentificationDataIdOneOf {
|
|
1377
|
-
/**
|
|
1378
|
-
* ID of a site visitor that has not logged in to the site.
|
|
1379
|
-
* @format GUID
|
|
1380
|
-
*/
|
|
1381
|
-
anonymousVisitorId?: string;
|
|
1382
|
-
/**
|
|
1383
|
-
* ID of a site visitor that has logged in to the site.
|
|
1384
|
-
* @format GUID
|
|
1385
|
-
*/
|
|
1386
|
-
memberId?: string;
|
|
1387
|
-
/**
|
|
1388
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
1389
|
-
* @format GUID
|
|
1390
|
-
*/
|
|
1391
|
-
wixUserId?: string;
|
|
1392
|
-
/**
|
|
1393
|
-
* ID of an app.
|
|
1394
|
-
* @format GUID
|
|
1395
|
-
*/
|
|
1396
|
-
appId?: string;
|
|
1397
|
-
}
|
|
1398
|
-
declare enum WebhookIdentityType {
|
|
1399
|
-
UNKNOWN = "UNKNOWN",
|
|
1400
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1401
|
-
MEMBER = "MEMBER",
|
|
1402
|
-
WIX_USER = "WIX_USER",
|
|
1403
|
-
APP = "APP"
|
|
1404
|
-
}
|
|
1405
|
-
/** @enumType */
|
|
1406
|
-
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1407
1496
|
interface CreateMultiServiceBookingRequest {
|
|
1408
1497
|
/**
|
|
1409
1498
|
* Between 2 to 8 new single-service booking specifications to create and combine in a multi-service booking.
|
|
@@ -1630,10 +1719,12 @@ interface RescheduleBookingInfo extends RescheduleBookingInfoParticipantsInfoOne
|
|
|
1630
1719
|
*/
|
|
1631
1720
|
revision?: string | null;
|
|
1632
1721
|
/**
|
|
1633
|
-
* List of [add-ons](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction)
|
|
1634
|
-
*
|
|
1722
|
+
* List of [add-ons](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction) added to the booking.
|
|
1723
|
+
*
|
|
1724
|
+
* To replace the booking's the list of booked add-ons, all of these conditions must be met:
|
|
1635
1725
|
* - The booking must have been created with `flowControlSettings.allowAddOnChanges` set to `true`.
|
|
1636
|
-
* - You must have `BOOKINGS.MANAGE_ADDONS` permissions
|
|
1726
|
+
* - You must have `BOOKINGS.MANAGE_ADDONS` permissions.
|
|
1727
|
+
* - 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.
|
|
1637
1728
|
* @maxSize 21
|
|
1638
1729
|
*/
|
|
1639
1730
|
bookedAddOns?: BookedAddOn[];
|
|
@@ -2124,24 +2215,6 @@ interface BulkCalculateAllowedActionsResult {
|
|
|
2124
2215
|
/** Booking entity. */
|
|
2125
2216
|
item?: AllowedActions;
|
|
2126
2217
|
}
|
|
2127
|
-
interface ItemMetadata {
|
|
2128
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
2129
|
-
id?: string | null;
|
|
2130
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
2131
|
-
originalIndex?: number;
|
|
2132
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
2133
|
-
success?: boolean;
|
|
2134
|
-
/** Details about the error in case of failure. */
|
|
2135
|
-
error?: ApplicationError;
|
|
2136
|
-
}
|
|
2137
|
-
interface ApplicationError {
|
|
2138
|
-
/** Error code. */
|
|
2139
|
-
code?: string;
|
|
2140
|
-
/** Description of the error. */
|
|
2141
|
-
description?: string;
|
|
2142
|
-
/** Data related to the error. */
|
|
2143
|
-
data?: Record<string, any> | null;
|
|
2144
|
-
}
|
|
2145
2218
|
/** Possible actions allowed for the booking. */
|
|
2146
2219
|
interface AllowedActions {
|
|
2147
2220
|
/** Whether canceling the booking is allowed. */
|
|
@@ -2149,14 +2222,6 @@ interface AllowedActions {
|
|
|
2149
2222
|
/** Whether rescheduling the booking is allowed. */
|
|
2150
2223
|
reschedule?: boolean;
|
|
2151
2224
|
}
|
|
2152
|
-
interface BulkActionMetadata {
|
|
2153
|
-
/** Number of items that were successfully processed. */
|
|
2154
|
-
totalSuccesses?: number;
|
|
2155
|
-
/** Number of items that couldn't be processed. */
|
|
2156
|
-
totalFailures?: number;
|
|
2157
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
2158
|
-
undetailedFailures?: number;
|
|
2159
|
-
}
|
|
2160
2225
|
interface GetMultiServiceBookingRequest {
|
|
2161
2226
|
/**
|
|
2162
2227
|
* ID of the multi-service booking.
|
|
@@ -2233,69 +2298,6 @@ interface RemoveBookingsFromMultiServiceBookingResponse {
|
|
|
2233
2298
|
/** Single-service bookings that were removed from the multi-service booking. */
|
|
2234
2299
|
bookings?: BookingResult[];
|
|
2235
2300
|
}
|
|
2236
|
-
interface ConfirmOrDeclineBookingRequest {
|
|
2237
|
-
/**
|
|
2238
|
-
* ID of the booking to confirm or decline.
|
|
2239
|
-
* @format GUID
|
|
2240
|
-
*/
|
|
2241
|
-
bookingId: string;
|
|
2242
|
-
/**
|
|
2243
|
-
* Current payment status of the booking when using a custom checkout page and
|
|
2244
|
-
* not the [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
2245
|
-
*
|
|
2246
|
-
* The booking is declined if there is a double booking conflict and you provide
|
|
2247
|
-
* one of these payment statuses: `UNDEFINED`, `NOT_PAID`, `REFUNDED`, or `EXEMPT`.
|
|
2248
|
-
*/
|
|
2249
|
-
paymentStatus?: PaymentStatusWithLiterals;
|
|
2250
|
-
}
|
|
2251
|
-
interface ConfirmOrDeclineBookingResponse {
|
|
2252
|
-
/** Updated booking. */
|
|
2253
|
-
booking?: Booking;
|
|
2254
|
-
}
|
|
2255
|
-
interface BulkConfirmOrDeclineBookingRequest {
|
|
2256
|
-
/**
|
|
2257
|
-
* Bookings to confirm or decline.
|
|
2258
|
-
* @minSize 1
|
|
2259
|
-
* @maxSize 300
|
|
2260
|
-
*/
|
|
2261
|
-
details: BulkConfirmOrDeclineBookingRequestBookingDetails[];
|
|
2262
|
-
/** Whether to return the confirmed or declined booking objects. */
|
|
2263
|
-
returnEntity?: boolean;
|
|
2264
|
-
}
|
|
2265
|
-
interface BulkConfirmOrDeclineBookingRequestBookingDetails {
|
|
2266
|
-
/**
|
|
2267
|
-
* ID of the booking to confirm or decline.
|
|
2268
|
-
* @format GUID
|
|
2269
|
-
*/
|
|
2270
|
-
bookingId?: string;
|
|
2271
|
-
/**
|
|
2272
|
-
* Current payment status of the booking when using a custom checkout page and
|
|
2273
|
-
* not the [eCommerce checkout](https://dev.wix.com/docs/rest/business-solutions/e-commerce/checkout/introduction).
|
|
2274
|
-
*
|
|
2275
|
-
* The booking is declined if there is a double booking conflict and you provide
|
|
2276
|
-
* one of these payment statuses: `UNDEFINED`, `NOT_PAID`, `REFUNDED`, or `EXEMPT`.
|
|
2277
|
-
*/
|
|
2278
|
-
paymentStatus?: PaymentStatusWithLiterals;
|
|
2279
|
-
}
|
|
2280
|
-
interface BulkConfirmOrDeclineBookingResponse {
|
|
2281
|
-
/** List of confirmed or declined bookings, including metadata. */
|
|
2282
|
-
results?: BulkBookingResult[];
|
|
2283
|
-
/** Total successes and failures of the Bulk Confirm Or Decline call. */
|
|
2284
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
2285
|
-
}
|
|
2286
|
-
interface BulkBookingResult {
|
|
2287
|
-
/**
|
|
2288
|
-
* Information about the booking that was created or updated.
|
|
2289
|
-
* Including its ID, index in the bulk request and whether it was
|
|
2290
|
-
* successfully created or updated.
|
|
2291
|
-
*/
|
|
2292
|
-
itemMetadata?: ItemMetadata;
|
|
2293
|
-
/**
|
|
2294
|
-
* Created or updated booking. Available only if you requested
|
|
2295
|
-
* to return the booking entity.
|
|
2296
|
-
*/
|
|
2297
|
-
item?: Booking;
|
|
2298
|
-
}
|
|
2299
2301
|
interface BookingChanged {
|
|
2300
2302
|
/** The booking before the changes. */
|
|
2301
2303
|
previousBooking?: Booking;
|
|
@@ -2448,7 +2450,11 @@ interface RescheduleBookingRequest extends RescheduleBookingRequestParticipantsI
|
|
|
2448
2450
|
flowControlSettings?: RescheduleBookingFlowControlSettings;
|
|
2449
2451
|
/**
|
|
2450
2452
|
* List of [add-ons](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction) added to the booking.
|
|
2451
|
-
*
|
|
2453
|
+
*
|
|
2454
|
+
* To replace the booking's the list of booked add-ons, all of these conditions must be met:
|
|
2455
|
+
* - The booking must have been created with `flowControlSettings.allowAddOnChanges` set to `true`.
|
|
2456
|
+
* - You must have `BOOKINGS.MANAGE_ADDONS` permissions.
|
|
2457
|
+
* - 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.
|
|
2452
2458
|
* @maxSize 21
|
|
2453
2459
|
*/
|
|
2454
2460
|
bookedAddOns?: BookedAddOn[];
|
|
@@ -3209,6 +3215,22 @@ interface GetSchedulingUrlResponse {
|
|
|
3209
3215
|
schedulingUrl?: string | null;
|
|
3210
3216
|
}
|
|
3211
3217
|
/** @docsIgnore */
|
|
3218
|
+
type ConfirmOrDeclineBookingApplicationErrors = {
|
|
3219
|
+
code?: 'INVALID_BOOKING_STATUS';
|
|
3220
|
+
description?: string;
|
|
3221
|
+
data?: Record<string, any>;
|
|
3222
|
+
} | {
|
|
3223
|
+
code?: 'BOOKING_NOT_FOUND';
|
|
3224
|
+
description?: string;
|
|
3225
|
+
data?: Record<string, any>;
|
|
3226
|
+
};
|
|
3227
|
+
/** @docsIgnore */
|
|
3228
|
+
type BulkConfirmOrDeclineBookingApplicationErrors = {
|
|
3229
|
+
code?: 'DUPLICATED_BOOKINGS';
|
|
3230
|
+
description?: string;
|
|
3231
|
+
data?: Record<string, any>;
|
|
3232
|
+
};
|
|
3233
|
+
/** @docsIgnore */
|
|
3212
3234
|
type CreateMultiServiceBookingApplicationErrors = {
|
|
3213
3235
|
code?: 'VALIDATION_FAILURE';
|
|
3214
3236
|
description?: string;
|
|
@@ -3479,22 +3501,6 @@ type RemoveBookingsFromMultiServiceBookingApplicationErrors = {
|
|
|
3479
3501
|
data?: Record<string, any>;
|
|
3480
3502
|
};
|
|
3481
3503
|
/** @docsIgnore */
|
|
3482
|
-
type ConfirmOrDeclineBookingApplicationErrors = {
|
|
3483
|
-
code?: 'INVALID_BOOKING_STATUS';
|
|
3484
|
-
description?: string;
|
|
3485
|
-
data?: Record<string, any>;
|
|
3486
|
-
} | {
|
|
3487
|
-
code?: 'BOOKING_NOT_FOUND';
|
|
3488
|
-
description?: string;
|
|
3489
|
-
data?: Record<string, any>;
|
|
3490
|
-
};
|
|
3491
|
-
/** @docsIgnore */
|
|
3492
|
-
type BulkConfirmOrDeclineBookingApplicationErrors = {
|
|
3493
|
-
code?: 'DUPLICATED_BOOKINGS';
|
|
3494
|
-
description?: string;
|
|
3495
|
-
data?: Record<string, any>;
|
|
3496
|
-
};
|
|
3497
|
-
/** @docsIgnore */
|
|
3498
3504
|
type CreateBookingApplicationErrors = {
|
|
3499
3505
|
code?: 'SESSION_NOT_FOUND';
|
|
3500
3506
|
description?: string;
|
|
@@ -3797,6 +3803,10 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
|
|
|
3797
3803
|
__responseType: Q;
|
|
3798
3804
|
__originalResponseType: R;
|
|
3799
3805
|
};
|
|
3806
|
+
declare function confirmOrDeclineBooking(): __PublicMethodMetaInfo<'POST', {
|
|
3807
|
+
bookingId: string;
|
|
3808
|
+
}, ConfirmOrDeclineBookingRequest$1, ConfirmOrDeclineBookingRequest, ConfirmOrDeclineBookingResponse$1, ConfirmOrDeclineBookingResponse>;
|
|
3809
|
+
declare function bulkConfirmOrDeclineBooking(): __PublicMethodMetaInfo<'POST', {}, BulkConfirmOrDeclineBookingRequest$1, BulkConfirmOrDeclineBookingRequest, BulkConfirmOrDeclineBookingResponse$1, BulkConfirmOrDeclineBookingResponse>;
|
|
3800
3810
|
declare function createMultiServiceBooking(): __PublicMethodMetaInfo<'POST', {}, CreateMultiServiceBookingRequest$1, CreateMultiServiceBookingRequest, CreateMultiServiceBookingResponse$1, CreateMultiServiceBookingResponse>;
|
|
3801
3811
|
declare function rescheduleMultiServiceBooking(): __PublicMethodMetaInfo<'POST', {
|
|
3802
3812
|
multiServiceBookingId: string;
|
|
@@ -3822,10 +3832,6 @@ declare function getMultiServiceBooking(): __PublicMethodMetaInfo<'GET', {
|
|
|
3822
3832
|
}, GetMultiServiceBookingRequest$1, GetMultiServiceBookingRequest, GetMultiServiceBookingResponse$1, GetMultiServiceBookingResponse>;
|
|
3823
3833
|
declare function addBookingsToMultiServiceBooking(): __PublicMethodMetaInfo<'POST', {}, AddBookingsToMultiServiceBookingRequest$1, AddBookingsToMultiServiceBookingRequest, AddBookingsToMultiServiceBookingResponse$1, AddBookingsToMultiServiceBookingResponse>;
|
|
3824
3834
|
declare function removeBookingsFromMultiServiceBooking(): __PublicMethodMetaInfo<'POST', {}, RemoveBookingsFromMultiServiceBookingRequest$1, RemoveBookingsFromMultiServiceBookingRequest, RemoveBookingsFromMultiServiceBookingResponse$1, RemoveBookingsFromMultiServiceBookingResponse>;
|
|
3825
|
-
declare function confirmOrDeclineBooking(): __PublicMethodMetaInfo<'POST', {
|
|
3826
|
-
bookingId: string;
|
|
3827
|
-
}, ConfirmOrDeclineBookingRequest$1, ConfirmOrDeclineBookingRequest, ConfirmOrDeclineBookingResponse$1, ConfirmOrDeclineBookingResponse>;
|
|
3828
|
-
declare function bulkConfirmOrDeclineBooking(): __PublicMethodMetaInfo<'POST', {}, BulkConfirmOrDeclineBookingRequest$1, BulkConfirmOrDeclineBookingRequest, BulkConfirmOrDeclineBookingResponse$1, BulkConfirmOrDeclineBookingResponse>;
|
|
3829
3835
|
declare function createBooking(): __PublicMethodMetaInfo<'POST', {}, CreateBookingRequest$1, CreateBookingRequest, CreateBookingResponse$1, CreateBookingResponse>;
|
|
3830
3836
|
declare function bulkCreateBooking(): __PublicMethodMetaInfo<'POST', {}, BulkCreateBookingRequest$1, BulkCreateBookingRequest, BulkCreateBookingResponse$1, BulkCreateBookingResponse>;
|
|
3831
3837
|
declare function rescheduleBooking(): __PublicMethodMetaInfo<'POST', {
|