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