@wix/metro 1.0.80 → 1.0.81

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/metro",
3
- "version": "1.0.80",
3
+ "version": "1.0.81",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -18,7 +18,7 @@
18
18
  "type-bundles"
19
19
  ],
20
20
  "dependencies": {
21
- "@wix/metro_products": "1.0.6"
21
+ "@wix/metro_products": "1.0.7"
22
22
  },
23
23
  "devDependencies": {
24
24
  "@wix/sdk": "https://cdn.dev.wixpress.com/@wix/sdk/02e8069ab2fd783e0e6a080fc7d590e76cb26ab93c8389574286305b.tar.gz",
@@ -43,5 +43,5 @@
43
43
  "fqdn": ""
44
44
  }
45
45
  },
46
- "falconPackageHash": "679ed5c0c092341d244fecd00369348a1e592f40bd2b7019176fb7bb"
46
+ "falconPackageHash": "16dc219e69c30884b1c98a85e63ae90b23818091f4b9d3ab9116b213"
47
47
  }
@@ -381,6 +381,55 @@ type APIMetadata = {
381
381
  };
382
382
  type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
383
383
 
384
+ /**
385
+ * Creates a booking.
386
+ *
387
+ *
388
+ * To create a booking for an appointment or a session of a class, pass a booking with the relevant `slot`.
389
+ *
390
+ * To create a booking for the entire course, pass a booking with the relevant `schedule`.
391
+ * You can use Query Availability to check the availability beforehand.
392
+ *
393
+ * If you create a booking for an existing session, we recommend that you only pass `slot.sessionId`.
394
+ * Then, any specified slot details are calculated.
395
+ *
396
+ * If you create a booking for a new session, we recommend to call Query Availability first.
397
+ * Then, pass the retrieved `availability.slot` object as the BookedEntity.Slot of the booking in the request.
398
+ *
399
+ * Bookings are created with a status of `CREATED`.
400
+ * `CREATED` bookings don't appear on the business calendar and don't affect a related schedule's availability.
401
+ *
402
+ * To create a booking with a given status, pass a booking with the wanted status.
403
+ * This is only permitted for site Owners.
404
+ *
405
+ * You can pass a `participantNotification.message` to notify the customer of the booking with a message.
406
+ * It's also necessary to pass `participantNotification.notifyParticipants`as `true` to send the message.
407
+ *
408
+ * 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.
409
+ *
410
+ * When creating a booking you must pass either `participantsChoices` or `totalParticipants`. If you pass `participantsChoices`, all the
411
+ * provided choices must exist for the service, otherwise the call returns an `INVALID_SERVICE_CHOICES` error.
412
+ *
413
+ * When creating a booking, you can pass `selectedPaymentOption`.
414
+ * This specifies which payment method the customer plans to use.
415
+ * But it's possible for them to later use another supported payment method.
416
+ *
417
+ * 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
418
+ * Wix eCommerce APIs (coming soon) for the checkout and payment flow or use a different service for checkout.
419
+ * @param booking - The booking to create.
420
+ * @public
421
+ * @documentationMaturity preview
422
+ * @requiredField booking
423
+ * @requiredField booking.additionalFields._id
424
+ * @requiredField booking.bookedEntity
425
+ * @permissionScope Manage Bookings
426
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
427
+ * @permissionScope Manage Bookings - all permissions
428
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
429
+ * @applicableIdentity APP
430
+ * @applicableIdentity MEMBER
431
+ * @applicableIdentity VISITOR
432
+ */
384
433
  declare function createProduct$1(httpClient: HttpClient): (options?: CreateProductOptions) => Promise<Product & {
385
434
  _id: string;
386
435
  collectionId: string;
@@ -457,6 +506,9 @@ declare function bulkCreateProducts$1(httpClient: HttpClient): (products: Produc
457
506
  declare function bulkUpdateProducts$1(httpClient: HttpClient): (products: MaskedProduct[], options?: BulkUpdateProductsOptions) => Promise<BulkUpdateProductsResponse & BulkUpdateProductsResponseNonNullableFields>;
458
507
  declare function bulkDeleteProducts$1(httpClient: HttpClient): (productIds: string[]) => Promise<BulkDeleteProductsResponse & BulkDeleteProductsResponseNonNullableFields>;
459
508
 
509
+ /**
510
+ * something else
511
+ */
460
512
  declare const createProduct: BuildRESTFunction<typeof createProduct$1>;
461
513
  declare const deleteProduct: BuildRESTFunction<typeof deleteProduct$1>;
462
514
  declare const updateProduct: BuildRESTFunction<typeof updateProduct$1>;
@@ -759,6 +759,55 @@ type APIMetadata = {
759
759
  declare const __metadata: {
760
760
  PACKAGE_NAME: string;
761
761
  };
762
+ /**
763
+ * Creates a booking.
764
+ *
765
+ *
766
+ * To create a booking for an appointment or a session of a class, pass a booking with the relevant `slot`.
767
+ *
768
+ * To create a booking for the entire course, pass a booking with the relevant `schedule`.
769
+ * You can use Query Availability to check the availability beforehand.
770
+ *
771
+ * If you create a booking for an existing session, we recommend that you only pass `slot.sessionId`.
772
+ * Then, any specified slot details are calculated.
773
+ *
774
+ * If you create a booking for a new session, we recommend to call Query Availability first.
775
+ * Then, pass the retrieved `availability.slot` object as the BookedEntity.Slot of the booking in the request.
776
+ *
777
+ * Bookings are created with a status of `CREATED`.
778
+ * `CREATED` bookings don't appear on the business calendar and don't affect a related schedule's availability.
779
+ *
780
+ * To create a booking with a given status, pass a booking with the wanted status.
781
+ * This is only permitted for site Owners.
782
+ *
783
+ * You can pass a `participantNotification.message` to notify the customer of the booking with a message.
784
+ * It's also necessary to pass `participantNotification.notifyParticipants`as `true` to send the message.
785
+ *
786
+ * 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.
787
+ *
788
+ * When creating a booking you must pass either `participantsChoices` or `totalParticipants`. If you pass `participantsChoices`, all the
789
+ * provided choices must exist for the service, otherwise the call returns an `INVALID_SERVICE_CHOICES` error.
790
+ *
791
+ * When creating a booking, you can pass `selectedPaymentOption`.
792
+ * This specifies which payment method the customer plans to use.
793
+ * But it's possible for them to later use another supported payment method.
794
+ *
795
+ * 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
796
+ * Wix eCommerce APIs (coming soon) for the checkout and payment flow or use a different service for checkout.
797
+ * @param booking - The booking to create.
798
+ * @public
799
+ * @documentationMaturity preview
800
+ * @requiredField booking
801
+ * @requiredField booking.additionalFields._id
802
+ * @requiredField booking.bookedEntity
803
+ * @permissionScope Manage Bookings
804
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
805
+ * @permissionScope Manage Bookings - all permissions
806
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
807
+ * @applicableIdentity APP
808
+ * @applicableIdentity MEMBER
809
+ * @applicableIdentity VISITOR
810
+ */
762
811
  declare function createProduct(httpClient: HttpClient): (options?: CreateProductOptions) => Promise<Product & {
763
812
  _id: string;
764
813
  collectionId: string;