@wix/motion 1.0.39 → 1.0.40

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/motion",
-  "version": "1.0.39",
+  "version": "1.0.40",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -18,7 +18,7 @@
     "type-bundles"
   ],
   "dependencies": {
-    "@wix/motion_alarms": "1.0.8",
+    "@wix/motion_alarms": "1.0.9",
     "@wix/motion_metroinspector": "1.0.5",
     "@wix/motion_products": "1.0.8"
   },
@@ -45,5 +45,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "618c0372961d899242c8295b4f95a23c77914c34c8283af99e1684d9"
+  "falconPackageHash": "d739a008ec8fde53fc7bfe180a1e14ae7e2abe27c306dc056b586bd6"
 }

package/type-bundles/context.bundle.d.ts

@@ -153,7 +153,59 @@ declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?
 type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
 type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
 
+/**
+ * Creates a booking.
+ *
+ *
+ * To create a booking for an appointment or a session of a class, pass a booking with the relevant `slot`.
+ *
+ * To create a booking for the entire course, pass a booking with the relevant `schedule`.
+ * You can use Query Availability to check the availability beforehand.
+ *
+ * If you create a booking for an existing session, we recommend that you only pass `slot.sessionId`.
+ * Then, any specified slot details are calculated.
+ *
+ * If you create a booking for a new session, we recommend to call Query Availability first.
+ * Then, pass the retrieved `availability.slot` object as the BookedEntity.Slot of the booking in the request.
+ *
+ * Bookings are created with a status of `CREATED`.
+ * `CREATED` bookings don't appear on the business calendar and don't affect a related schedule's availability.
+ *
+ * To create a booking with a given status, pass a booking with the wanted status.
+ * This is only permitted for site Owners.
+ *
+ * You can pass a `participantNotification.message` to notify the customer of the booking with a message.
+ * It's also necessary to pass `participantNotification.notifyParticipants`as `true` to send the message.
+ *
+ * You can pass `sendSmsReminder` as `true`, if you want an SMS reminder to be sent to the phone number specified in the ContactDetails, 24 hours before the session starts.
+ *
+ * When creating a booking you must pass either `participantsChoices` or `totalParticipants`. If you pass `participantsChoices`, all the
+ * provided choices must exist for the service, otherwise the call returns an `INVALID_SERVICE_CHOICES` error.
+ *
+ * When creating a booking, you can pass `selectedPaymentOption`.
+ * This specifies which payment method the customer plans to use.
+ * But it's possible for them to later use another supported payment method.
+ *
+ * You can skip the checkout and payment flow if you call Confirm Or Decline Booking otherwise, after you create the booking, you can use the
+ * Wix eCommerce APIs (coming soon) for the checkout and payment flow or use a different service for checkout.
+ * @param booking - The booking to create.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField booking
+ * @requiredField booking.additionalFields._id
+ * @requiredField booking.bookedEntity
+ * @permissionScope Manage Bookings
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
+ * @permissionScope Manage Bookings - all permissions
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
+ * @applicableIdentity APP
+ * @applicableIdentity MEMBER
+ * @applicableIdentity VISITOR
+ */
 declare function alarm$1(httpClient: HttpClient): (seconds: number, options?: AlarmOptions) => Promise<AlarmResponse>;
+/**
+ * Another thing
+ */
 declare function updateAlarm$1(httpClient: HttpClient): (_id: string, alarm: UpdateAlarm) => Promise<UpdateAlarmResponse & UpdateAlarmResponseNonNullableFields>;
 declare const onAlarmTriggered$1: EventDefinition<AlarmTriggeredEnvelope, "wix.alarm.v1.alarm_alarm_triggered">;
 declare const onAlarmSnoozed$1: EventDefinition<AlarmSnoozedEnvelope, "wix.alarm.v1.alarm_alarm_snoozed">;

package/type-bundles/index.bundle.d.ts

@@ -246,7 +246,59 @@ declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?
 declare const __metadata$2: {
     PACKAGE_NAME: string;
 };
+/**
+ * Creates a booking.
+ *
+ *
+ * To create a booking for an appointment or a session of a class, pass a booking with the relevant `slot`.
+ *
+ * To create a booking for the entire course, pass a booking with the relevant `schedule`.
+ * You can use Query Availability to check the availability beforehand.
+ *
+ * If you create a booking for an existing session, we recommend that you only pass `slot.sessionId`.
+ * Then, any specified slot details are calculated.
+ *
+ * If you create a booking for a new session, we recommend to call Query Availability first.
+ * Then, pass the retrieved `availability.slot` object as the BookedEntity.Slot of the booking in the request.
+ *
+ * Bookings are created with a status of `CREATED`.
+ * `CREATED` bookings don't appear on the business calendar and don't affect a related schedule's availability.
+ *
+ * To create a booking with a given status, pass a booking with the wanted status.
+ * This is only permitted for site Owners.
+ *
+ * You can pass a `participantNotification.message` to notify the customer of the booking with a message.
+ * It's also necessary to pass `participantNotification.notifyParticipants`as `true` to send the message.
+ *
+ * You can pass `sendSmsReminder` as `true`, if you want an SMS reminder to be sent to the phone number specified in the ContactDetails, 24 hours before the session starts.
+ *
+ * When creating a booking you must pass either `participantsChoices` or `totalParticipants`. If you pass `participantsChoices`, all the
+ * provided choices must exist for the service, otherwise the call returns an `INVALID_SERVICE_CHOICES` error.
+ *
+ * When creating a booking, you can pass `selectedPaymentOption`.
+ * This specifies which payment method the customer plans to use.
+ * But it's possible for them to later use another supported payment method.
+ *
+ * You can skip the checkout and payment flow if you call Confirm Or Decline Booking otherwise, after you create the booking, you can use the
+ * Wix eCommerce APIs (coming soon) for the checkout and payment flow or use a different service for checkout.
+ * @param booking - The booking to create.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField booking
+ * @requiredField booking.additionalFields._id
+ * @requiredField booking.bookedEntity
+ * @permissionScope Manage Bookings
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
+ * @permissionScope Manage Bookings - all permissions
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
+ * @applicableIdentity APP
+ * @applicableIdentity MEMBER
+ * @applicableIdentity VISITOR
+ */
 declare function alarm(httpClient: HttpClient): (seconds: number, options?: AlarmOptions) => Promise<AlarmResponse>;
+/**
+ * Another thing
+ */
 declare function updateAlarm(httpClient: HttpClient): (_id: string, alarm: UpdateAlarm) => Promise<UpdateAlarmResponse & UpdateAlarmResponseNonNullableFields>;
 declare const onAlarmTriggered: EventDefinition<AlarmTriggeredEnvelope, "wix.alarm.v1.alarm_alarm_triggered">;
 declare const onAlarmSnoozed: EventDefinition<AlarmSnoozedEnvelope, "wix.alarm.v1.alarm_alarm_snoozed">;