@wix/auto_sdk_bookings_services 1.0.46 → 1.0.48

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.
Files changed (49) hide show
  1. package/build/cjs/src/bookings-services-v2-service-services.context.d.ts +2 -2
  2. package/build/cjs/src/bookings-services-v2-service-services.context.js +5 -16
  3. package/build/cjs/src/bookings-services-v2-service-services.context.js.map +1 -1
  4. package/build/cjs/src/bookings-services-v2-service-services.public.d.ts +3 -3
  5. package/build/cjs/src/bookings-services-v2-service-services.public.js +3 -14
  6. package/build/cjs/src/bookings-services-v2-service-services.public.js.map +1 -1
  7. package/build/cjs/src/bookings-services-v2-service-services.types.d.ts +90 -809
  8. package/build/cjs/src/bookings-services-v2-service-services.types.js +30 -144
  9. package/build/cjs/src/bookings-services-v2-service-services.types.js.map +1 -1
  10. package/build/cjs/src/bookings-services-v2-service-services.universal.d.ts +101 -800
  11. package/build/cjs/src/bookings-services-v2-service-services.universal.js +30 -145
  12. package/build/cjs/src/bookings-services-v2-service-services.universal.js.map +1 -1
  13. package/build/es/src/bookings-services-v2-service-services.context.d.ts +2 -2
  14. package/build/es/src/bookings-services-v2-service-services.context.js +1 -1
  15. package/build/es/src/bookings-services-v2-service-services.context.js.map +1 -1
  16. package/build/es/src/bookings-services-v2-service-services.public.d.ts +3 -3
  17. package/build/es/src/bookings-services-v2-service-services.public.js +1 -1
  18. package/build/es/src/bookings-services-v2-service-services.public.js.map +1 -1
  19. package/build/es/src/bookings-services-v2-service-services.types.d.ts +90 -809
  20. package/build/es/src/bookings-services-v2-service-services.types.js +29 -143
  21. package/build/es/src/bookings-services-v2-service-services.types.js.map +1 -1
  22. package/build/es/src/bookings-services-v2-service-services.universal.d.ts +101 -800
  23. package/build/es/src/bookings-services-v2-service-services.universal.js +29 -143
  24. package/build/es/src/bookings-services-v2-service-services.universal.js.map +1 -1
  25. package/build/internal/cjs/src/bookings-services-v2-service-services.context.d.ts +2 -2
  26. package/build/internal/cjs/src/bookings-services-v2-service-services.context.js +5 -16
  27. package/build/internal/cjs/src/bookings-services-v2-service-services.context.js.map +1 -1
  28. package/build/internal/cjs/src/bookings-services-v2-service-services.public.d.ts +3 -3
  29. package/build/internal/cjs/src/bookings-services-v2-service-services.public.js +3 -14
  30. package/build/internal/cjs/src/bookings-services-v2-service-services.public.js.map +1 -1
  31. package/build/internal/cjs/src/bookings-services-v2-service-services.types.d.ts +90 -809
  32. package/build/internal/cjs/src/bookings-services-v2-service-services.types.js +30 -144
  33. package/build/internal/cjs/src/bookings-services-v2-service-services.types.js.map +1 -1
  34. package/build/internal/cjs/src/bookings-services-v2-service-services.universal.d.ts +101 -800
  35. package/build/internal/cjs/src/bookings-services-v2-service-services.universal.js +30 -145
  36. package/build/internal/cjs/src/bookings-services-v2-service-services.universal.js.map +1 -1
  37. package/build/internal/es/src/bookings-services-v2-service-services.context.d.ts +2 -2
  38. package/build/internal/es/src/bookings-services-v2-service-services.context.js +1 -1
  39. package/build/internal/es/src/bookings-services-v2-service-services.context.js.map +1 -1
  40. package/build/internal/es/src/bookings-services-v2-service-services.public.d.ts +3 -3
  41. package/build/internal/es/src/bookings-services-v2-service-services.public.js +1 -1
  42. package/build/internal/es/src/bookings-services-v2-service-services.public.js.map +1 -1
  43. package/build/internal/es/src/bookings-services-v2-service-services.types.d.ts +90 -809
  44. package/build/internal/es/src/bookings-services-v2-service-services.types.js +29 -143
  45. package/build/internal/es/src/bookings-services-v2-service-services.types.js.map +1 -1
  46. package/build/internal/es/src/bookings-services-v2-service-services.universal.d.ts +101 -800
  47. package/build/internal/es/src/bookings-services-v2-service-services.universal.js +29 -143
  48. package/build/internal/es/src/bookings-services-v2-service-services.universal.js.map +1 -1
  49. package/package.json +2 -2
@@ -68,7 +68,7 @@ export interface Service {
68
68
  * @immutable
69
69
  * @maxSize 500
70
70
  */
71
- locations?: V2Location[];
71
+ locations?: Location[];
72
72
  /**
73
73
  * _Policy_
74
74
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction))
@@ -81,7 +81,7 @@ export interface Service {
81
81
  * which can be used to manage the service's *events*
82
82
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction)).
83
83
  */
84
- schedule?: V2Schedule;
84
+ schedule?: Schedule;
85
85
  /**
86
86
  * IDs of the *staff members*
87
87
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/introduction))
@@ -362,7 +362,7 @@ export interface Conferencing {
362
362
  /** Whether a conference link is generated for the service's sessions. */
363
363
  enabled?: boolean | null;
364
364
  }
365
- export interface V2Location extends V2LocationOptionsOneOf {
365
+ export interface Location extends LocationOptionsOneOf {
366
366
  /** Information about business locations. */
367
367
  business?: BusinessLocationOptions;
368
368
  /** Information about custom locations. */
@@ -378,7 +378,7 @@ export interface V2Location extends V2LocationOptionsOneOf {
378
378
  *
379
379
  * Default: `CUSTOM`
380
380
  */
381
- type?: LocationTypeEnumLocationType;
381
+ type?: LocationType;
382
382
  /**
383
383
  * Location address. Empty for `{"type": "CUSTOMER"}`.
384
384
  * @readonly
@@ -386,13 +386,13 @@ export interface V2Location extends V2LocationOptionsOneOf {
386
386
  calculatedAddress?: CommonAddress;
387
387
  }
388
388
  /** @oneof */
389
- export interface V2LocationOptionsOneOf {
389
+ export interface LocationOptionsOneOf {
390
390
  /** Information about business locations. */
391
391
  business?: BusinessLocationOptions;
392
392
  /** Information about custom locations. */
393
393
  custom?: CustomLocationOptions;
394
394
  }
395
- export declare enum LocationTypeEnumLocationType {
395
+ export declare enum LocationType {
396
396
  UNKNOWN_LOCATION_TYPE = "UNKNOWN_LOCATION_TYPE",
397
397
  /**
398
398
  * Location set by the business that is not a standard business *location*
@@ -412,7 +412,7 @@ export declare enum LocationTypeEnumLocationType {
412
412
  }
413
413
  export interface CommonAddress extends CommonAddressStreetOneOf {
414
414
  /** Street name and number. */
415
- streetAddress?: CommonStreetAddress;
415
+ streetAddress?: StreetAddress;
416
416
  /** @maxLength 255 */
417
417
  addressLine1?: string | null;
418
418
  /**
@@ -444,12 +444,12 @@ export interface CommonAddress extends CommonAddressStreetOneOf {
444
444
  /** @oneof */
445
445
  export interface CommonAddressStreetOneOf {
446
446
  /** Street name and number. */
447
- streetAddress?: CommonStreetAddress;
447
+ streetAddress?: StreetAddress;
448
448
  /** @maxLength 255 */
449
449
  addressLine?: string | null;
450
450
  }
451
451
  /** Street address. Includes street name, number, and apartment number in separate fields. */
452
- export interface CommonStreetAddress {
452
+ export interface StreetAddress {
453
453
  /**
454
454
  * Street number.
455
455
  * @maxLength 255
@@ -466,7 +466,7 @@ export interface CommonStreetAddress {
466
466
  */
467
467
  apt?: string;
468
468
  }
469
- export interface CommonAddressLocation {
469
+ export interface AddressLocation {
470
470
  /** Address latitude. */
471
471
  latitude?: number | null;
472
472
  /** Address longitude. */
@@ -853,7 +853,7 @@ export interface SaveCreditCardPolicy {
853
853
  /** Default: `false` */
854
854
  enabled?: boolean;
855
855
  }
856
- export interface V2Schedule {
856
+ export interface Schedule {
857
857
  /**
858
858
  * ID of the *schedule*
859
859
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction))
@@ -873,9 +873,9 @@ export interface V2Schedule {
873
873
  */
874
874
  lastSessionEnd?: Date | null;
875
875
  /** Limitations affecting the service availability. */
876
- availabilityConstraints?: V2AvailabilityConstraints;
876
+ availabilityConstraints?: AvailabilityConstraints;
877
877
  }
878
- export interface V2AvailabilityConstraints {
878
+ export interface AvailabilityConstraints {
879
879
  /**
880
880
  * Calculated list of all supported session durations for the service. For
881
881
  * appointment-based services without varied pricing based on session length, it
@@ -1203,25 +1203,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
1203
1203
  updatedEvent?: EntityUpdatedEvent;
1204
1204
  deletedEvent?: EntityDeletedEvent;
1205
1205
  actionEvent?: ActionEvent;
1206
- /**
1207
- * Unique event ID.
1208
- * Allows clients to ignore duplicate webhooks.
1209
- */
1206
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
1210
1207
  _id?: string;
1211
1208
  /**
1212
- * Assumes actions are also always typed to an entity_type
1213
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1209
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
1210
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
1214
1211
  */
1215
1212
  entityFqdn?: string;
1216
1213
  /**
1217
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1218
- * This is although the created/updated/deleted notion is duplication of the oneof types
1219
- * Example: created/updated/deleted/started/completed/email_opened
1214
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
1215
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
1220
1216
  */
1221
1217
  slug?: string;
1222
1218
  /** ID of the entity associated with the event. */
1223
1219
  entityId?: string;
1224
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1220
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
1225
1221
  eventTime?: Date | null;
1226
1222
  /**
1227
1223
  * Whether the event was triggered as a result of a privacy regulation application
@@ -1231,12 +1227,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
1231
1227
  /** If present, indicates the action that triggered the event. */
1232
1228
  originatedFrom?: string | null;
1233
1229
  /**
1234
- * A sequence number defining the order of updates to the underlying entity.
1235
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
1236
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1237
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1238
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
1239
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1230
+ * 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.
1231
+ * 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.
1240
1232
  */
1241
1233
  entityEventSequence?: string | null;
1242
1234
  }
@@ -1262,7 +1254,7 @@ export interface EntityUpdatedEvent {
1262
1254
  currentEntity?: string;
1263
1255
  }
1264
1256
  export interface EntityDeletedEvent {
1265
- /** Entity that was deleted */
1257
+ /** Entity that was deleted. */
1266
1258
  deletedEntity?: string | null;
1267
1259
  }
1268
1260
  export interface ActionEvent {
@@ -1463,7 +1455,7 @@ export interface ServiceAvailabilityConstraints {
1463
1455
  * The service schedule, including the schedule ID and availability constraints.
1464
1456
  * @readonly
1465
1457
  */
1466
- schedule?: V2Schedule;
1458
+ schedule?: Schedule;
1467
1459
  /**
1468
1460
  * The locations this service is offered at.
1469
1461
  * Only multiple locations of type `BUSINESS` are supported. Multiple locations of type `CUSTOM` or `CUSTOMER` are not supported.
@@ -1472,7 +1464,7 @@ export interface ServiceAvailabilityConstraints {
1472
1464
  * @readonly
1473
1465
  * @maxSize 100
1474
1466
  */
1475
- locations?: V2Location[];
1467
+ locations?: Location[];
1476
1468
  /**
1477
1469
  * Resource groups required to book the service. For backward compatibility only. Use `Service Resources` instead.
1478
1470
  * @maxSize 3
@@ -1495,7 +1487,7 @@ export interface ServiceAvailabilityConstraints {
1495
1487
  * For appointments only.
1496
1488
  * @readonly
1497
1489
  */
1498
- slotsSplitInterval?: V1SplitInterval;
1490
+ slotsSplitInterval?: SplitInterval;
1499
1491
  /**
1500
1492
  * Online booking settings.
1501
1493
  * @readonly
@@ -1503,7 +1495,7 @@ export interface ServiceAvailabilityConstraints {
1503
1495
  onlineBooking?: OnlineBooking;
1504
1496
  }
1505
1497
  /** The time between available slots' start times. For example, For 5 minute slots, 3:00, 3:05, 3:15 etc. For 1 hour slots, 3:00, 4:00, 5:00 etc. */
1506
- export interface V1SplitInterval {
1498
+ export interface SplitInterval {
1507
1499
  /**
1508
1500
  * Whether the slot duration is used as the split interval value.
1509
1501
  * If `same_as_duration` is `true`, the `value_in_minutes` is the sum of the first duration in
@@ -1892,9 +1884,9 @@ export interface ScalarAggregation {
1892
1884
  }
1893
1885
  export interface DateHistogramAggregation {
1894
1886
  /** Interval for date histogram aggregation */
1895
- interval?: DateHistogramAggregationInterval;
1887
+ interval?: Interval;
1896
1888
  }
1897
- export declare enum DateHistogramAggregationInterval {
1889
+ export declare enum Interval {
1898
1890
  /** Unknown interval. */
1899
1891
  UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
1900
1892
  /** Yearly interval. */
@@ -2414,7 +2406,7 @@ export interface BusinessLocations {
2414
2406
  * Retrieved business locations.
2415
2407
  * @maxSize 100
2416
2408
  */
2417
- locations?: V2Location[];
2409
+ locations?: Location[];
2418
2410
  }
2419
2411
  export interface CustomLocations {
2420
2412
  /**
@@ -2477,7 +2469,7 @@ export interface SetServiceLocationsRequest {
2477
2469
  * List of locations replacing existing service locations. Omitting an existing location removes it from the service. Specify `removedLocationSessionsAction` to determine the handling of future sessions scheduled at that location.
2478
2470
  * @maxSize 100
2479
2471
  */
2480
- locations: V2Location[];
2472
+ locations: Location[];
2481
2473
  /**
2482
2474
  * The action to perform on sessions currently set to a removed location. For
2483
2475
  * example, move existing sessions to a new specified location.
@@ -2521,7 +2513,7 @@ export declare enum Action {
2521
2513
  }
2522
2514
  export interface MoveToNewLocationsOptions {
2523
2515
  /** The new location to move existing sessions currently set to a removed location, used when `action` is `MOVE_TO_LOCATION`. */
2524
- newLocation?: V2Location;
2516
+ newLocation?: Location;
2525
2517
  }
2526
2518
  export interface SetServiceLocationsResponse {
2527
2519
  /** The updated service with the newly set locations. */
@@ -2699,746 +2691,6 @@ export declare enum CategoryNotificationEvent {
2699
2691
  }
2700
2692
  export interface Empty {
2701
2693
  }
2702
- export interface ResourceNotification {
2703
- /**
2704
- * Updated resource entity.
2705
- * 'resource.schedules' is deprecated and will not be returned. Please use 'resource.scheduleIds' instead.
2706
- */
2707
- resource?: Resource;
2708
- /** Event type. */
2709
- event?: ResourceNotificationEvent;
2710
- }
2711
- export interface Resource {
2712
- /**
2713
- * Resource ID.
2714
- * @format GUID
2715
- * @readonly
2716
- */
2717
- _id?: string | null;
2718
- /**
2719
- * Resource name.
2720
- * @maxLength 1200
2721
- */
2722
- name?: string | null;
2723
- /**
2724
- * Resource email address.
2725
- * @maxLength 500
2726
- */
2727
- email?: string | null;
2728
- /**
2729
- * Resource phone number.
2730
- * @maxLength 500
2731
- */
2732
- phone?: string | null;
2733
- /**
2734
- * Resource description.
2735
- * @maxLength 500
2736
- */
2737
- description?: string | null;
2738
- /**
2739
- * Deprecated. Please use tags.
2740
- * @maxLength 500
2741
- * @deprecated
2742
- */
2743
- tag?: string | null;
2744
- /**
2745
- * Resource tags. Tags are used to identify, group, and filter the different types of resources. For example, 'staff' or 'room'.
2746
- * @maxLength 200
2747
- */
2748
- tags?: string[] | null;
2749
- /** Resource images. */
2750
- images?: string[];
2751
- /**
2752
- * Deprecated. Please use scheduleIds. List of the schedules owned by this resource. Min size 1.
2753
- * @deprecated
2754
- */
2755
- schedules?: Schedule[];
2756
- /**
2757
- * List of IDs of schedules owned by this resource.
2758
- * @format GUID
2759
- * @readonly
2760
- */
2761
- scheduleIds?: string[] | null;
2762
- /**
2763
- * Resource status. Default: `CREATED`.
2764
- * @readonly
2765
- */
2766
- status?: ResourceStatus;
2767
- /**
2768
- * Wix user ID, if the resource is associated with the Wix user.
2769
- * A staff member resource can be associated with a Wix user via assignment of a permissions role in the business manager.
2770
- * @format GUID
2771
- * @readonly
2772
- */
2773
- wixUserId?: string | null;
2774
- }
2775
- export interface FocalPoint {
2776
- /** X-coordinate of the focal point. */
2777
- x?: number;
2778
- /** Y-coordinate of the focal point. */
2779
- y?: number;
2780
- /** crop by height */
2781
- height?: number | null;
2782
- /** crop by width */
2783
- width?: number | null;
2784
- }
2785
- export interface Schedule {
2786
- /** Schedule ID. */
2787
- _id?: string;
2788
- /** ID of the schedule's owner entity. This may be a resource ID or a service ID. */
2789
- scheduleOwnerId?: string | null;
2790
- /**
2791
- * Schedule's time zone in [Area/Location](https://en.wikipedia.org/wiki/Tz_database) format. Read-only.
2792
- * Derived from the Wix Business time zone.
2793
- * @readonly
2794
- */
2795
- timeZone?: string | null;
2796
- /**
2797
- * Deprecated. Please use the [Sessions API](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/session) instead.
2798
- * @deprecated
2799
- */
2800
- intervals?: RecurringInterval[];
2801
- /**
2802
- * Default title for the schedule's sessions. Maximum length: 6000 characters.
2803
- * @maxLength 6000
2804
- */
2805
- title?: string | null;
2806
- /**
2807
- * __Deprecated.__
2808
- * Tags for grouping schedules. These tags are the default tags for the schedule's sessions.
2809
- * The Wix Bookings app uses the following predefined tags to set schedule type: `"INDIVIDUAL"`, `"GROUP"`, and `"COURSE"`. Once the schedule type is set using these tags, you cannot update it. In addition to the app's tags, you can create and update your own tags.
2810
- * @deprecated
2811
- */
2812
- tags?: string[] | null;
2813
- /** Default location for the schedule's sessions. */
2814
- location?: Location;
2815
- /**
2816
- * Maximum number of participants that can be added to the schedule's sessions.
2817
- * Must be at most `1` for schedule whose availability is affected by another schedule. E.g, appointment schedules of the Wix Bookings app.
2818
- * @min 1
2819
- * @max 1000
2820
- */
2821
- capacity?: number | null;
2822
- /**
2823
- * Deprecated. Please use the [Booking Services V2](https://dev.wix.com/api/rest/wix-bookings/services-v2) payment instead.
2824
- * @deprecated
2825
- */
2826
- rate?: Rate;
2827
- /**
2828
- * __Deprecated.__
2829
- * @deprecated
2830
- */
2831
- availability?: Availability;
2832
- /**
2833
- * Number of participants registered to sessions in this schedule, calculated as the sum of the party sizes.
2834
- * @readonly
2835
- */
2836
- totalNumberOfParticipants?: number;
2837
- /**
2838
- * *Partial list** of participants which are registered to sessions in this schedule.
2839
- * Participants who are registered in the schedule are automatically registered to any session that is created for the schedule.
2840
- * To retrieve the full list of schedule participants please use the [Query Extended Bookings API](https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/query-extended-bookings).
2841
- * @readonly
2842
- */
2843
- participants?: Participant[];
2844
- /**
2845
- * __Deprecated.__
2846
- * @deprecated
2847
- */
2848
- externalCalendarOverrides?: ExternalCalendarOverrides;
2849
- /**
2850
- * Schedule status. Default: Created
2851
- * @readonly
2852
- */
2853
- status?: ScheduleStatus;
2854
- /**
2855
- * Schedule creation date.
2856
- * @readonly
2857
- */
2858
- created?: Date | null;
2859
- /**
2860
- * Schedule last update date.
2861
- * @readonly
2862
- */
2863
- updated?: Date | null;
2864
- /**
2865
- * Schedule version number, updated each time the schedule is updated.
2866
- * @readonly
2867
- */
2868
- version?: number;
2869
- /**
2870
- * Fields which were inherited from the Business Info page under Settings in the Dashboard.
2871
- * @readonly
2872
- */
2873
- inheritedFields?: string[];
2874
- /**
2875
- * __Deprecated.__
2876
- * @deprecated
2877
- */
2878
- conferenceProvider?: ConferenceProvider;
2879
- /**
2880
- * A conference created for the schedule. This is used when a participant is added to a schedule.
2881
- * **Partially deprecated.** Only `hostUrl` and `guestUrl` are to be supported.
2882
- * @deprecated
2883
- */
2884
- calendarConference?: CalendarConference;
2885
- }
2886
- export interface RecurringInterval {
2887
- /**
2888
- * The recurring interval identifier.
2889
- * @readonly
2890
- */
2891
- _id?: string;
2892
- /** The start time of the recurring interval. Required. */
2893
- start?: Date | null;
2894
- /** The end time of the recurring interval. Optional. Empty value indicates that there is no end time. */
2895
- end?: Date | null;
2896
- /** The interval rules. The day, hour and minutes the interval is recurring. */
2897
- interval?: Interval;
2898
- /** The frequency of the interval. Optional. The default is frequency with the default repetition. */
2899
- frequency?: Frequency;
2900
- /** Specifies the list of linked schedules and the way this link affects the corresponding schedules' availability. Can be calculated from the schedule or overridden on the recurring interval. */
2901
- affectedSchedules?: LinkedSchedule[];
2902
- /** The type of recurring interval. */
2903
- intervalType?: RecurringIntervalType;
2904
- }
2905
- export interface Interval {
2906
- /** The day the interval occurs. Optional. The default is the day of the recurring interval's start time. */
2907
- daysOfWeek?: Day;
2908
- /**
2909
- * The hour of the day the interval occurs. Must be consistent with the interval start time. Optional. The default is 0. Minimum: 0, maximum: 23.
2910
- * @max 23
2911
- */
2912
- hourOfDay?: number | null;
2913
- /**
2914
- * The minutes of the hour the interval accrues. Must be consistent with the interval end time. Optional. The default is 0. Minimum: 0, maximum: 59.
2915
- * @max 59
2916
- */
2917
- minuteOfHour?: number | null;
2918
- /** The duration of the interval in minutes. Required. Part of the session end time calculation. */
2919
- duration?: number;
2920
- }
2921
- export declare enum Day {
2922
- /** Undefined. */
2923
- UNDEFINED = "UNDEFINED",
2924
- /** Monday. */
2925
- MON = "MON",
2926
- /** Tuesday. */
2927
- TUE = "TUE",
2928
- /** Wednesday. */
2929
- WED = "WED",
2930
- /** Thursday. */
2931
- THU = "THU",
2932
- /** Friday. */
2933
- FRI = "FRI",
2934
- /** Saturday. */
2935
- SAT = "SAT",
2936
- /** Sunday. */
2937
- SUN = "SUN"
2938
- }
2939
- export interface Frequency {
2940
- /**
2941
- * The frequency of the recurrence in weeks. i.e. when this value is 4, the interval occurs every 4 weeks. Optional. The default is 1. minimum: 1, maximum: 52.
2942
- * @min 1
2943
- * @max 52
2944
- */
2945
- repetition?: number | null;
2946
- }
2947
- export interface LinkedSchedule {
2948
- /**
2949
- * Schedule ID.
2950
- * @format GUID
2951
- */
2952
- scheduleId?: string;
2953
- /** Sets this schedule's availability for the duration of the linked schedule's sessions. Default is `"BUSY"`. */
2954
- transparency?: Transparency;
2955
- /**
2956
- * Owner ID, of the linked schedule.
2957
- * @readonly
2958
- */
2959
- scheduleOwnerId?: string;
2960
- }
2961
- export declare enum Transparency {
2962
- UNDEFINED = "UNDEFINED",
2963
- /** The schedule can have available slots during the linked schedule's sessions. */
2964
- FREE = "FREE",
2965
- /** The schedule can't have available slots during the linked schedule's sessions. */
2966
- BUSY = "BUSY"
2967
- }
2968
- export declare enum RecurringIntervalType {
2969
- /** The default value. Sessions for this interval will be of type EVENT. */
2970
- UNDEFINED = "UNDEFINED",
2971
- /** A recurring interval of events. */
2972
- EVENT = "EVENT",
2973
- /** Deprecated. */
2974
- TIME_AVAILABILITY = "TIME_AVAILABILITY",
2975
- /** A recurring interval for availability. */
2976
- AVAILABILITY = "AVAILABILITY"
2977
- }
2978
- export interface Location {
2979
- /**
2980
- * Location type.
2981
- * One of:
2982
- * - `"OWNER_BUSINESS"` The business address as set in the site’s general settings.
2983
- * - `"OWNER_CUSTOM"` The address as set when creating the service.
2984
- * - `"CUSTOM"` The address set for the individual session.
2985
- */
2986
- locationType?: LocationType;
2987
- /**
2988
- * Free text address used when locationType is `OWNER_CUSTOM`.
2989
- * @deprecated
2990
- */
2991
- address?: string | null;
2992
- /** Custom address, used when locationType is `"OWNER_CUSTOM"`. Might be used when locationType is `"CUSTOM"` in case the owner sets a custom address for the session which is different from the default. */
2993
- customAddress?: Address;
2994
- }
2995
- export declare enum LocationType {
2996
- UNDEFINED = "UNDEFINED",
2997
- OWNER_BUSINESS = "OWNER_BUSINESS",
2998
- OWNER_CUSTOM = "OWNER_CUSTOM",
2999
- CUSTOM = "CUSTOM"
3000
- }
3001
- /** Physical address */
3002
- export interface Address extends AddressStreetOneOf {
3003
- /** Street name, number and apartment number. */
3004
- streetAddress?: StreetAddress;
3005
- /** Main address line, usually street and number, as free text. */
3006
- addressLine?: string | null;
3007
- /**
3008
- * Country code.
3009
- * @format COUNTRY
3010
- */
3011
- country?: string | null;
3012
- /** Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
3013
- subdivision?: string | null;
3014
- /** City name. */
3015
- city?: string | null;
3016
- /** Zip/postal code. */
3017
- postalCode?: string | null;
3018
- /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
3019
- addressLine2?: string | null;
3020
- /** A string containing the full address of this location. */
3021
- formattedAddress?: string | null;
3022
- /** Free text to help find the address. */
3023
- hint?: string | null;
3024
- /** Coordinates of the physical address. */
3025
- geocode?: AddressLocation;
3026
- /** Country full name. */
3027
- countryFullname?: string | null;
3028
- /** Multi-level subdivisions from top to bottom. */
3029
- subdivisions?: Subdivision[];
3030
- }
3031
- /** @oneof */
3032
- export interface AddressStreetOneOf {
3033
- /** Street name, number and apartment number. */
3034
- streetAddress?: StreetAddress;
3035
- /** Main address line, usually street and number, as free text. */
3036
- addressLine?: string | null;
3037
- }
3038
- export interface StreetAddress {
3039
- /** Street number. */
3040
- number?: string;
3041
- /** Street name. */
3042
- name?: string;
3043
- /** Apartment number. */
3044
- apt?: string;
3045
- }
3046
- export interface AddressLocation {
3047
- /** Address latitude. */
3048
- latitude?: number | null;
3049
- /** Address longitude. */
3050
- longitude?: number | null;
3051
- }
3052
- export interface Subdivision {
3053
- /** Subdivision code. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
3054
- code?: string;
3055
- /** Subdivision full name. */
3056
- name?: string;
3057
- }
3058
- export interface LocationsLocation {
3059
- /**
3060
- * Location ID.
3061
- * @format GUID
3062
- * @readonly
3063
- */
3064
- _id?: string | null;
3065
- /**
3066
- * Location name.
3067
- * @maxLength 150
3068
- */
3069
- name?: string;
3070
- /**
3071
- * Location description.
3072
- * @maxLength 500
3073
- */
3074
- description?: string | null;
3075
- /**
3076
- * Whether this is the default location. There can only be one default location per site. The default location can't be archived.
3077
- * @readonly
3078
- */
3079
- default?: boolean;
3080
- /**
3081
- * Location status. Defaults to `ACTIVE`.
3082
- * __Notes:__
3083
- * - [Archiving a location](https://dev.wix.com/api/rest/business-info/locations/archive-location)
3084
- * doesn't affect the location's status.
3085
- * - `INACTIVE` status is currently not supported.
3086
- */
3087
- status?: LocationStatus;
3088
- /**
3089
- * Location type.
3090
- *
3091
- * **Note:** Currently not supported.
3092
- * @deprecated
3093
- */
3094
- locationType?: LocationsLocationType;
3095
- /** Fax number. */
3096
- fax?: string | null;
3097
- /** Timezone in `America/New_York` format. */
3098
- timeZone?: string | null;
3099
- /** Email address. */
3100
- email?: string | null;
3101
- /** Phone number. */
3102
- phone?: string | null;
3103
- /** Address. */
3104
- address?: LocationsAddress;
3105
- /**
3106
- * Business schedule. Array of weekly recurring time periods when the location is open for business. Limited to 100 time periods.
3107
- *
3108
- * __Note:__ Not supported by Wix Bookings.
3109
- */
3110
- businessSchedule?: BusinessSchedule;
3111
- /**
3112
- * Revision number, which increments by 1 each time the location is updated.
3113
- * To prevent conflicting changes, the existing revision must be used when updating a location.
3114
- */
3115
- revision?: string | null;
3116
- /**
3117
- * Whether the location is archived. Archived locations can't be updated.
3118
- * __Note:__ [Archiving a location](https://dev.wix.com/api/rest/business-info/locations/archive-location)
3119
- * doesn't affect its `status`.
3120
- * @readonly
3121
- */
3122
- archived?: boolean;
3123
- /**
3124
- * Location types.
3125
- * @maxSize 10
3126
- */
3127
- locationTypes?: LocationsLocationType[];
3128
- }
3129
- /** For future use */
3130
- export declare enum LocationStatus {
3131
- ACTIVE = "ACTIVE",
3132
- INACTIVE = "INACTIVE"
3133
- }
3134
- /** For future use */
3135
- export declare enum LocationsLocationType {
3136
- UNKNOWN = "UNKNOWN",
3137
- BRANCH = "BRANCH",
3138
- OFFICES = "OFFICES",
3139
- RECEPTION = "RECEPTION",
3140
- HEADQUARTERS = "HEADQUARTERS",
3141
- INVENTORY = "INVENTORY"
3142
- }
3143
- export interface LocationsAddress {
3144
- /**
3145
- * 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
3146
- * @format COUNTRY
3147
- */
3148
- country?: string | null;
3149
- /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. */
3150
- subdivision?: string | null;
3151
- /** City name. */
3152
- city?: string | null;
3153
- /**
3154
- * Postal or zip code.
3155
- * @maxLength 20
3156
- */
3157
- postalCode?: string | null;
3158
- /** Street address. Includes street name, number, and apartment number in separate fields. */
3159
- streetAddress?: LocationsStreetAddress;
3160
- /** Full address of the location. */
3161
- formatted?: string | null;
3162
- /** Geographic coordinates of location. */
3163
- location?: LocationsAddressLocation;
3164
- }
3165
- /** Street address. Includes street name, number, and apartment number in separate fields. */
3166
- export interface LocationsStreetAddress {
3167
- /** Street number. */
3168
- number?: string;
3169
- /** Street name. */
3170
- name?: string;
3171
- /** Apartment number. */
3172
- apt?: string;
3173
- }
3174
- /** Address Geolocation */
3175
- export interface LocationsAddressLocation {
3176
- /** Latitude of the location. Must be between -90 and 90. */
3177
- latitude?: number | null;
3178
- /** Longitude of the location. Must be between -180 and 180. */
3179
- longitude?: number | null;
3180
- }
3181
- /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
3182
- export interface BusinessSchedule {
3183
- /**
3184
- * Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
3185
- * @maxSize 100
3186
- */
3187
- periods?: TimePeriod[];
3188
- /**
3189
- * Exceptions to the business's regular hours. The business can be open or closed during the exception.
3190
- * @maxSize 100
3191
- */
3192
- specialHourPeriod?: SpecialHourPeriod[];
3193
- }
3194
- /** Weekly recurring time periods when the business is regularly open or the service is available. */
3195
- export interface TimePeriod {
3196
- /** Day of the week the period starts on. */
3197
- openDay?: DayOfWeek;
3198
- /**
3199
- * Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
3200
- * midnight at the end of the specified day.
3201
- */
3202
- openTime?: string;
3203
- /** Day of the week the period ends on. */
3204
- closeDay?: DayOfWeek;
3205
- /**
3206
- * Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
3207
- * midnight at the end of the specified day.
3208
- *
3209
- * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
3210
- */
3211
- closeTime?: string;
3212
- }
3213
- /** Enumerates the days of the week. */
3214
- export declare enum DayOfWeek {
3215
- MONDAY = "MONDAY",
3216
- TUESDAY = "TUESDAY",
3217
- WEDNESDAY = "WEDNESDAY",
3218
- THURSDAY = "THURSDAY",
3219
- FRIDAY = "FRIDAY",
3220
- SATURDAY = "SATURDAY",
3221
- SUNDAY = "SUNDAY"
3222
- }
3223
- /** Exception to the business's regular hours. The business can be open or closed during the exception. */
3224
- export interface SpecialHourPeriod {
3225
- /** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
3226
- startDate?: string;
3227
- /** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
3228
- endDate?: string;
3229
- /**
3230
- * Whether the business is closed (or the service is not available) during the exception.
3231
- *
3232
- * Default: `true`.
3233
- */
3234
- isClosed?: boolean;
3235
- /** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
3236
- comment?: string;
3237
- }
3238
- export interface Rate {
3239
- /**
3240
- * Mapping between a named price option, for example, adult or child prices, and the price, currency, and down payment amount.
3241
- * When present in an update request, the `default_varied_price` is ignored to support backward compatibility.
3242
- */
3243
- labeledPriceOptions?: Record<string, Price>;
3244
- /**
3245
- * Textual price information used when **Price Per Session** is set to **Custom Price** in the app's service details page.
3246
- * When present in an update request, the `default_varied_price` is ignored to support backward compatibility.
3247
- */
3248
- priceText?: string | null;
3249
- }
3250
- export interface Price {
3251
- /**
3252
- * Required payment amount.
3253
- * @format DECIMAL_VALUE
3254
- */
3255
- amount?: string;
3256
- /**
3257
- * Currency in which the amount is quoted.
3258
- * @format CURRENCY
3259
- */
3260
- currency?: string;
3261
- /**
3262
- * Amount of a down payment or deposit as part of the transaction.
3263
- * @format DECIMAL_VALUE
3264
- */
3265
- downPayAmount?: string;
3266
- }
3267
- /**
3268
- * <!-- Needs updating when recurrence has been tested
3269
- * Schedule's availability calculation is executed by the schedule's available intervals and this additional information.
3270
- * Schedule's available intervals are recurring intervals (defined in the schedule) minus sessions that has no more spots for bookings (including time between_slots), or schedule's sessions with open spots for bookings.-->
3271
- */
3272
- export interface Availability {
3273
- /** Date and time the schedule starts to be available for booking. */
3274
- start?: Date | null;
3275
- /** Date and time the schedule stops being available for booking. No value indicates no end time. */
3276
- end?: Date | null;
3277
- /** Other schedules that impact the availability calculation. Relevant only when there are availability constraints. */
3278
- linkedSchedules?: LinkedSchedule[];
3279
- /** Constraints for calculating the schedule's availability. */
3280
- constraints?: AvailabilityConstraints;
3281
- }
3282
- /** Describes how to calculate the specific slots that are available for booking. */
3283
- export interface AvailabilityConstraints {
3284
- /**
3285
- * A list of duration options for slots, in minutes. Minimum value for a duration is 1.
3286
- * The availability calculation generates slots with these durations, where there is no conflict with existing sessions or other availability constraints.
3287
- * @min 1
3288
- */
3289
- slotDurations?: number[];
3290
- /**
3291
- * The number of minutes between the `end` of one slot, and the `start` of the next.
3292
- * Minimum value is 0, maximum value is 120.
3293
- * @max 720
3294
- */
3295
- timeBetweenSlots?: number;
3296
- /**
3297
- * Specify how to split the slots in intervals of minutes.
3298
- * This value indicates the time between available slots' start time. e.g., from 5 minute slots (3:00, 3:05, 3:15) and 1 hour slots (3:00, 4:00, 5:00).
3299
- * Optional. The default is the first duration in slot_durations field.
3300
- * Deprecated. Use the `split_slots_interval.value_in_minutes`.
3301
- * @deprecated
3302
- */
3303
- splitInterval?: number | null;
3304
- /**
3305
- * An object defining the time between available slots' start times. For example, a slot with slots_split_interval=5 can start every 5 minutes. The default is the slot duration.
3306
- * @readonly
3307
- */
3308
- slotsSplitInterval?: SplitInterval;
3309
- }
3310
- /** The time between available slots' start times. For example, For 5 minute slots, 3:00, 3:05, 3:15 etc. For 1 hour slots, 3:00, 4:00, 5:00 etc. */
3311
- export interface SplitInterval {
3312
- /**
3313
- * Whether the slot duration is used as the split interval value.
3314
- * If `same_as_duration` is `true`, the `value_in_minutes` is the sum of the first duration in
3315
- * `schedule.availabilityConstraints.SlotDurations` field, and `schedule.availabilityConstraints.TimeBetweenSlots` field.
3316
- */
3317
- sameAsDuration?: boolean | null;
3318
- /** Number of minutes between available slots' start times when `same_as_duration` is `false`. */
3319
- valueInMinutes?: number | null;
3320
- }
3321
- export interface Participant {
3322
- /**
3323
- * Participant ID. Currently represents the booking.id.
3324
- * @format GUID
3325
- */
3326
- _id?: string;
3327
- /**
3328
- * Contact ID.
3329
- * @format GUID
3330
- */
3331
- contactId?: string | null;
3332
- /** Participant's name. */
3333
- name?: string | null;
3334
- /** Participant's phone number. */
3335
- phone?: string | null;
3336
- /** Participant's email address. */
3337
- email?: string | null;
3338
- /** Group or party size. The number of people attending. Defaults to 0. Maximum is 250. */
3339
- partySize?: number;
3340
- /**
3341
- * Approval status for the participant.
3342
- * <!-- Commented out untill updateParticipant is exposed Generally the same status as the booking, unless updated using the `updateParticipant()` API. Defaults to `"UNDEFINED"`.-->
3343
- */
3344
- approvalStatus?: ApprovalStatus;
3345
- /**
3346
- * Whether the participant was inherited from the schedule, as opposed to being booked directly to the session.
3347
- * @readonly
3348
- */
3349
- inherited?: boolean;
3350
- }
3351
- export declare enum ApprovalStatus {
3352
- /** Default. */
3353
- UNDEFINED = "UNDEFINED",
3354
- /** Pending business approval. */
3355
- PENDING = "PENDING",
3356
- /** Approved by the business. */
3357
- APPROVED = "APPROVED",
3358
- /** Declined by the business. */
3359
- DECLINED = "DECLINED"
3360
- }
3361
- export interface ExternalCalendarOverrides {
3362
- /** Synced title of the external calendar event. */
3363
- title?: string | null;
3364
- /** Synced description of the external calendar event. */
3365
- description?: string | null;
3366
- }
3367
- export declare enum ScheduleStatus {
3368
- /** Undefined schedule status. */
3369
- UNDEFINED = "UNDEFINED",
3370
- /** The schedule was created. */
3371
- CREATED = "CREATED",
3372
- /** The schedule was cancelled. */
3373
- CANCELLED = "CANCELLED"
3374
- }
3375
- export interface Version {
3376
- /** Schedule version number, updated each time the schedule is updated. */
3377
- scheduleVersion?: number | null;
3378
- /** Participants version number, updated each time the schedule participants are updated. */
3379
- participantsVersion?: number | null;
3380
- }
3381
- export interface ConferenceProvider {
3382
- /** Conferencing provider ID */
3383
- providerId?: string;
3384
- }
3385
- export interface CalendarConference {
3386
- /** Wix Calendar conference ID. */
3387
- _id?: string;
3388
- /** Conference meeting ID in the provider's conferencing system. */
3389
- externalId?: string;
3390
- /** Conference provider ID. */
3391
- providerId?: string;
3392
- /** URL used by the host to start the conference. */
3393
- hostUrl?: string;
3394
- /** URL used by a guest to join the conference. */
3395
- guestUrl?: string;
3396
- /** Password to join the conference. */
3397
- password?: string | null;
3398
- /** Conference description. */
3399
- description?: string | null;
3400
- /** Conference type. */
3401
- conferenceType?: ConferenceType;
3402
- /** ID of the account owner in the video conferencing service. */
3403
- accountOwnerId?: string | null;
3404
- }
3405
- export declare enum ConferenceType {
3406
- /** Undefined conference type. */
3407
- UNDEFINED = "UNDEFINED",
3408
- /** API-generated online meeting. */
3409
- ONLINE_MEETING_PROVIDER = "ONLINE_MEETING_PROVIDER",
3410
- /** User-defined meeting. */
3411
- CUSTOM = "CUSTOM"
3412
- }
3413
- export declare enum ResourceStatus {
3414
- /** Undefined resource status. */
3415
- UNDEFINED = "UNDEFINED",
3416
- /** The resource was created. */
3417
- CREATED = "CREATED",
3418
- /** The resource was deleted. */
3419
- DELETED = "DELETED",
3420
- /** The resource was updated. */
3421
- UPDATED = "UPDATED"
3422
- }
3423
- export interface BusinessLocation {
3424
- /**
3425
- * The ID of the business location. Has to be non-empty
3426
- * @format GUID
3427
- */
3428
- locationId?: string;
3429
- }
3430
- export declare enum ResourceNotificationEvent {
3431
- /** Undefined resource event. */
3432
- UNDEFINED = "UNDEFINED",
3433
- /** The resource was updated. */
3434
- Updated = "Updated",
3435
- /** The resource was deleted. */
3436
- Deleted = "Deleted",
3437
- /** The resource was created. */
3438
- Created = "Created",
3439
- /** The schedule was updated. */
3440
- Schedule_Updated = "Schedule_Updated"
3441
- }
3442
2694
  export interface BenefitNotification {
3443
2695
  /**
3444
2696
  * Plan unique ID
@@ -3643,7 +2895,7 @@ export interface Properties {
3643
2895
  /** Fax number. */
3644
2896
  fax?: string | null;
3645
2897
  /** Address. */
3646
- address?: V4Address;
2898
+ address?: Address;
3647
2899
  /** Site display name. */
3648
2900
  siteDisplayName?: string | null;
3649
2901
  /** Business name. */
@@ -3690,7 +2942,7 @@ export interface Locale {
3690
2942
  /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
3691
2943
  country?: string;
3692
2944
  }
3693
- export interface V4Address {
2945
+ export interface Address {
3694
2946
  /** Street name. */
3695
2947
  street?: string;
3696
2948
  /** City name. */
@@ -3741,6 +2993,63 @@ export interface GeoCoordinates {
3741
2993
  /** Longitude of the location. Must be between -180 and 180. */
3742
2994
  longitude?: number;
3743
2995
  }
2996
+ /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
2997
+ export interface BusinessSchedule {
2998
+ /**
2999
+ * Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
3000
+ * @maxSize 100
3001
+ */
3002
+ periods?: TimePeriod[];
3003
+ /**
3004
+ * Exceptions to the business's regular hours. The business can be open or closed during the exception.
3005
+ * @maxSize 100
3006
+ */
3007
+ specialHourPeriod?: SpecialHourPeriod[];
3008
+ }
3009
+ /** Weekly recurring time periods when the business is regularly open or the service is available. */
3010
+ export interface TimePeriod {
3011
+ /** Day of the week the period starts on. */
3012
+ openDay?: DayOfWeek;
3013
+ /**
3014
+ * Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
3015
+ * midnight at the end of the specified day.
3016
+ */
3017
+ openTime?: string;
3018
+ /** Day of the week the period ends on. */
3019
+ closeDay?: DayOfWeek;
3020
+ /**
3021
+ * Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
3022
+ * midnight at the end of the specified day.
3023
+ *
3024
+ * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
3025
+ */
3026
+ closeTime?: string;
3027
+ }
3028
+ /** Enumerates the days of the week. */
3029
+ export declare enum DayOfWeek {
3030
+ MONDAY = "MONDAY",
3031
+ TUESDAY = "TUESDAY",
3032
+ WEDNESDAY = "WEDNESDAY",
3033
+ THURSDAY = "THURSDAY",
3034
+ FRIDAY = "FRIDAY",
3035
+ SATURDAY = "SATURDAY",
3036
+ SUNDAY = "SUNDAY"
3037
+ }
3038
+ /** Exception to the business's regular hours. The business can be open or closed during the exception. */
3039
+ export interface SpecialHourPeriod {
3040
+ /** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
3041
+ startDate?: string;
3042
+ /** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
3043
+ endDate?: string;
3044
+ /**
3045
+ * Whether the business is closed (or the service is not available) during the exception.
3046
+ *
3047
+ * Default: `true`.
3048
+ */
3049
+ isClosed?: boolean;
3050
+ /** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
3051
+ comment?: string;
3052
+ }
3744
3053
  export interface Multilingual {
3745
3054
  /**
3746
3055
  * Supported languages list.
@@ -3996,25 +3305,21 @@ export interface BaseEventMetadata {
3996
3305
  identity?: IdentificationData;
3997
3306
  }
3998
3307
  export interface EventMetadata extends BaseEventMetadata {
3999
- /**
4000
- * Unique event ID.
4001
- * Allows clients to ignore duplicate webhooks.
4002
- */
3308
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
4003
3309
  _id?: string;
4004
3310
  /**
4005
- * Assumes actions are also always typed to an entity_type
4006
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
3311
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
3312
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
4007
3313
  */
4008
3314
  entityFqdn?: string;
4009
3315
  /**
4010
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
4011
- * This is although the created/updated/deleted notion is duplication of the oneof types
4012
- * Example: created/updated/deleted/started/completed/email_opened
3316
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
3317
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
4013
3318
  */
4014
3319
  slug?: string;
4015
3320
  /** ID of the entity associated with the event. */
4016
3321
  entityId?: string;
4017
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
3322
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
4018
3323
  eventTime?: Date | null;
4019
3324
  /**
4020
3325
  * Whether the event was triggered as a result of a privacy regulation application
@@ -4024,12 +3329,8 @@ export interface EventMetadata extends BaseEventMetadata {
4024
3329
  /** If present, indicates the action that triggered the event. */
4025
3330
  originatedFrom?: string | null;
4026
3331
  /**
4027
- * A sequence number defining the order of updates to the underlying entity.
4028
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
4029
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
4030
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
4031
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
4032
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
3332
+ * 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.
3333
+ * 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.
4033
3334
  */
4034
3335
  entityEventSequence?: string | null;
4035
3336
  }
@@ -4319,7 +3620,7 @@ export interface UpdateService {
4319
3620
  * @immutable
4320
3621
  * @maxSize 500
4321
3622
  */
4322
- locations?: V2Location[];
3623
+ locations?: Location[];
4323
3624
  /**
4324
3625
  * _Policy_
4325
3626
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction))
@@ -4332,7 +3633,7 @@ export interface UpdateService {
4332
3633
  * which can be used to manage the service's *events*
4333
3634
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction)).
4334
3635
  */
4335
- schedule?: V2Schedule;
3636
+ schedule?: Schedule;
4336
3637
  /**
4337
3638
  * IDs of the *staff members*
4338
3639
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/introduction))
@@ -5077,7 +4378,7 @@ export interface QueryCategoriesOptions {
5077
4378
  * @applicableIdentity APP
5078
4379
  * @fqn wix.bookings.services.v2.ServicesService.SetServiceLocations
5079
4380
  */
5080
- export declare function setServiceLocations(serviceId: string, locations: V2Location[], options?: SetServiceLocationsOptions): Promise<NonNullablePaths<SetServiceLocationsResponse, {
4381
+ export declare function setServiceLocations(serviceId: string, locations: Location[], options?: SetServiceLocationsOptions): Promise<NonNullablePaths<SetServiceLocationsResponse, {
5081
4382
  [P in ServiceNonNullablePaths]: `service.${P}`;
5082
4383
  }[ServiceNonNullablePaths]>>;
5083
4384
  export interface SetServiceLocationsOptions {