@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
@@ -67,7 +67,7 @@ export interface Service {
67
67
  * @immutable
68
68
  * @maxSize 500
69
69
  */
70
- locations?: V2Location[];
70
+ locations?: Location[];
71
71
  /**
72
72
  * _Policy_
73
73
  * ([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))
@@ -80,7 +80,7 @@ export interface Service {
80
80
  * which can be used to manage the service's *events*
81
81
  * ([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)).
82
82
  */
83
- schedule?: V2Schedule;
83
+ schedule?: Schedule;
84
84
  /**
85
85
  * IDs of the *staff members*
86
86
  * ([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))
@@ -388,7 +388,7 @@ export interface Conferencing {
388
388
  /** Whether a conference link is generated for the service's sessions. */
389
389
  enabled?: boolean | null;
390
390
  }
391
- export interface V2Location extends V2LocationOptionsOneOf {
391
+ export interface Location extends LocationOptionsOneOf {
392
392
  /** Information about business locations. */
393
393
  business?: BusinessLocationOptions;
394
394
  /** Information about custom locations. */
@@ -404,7 +404,7 @@ export interface V2Location extends V2LocationOptionsOneOf {
404
404
  *
405
405
  * Default: `CUSTOM`
406
406
  */
407
- type?: LocationTypeEnumLocationType;
407
+ type?: LocationType;
408
408
  /**
409
409
  * Location address. Empty for `{"type": "CUSTOMER"}`.
410
410
  * @readonly
@@ -412,13 +412,13 @@ export interface V2Location extends V2LocationOptionsOneOf {
412
412
  calculatedAddress?: CommonAddress;
413
413
  }
414
414
  /** @oneof */
415
- export interface V2LocationOptionsOneOf {
415
+ export interface LocationOptionsOneOf {
416
416
  /** Information about business locations. */
417
417
  business?: BusinessLocationOptions;
418
418
  /** Information about custom locations. */
419
419
  custom?: CustomLocationOptions;
420
420
  }
421
- export declare enum LocationTypeEnumLocationType {
421
+ export declare enum LocationType {
422
422
  UNKNOWN_LOCATION_TYPE = "UNKNOWN_LOCATION_TYPE",
423
423
  /**
424
424
  * Location set by the business that is not a standard business *location*
@@ -438,7 +438,7 @@ export declare enum LocationTypeEnumLocationType {
438
438
  }
439
439
  export interface CommonAddress extends CommonAddressStreetOneOf {
440
440
  /** Street name and number. */
441
- streetAddress?: CommonStreetAddress;
441
+ streetAddress?: StreetAddress;
442
442
  /** @maxLength 255 */
443
443
  addressLine?: string | null;
444
444
  /**
@@ -470,12 +470,12 @@ export interface CommonAddress extends CommonAddressStreetOneOf {
470
470
  /** @oneof */
471
471
  export interface CommonAddressStreetOneOf {
472
472
  /** Street name and number. */
473
- streetAddress?: CommonStreetAddress;
473
+ streetAddress?: StreetAddress;
474
474
  /** @maxLength 255 */
475
475
  addressLine?: string | null;
476
476
  }
477
477
  /** Street address. Includes street name, number, and apartment number in separate fields. */
478
- export interface CommonStreetAddress {
478
+ export interface StreetAddress {
479
479
  /**
480
480
  * Street number.
481
481
  * @maxLength 255
@@ -492,7 +492,7 @@ export interface CommonStreetAddress {
492
492
  */
493
493
  apt?: string;
494
494
  }
495
- export interface CommonAddressLocation {
495
+ export interface AddressLocation {
496
496
  /** Address latitude. */
497
497
  latitude?: number | null;
498
498
  /** Address longitude. */
@@ -879,7 +879,7 @@ export interface SaveCreditCardPolicy {
879
879
  /** Default: `false` */
880
880
  enabled?: boolean;
881
881
  }
882
- export interface V2Schedule {
882
+ export interface Schedule {
883
883
  /**
884
884
  * ID of the *schedule*
885
885
  * ([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))
@@ -899,9 +899,9 @@ export interface V2Schedule {
899
899
  */
900
900
  lastSessionEnd?: Date | null;
901
901
  /** Limitations affecting the service availability. */
902
- availabilityConstraints?: V2AvailabilityConstraints;
902
+ availabilityConstraints?: AvailabilityConstraints;
903
903
  }
904
- export interface V2AvailabilityConstraints {
904
+ export interface AvailabilityConstraints {
905
905
  /**
906
906
  * Calculated list of all supported session durations for the service. For
907
907
  * appointment-based services without varied pricing based on session length, it
@@ -1241,25 +1241,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
1241
1241
  updatedEvent?: EntityUpdatedEvent;
1242
1242
  deletedEvent?: EntityDeletedEvent;
1243
1243
  actionEvent?: ActionEvent;
1244
- /**
1245
- * Unique event ID.
1246
- * Allows clients to ignore duplicate webhooks.
1247
- */
1244
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
1248
1245
  id?: string;
1249
1246
  /**
1250
- * Assumes actions are also always typed to an entity_type
1251
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1247
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
1248
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
1252
1249
  */
1253
1250
  entityFqdn?: string;
1254
1251
  /**
1255
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1256
- * This is although the created/updated/deleted notion is duplication of the oneof types
1257
- * Example: created/updated/deleted/started/completed/email_opened
1252
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
1253
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
1258
1254
  */
1259
1255
  slug?: string;
1260
1256
  /** ID of the entity associated with the event. */
1261
1257
  entityId?: string;
1262
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1258
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
1263
1259
  eventTime?: Date | null;
1264
1260
  /**
1265
1261
  * Whether the event was triggered as a result of a privacy regulation application
@@ -1269,12 +1265,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
1269
1265
  /** If present, indicates the action that triggered the event. */
1270
1266
  originatedFrom?: string | null;
1271
1267
  /**
1272
- * A sequence number defining the order of updates to the underlying entity.
1273
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
1274
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1275
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1276
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
1277
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1268
+ * 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.
1269
+ * 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.
1278
1270
  */
1279
1271
  entityEventSequence?: string | null;
1280
1272
  }
@@ -1302,7 +1294,7 @@ export interface EntityUpdatedEvent {
1302
1294
  currentEntityAsJson?: string;
1303
1295
  }
1304
1296
  export interface EntityDeletedEvent {
1305
- /** Entity that was deleted */
1297
+ /** Entity that was deleted. */
1306
1298
  deletedEntityAsJson?: string | null;
1307
1299
  }
1308
1300
  export interface ActionEvent {
@@ -1503,7 +1495,7 @@ export interface ServiceAvailabilityConstraints {
1503
1495
  * The service schedule, including the schedule ID and availability constraints.
1504
1496
  * @readonly
1505
1497
  */
1506
- schedule?: V2Schedule;
1498
+ schedule?: Schedule;
1507
1499
  /**
1508
1500
  * The locations this service is offered at.
1509
1501
  * Only multiple locations of type `BUSINESS` are supported. Multiple locations of type `CUSTOM` or `CUSTOMER` are not supported.
@@ -1512,7 +1504,7 @@ export interface ServiceAvailabilityConstraints {
1512
1504
  * @readonly
1513
1505
  * @maxSize 100
1514
1506
  */
1515
- locations?: V2Location[];
1507
+ locations?: Location[];
1516
1508
  /**
1517
1509
  * Resource groups required to book the service. For backward compatibility only. Use `Service Resources` instead.
1518
1510
  * @maxSize 3
@@ -1535,7 +1527,7 @@ export interface ServiceAvailabilityConstraints {
1535
1527
  * For appointments only.
1536
1528
  * @readonly
1537
1529
  */
1538
- slotsSplitInterval?: V1SplitInterval;
1530
+ slotsSplitInterval?: SplitInterval;
1539
1531
  /**
1540
1532
  * Online booking settings.
1541
1533
  * @readonly
@@ -1543,7 +1535,7 @@ export interface ServiceAvailabilityConstraints {
1543
1535
  onlineBooking?: OnlineBooking;
1544
1536
  }
1545
1537
  /** 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. */
1546
- export interface V1SplitInterval {
1538
+ export interface SplitInterval {
1547
1539
  /**
1548
1540
  * Whether the slot duration is used as the split interval value.
1549
1541
  * If `same_as_duration` is `true`, the `value_in_minutes` is the sum of the first duration in
@@ -1932,9 +1924,9 @@ export interface ScalarAggregation {
1932
1924
  }
1933
1925
  export interface DateHistogramAggregation {
1934
1926
  /** Interval for date histogram aggregation */
1935
- interval?: DateHistogramAggregationInterval;
1927
+ interval?: Interval;
1936
1928
  }
1937
- export declare enum DateHistogramAggregationInterval {
1929
+ export declare enum Interval {
1938
1930
  /** Unknown interval. */
1939
1931
  UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
1940
1932
  /** Yearly interval. */
@@ -2454,7 +2446,7 @@ export interface BusinessLocations {
2454
2446
  * Retrieved business locations.
2455
2447
  * @maxSize 100
2456
2448
  */
2457
- locations?: V2Location[];
2449
+ locations?: Location[];
2458
2450
  }
2459
2451
  export interface CustomLocations {
2460
2452
  /**
@@ -2517,7 +2509,7 @@ export interface SetServiceLocationsRequest {
2517
2509
  * 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.
2518
2510
  * @maxSize 100
2519
2511
  */
2520
- locations: V2Location[];
2512
+ locations: Location[];
2521
2513
  /**
2522
2514
  * The action to perform on sessions currently set to a removed location. For
2523
2515
  * example, move existing sessions to a new specified location.
@@ -2561,7 +2553,7 @@ export declare enum Action {
2561
2553
  }
2562
2554
  export interface MoveToNewLocationsOptions {
2563
2555
  /** The new location to move existing sessions currently set to a removed location, used when `action` is `MOVE_TO_LOCATION`. */
2564
- newLocation?: V2Location;
2556
+ newLocation?: Location;
2565
2557
  }
2566
2558
  export interface SetServiceLocationsResponse {
2567
2559
  /** The updated service with the newly set locations. */
@@ -2739,774 +2731,6 @@ export declare enum CategoryNotificationEvent {
2739
2731
  }
2740
2732
  export interface Empty {
2741
2733
  }
2742
- export interface ResourceNotification {
2743
- /**
2744
- * Updated resource entity.
2745
- * 'resource.schedules' is deprecated and will not be returned. Please use 'resource.scheduleIds' instead.
2746
- */
2747
- resource?: Resource;
2748
- /** Event type. */
2749
- event?: ResourceNotificationEvent;
2750
- }
2751
- export interface Resource {
2752
- /**
2753
- * Resource ID.
2754
- * @format GUID
2755
- * @readonly
2756
- */
2757
- id?: string | null;
2758
- /**
2759
- * Resource name.
2760
- * @maxLength 1200
2761
- */
2762
- name?: string | null;
2763
- /**
2764
- * Resource email address.
2765
- * @maxLength 500
2766
- */
2767
- email?: string | null;
2768
- /**
2769
- * Resource phone number.
2770
- * @maxLength 500
2771
- */
2772
- phone?: string | null;
2773
- /**
2774
- * Resource description.
2775
- * @maxLength 500
2776
- */
2777
- description?: string | null;
2778
- /**
2779
- * Deprecated. Please use tags.
2780
- * @maxLength 500
2781
- * @deprecated
2782
- */
2783
- tag?: string | null;
2784
- /**
2785
- * Resource tags. Tags are used to identify, group, and filter the different types of resources. For example, 'staff' or 'room'.
2786
- * @maxLength 200
2787
- */
2788
- tags?: string[] | null;
2789
- /** Resource images. */
2790
- images?: CommonImage[];
2791
- /**
2792
- * Deprecated. Please use scheduleIds. List of the schedules owned by this resource. Min size 1.
2793
- * @deprecated
2794
- */
2795
- schedules?: Schedule[];
2796
- /**
2797
- * List of IDs of schedules owned by this resource.
2798
- * @format GUID
2799
- * @readonly
2800
- */
2801
- scheduleIds?: string[] | null;
2802
- /**
2803
- * Resource status. Default: `CREATED`.
2804
- * @readonly
2805
- */
2806
- status?: ResourceStatus;
2807
- /**
2808
- * Wix user ID, if the resource is associated with the Wix user.
2809
- * A staff member resource can be associated with a Wix user via assignment of a permissions role in the business manager.
2810
- * @format GUID
2811
- * @readonly
2812
- */
2813
- wixUserId?: string | null;
2814
- }
2815
- export interface CommonImage {
2816
- /** WixMedia image ID. */
2817
- id?: string;
2818
- /** Image URL. */
2819
- url?: string;
2820
- /**
2821
- * Original image height.
2822
- * @readonly
2823
- */
2824
- height?: number;
2825
- /**
2826
- * Original image width.
2827
- * @readonly
2828
- */
2829
- width?: number;
2830
- /** Image alt text. */
2831
- altText?: string | null;
2832
- /**
2833
- * Image filename.
2834
- * @readonly
2835
- */
2836
- filename?: string | null;
2837
- }
2838
- export interface FocalPoint {
2839
- /** X-coordinate of the focal point. */
2840
- x?: number;
2841
- /** Y-coordinate of the focal point. */
2842
- y?: number;
2843
- /** crop by height */
2844
- height?: number | null;
2845
- /** crop by width */
2846
- width?: number | null;
2847
- }
2848
- export interface Schedule {
2849
- /** Schedule ID. */
2850
- id?: string;
2851
- /** ID of the schedule's owner entity. This may be a resource ID or a service ID. */
2852
- scheduleOwnerId?: string | null;
2853
- /**
2854
- * Schedule's time zone in [Area/Location](https://en.wikipedia.org/wiki/Tz_database) format. Read-only.
2855
- * Derived from the Wix Business time zone.
2856
- * @readonly
2857
- */
2858
- timeZone?: string | null;
2859
- /**
2860
- * Deprecated. Please use the [Sessions API](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/session) instead.
2861
- * @deprecated
2862
- */
2863
- intervals?: RecurringInterval[];
2864
- /**
2865
- * Default title for the schedule's sessions. Maximum length: 6000 characters.
2866
- * @maxLength 6000
2867
- */
2868
- title?: string | null;
2869
- /**
2870
- * __Deprecated.__
2871
- * Tags for grouping schedules. These tags are the default tags for the schedule's sessions.
2872
- * 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.
2873
- * @deprecated
2874
- */
2875
- tags?: string[] | null;
2876
- /** Default location for the schedule's sessions. */
2877
- location?: Location;
2878
- /**
2879
- * Maximum number of participants that can be added to the schedule's sessions.
2880
- * Must be at most `1` for schedule whose availability is affected by another schedule. E.g, appointment schedules of the Wix Bookings app.
2881
- * @min 1
2882
- * @max 1000
2883
- */
2884
- capacity?: number | null;
2885
- /**
2886
- * Deprecated. Please use the [Booking Services V2](https://dev.wix.com/api/rest/wix-bookings/services-v2) payment instead.
2887
- * @deprecated
2888
- */
2889
- rate?: Rate;
2890
- /**
2891
- * __Deprecated.__
2892
- * @deprecated
2893
- */
2894
- availability?: Availability;
2895
- /**
2896
- * Number of participants registered to sessions in this schedule, calculated as the sum of the party sizes.
2897
- * @readonly
2898
- */
2899
- totalNumberOfParticipants?: number;
2900
- /**
2901
- * *Partial list** of participants which are registered to sessions in this schedule.
2902
- * Participants who are registered in the schedule are automatically registered to any session that is created for the schedule.
2903
- * 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).
2904
- * @readonly
2905
- */
2906
- participants?: Participant[];
2907
- /**
2908
- * __Deprecated.__
2909
- * @deprecated
2910
- */
2911
- externalCalendarOverrides?: ExternalCalendarOverrides;
2912
- /**
2913
- * Schedule status. Default: Created
2914
- * @readonly
2915
- */
2916
- status?: ScheduleStatus;
2917
- /**
2918
- * Schedule creation date.
2919
- * @readonly
2920
- */
2921
- created?: Date | null;
2922
- /**
2923
- * Schedule last update date.
2924
- * @readonly
2925
- */
2926
- updated?: Date | null;
2927
- /**
2928
- * Schedule version number, updated each time the schedule is updated.
2929
- * @readonly
2930
- */
2931
- version?: number;
2932
- /**
2933
- * Fields which were inherited from the Business Info page under Settings in the Dashboard.
2934
- * @readonly
2935
- */
2936
- inheritedFields?: string[];
2937
- /**
2938
- * __Deprecated.__
2939
- * @deprecated
2940
- */
2941
- conferenceProvider?: ConferenceProvider;
2942
- /**
2943
- * A conference created for the schedule. This is used when a participant is added to a schedule.
2944
- * **Partially deprecated.** Only `hostUrl` and `guestUrl` are to be supported.
2945
- * @deprecated
2946
- */
2947
- calendarConference?: CalendarConference;
2948
- }
2949
- export interface RecurringInterval {
2950
- /**
2951
- * The recurring interval identifier.
2952
- * @readonly
2953
- */
2954
- id?: string;
2955
- /** The start time of the recurring interval. Required. */
2956
- start?: Date | null;
2957
- /** The end time of the recurring interval. Optional. Empty value indicates that there is no end time. */
2958
- end?: Date | null;
2959
- /** The interval rules. The day, hour and minutes the interval is recurring. */
2960
- interval?: Interval;
2961
- /** The frequency of the interval. Optional. The default is frequency with the default repetition. */
2962
- frequency?: Frequency;
2963
- /** 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. */
2964
- affectedSchedules?: LinkedSchedule[];
2965
- /** The type of recurring interval. */
2966
- intervalType?: RecurringIntervalType;
2967
- }
2968
- export interface Interval {
2969
- /** The day the interval occurs. Optional. The default is the day of the recurring interval's start time. */
2970
- daysOfWeek?: Day;
2971
- /**
2972
- * 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.
2973
- * @max 23
2974
- */
2975
- hourOfDay?: number | null;
2976
- /**
2977
- * 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.
2978
- * @max 59
2979
- */
2980
- minuteOfHour?: number | null;
2981
- /** The duration of the interval in minutes. Required. Part of the session end time calculation. */
2982
- duration?: number;
2983
- }
2984
- export declare enum Day {
2985
- /** Undefined. */
2986
- UNDEFINED = "UNDEFINED",
2987
- /** Monday. */
2988
- MON = "MON",
2989
- /** Tuesday. */
2990
- TUE = "TUE",
2991
- /** Wednesday. */
2992
- WED = "WED",
2993
- /** Thursday. */
2994
- THU = "THU",
2995
- /** Friday. */
2996
- FRI = "FRI",
2997
- /** Saturday. */
2998
- SAT = "SAT",
2999
- /** Sunday. */
3000
- SUN = "SUN"
3001
- }
3002
- export interface Frequency {
3003
- /**
3004
- * 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.
3005
- * @min 1
3006
- * @max 52
3007
- */
3008
- repetition?: number | null;
3009
- }
3010
- export interface LinkedSchedule {
3011
- /**
3012
- * Schedule ID.
3013
- * @format GUID
3014
- */
3015
- scheduleId?: string;
3016
- /** Sets this schedule's availability for the duration of the linked schedule's sessions. Default is `"BUSY"`. */
3017
- transparency?: Transparency;
3018
- /**
3019
- * Owner ID, of the linked schedule.
3020
- * @readonly
3021
- */
3022
- scheduleOwnerId?: string;
3023
- }
3024
- export declare enum Transparency {
3025
- UNDEFINED = "UNDEFINED",
3026
- /** The schedule can have available slots during the linked schedule's sessions. */
3027
- FREE = "FREE",
3028
- /** The schedule can't have available slots during the linked schedule's sessions. */
3029
- BUSY = "BUSY"
3030
- }
3031
- export declare enum RecurringIntervalType {
3032
- /** The default value. Sessions for this interval will be of type EVENT. */
3033
- UNDEFINED = "UNDEFINED",
3034
- /** A recurring interval of events. */
3035
- EVENT = "EVENT",
3036
- /** Deprecated. */
3037
- TIME_AVAILABILITY = "TIME_AVAILABILITY",
3038
- /** A recurring interval for availability. */
3039
- AVAILABILITY = "AVAILABILITY"
3040
- }
3041
- export interface Location {
3042
- /**
3043
- * Location type.
3044
- * One of:
3045
- * - `"OWNER_BUSINESS"` The business address as set in the site’s general settings.
3046
- * - `"OWNER_CUSTOM"` The address as set when creating the service.
3047
- * - `"CUSTOM"` The address set for the individual session.
3048
- */
3049
- locationType?: LocationType;
3050
- /**
3051
- * Free text address used when locationType is `OWNER_CUSTOM`.
3052
- * @deprecated
3053
- */
3054
- address?: string | null;
3055
- /** 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. */
3056
- customAddress?: Address;
3057
- }
3058
- export declare enum LocationType {
3059
- UNDEFINED = "UNDEFINED",
3060
- OWNER_BUSINESS = "OWNER_BUSINESS",
3061
- OWNER_CUSTOM = "OWNER_CUSTOM",
3062
- CUSTOM = "CUSTOM"
3063
- }
3064
- /** Physical address */
3065
- export interface Address extends AddressStreetOneOf {
3066
- /** Street name, number and apartment number. */
3067
- streetAddress?: StreetAddress;
3068
- /** Main address line, usually street and number, as free text. */
3069
- addressLine?: string | null;
3070
- /**
3071
- * Country code.
3072
- * @format COUNTRY
3073
- */
3074
- country?: string | null;
3075
- /** Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
3076
- subdivision?: string | null;
3077
- /** City name. */
3078
- city?: string | null;
3079
- /** Zip/postal code. */
3080
- postalCode?: string | null;
3081
- /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
3082
- addressLine2?: string | null;
3083
- /** A string containing the full address of this location. */
3084
- formattedAddress?: string | null;
3085
- /** Free text to help find the address. */
3086
- hint?: string | null;
3087
- /** Coordinates of the physical address. */
3088
- geocode?: AddressLocation;
3089
- /** Country full name. */
3090
- countryFullname?: string | null;
3091
- /** Multi-level subdivisions from top to bottom. */
3092
- subdivisions?: Subdivision[];
3093
- }
3094
- /** @oneof */
3095
- export interface AddressStreetOneOf {
3096
- /** Street name, number and apartment number. */
3097
- streetAddress?: StreetAddress;
3098
- /** Main address line, usually street and number, as free text. */
3099
- addressLine?: string | null;
3100
- }
3101
- export interface StreetAddress {
3102
- /** Street number. */
3103
- number?: string;
3104
- /** Street name. */
3105
- name?: string;
3106
- /** Apartment number. */
3107
- apt?: string;
3108
- }
3109
- export interface AddressLocation {
3110
- /** Address latitude. */
3111
- latitude?: number | null;
3112
- /** Address longitude. */
3113
- longitude?: number | null;
3114
- }
3115
- export interface Subdivision {
3116
- /** Subdivision code. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
3117
- code?: string;
3118
- /** Subdivision full name. */
3119
- name?: string;
3120
- }
3121
- export interface LocationsLocation {
3122
- /**
3123
- * Location ID.
3124
- * @format GUID
3125
- * @readonly
3126
- */
3127
- id?: string | null;
3128
- /**
3129
- * Location name.
3130
- * @maxLength 150
3131
- */
3132
- name?: string;
3133
- /**
3134
- * Location description.
3135
- * @maxLength 500
3136
- */
3137
- description?: string | null;
3138
- /**
3139
- * Whether this is the default location. There can only be one default location per site. The default location can't be archived.
3140
- * @readonly
3141
- */
3142
- default?: boolean;
3143
- /**
3144
- * Location status. Defaults to `ACTIVE`.
3145
- * __Notes:__
3146
- * - [Archiving a location](https://dev.wix.com/api/rest/business-info/locations/archive-location)
3147
- * doesn't affect the location's status.
3148
- * - `INACTIVE` status is currently not supported.
3149
- */
3150
- status?: LocationStatus;
3151
- /**
3152
- * Location type.
3153
- *
3154
- * **Note:** Currently not supported.
3155
- * @deprecated
3156
- */
3157
- locationType?: LocationsLocationType;
3158
- /** Fax number. */
3159
- fax?: string | null;
3160
- /** Timezone in `America/New_York` format. */
3161
- timeZone?: string | null;
3162
- /** Email address. */
3163
- email?: string | null;
3164
- /** Phone number. */
3165
- phone?: string | null;
3166
- /** Address. */
3167
- address?: LocationsAddress;
3168
- /**
3169
- * Business schedule. Array of weekly recurring time periods when the location is open for business. Limited to 100 time periods.
3170
- *
3171
- * __Note:__ Not supported by Wix Bookings.
3172
- */
3173
- businessSchedule?: BusinessSchedule;
3174
- /**
3175
- * Revision number, which increments by 1 each time the location is updated.
3176
- * To prevent conflicting changes, the existing revision must be used when updating a location.
3177
- */
3178
- revision?: string | null;
3179
- /**
3180
- * Whether the location is archived. Archived locations can't be updated.
3181
- * __Note:__ [Archiving a location](https://dev.wix.com/api/rest/business-info/locations/archive-location)
3182
- * doesn't affect its `status`.
3183
- * @readonly
3184
- */
3185
- archived?: boolean;
3186
- /**
3187
- * Location types.
3188
- * @maxSize 10
3189
- */
3190
- locationTypes?: LocationsLocationType[];
3191
- }
3192
- /** For future use */
3193
- export declare enum LocationStatus {
3194
- ACTIVE = "ACTIVE",
3195
- INACTIVE = "INACTIVE"
3196
- }
3197
- /** For future use */
3198
- export declare enum LocationsLocationType {
3199
- UNKNOWN = "UNKNOWN",
3200
- BRANCH = "BRANCH",
3201
- OFFICES = "OFFICES",
3202
- RECEPTION = "RECEPTION",
3203
- HEADQUARTERS = "HEADQUARTERS",
3204
- INVENTORY = "INVENTORY"
3205
- }
3206
- export interface LocationsAddress {
3207
- /**
3208
- * 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
3209
- * @format COUNTRY
3210
- */
3211
- country?: string | null;
3212
- /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. */
3213
- subdivision?: string | null;
3214
- /** City name. */
3215
- city?: string | null;
3216
- /**
3217
- * Postal or zip code.
3218
- * @maxLength 20
3219
- */
3220
- postalCode?: string | null;
3221
- /** Street address. Includes street name, number, and apartment number in separate fields. */
3222
- streetAddress?: LocationsStreetAddress;
3223
- /** Full address of the location. */
3224
- formattedAddress?: string | null;
3225
- /**
3226
- * Extra information that helps finding the location.
3227
- * @maxLength 500
3228
- */
3229
- hint?: string | null;
3230
- /** Geographic coordinates of location. */
3231
- geocode?: LocationsAddressLocation;
3232
- }
3233
- /** Street address. Includes street name, number, and apartment number in separate fields. */
3234
- export interface LocationsStreetAddress {
3235
- /** Street number. */
3236
- number?: string;
3237
- /** Street name. */
3238
- name?: string;
3239
- /** Apartment number. */
3240
- apt?: string;
3241
- }
3242
- /** Address Geolocation */
3243
- export interface LocationsAddressLocation {
3244
- /** Latitude of the location. Must be between -90 and 90. */
3245
- latitude?: number | null;
3246
- /** Longitude of the location. Must be between -180 and 180. */
3247
- longitude?: number | null;
3248
- }
3249
- /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
3250
- export interface BusinessSchedule {
3251
- /**
3252
- * Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
3253
- * @maxSize 100
3254
- */
3255
- periods?: TimePeriod[];
3256
- /**
3257
- * Exceptions to the business's regular hours. The business can be open or closed during the exception.
3258
- * @maxSize 100
3259
- */
3260
- specialHourPeriod?: SpecialHourPeriod[];
3261
- }
3262
- /** Weekly recurring time periods when the business is regularly open or the service is available. */
3263
- export interface TimePeriod {
3264
- /** Day of the week the period starts on. */
3265
- openDay?: DayOfWeek;
3266
- /**
3267
- * 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
3268
- * midnight at the end of the specified day.
3269
- */
3270
- openTime?: string;
3271
- /** Day of the week the period ends on. */
3272
- closeDay?: DayOfWeek;
3273
- /**
3274
- * 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
3275
- * midnight at the end of the specified day.
3276
- *
3277
- * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
3278
- */
3279
- closeTime?: string;
3280
- }
3281
- /** Enumerates the days of the week. */
3282
- export declare enum DayOfWeek {
3283
- MONDAY = "MONDAY",
3284
- TUESDAY = "TUESDAY",
3285
- WEDNESDAY = "WEDNESDAY",
3286
- THURSDAY = "THURSDAY",
3287
- FRIDAY = "FRIDAY",
3288
- SATURDAY = "SATURDAY",
3289
- SUNDAY = "SUNDAY"
3290
- }
3291
- /** Exception to the business's regular hours. The business can be open or closed during the exception. */
3292
- export interface SpecialHourPeriod {
3293
- /** 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). */
3294
- startDate?: string;
3295
- /** 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). */
3296
- endDate?: string;
3297
- /**
3298
- * Whether the business is closed (or the service is not available) during the exception.
3299
- *
3300
- * Default: `true`.
3301
- */
3302
- isClosed?: boolean;
3303
- /** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
3304
- comment?: string;
3305
- }
3306
- export interface Rate {
3307
- /**
3308
- * Mapping between a named price option, for example, adult or child prices, and the price, currency, and down payment amount.
3309
- * When present in an update request, the `default_varied_price` is ignored to support backward compatibility.
3310
- */
3311
- labeledPriceOptions?: Record<string, Price>;
3312
- /**
3313
- * Textual price information used when **Price Per Session** is set to **Custom Price** in the app's service details page.
3314
- * When present in an update request, the `default_varied_price` is ignored to support backward compatibility.
3315
- */
3316
- priceText?: string | null;
3317
- }
3318
- export interface Price {
3319
- /**
3320
- * Required payment amount.
3321
- * @format DECIMAL_VALUE
3322
- */
3323
- amount?: string;
3324
- /**
3325
- * Currency in which the amount is quoted.
3326
- * @format CURRENCY
3327
- */
3328
- currency?: string;
3329
- /**
3330
- * Amount of a down payment or deposit as part of the transaction.
3331
- * @format DECIMAL_VALUE
3332
- */
3333
- downPayAmount?: string;
3334
- }
3335
- /**
3336
- * <!-- Needs updating when recurrence has been tested
3337
- * Schedule's availability calculation is executed by the schedule's available intervals and this additional information.
3338
- * 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.-->
3339
- */
3340
- export interface Availability {
3341
- /** Date and time the schedule starts to be available for booking. */
3342
- start?: Date | null;
3343
- /** Date and time the schedule stops being available for booking. No value indicates no end time. */
3344
- end?: Date | null;
3345
- /** Other schedules that impact the availability calculation. Relevant only when there are availability constraints. */
3346
- linkedSchedules?: LinkedSchedule[];
3347
- /** Constraints for calculating the schedule's availability. */
3348
- constraints?: AvailabilityConstraints;
3349
- }
3350
- /** Describes how to calculate the specific slots that are available for booking. */
3351
- export interface AvailabilityConstraints {
3352
- /**
3353
- * A list of duration options for slots, in minutes. Minimum value for a duration is 1.
3354
- * The availability calculation generates slots with these durations, where there is no conflict with existing sessions or other availability constraints.
3355
- * @min 1
3356
- */
3357
- slotDurations?: number[];
3358
- /**
3359
- * The number of minutes between the `end` of one slot, and the `start` of the next.
3360
- * Minimum value is 0, maximum value is 120.
3361
- * @max 720
3362
- */
3363
- timeBetweenSlots?: number;
3364
- /**
3365
- * Specify how to split the slots in intervals of minutes.
3366
- * 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).
3367
- * Optional. The default is the first duration in slot_durations field.
3368
- * Deprecated. Use the `split_slots_interval.value_in_minutes`.
3369
- * @deprecated
3370
- */
3371
- splitInterval?: number | null;
3372
- /**
3373
- * 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.
3374
- * @readonly
3375
- */
3376
- slotsSplitInterval?: SplitInterval;
3377
- }
3378
- /** 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. */
3379
- export interface SplitInterval {
3380
- /**
3381
- * Whether the slot duration is used as the split interval value.
3382
- * If `same_as_duration` is `true`, the `value_in_minutes` is the sum of the first duration in
3383
- * `schedule.availabilityConstraints.SlotDurations` field, and `schedule.availabilityConstraints.TimeBetweenSlots` field.
3384
- */
3385
- sameAsDuration?: boolean | null;
3386
- /** Number of minutes between available slots' start times when `same_as_duration` is `false`. */
3387
- valueInMinutes?: number | null;
3388
- }
3389
- export interface Participant {
3390
- /**
3391
- * Participant ID. Currently represents the booking.id.
3392
- * @format GUID
3393
- */
3394
- id?: string;
3395
- /**
3396
- * Contact ID.
3397
- * @format GUID
3398
- */
3399
- contactId?: string | null;
3400
- /** Participant's name. */
3401
- name?: string | null;
3402
- /** Participant's phone number. */
3403
- phone?: string | null;
3404
- /** Participant's email address. */
3405
- email?: string | null;
3406
- /** Group or party size. The number of people attending. Defaults to 0. Maximum is 250. */
3407
- partySize?: number;
3408
- /**
3409
- * Approval status for the participant.
3410
- * <!-- Commented out untill updateParticipant is exposed Generally the same status as the booking, unless updated using the `updateParticipant()` API. Defaults to `"UNDEFINED"`.-->
3411
- */
3412
- approvalStatus?: ApprovalStatus;
3413
- /**
3414
- * Whether the participant was inherited from the schedule, as opposed to being booked directly to the session.
3415
- * @readonly
3416
- */
3417
- inherited?: boolean;
3418
- }
3419
- export declare enum ApprovalStatus {
3420
- /** Default. */
3421
- UNDEFINED = "UNDEFINED",
3422
- /** Pending business approval. */
3423
- PENDING = "PENDING",
3424
- /** Approved by the business. */
3425
- APPROVED = "APPROVED",
3426
- /** Declined by the business. */
3427
- DECLINED = "DECLINED"
3428
- }
3429
- export interface ExternalCalendarOverrides {
3430
- /** Synced title of the external calendar event. */
3431
- title?: string | null;
3432
- /** Synced description of the external calendar event. */
3433
- description?: string | null;
3434
- }
3435
- export declare enum ScheduleStatus {
3436
- /** Undefined schedule status. */
3437
- UNDEFINED = "UNDEFINED",
3438
- /** The schedule was created. */
3439
- CREATED = "CREATED",
3440
- /** The schedule was cancelled. */
3441
- CANCELLED = "CANCELLED"
3442
- }
3443
- export interface Version {
3444
- /** Schedule version number, updated each time the schedule is updated. */
3445
- scheduleVersion?: number | null;
3446
- /** Participants version number, updated each time the schedule participants are updated. */
3447
- participantsVersion?: number | null;
3448
- }
3449
- export interface ConferenceProvider {
3450
- /** Conferencing provider ID */
3451
- providerId?: string;
3452
- }
3453
- export interface CalendarConference {
3454
- /** Wix Calendar conference ID. */
3455
- id?: string;
3456
- /** Conference meeting ID in the provider's conferencing system. */
3457
- externalId?: string;
3458
- /** Conference provider ID. */
3459
- providerId?: string;
3460
- /** URL used by the host to start the conference. */
3461
- hostUrl?: string;
3462
- /** URL used by a guest to join the conference. */
3463
- guestUrl?: string;
3464
- /** Password to join the conference. */
3465
- password?: string | null;
3466
- /** Conference description. */
3467
- description?: string | null;
3468
- /** Conference type. */
3469
- conferenceType?: ConferenceType;
3470
- /** ID of the account owner in the video conferencing service. */
3471
- accountOwnerId?: string | null;
3472
- }
3473
- export declare enum ConferenceType {
3474
- /** Undefined conference type. */
3475
- UNDEFINED = "UNDEFINED",
3476
- /** API-generated online meeting. */
3477
- ONLINE_MEETING_PROVIDER = "ONLINE_MEETING_PROVIDER",
3478
- /** User-defined meeting. */
3479
- CUSTOM = "CUSTOM"
3480
- }
3481
- export declare enum ResourceStatus {
3482
- /** Undefined resource status. */
3483
- UNDEFINED = "UNDEFINED",
3484
- /** The resource was created. */
3485
- CREATED = "CREATED",
3486
- /** The resource was deleted. */
3487
- DELETED = "DELETED",
3488
- /** The resource was updated. */
3489
- UPDATED = "UPDATED"
3490
- }
3491
- export interface BusinessLocation {
3492
- /**
3493
- * The ID of the business location. Has to be non-empty
3494
- * @format GUID
3495
- */
3496
- locationId?: string;
3497
- }
3498
- export declare enum ResourceNotificationEvent {
3499
- /** Undefined resource event. */
3500
- UNDEFINED = "UNDEFINED",
3501
- /** The resource was updated. */
3502
- Updated = "Updated",
3503
- /** The resource was deleted. */
3504
- Deleted = "Deleted",
3505
- /** The resource was created. */
3506
- Created = "Created",
3507
- /** The schedule was updated. */
3508
- Schedule_Updated = "Schedule_Updated"
3509
- }
3510
2734
  export interface BenefitNotification {
3511
2735
  /**
3512
2736
  * Plan unique ID
@@ -3711,7 +2935,7 @@ export interface Properties {
3711
2935
  /** Fax number. */
3712
2936
  fax?: string | null;
3713
2937
  /** Address. */
3714
- address?: V4Address;
2938
+ address?: Address;
3715
2939
  /** Site display name. */
3716
2940
  siteDisplayName?: string | null;
3717
2941
  /** Business name. */
@@ -3758,7 +2982,7 @@ export interface Locale {
3758
2982
  /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
3759
2983
  country?: string;
3760
2984
  }
3761
- export interface V4Address {
2985
+ export interface Address {
3762
2986
  /** Street name. */
3763
2987
  street?: string;
3764
2988
  /** City name. */
@@ -3809,6 +3033,63 @@ export interface GeoCoordinates {
3809
3033
  /** Longitude of the location. Must be between -180 and 180. */
3810
3034
  longitude?: number;
3811
3035
  }
3036
+ /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
3037
+ export interface BusinessSchedule {
3038
+ /**
3039
+ * Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
3040
+ * @maxSize 100
3041
+ */
3042
+ periods?: TimePeriod[];
3043
+ /**
3044
+ * Exceptions to the business's regular hours. The business can be open or closed during the exception.
3045
+ * @maxSize 100
3046
+ */
3047
+ specialHourPeriod?: SpecialHourPeriod[];
3048
+ }
3049
+ /** Weekly recurring time periods when the business is regularly open or the service is available. */
3050
+ export interface TimePeriod {
3051
+ /** Day of the week the period starts on. */
3052
+ openDay?: DayOfWeek;
3053
+ /**
3054
+ * 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
3055
+ * midnight at the end of the specified day.
3056
+ */
3057
+ openTime?: string;
3058
+ /** Day of the week the period ends on. */
3059
+ closeDay?: DayOfWeek;
3060
+ /**
3061
+ * 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
3062
+ * midnight at the end of the specified day.
3063
+ *
3064
+ * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
3065
+ */
3066
+ closeTime?: string;
3067
+ }
3068
+ /** Enumerates the days of the week. */
3069
+ export declare enum DayOfWeek {
3070
+ MONDAY = "MONDAY",
3071
+ TUESDAY = "TUESDAY",
3072
+ WEDNESDAY = "WEDNESDAY",
3073
+ THURSDAY = "THURSDAY",
3074
+ FRIDAY = "FRIDAY",
3075
+ SATURDAY = "SATURDAY",
3076
+ SUNDAY = "SUNDAY"
3077
+ }
3078
+ /** Exception to the business's regular hours. The business can be open or closed during the exception. */
3079
+ export interface SpecialHourPeriod {
3080
+ /** 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). */
3081
+ startDate?: string;
3082
+ /** 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). */
3083
+ endDate?: string;
3084
+ /**
3085
+ * Whether the business is closed (or the service is not available) during the exception.
3086
+ *
3087
+ * Default: `true`.
3088
+ */
3089
+ isClosed?: boolean;
3090
+ /** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
3091
+ comment?: string;
3092
+ }
3812
3093
  export interface Multilingual {
3813
3094
  /**
3814
3095
  * Supported languages list.