@wix/auto_sdk_bookings_multi-service-availability-time-slots 1.0.133 → 1.0.135

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 (129) hide show
  1. package/build/{cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.types.d.ts → bookings-availability-v2-time-slot-multi-service-availability-time-slots.universal-B2t3dqyF.d.mts} +154 -33
  2. package/build/{internal/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.types.d.ts → bookings-availability-v2-time-slot-multi-service-availability-time-slots.universal-B2t3dqyF.d.ts} +154 -33
  3. package/build/{es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.public.d.ts → index.d.mts} +11 -8
  4. package/build/{internal/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.public.d.ts → index.d.ts} +11 -8
  5. package/build/index.js +350 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +324 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/{es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.types.d.ts → internal/bookings-availability-v2-time-slot-multi-service-availability-time-slots.universal-B2t3dqyF.d.mts} +154 -33
  10. package/build/internal/{es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.types.d.ts → bookings-availability-v2-time-slot-multi-service-availability-time-slots.universal-B2t3dqyF.d.ts} +154 -33
  11. package/build/{cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.public.d.ts → internal/index.d.mts} +11 -8
  12. package/build/internal/{cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.public.d.ts → index.d.ts} +11 -8
  13. package/build/internal/index.js +350 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +324 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +539 -0
  18. package/build/internal/meta.d.ts +539 -0
  19. package/build/internal/meta.js +270 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +242 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +539 -0
  24. package/build/meta.d.ts +539 -0
  25. package/build/meta.js +270 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +242 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +12 -11
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.context.d.ts +0 -6
  40. package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.context.js +0 -10
  41. package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.context.js.map +0 -1
  42. package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.http.d.ts +0 -111
  43. package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.http.js +0 -304
  44. package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.http.js.map +0 -1
  45. package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.meta.d.ts +0 -14
  46. package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.meta.js +0 -66
  47. package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.meta.js.map +0 -1
  48. package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.public.js +0 -20
  49. package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.public.js.map +0 -1
  50. package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.types.js +0 -14
  51. package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.types.js.map +0 -1
  52. package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.universal.d.ts +0 -1213
  53. package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.universal.js +0 -290
  54. package/build/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.universal.js.map +0 -1
  55. package/build/es/index.d.ts +0 -1
  56. package/build/es/index.js +0 -2
  57. package/build/es/index.js.map +0 -1
  58. package/build/es/index.typings.d.ts +0 -1
  59. package/build/es/index.typings.js +0 -2
  60. package/build/es/index.typings.js.map +0 -1
  61. package/build/es/meta.d.ts +0 -1
  62. package/build/es/meta.js +0 -2
  63. package/build/es/meta.js.map +0 -1
  64. package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.context.d.ts +0 -6
  65. package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.context.js +0 -6
  66. package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.context.js.map +0 -1
  67. package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.http.d.ts +0 -111
  68. package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.http.js +0 -299
  69. package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.http.js.map +0 -1
  70. package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.meta.d.ts +0 -14
  71. package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.meta.js +0 -38
  72. package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.meta.js.map +0 -1
  73. package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.public.js +0 -14
  74. package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.public.js.map +0 -1
  75. package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.types.js +0 -11
  76. package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.types.js.map +0 -1
  77. package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.universal.d.ts +0 -1213
  78. package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.universal.js +0 -262
  79. package/build/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.universal.js.map +0 -1
  80. package/build/internal/cjs/index.d.ts +0 -1
  81. package/build/internal/cjs/index.js +0 -18
  82. package/build/internal/cjs/index.js.map +0 -1
  83. package/build/internal/cjs/index.typings.d.ts +0 -1
  84. package/build/internal/cjs/index.typings.js +0 -18
  85. package/build/internal/cjs/index.typings.js.map +0 -1
  86. package/build/internal/cjs/meta.d.ts +0 -1
  87. package/build/internal/cjs/meta.js +0 -18
  88. package/build/internal/cjs/meta.js.map +0 -1
  89. package/build/internal/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.context.d.ts +0 -6
  90. package/build/internal/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.context.js +0 -10
  91. package/build/internal/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.context.js.map +0 -1
  92. package/build/internal/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.http.d.ts +0 -111
  93. package/build/internal/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.http.js +0 -304
  94. package/build/internal/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.http.js.map +0 -1
  95. package/build/internal/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.meta.d.ts +0 -14
  96. package/build/internal/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.meta.js +0 -66
  97. package/build/internal/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.meta.js.map +0 -1
  98. package/build/internal/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.public.js +0 -20
  99. package/build/internal/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.public.js.map +0 -1
  100. package/build/internal/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.types.js +0 -14
  101. package/build/internal/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.types.js.map +0 -1
  102. package/build/internal/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.universal.d.ts +0 -1213
  103. package/build/internal/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.universal.js +0 -290
  104. package/build/internal/cjs/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.universal.js.map +0 -1
  105. package/build/internal/es/index.d.ts +0 -1
  106. package/build/internal/es/index.js +0 -2
  107. package/build/internal/es/index.js.map +0 -1
  108. package/build/internal/es/index.typings.d.ts +0 -1
  109. package/build/internal/es/index.typings.js +0 -2
  110. package/build/internal/es/index.typings.js.map +0 -1
  111. package/build/internal/es/meta.d.ts +0 -1
  112. package/build/internal/es/meta.js +0 -2
  113. package/build/internal/es/meta.js.map +0 -1
  114. package/build/internal/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.context.d.ts +0 -6
  115. package/build/internal/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.context.js +0 -6
  116. package/build/internal/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.context.js.map +0 -1
  117. package/build/internal/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.http.d.ts +0 -111
  118. package/build/internal/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.http.js +0 -299
  119. package/build/internal/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.http.js.map +0 -1
  120. package/build/internal/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.meta.d.ts +0 -14
  121. package/build/internal/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.meta.js +0 -38
  122. package/build/internal/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.meta.js.map +0 -1
  123. package/build/internal/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.public.js +0 -14
  124. package/build/internal/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.public.js.map +0 -1
  125. package/build/internal/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.types.js +0 -11
  126. package/build/internal/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.types.js.map +0 -1
  127. package/build/internal/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.universal.d.ts +0 -1213
  128. package/build/internal/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.universal.js +0 -262
  129. package/build/internal/es/src/bookings-availability-v2-time-slot-multi-service-availability-time-slots.universal.js.map +0 -1
@@ -1,1213 +0,0 @@
1
- import { NonNullablePaths } from '@wix/sdk-types';
2
- /**
3
- * The `TimeSlot` object represents the availability information
4
- * for an `Appointment` service's specific slot, including:
5
- *
6
- * 1. Whether the slot is bookable for the given service?
7
- *
8
- * 2. In what location the service is available for this slot?
9
- *
10
- * 3. Which available resources can provide the service for this slot?
11
- *
12
- * 4. Does booking the slot for the service violates any of the service booking policies?
13
- *
14
- * 5. What is the total capacity and remaining capacity of the service at the time of the calculation of the `TimeSlot`?
15
- *
16
- * > __Note:__
17
- * > When the `TimeSlot` has a non empty `NestedTimeSlots`, it represents the availability information
18
- * > for a given list of `Appointment` services within a specific time slot.
19
- */
20
- export interface TimeSlot {
21
- /**
22
- * Service ID.
23
- *
24
- * > Not returned from `MultiServiceAvailabilityTimeSlots` API calls.
25
- * > Instead, each nested time slot has its own serviceId.
26
- * @format GUID
27
- */
28
- serviceId?: string | null;
29
- /**
30
- * Local start date of the time slot in ISO-8601 format.
31
- * For example, "2024-01-30T13:30:00".
32
- * @format LOCAL_DATE_TIME
33
- */
34
- localStartDate?: string | null;
35
- /**
36
- * Local end date of the time slot in ISO-8601 format.
37
- * For example, "2024-01-30T14:30:00".
38
- * @format LOCAL_DATE_TIME
39
- */
40
- localEndDate?: string | null;
41
- /**
42
- * Whether the slot is bookable according to the service's booking policies.
43
- *
44
- * If booking this time slot does not violates any of the service's booking policies,
45
- * the returned value is `true`. Otherwise, returns `false`.
46
- */
47
- bookable?: boolean | null;
48
- /** The geographic location of the slot. */
49
- location?: Location;
50
- /** The event information if the time slot is an event based slot. */
51
- eventInfo?: EventInfo;
52
- /**
53
- * Total number of spots for the slot.
54
- * @min 1
55
- * @max 1000
56
- */
57
- totalCapacity?: number | null;
58
- /**
59
- * Remaining number of spots for the slot.
60
- * For example, for an appointment service with total capacity of 1 spot and one booked spot, the remaining capacity will be 0.
61
- * @max 1000
62
- */
63
- remainingCapacity?: number | null;
64
- /**
65
- * Number of spots in the slot that are available for booking.
66
- * This is calculated as the remaining capacity minus the spots reserved for the waiting list.
67
- */
68
- bookableCapacity?: number | null;
69
- /**
70
- * Indicators for booking policy violations for the slot.
71
- *
72
- * Each nested field is checked on its own. i.e. if `tooEarlyToBook` is defined and `bookOnlineDisabled` is not defined
73
- * we will return also slots for which `tooEarlyToBook` is same as on the request, regardless of `bookOnlineDisabled`.
74
- */
75
- bookingPolicyViolations?: BookingPolicyViolations;
76
- /**
77
- * List of `AvailableResources` for the time slot.
78
- * Each `AvailableResources` contains information about available resources of the same type.
79
- *
80
- * > Not returned from `MultiServiceAvailabilityTimeSlots` API calls.
81
- * > Instead, each nested time slot has its own available resources.
82
- */
83
- availableResources?: AvailableResources[];
84
- /**
85
- * > Nested time slots.
86
- * > Returned only from `MultiServiceAvailabilityTimeSlots` API calls.
87
- * @maxSize 8
88
- */
89
- nestedTimeSlots?: NestedTimeSlot[];
90
- /** Reasons why the time slot is not available for booking. */
91
- nonBookableReasons?: NonBookableReasons;
92
- }
93
- export interface Location {
94
- /**
95
- * Business Location ID. Present only if the location is a business location.
96
- * @format GUID
97
- */
98
- _id?: string | null;
99
- /** The location name. */
100
- name?: string | null;
101
- /** A string representation for the full address of the location. */
102
- formattedAddress?: string | null;
103
- /**
104
- * The type of location:
105
- * - `CUSTOM`: The location is specific to this service, and is not derived from the business location.
106
- * - `BUSINESS`: A business location, either the default business address, or locations defined for the business by the Business Info.
107
- * - `CUSTOMER`: The location is determined by the customer and is not set up beforehand.
108
- */
109
- locationType?: LocationTypeWithLiterals;
110
- }
111
- export declare enum LocationType {
112
- UNKNOWN_LOCATION_TYPE = "UNKNOWN_LOCATION_TYPE",
113
- /** A business location, either the default business address, or locations defined for the business by the Business Info. */
114
- BUSINESS = "BUSINESS",
115
- /** The location is unique to this service and isn't defined as one of the business locations. */
116
- CUSTOM = "CUSTOM",
117
- /** The location can be determined by the customer and is not set up beforehand. */
118
- CUSTOMER = "CUSTOMER"
119
- }
120
- /** @enumType */
121
- export type LocationTypeWithLiterals = LocationType | 'UNKNOWN_LOCATION_TYPE' | 'BUSINESS' | 'CUSTOM' | 'CUSTOMER';
122
- /** relevant for event based slots, and not for availability based slots */
123
- export interface EventInfo {
124
- /**
125
- * The event ID.
126
- * @minLength 36
127
- * @maxLength 250
128
- */
129
- eventId?: string | null;
130
- /** Waiting list details for the event, if enabled in the service's booking policy. */
131
- waitingList?: WaitingList;
132
- }
133
- export interface WaitingList {
134
- /**
135
- * Total number of spots in the waiting list.
136
- * @min 1
137
- */
138
- totalCapacity?: number | null;
139
- /**
140
- * Number of remaining spots in the waiting list.
141
- * For example, a yoga event with a capacity of `10` and `3` registrants will have a `remainingCapacity` of `7`.
142
- */
143
- remainingCapacity?: number | null;
144
- }
145
- export interface BookingPolicyViolations {
146
- /** Bookings policy violation. Too early to book this slot. */
147
- tooEarlyToBook?: boolean | null;
148
- /** The earliest time at which booking for this slot is allowed, in UTC format (`YYYY-MM-DDThh:mm:ss.sssZ`). */
149
- earliestBookingDate?: Date | null;
150
- /** Bookings policy violation. Too late to book this slot. */
151
- tooLateToBook?: boolean | null;
152
- /** Bookings policy violation. Online booking is disabled for the `TimeSlot` service. */
153
- bookOnlineDisabled?: boolean | null;
154
- }
155
- export interface AvailableResources {
156
- /**
157
- * Resource type ID.
158
- * @format GUID
159
- */
160
- resourceTypeId?: string | null;
161
- /**
162
- * Available resources for the time slot.
163
- *
164
- * + When returned from `ListAvailabilityTimeSlots`, empty by default.
165
- * + + If you provided `includeResourceTypeIds` or `resourceIds` in request,
166
- * contains __up__ to 10 available resources out of those provided.
167
- *
168
- * + When returned from `GetAvailabilityTimeSlots`, contains all available resources by default.
169
- * + + If you provided `includeResourceTypeIds` or `resourceIds` in request,
170
- * contains all of the available resources out of those provided.
171
- *
172
- *
173
- * > + When returned from `ListMultiServiceAvailabilityTimeSlots`, empty by default.
174
- * > + + If you provided `includeResourceTypeIds` or `resourceIds` in request,
175
- * > contains __up__ to 10 available resources out of those provided.
176
- *
177
- * > + When returned from `GetMultiServiceAvailabilityTimeSlots`, contains all available resources by default.
178
- * > + + If you provided `includeResourceTypeIds` or `resourceIds` in request,
179
- * > contains all of the available resources out of those provided.
180
- */
181
- resources?: Resource[];
182
- /**
183
- * Whether there are more available resources for the slot that are not listed in `resources` due to size limitations.
184
- * @readonly
185
- */
186
- hasMoreAvailableResources?: boolean | null;
187
- }
188
- export interface Resource {
189
- /**
190
- * Resource ID.
191
- * @format GUID
192
- */
193
- _id?: string;
194
- /**
195
- * Resource name.
196
- * @minLength 1
197
- */
198
- name?: string | null;
199
- }
200
- export interface NestedTimeSlot {
201
- /**
202
- * Service ID of the nested time slot.
203
- * @format GUID
204
- */
205
- serviceId?: string;
206
- /**
207
- * Local start date of the nested time slot in ISO-8601 format.
208
- * For example, "2024-01-30T13:30:00".
209
- * @format LOCAL_DATE_TIME
210
- */
211
- localStartDate?: string;
212
- /**
213
- * Local end date of the nested time slot in ISO-8601 format.
214
- * For example, "2024-01-30T14:30:00".
215
- * @format LOCAL_DATE_TIME
216
- */
217
- localEndDate?: string;
218
- /**
219
- * List of `AvailableResources` for the nested time slot.
220
- * Each `AvailableResources` contains information about available resources of the same type.
221
- * @maxSize 10
222
- */
223
- availableResources?: AvailableResources[];
224
- }
225
- export interface NonBookableReasons {
226
- /** The slot is fully booked with no remaining capacity. */
227
- noRemainingCapacity?: boolean | null;
228
- /** Booking this slot would violate the service's booking policy. */
229
- violatesBookingPolicy?: boolean | null;
230
- /** The slot is reserved for the waiting list and not available for direct booking. */
231
- reservedForWaitingList?: boolean | null;
232
- }
233
- export interface ListMultiServiceAvailabilityTimeSlotsRequest {
234
- /**
235
- * Services for which the multiService time slots are being returned for.
236
- * Each service contains its own resources filters within.
237
- *
238
- * MinSize: `2`.
239
- * MaxSize: `8`.
240
- *
241
- * Required, unless `cursorPaging`.`cursor` is provided.
242
- * @maxSize 8
243
- */
244
- services?: Service[];
245
- /**
246
- * Lower boundary for `localStartDate` to include in response, in ISO-8601 format.
247
- * For example, "2024-01-30T13:30:00".
248
- *
249
- * Each returned `TimeSlot` in response has a `localStartDate`
250
- * within the provided `fromLocalDate` and `toLocalDate` exclusive.
251
- *
252
- * Required, unless `cursorPaging`.`cursor` is provided.
253
- * @format LOCAL_DATE_TIME
254
- */
255
- fromLocalDate?: string | null;
256
- /**
257
- * Upper boundary for `localStartDate` to include in response, in ISO-8601 format.
258
- * For example, "2024-01-30T14:30:00".
259
- *
260
- * Each returned `TimeSlot` in response has a `localStartDate`
261
- * within the provided `fromLocalDate` and `toLocalDate` exclusive.
262
- *
263
- * Required, unless `cursorPaging`.`cursor` is provided.
264
- * @format LOCAL_DATE_TIME
265
- */
266
- toLocalDate?: string | null;
267
- /**
268
- * Time zone, in IANA time zone format.
269
- *
270
- * Required, unless `cursorPaging`.`cursor` is provided.
271
- * @minLength 1
272
- * @maxLength 150
273
- */
274
- timeZone?: string | null;
275
- /**
276
- * Location for which the multiService TimeSlots are being returned for.
277
- *
278
- * You can specify location or location type for which the TimeSlots will be returned for.
279
- * If locationType is `BUSINESS`, you __must__ provide a locationId.
280
- *
281
- * <blockquote class="warning">
282
- * <p><strong>warning:</strong><br/>
283
- * Supports filtering by location type, or by location ID. </br>
284
- * Other fields like <code class="grey-background">name</code> are ignored.</p>
285
- * </blockquote>
286
- *
287
- * Required, unless `cursorPaging`.`cursor` is provided.
288
- */
289
- location?: Location;
290
- /**
291
- * Whether the `TimeSlot` is bookable according to all of the services booking policies.
292
- *
293
- * If booking any of the `TimeSlot`.`NestedTimeSlot`s violates any of its services bookings policies,
294
- * returns as `false`. Otherwise, returns as `true`.
295
- *
296
- * > __Note:__
297
- * > A `TimeSlot` with a `NestedTimeSlot` that doesn't meet its service's bookings policies will be returned with `bookable` = false,
298
- * > while a `TimeSlot` with no available resources will not be returned at all.
299
- */
300
- bookable?: boolean | null;
301
- /**
302
- * Indicators for service's booking policy violations for booking the `TimeSlot`.
303
- *
304
- * A bookable time slot must not violate any policy,
305
- * therefor, this filter is only relevant when `bookable` filter is false.
306
- *
307
- * Each nested field is checked on all `NestedTimeSlot`s. For example, if only one of the `NestedTimeSlot`'s
308
- * has a service with `tooEarlyToBook` same as in the request, we return the `TimeSlot` regardless of whether
309
- * the other `NestedTimeSlots` has the same `tooEarlyToBook` as in request.
310
- *
311
- * Each nested field is checked on its own. For example, if `tooEarlyToBook` is defined and `bookOnlineDisabled` is not defined
312
- * we return slots for which `tooEarlyToBook` is same as on the request, regardless of `bookOnlineDisabled`.
313
- */
314
- bookingPolicyViolations?: BookingPolicyViolations;
315
- /**
316
- * Maximum number of slots to load for each day. For example, if `timeSlotsPerDay` is set to `3`,
317
- * we return at most 3 available TimeSlots for each day within the date range specified in request.
318
- *
319
- * By default,
320
- * if `bookable` filter was not specified,
321
- * and a day has both `bookable` and `un-bookable` slots, `bookable` slots are returned first.
322
- *
323
- * If the number of `bookable` slots is less than the requested `timeSlotsPerDay`,
324
- * `un-bookable` slots will be returned according to the specified filters.
325
- */
326
- timeSlotsPerDay?: number | null;
327
- /**
328
- * CursorPaging.
329
- *
330
- * Enables you to fetch TimeSlots in smaller, more manageable chunks
331
- * by setting a limit on the number of results returned in response.
332
- * This is useful in order to enhance efficiency of data retrieval and reduce load on both the client and server.
333
- *
334
- * If there are more results than the specified limit, the response will contain a `cursorPagingMetaData`
335
- * with a cursor pointing to next page of results. In order to fetch the next page of results, you should pass the
336
- * returned cursor to the next call as `cursorPaging`.`cursor`.
337
- *
338
- * For the first call, you should only specify the `limit` for the results page.
339
- * For each following call, you should only pass the previous returned cursor as `cursorPaging`.`cursor`
340
- * the `cursorPaging`.`limit`. You may pass a different `limit`.
341
- * No need to specify any additional parameters.
342
- *
343
- * <blockquote class="important">
344
- * <p><strong>Important:</strong><br/>
345
- * If you only provide a <code class="grey-background">cursorPaging</code>. <code class="grey-background">cursor</code>,
346
- * the response will contain the default size of results which is `1000`.
347
- * </p>
348
- * </blockquote>
349
- */
350
- cursorPaging?: CursorPaging;
351
- }
352
- export interface Service {
353
- /**
354
- * Service ID.
355
- * @format GUID
356
- */
357
- serviceId?: string;
358
- /**
359
- * Resources to include in response.
360
- * @format GUID
361
- * @maxSize 135
362
- */
363
- resourceIds?: string[];
364
- /**
365
- * The resource type ID's to include in returned time slots.
366
- * This is in addition to the specifically requested resources.
367
- *
368
- * <blockquote class="important">
369
- * Currently supported only for Staff Member resource type.
370
- * Staff Member type ID: 1cd44cf8-756f-41c3-bd90-3e2ffcaf1155
371
- * </blockquote>
372
- * @format GUID
373
- * @maxSize 100
374
- */
375
- includeResourceTypeIds?: string[];
376
- /**
377
- * Selected customer choices.
378
- * If specified, the selected choices will be used to calculate service configuration.
379
- * If not specified, the service default configuration will be used.
380
- * Enforcing this field is the responsibility of the SPI implementer, and not by the Availability API.
381
- */
382
- customerChoices?: V2CustomerChoices;
383
- }
384
- /**
385
- * Selected customer choices.
386
- * These choices are selected by the customer during the booking flow and can be utilized to calculate the corresponding service's configuration properties.
387
- */
388
- export interface V2CustomerChoices {
389
- /**
390
- * The selected customer duration in minutes.
391
- * Min: `1 minute`
392
- * Max: `44639 minutes` (30 days, 23 hours, and 59 minutes)
393
- * @min 1
394
- * @max 44639
395
- */
396
- durationInMinutes?: number | null;
397
- /**
398
- * The selected add-ons IDs.
399
- * Max: Derived from max amount of Add-On groups * max amount of Add-Ons per group.
400
- * @format GUID
401
- * @maxSize 21
402
- */
403
- addOnIds?: string[] | null;
404
- /**
405
- * The selected duration choice ID.
406
- * @format GUID
407
- */
408
- durationChoiceId?: string | null;
409
- }
410
- export interface CursorPaging {
411
- /**
412
- * Number of results to load.
413
- *
414
- * Default: `1000`.
415
- * Max: `1000`.
416
- * @max 1000
417
- */
418
- limit?: number | null;
419
- /**
420
- * Pointer to the next or previous page in the list of results.
421
- *
422
- * You can get the relevant cursor token
423
- * from the `pagingMetadata` object in the previous call's response.
424
- * Not relevant for the first request.
425
- */
426
- cursor?: string | null;
427
- }
428
- export interface ListMultiServiceAvailabilityTimeSlotsResponse {
429
- /**
430
- * Time slots.
431
- * @maxSize 1000
432
- */
433
- timeSlots?: TimeSlot[];
434
- /**
435
- * Time zone, in IANA time zone format.
436
- * Shared for all TimeSlots in response.
437
- * @minLength 1
438
- * @maxLength 150
439
- */
440
- timeZone?: string | null;
441
- /**
442
- * CursorPagingMetaData.
443
- * Contains information about the next page of results.
444
- *
445
- * By default,
446
- * if there are more than 1000 results,
447
- * the response will contain a `cursorPagingMetaData` with a cursor to the next page of results.
448
- *
449
- * <blockquote class="important">
450
- * <p><strong>Important:</strong><br/>
451
- * <code class="grey-background">count</code> is not supported.</p>
452
- * </blockquote>
453
- */
454
- cursorPagingMetadata?: CursorPagingMetadata;
455
- }
456
- export interface CursorPagingMetadata {
457
- /** Offset that was requested. */
458
- cursors?: Cursors;
459
- /**
460
- * Indicates if there are more results after the current page.
461
- * If `true`, another page of results can be retrieved.
462
- * If `false`, this is the last page.
463
- */
464
- hasNext?: boolean | null;
465
- }
466
- export interface Cursors {
467
- /** Cursor pointing to next page in the list of results. */
468
- next?: string | null;
469
- /** Cursor pointing to previous page in the list of results. */
470
- prev?: string | null;
471
- }
472
- export interface GetMultiServiceAvailabilityTimeSlotRequest {
473
- /**
474
- * Services for which the multiService TimeSlots are being returned for.
475
- * Each service contains its own resources filters within.
476
- *
477
- * MinSize: 2.
478
- * MaxSize: 8.
479
- * @minSize 2
480
- * @maxSize 8
481
- */
482
- services: Service[];
483
- /**
484
- * Local start date of the time slot, in ISO-8601 format.
485
- * For example, "2024-01-30T13:30:00".
486
- * @format LOCAL_DATE_TIME
487
- */
488
- localStartDate: string;
489
- /**
490
- * Local end date of the time slot, in ISO-8601 format.
491
- * For example, "2024-01-30T14:30:00".
492
- * @format LOCAL_DATE_TIME
493
- */
494
- localEndDate: string;
495
- /**
496
- * Time zone, in IANA time zone format.
497
- * @minLength 1
498
- * @maxLength 150
499
- */
500
- timeZone: string | null;
501
- /**
502
- * The location of the time slot.
503
- *
504
- * You must provide a specific `locationType`.
505
- * If locationType is `BUSINESS`, you __must__ also provide a `locationId`.
506
- *
507
- * <blockquote class="warning">
508
- * <p>Supports filtering by location type, or by location ID.
509
- * Other fields like <code class="grey-background">name</code> are ignored.</p>
510
- * </blockquote>
511
- */
512
- location: Location;
513
- }
514
- export interface GetMultiServiceAvailabilityTimeSlotResponse {
515
- /** Time slot. */
516
- timeSlot?: TimeSlot;
517
- /**
518
- * The time zone, in IANA time zone format.
519
- * @minLength 1
520
- * @maxLength 150
521
- */
522
- timeZone?: string | null;
523
- }
524
- export interface ListAvailabilityTimeSlotsRequest {
525
- /**
526
- * Service ID for which the time slots are being returned for.
527
- * Currently supported only for services of type `APPOINTMENT`.
528
- *
529
- * Required, unless `cursorPaging`.`cursor` is provided.
530
- * @format GUID
531
- */
532
- serviceId?: string | null;
533
- /**
534
- * Lower boundary for `localStartDate` to include in response, in ISO-8601 format.
535
- * For example, "2024-01-30T13:30:00".
536
- *
537
- * Each returned `TimeSlot` in response has a `localStartDate`
538
- * within the provided `fromLocalDate` and `toLocalDate` exclusive.
539
- *
540
- * Required, unless `cursorPaging`.`cursor` is provided.
541
- * @format LOCAL_DATE_TIME
542
- */
543
- fromLocalDate?: string | null;
544
- /**
545
- * Upper boundary for `localStartDate` to include in response, in ISO-8601 format.
546
- * For example, "2024-01-30T14:30:00".
547
- *
548
- * Each returned `TimeSlot` in response has a `localStartDate`
549
- * within the provided `fromLocalDate` and `toLocalDate` exclusive.
550
- *
551
- * Required, unless `cursorPaging`.`cursor` is provided.
552
- * @format LOCAL_DATE_TIME
553
- */
554
- toLocalDate?: string | null;
555
- /**
556
- * Time zone, in IANA time zone format.
557
- *
558
- * Required, unless `cursorPaging`.`cursor` is provided.
559
- * @minLength 1
560
- * @maxLength 150
561
- */
562
- timeZone?: string | null;
563
- /**
564
- * Locations to include in response.
565
- *
566
- * By default,
567
- * if no locations are provided,
568
- * the response contains TimeSlots for all locations where the service is available.
569
- *
570
- * You can specify locations or location types for which the time slots will be returned for.
571
- * If locationType is `BUSINESS`, you __must__ provide a locationId.
572
- *
573
- * <blockquote class="warning">
574
- * <p><strong>warning:</strong><br/>
575
- * Supports filtering by location type, or by location ID. </br>
576
- * Other fields like <code class="grey-background">name</code> are ignored.</p>
577
- * </blockquote>
578
- * @maxSize 5
579
- */
580
- locations?: Location[];
581
- /**
582
- * Resources to include in response.
583
- *
584
- * If specified,
585
- * the returned TimeSlots will contain __up__ to 10 available resources out of the provided list.
586
- * Otherwise, the returned TimeSlots returns with an empty `AvailableResources`.
587
- * @format GUID
588
- * @maxSize 135
589
- * @deprecated
590
- */
591
- resourceIds?: string[];
592
- /**
593
- * Resource type ID's to include in response, this is in addition to the requested `resourceIds`.
594
- *
595
- * If specified in request, the returned TimeSlots will contain __up__ to 10 `AvailableResources` with `ResourceTypeId`
596
- * out of those specified, each contains __up__ to 10 available resources of this type.
597
- * @format GUID
598
- * @maxSize 100
599
- */
600
- includeResourceTypeIds?: string[];
601
- /**
602
- * Whether the `TimeSlot` is bookable according to the service's booking policies.
603
- *
604
- * If booking this `TimeSlot` does not violates any of the service's booking policies,
605
- * returns as `true`. Otherwise, returns as `false`.
606
- *
607
- * > __Note:__
608
- * > A time slot that doesn't meet the service's bookings policies will be returned with `bookable` = false,
609
- * > while a time slot with no available resources will not be returned at all.
610
- */
611
- bookable?: boolean | null;
612
- /**
613
- * Indicators for service's booking policy violations for booking the `TimeSlot`.
614
- *
615
- * A bookable time slot must not violate any policy,
616
- * therefor, this filter is only relevant when `bookable` filter is false.
617
- *
618
- * Each nested field is checked on its own. i.e. if `tooEarlyToBook` is defined and `bookOnlineDisabled` is not defined
619
- * we return slots for which `tooEarlyToBook` is same as on the request, regardless of `bookOnlineDisabled`.
620
- */
621
- bookingPolicyViolations?: BookingPolicyViolations;
622
- /**
623
- * Maximum number of slots to load for each day. For example, if `timeSlotsPerDay` is set to `3`,
624
- * we return at most 3 available TimeSlots for each day within the date range specified in request.
625
- *
626
- * By default,
627
- * if `bookable` filter was not specified,
628
- * and a day has both `bookable` and `un-bookable` slots, `bookable` slots are returned first.
629
- *
630
- * If the number of `bookable` slots is less than the requested `timeSlotsPerDay`,
631
- * `un-bookable` slots will be returned according to the specified filters.
632
- */
633
- timeSlotsPerDay?: number | null;
634
- /**
635
- * CursorPaging.
636
- *
637
- * Enables you to fetch results in smaller, more manageable chunks
638
- * by setting a limit on the number of results returned in response.
639
- * This is useful in order to enhance efficiency of data retrieval and reduce load on both the client and server.
640
- *
641
- * If there are more results than the specified limit, the response will contain a `cursorPagingMetaData`
642
- * with a cursor pointing to next page of results. In order to fetch the next page of results, you should pass the
643
- * returned cursor to the next call as `cursorPaging`.`cursor`.
644
- *
645
- * For the first call, you should only specify the `limit` for the results page.
646
- * For each following call, you should only pass `cursorPaging`.`cursor` with the returned cursor from previous call, and
647
- * a `cursorPaging`.`limit`.
648
- * No need to specify any additional parameters.
649
- *
650
- * <blockquote class="important">
651
- * <p><strong>Important:</strong><br/>
652
- * If you only provide a <code class="grey-background">cursorPaging</code>. <code class="grey-background">cursor</code>,
653
- * the response will contain the default size of results which is `1000`.
654
- * </p>
655
- * </blockquote>
656
- */
657
- cursorPaging?: CursorPaging;
658
- /**
659
- * resources filter
660
- * If specified, only time slots with these resources will be returned.
661
- * @maxSize 3
662
- */
663
- resourceTypes?: ResourceType[];
664
- }
665
- /**
666
- * Selected customer choices.
667
- * These choices are selected by the customer during the booking flow and can be utilized to calculate the corresponding service's configuration properties.
668
- */
669
- export interface CustomerChoices {
670
- /**
671
- * The selected customer duration in minutes.
672
- * Min: `1 minute`
673
- * Max: `44639 minutes` (30 days, 23 hours, and 59 minutes)
674
- * @min 1
675
- * @max 44639
676
- */
677
- durationInMinutes?: number | null;
678
- /**
679
- * The selected add-ons IDs.
680
- * Max: Derived from max amount of Add-On groups * max amount of Add-Ons per group.
681
- * @format GUID
682
- * @maxSize 21
683
- */
684
- addOnIds?: string[] | null;
685
- /**
686
- * The selected duration choice ID.
687
- * @format GUID
688
- */
689
- durationChoiceId?: string | null;
690
- }
691
- export interface ResourceType {
692
- /**
693
- * Resource type ID.
694
- * @format GUID
695
- */
696
- resourceTypeId?: string | null;
697
- /**
698
- * Resource IDs.
699
- * The response will contain only slots that have at least one of the specified resources.
700
- * @format GUID
701
- * @minSize 1
702
- * @maxSize 135
703
- */
704
- resourceIds?: string[] | null;
705
- }
706
- export interface ListAvailabilityTimeSlotsResponse {
707
- /**
708
- * Time slots.
709
- * @maxSize 1000
710
- */
711
- timeSlots?: TimeSlot[];
712
- /**
713
- * Time zone, in IANA time zone format.
714
- * Shared for all TimeSlots in response.
715
- * @minLength 1
716
- * @maxLength 150
717
- */
718
- timeZone?: string | null;
719
- /**
720
- * CursorPagingMetaData.
721
- * Contains information about the next page of results.
722
- *
723
- * By default,
724
- * if there are more than 1000 results,
725
- * the response will contain a `cursorPagingMetaData` with a cursor to the next page of results.
726
- *
727
- * <blockquote class="important">
728
- * <p><strong>Important:</strong><br/>
729
- * <code class="grey-background">count</code> is not supported.</p>
730
- * </blockquote>
731
- */
732
- cursorPagingMetadata?: CursorPagingMetadata;
733
- }
734
- export interface GetAvailabilityTimeSlotRequest {
735
- /**
736
- * Service ID of the time slot.
737
- * Currently supported only for services of type `APPOINTMENT`.
738
- * @format GUID
739
- */
740
- serviceId?: string;
741
- /**
742
- * Local start date of the time slot, in ISO-8601 format.
743
- * For example, "2024-01-30T13:30:00".
744
- * @format LOCAL_DATE_TIME
745
- */
746
- localStartDate?: string;
747
- /**
748
- * Local end date of the time slot, in ISO-8601 format.
749
- * For example, "2024-01-30T14:30:00".
750
- * @format LOCAL_DATE_TIME
751
- */
752
- localEndDate?: string;
753
- /**
754
- * Time zone, in IANA time zone format.
755
- * @minLength 1
756
- * @maxLength 150
757
- */
758
- timeZone?: string | null;
759
- /**
760
- * The location of the time slot.
761
- *
762
- * You must provide a specific `locationType`.
763
- * If locationType is `BUSINESS`, you __must__ also provide a `locationId`.
764
- *
765
- * <blockquote class="warning">
766
- * <p>Supports filtering by location type, or by location ID.
767
- * Other fields like <code class="grey-background">name</code> are ignored.</p>
768
- * </blockquote>
769
- */
770
- location?: Location;
771
- /**
772
- * Resources to include in response.
773
- *
774
- * If specified,
775
- * the returned `TimeSlot` contains only the available resources out of provided list.
776
- * Otherwise, the returned `TimeSlot` returned with all possible `AvailableResources`.
777
- * @format GUID
778
- * @maxSize 135
779
- */
780
- resourceIds?: string[];
781
- /**
782
- * Resource type IDs to include in response, this is in addition to the requested `resourceIds`.
783
- *
784
- * If specified in request, the returned `TimeSlot` contains only the `AvailableResources` with `ResourceTypeId`
785
- * out of those specified, each contains all the available resources of this type.
786
- * @format GUID
787
- * @maxSize 100
788
- */
789
- includeResourceTypeIds?: string[];
790
- }
791
- export interface GetAvailabilityTimeSlotRequestCustomerChoices {
792
- /**
793
- * The selected add-ons IDs.
794
- * Max: Derived from max amount of Add-On groups * max amount of Add-Ons per group.
795
- * @format GUID
796
- * @maxSize 21
797
- */
798
- addOnIds?: string[] | null;
799
- /**
800
- * The selected duration choice ID.
801
- * @format GUID
802
- */
803
- durationChoiceId?: string | null;
804
- }
805
- export interface GetAvailabilityTimeSlotResponse {
806
- /** Time slot. */
807
- timeSlot?: TimeSlot;
808
- /**
809
- * Time zone, in IANA time zone format.
810
- * @minLength 1
811
- * @maxLength 150
812
- */
813
- timeZone?: string | null;
814
- }
815
- export interface ListEventTimeSlotsRequest {
816
- /**
817
- * Local start date for which event time slots are returned, in ISO-8601 format.
818
- * E.g., "2024-01-30T13:30:00".
819
- * Required, unless `cursorPaging` is provided.
820
- * @format LOCAL_DATE_TIME
821
- */
822
- fromLocalDate?: string | null;
823
- /**
824
- * Local end date for which event time slots are returned, in ISO-8601 format.
825
- * E.g., "2024-01-30T13:30:00".
826
- * Required, unless `cursorPaging` is provided.
827
- * @format LOCAL_DATE_TIME
828
- */
829
- toLocalDate?: string | null;
830
- /**
831
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
832
- * For example, `America/New_York`.
833
- *
834
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
835
- * @maxLength 100
836
- */
837
- timeZone?: string | null;
838
- /**
839
- * Optional service IDs to filter by.
840
- * If not provided, time slots for all services are returned.
841
- * @format GUID
842
- * @maxSize 100
843
- */
844
- serviceIds?: string[] | null;
845
- /**
846
- * Whether to filter bookable slots only.
847
- * A bookable slot is a slot that has remaining capacity and also satisfies the booking policy.
848
- * Default false: Only bookable slots are returned.
849
- */
850
- includeNonBookable?: boolean | null;
851
- /**
852
- * Filter event time slots by the minimum bookable capacity.
853
- * @min 1
854
- */
855
- minBookableCapacity?: number | null;
856
- /**
857
- * Optional filter to apply to the events. E.g., resource, location, etc.
858
- * See the Events API [Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/supported-filters-and-sorting) for more information.
859
- */
860
- eventFilter?: Record<string, any> | null;
861
- /**
862
- * The maximum number of time slots to return for each day.
863
- * For example, if `maxSlotsPerDay` is set to `1`, at most 1 available slot is returned for each day.
864
- * When a day has both bookable and non-bookable slots, bookable slots are returned first.
865
- * If `maxSlotsPerDay` is provided, `toLocalDate` must also be provided and must be at most 1 month after `fromLocalDate`.
866
- * @min 1
867
- * @max 1
868
- */
869
- maxSlotsPerDay?: number | null;
870
- /** Cursor to retrieve the next page of results. */
871
- cursorPaging?: CursorPaging;
872
- }
873
- export interface ListEventTimeSlotsResponse {
874
- /** Retrieved time slots matching the specified filters. */
875
- timeSlots?: TimeSlot[];
876
- /**
877
- * The time slots time zone.
878
- * Either provided explicitly or default to the business time zone.
879
- * @minLength 1
880
- * @maxLength 150
881
- */
882
- timeZone?: string | null;
883
- /** Paging metadata. */
884
- pagingMetadata?: CursorPagingMetadata;
885
- }
886
- export interface GetEventTimeSlotRequest {
887
- /**
888
- * The event ID.
889
- * @minLength 36
890
- * @maxLength 250
891
- */
892
- eventId?: string | null;
893
- /**
894
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
895
- * For example, `America/New_York`.
896
- *
897
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
898
- * @maxLength 100
899
- */
900
- timeZone?: string | null;
901
- }
902
- export interface GetEventTimeSlotResponse {
903
- /** The time slot. */
904
- timeSlot?: TimeSlot;
905
- /**
906
- * The time slot time zone.
907
- * Either provided explicitly or default to the business time zone.
908
- * @minLength 1
909
- * @maxLength 150
910
- */
911
- timeZone?: string | null;
912
- }
913
- type TimeSlotNonNullablePaths = `location.locationType` | `availableResources` | `nestedTimeSlots` | `nestedTimeSlots.${number}.serviceId` | `nestedTimeSlots.${number}.localStartDate` | `nestedTimeSlots.${number}.localEndDate`;
914
- /**
915
- * Retrieves a list of multiService `TimeSlot`s that match the provided filters.
916
- *
917
- * <blockquote class="important">
918
- * <p><strong>Important:</strong><br/>
919
- * Currently supported only for services of type <code class="grey-background">APPOINTMENT</code>.</p>
920
- * </blockquote>
921
- *
922
- * The request body __must__ include either:
923
- * + All of the following filters: `service`.`serviceId`, `fromLocalDate`, `toLocalDate`, `location`, and `timeZone`. You may add additional filters as you wish.
924
- * + A `cursorPaging` with a valid `cursor` from previous response.
925
- *
926
- *
927
- * Each [TimeSlot](https://bo.wix.com/wix-docs/rest/all-apis/wix-service-availability/availability-time-slots/time-slot-object) in response
928
- * represents the availability of the given sequence of services in a specific order, location, and within a given range of time.
929
- *
930
- * Each `TimeSlot`.`NestedTimeSlot` represents a single service from the given list. The order of the `NestedTimeSlots` is the same as the order
931
- * of the given services in request.
932
- * The first `NestedTimeSlot` has `localStartDate` within the given `fromLocalDate` and `toLocalDate` exclusive,
933
- * and each following `NestedTimeSlot` has a `localStartDate` that equals to the previous `NestedTimeSlot`'s `localEndDate`.
934
- *
935
- * By default,
936
- * the response contains at most 1000 results.
937
- * If there are more than 1000 results, we return a `cursorPagingMetadata` with
938
- * a cursor for the next page of results, regardless of whether a `cursorPaging`
939
- * was provided in request.
940
- *
941
- * > __Notes:__
942
- * > + All nested time slots share the same location.
943
- * > + You can pass up to 8 services in request.
944
- *
945
- * ### AvailableResources in response:
946
- * The `TimeSlot`.`NestedTimeSlot`'s `AvailableResources` contains information about the resources that are available to provide the service
947
- * within the `NestedTimeSlot` range of time. Each `AvailableResources` contains information about available resources of the same type.
948
- *
949
- * <blockquote class="important">
950
- * <p><strong>Important:</strong><br/>
951
- * By default,
952
- * if you don't specify <code class="grey-background">service</code>.<code class="grey-background">includeResourceTypeIds</code>
953
- * or <code class="grey-background">service</code>.<code class="grey-background">resourceIds</code> filters in request,
954
- * we return TimeSlots with <code class="grey-background">NestedTimeSlot</code>s with an empty <code class="grey-background">AvailableResources</code>.
955
- * <br/><strong>Note:</strong><br/> Not specifying resources filters can be handy in case you want to avoid large response in flows that only
956
- * interested of whether the time slots are available. [Finding the next available slot within the next 3 months](https://bo.wix.com/wix-docs/rest/all-apis/service-availability/multi-service-availability-time-slots/sample-flows?localViewerId=inbari#all-apis_service-availability_multi-service-availability-time-slots_sample-flows_find-the-first-date-within-the-next-3-months-that-all-selected-services-are-available-for)
957
- * is an example for such flow.
958
- * </p>
959
- * </blockquote>
960
- *
961
- *
962
- * If you wish to get a list of available resources for a `TimeSlot`.`NestedTimeSlot` you should either:
963
- * + provide `service`.`resourceIds` in request.
964
- * + provide `service`.`includeResourceTypeIds` in request.
965
- *
966
- * __Notes:__
967
- * + In both cases the returned `TimeSlot`.`NestedTimeSlot` contains __up__ to 10 `AvailableResources` that match the provided filters. Each `AvailableResources` contains __up__ to 10 available `resources` of the same type that match the provided filters.
968
- * + If an `AvailableResources` has more available resources which are not listed within it, we return `AvailableResources`.`hasMoreAvailableResources` as true.
969
- * + If you wish to get the full available resources list for all `NestedTimeSlot` of a specific `TimeSlot`, you should call [GetMultiServiceAvailabilityTimeSlot](https://bo.wix.com/wix-docs/rest/all-apis/wix-service-availability/multi-service-availability-time-slots/get-multi-service-availability-time-slot).
970
- *
971
- *
972
- * ### Availability VS Bookability
973
- * An `available` time slot is not necessarily `bookable`.
974
- * The `bookable` field of a `TimeSlot` indicates whether the customer can book all of the of the services within the given time slot,
975
- * at a specific period of time.
976
- * Read more about [Availability VS Bookability](https://bo.wix.com/wix-docs/rest/all-apis/wix-service-availability/multi-service-availability-time-slots/introduction#all-apis_wix-service-availability_multi-service-availability-time-slots_introduction_availability-vs-bookability).
977
- *
978
- * By default,
979
- * + The response does not contains `unavailable` TimeSlots.For example, if there are no available resources to provide one of the services from `2024-01-30T14:30:00` to `2024-01-30T15:30:00`, we don't return TimeSlots with `NestedTimeSlot`.`localStartDate` within this range for this service.
980
- * + The response contains both `bookable` and `un-bookable` TimeSlots.For example, if one of the services has a booking policy which enforces booking the service up to 10 minutes before the session starts, we return TimeSlots with the violating `NestedTimeSlot`.`localStartDate`, with `bookable` as `false`. If you want to list only __bookable__ TimeSlots you should pass `bookable` as `true`.
981
- * + If booking one of the `NestedTimeSlot`s violates one of the corresponding service's booking policies, the `TimeSlot` returns with `bookable` as false. There is no indication which service's policy was violated.
982
- *
983
- * <blockquote class="important">
984
- * <p><strong>Important:</strong>
985
- * Because of DST, there are edge cases where certain times either do not exist or exist twice for a local time zone.
986
- * Read more about <a href="https://bo.wix.com/wix-docs/rest/all-apis/wix-service-availability/multi-service-availability-time-slots/introduction#all-apis_wix-service-availability_multi-service-availability-time-slots_introduction_daylight-saving-time-dst-handling">DST Handling</a></p>
987
- * </blockquote>
988
- *
989
- * ### ListAvailabilityTimeSlots runs with the following defaults:
990
- * + `localStartDate` is sorted in `ASC` order.
991
- * + `cursorPaging`.`limit` is `1000`.
992
- * @public
993
- * @documentationMaturity preview
994
- * @permissionId BOOKINGS.AVAILABILITY_READ_MULTI_SERVICE_TIME_SLOTS
995
- * @permissionScope Manage Stores
996
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
997
- * @permissionScope Read Bookings - Public Data
998
- * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
999
- * @permissionScope Manage Bookings Services and Settings
1000
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1001
- * @permissionScope Read Bookings - Including Participants
1002
- * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
1003
- * @permissionScope Read Bookings - all read permissions
1004
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
1005
- * @permissionScope Read Bookings Calendar Availability
1006
- * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
1007
- * @permissionScope Manage Bookings - all permissions
1008
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
1009
- * @applicableIdentity APP
1010
- * @applicableIdentity VISITOR
1011
- * @fqn com.wixpress.bookings.availability.v2.MultiServiceAvailabilityTimeSlots.ListMultiServiceAvailabilityTimeSlots
1012
- */
1013
- export declare function listMultiServiceAvailabilityTimeSlots(options?: ListMultiServiceAvailabilityTimeSlotsOptions): Promise<NonNullablePaths<ListMultiServiceAvailabilityTimeSlotsResponse, {
1014
- [P in TimeSlotNonNullablePaths]: `timeSlots.${number}.${P}`;
1015
- }[TimeSlotNonNullablePaths]>>;
1016
- export interface ListMultiServiceAvailabilityTimeSlotsOptions {
1017
- /**
1018
- * Services for which the multiService time slots are being returned for.
1019
- * Each service contains its own resources filters within.
1020
- *
1021
- * MinSize: `2`.
1022
- * MaxSize: `8`.
1023
- *
1024
- * Required, unless `cursorPaging`.`cursor` is provided.
1025
- * @maxSize 8
1026
- */
1027
- services?: Service[];
1028
- /**
1029
- * Lower boundary for `localStartDate` to include in response, in ISO-8601 format.
1030
- * For example, "2024-01-30T13:30:00".
1031
- *
1032
- * Each returned `TimeSlot` in response has a `localStartDate`
1033
- * within the provided `fromLocalDate` and `toLocalDate` exclusive.
1034
- *
1035
- * Required, unless `cursorPaging`.`cursor` is provided.
1036
- * @format LOCAL_DATE_TIME
1037
- */
1038
- fromLocalDate?: string | null;
1039
- /**
1040
- * Upper boundary for `localStartDate` to include in response, in ISO-8601 format.
1041
- * For example, "2024-01-30T14:30:00".
1042
- *
1043
- * Each returned `TimeSlot` in response has a `localStartDate`
1044
- * within the provided `fromLocalDate` and `toLocalDate` exclusive.
1045
- *
1046
- * Required, unless `cursorPaging`.`cursor` is provided.
1047
- * @format LOCAL_DATE_TIME
1048
- */
1049
- toLocalDate?: string | null;
1050
- /**
1051
- * Time zone, in IANA time zone format.
1052
- *
1053
- * Required, unless `cursorPaging`.`cursor` is provided.
1054
- * @minLength 1
1055
- * @maxLength 150
1056
- */
1057
- timeZone?: string | null;
1058
- /**
1059
- * Location for which the multiService TimeSlots are being returned for.
1060
- *
1061
- * You can specify location or location type for which the TimeSlots will be returned for.
1062
- * If locationType is `BUSINESS`, you __must__ provide a locationId.
1063
- *
1064
- * <blockquote class="warning">
1065
- * <p><strong>warning:</strong><br/>
1066
- * Supports filtering by location type, or by location ID. </br>
1067
- * Other fields like <code class="grey-background">name</code> are ignored.</p>
1068
- * </blockquote>
1069
- *
1070
- * Required, unless `cursorPaging`.`cursor` is provided.
1071
- */
1072
- location?: Location;
1073
- /**
1074
- * Whether the `TimeSlot` is bookable according to all of the services booking policies.
1075
- *
1076
- * If booking any of the `TimeSlot`.`NestedTimeSlot`s violates any of its services bookings policies,
1077
- * returns as `false`. Otherwise, returns as `true`.
1078
- *
1079
- * > __Note:__
1080
- * > A `TimeSlot` with a `NestedTimeSlot` that doesn't meet its service's bookings policies will be returned with `bookable` = false,
1081
- * > while a `TimeSlot` with no available resources will not be returned at all.
1082
- */
1083
- bookable?: boolean | null;
1084
- /**
1085
- * Indicators for service's booking policy violations for booking the `TimeSlot`.
1086
- *
1087
- * A bookable time slot must not violate any policy,
1088
- * therefor, this filter is only relevant when `bookable` filter is false.
1089
- *
1090
- * Each nested field is checked on all `NestedTimeSlot`s. For example, if only one of the `NestedTimeSlot`'s
1091
- * has a service with `tooEarlyToBook` same as in the request, we return the `TimeSlot` regardless of whether
1092
- * the other `NestedTimeSlots` has the same `tooEarlyToBook` as in request.
1093
- *
1094
- * Each nested field is checked on its own. For example, if `tooEarlyToBook` is defined and `bookOnlineDisabled` is not defined
1095
- * we return slots for which `tooEarlyToBook` is same as on the request, regardless of `bookOnlineDisabled`.
1096
- */
1097
- bookingPolicyViolations?: BookingPolicyViolations;
1098
- /**
1099
- * Maximum number of slots to load for each day. For example, if `timeSlotsPerDay` is set to `3`,
1100
- * we return at most 3 available TimeSlots for each day within the date range specified in request.
1101
- *
1102
- * By default,
1103
- * if `bookable` filter was not specified,
1104
- * and a day has both `bookable` and `un-bookable` slots, `bookable` slots are returned first.
1105
- *
1106
- * If the number of `bookable` slots is less than the requested `timeSlotsPerDay`,
1107
- * `un-bookable` slots will be returned according to the specified filters.
1108
- */
1109
- timeSlotsPerDay?: number | null;
1110
- /**
1111
- * CursorPaging.
1112
- *
1113
- * Enables you to fetch TimeSlots in smaller, more manageable chunks
1114
- * by setting a limit on the number of results returned in response.
1115
- * This is useful in order to enhance efficiency of data retrieval and reduce load on both the client and server.
1116
- *
1117
- * If there are more results than the specified limit, the response will contain a `cursorPagingMetaData`
1118
- * with a cursor pointing to next page of results. In order to fetch the next page of results, you should pass the
1119
- * returned cursor to the next call as `cursorPaging`.`cursor`.
1120
- *
1121
- * For the first call, you should only specify the `limit` for the results page.
1122
- * For each following call, you should only pass the previous returned cursor as `cursorPaging`.`cursor`
1123
- * the `cursorPaging`.`limit`. You may pass a different `limit`.
1124
- * No need to specify any additional parameters.
1125
- *
1126
- * <blockquote class="important">
1127
- * <p><strong>Important:</strong><br/>
1128
- * If you only provide a <code class="grey-background">cursorPaging</code>. <code class="grey-background">cursor</code>,
1129
- * the response will contain the default size of results which is `1000`.
1130
- * </p>
1131
- * </blockquote>
1132
- */
1133
- cursorPaging?: CursorPaging;
1134
- }
1135
- /**
1136
- * Retrieves an available multiService `TimeSlot` that match the provided filters.
1137
- *
1138
- * Throws `SlotNotFound` if there is no such available time slot.
1139
- *
1140
- * <blockquote class="important">
1141
- * <p><strong>Important:</strong><br/>
1142
- * Currently supported only for services of type <code class="grey-background">APPOINTMENT</code>.</p>
1143
- * </blockquote>
1144
- *
1145
- * By default,
1146
- * if you don't provide a `service`.`includeResourceTypeIds` or `service`.`resourceIds` in request,
1147
- * we return for each `TimeSlot`.`NestedTimeSlot` all `AvailableResources` with all `AvailableResources`.`resources` which are available to provide
1148
- * the corresponding service within the time slot.
1149
- *
1150
- * If you specify `service`.`includeResourceTypeIds` or `service`.`resourceIds` in request,
1151
- * the returned `TimeSlot`.`NestedTimeSlot` for this service will contain only `AvailableResources` with at least one available resource
1152
- * which match the given resources filters,
1153
- * each contains all available resources out of those requested.
1154
- *
1155
- * + Notes:
1156
- * + All nested time slots share the same location.
1157
- * + You can pass up to 8 services.
1158
- *
1159
- * <blockquote class="tip">
1160
- * <p><strong>Tip:</strong><br/>
1161
- * Use this API in order to get the availability of a specific <code class="grey-background">TimeSlot</code> out of those returned from <code class="grey-background">ListMultiServiceAvailabilityTimeSlots</code> API.</p>
1162
- * </blockquote>
1163
- * @param services - Services for which the multiService TimeSlots are being returned for.
1164
- * Each service contains its own resources filters within.
1165
- *
1166
- * MinSize: 2.
1167
- * MaxSize: 8.
1168
- * @param localStartDate - Local start date of the time slot, in ISO-8601 format.
1169
- * For example, "2024-01-30T13:30:00".
1170
- * @param localEndDate - Local end date of the time slot, in ISO-8601 format.
1171
- * For example, "2024-01-30T14:30:00".
1172
- * @param timeZone - Time zone, in IANA time zone format.
1173
- * @param location - The location of the time slot.
1174
- *
1175
- * You must provide a specific `locationType`.
1176
- * If locationType is `BUSINESS`, you __must__ also provide a `locationId`.
1177
- *
1178
- * <blockquote class="warning">
1179
- * <p>Supports filtering by location type, or by location ID.
1180
- * Other fields like <code class="grey-background">name</code> are ignored.</p>
1181
- * </blockquote>
1182
- * @public
1183
- * @documentationMaturity preview
1184
- * @requiredField localEndDate
1185
- * @requiredField localStartDate
1186
- * @requiredField location
1187
- * @requiredField location.locationType
1188
- * @requiredField services
1189
- * @requiredField services.serviceId
1190
- * @requiredField timeZone
1191
- * @permissionId BOOKINGS.AVAILABILITY_READ_MULTI_SERVICE_TIME_SLOTS
1192
- * @permissionScope Manage Stores
1193
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
1194
- * @permissionScope Read Bookings - Public Data
1195
- * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
1196
- * @permissionScope Manage Bookings Services and Settings
1197
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
1198
- * @permissionScope Read Bookings - Including Participants
1199
- * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
1200
- * @permissionScope Read Bookings - all read permissions
1201
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
1202
- * @permissionScope Read Bookings Calendar Availability
1203
- * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
1204
- * @permissionScope Manage Bookings - all permissions
1205
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
1206
- * @applicableIdentity APP
1207
- * @applicableIdentity VISITOR
1208
- * @fqn com.wixpress.bookings.availability.v2.MultiServiceAvailabilityTimeSlots.GetMultiServiceAvailabilityTimeSlot
1209
- */
1210
- export declare function getMultiServiceAvailabilityTimeSlot(services: NonNullablePaths<Service, `serviceId`>[], localStartDate: string, localEndDate: string, timeZone: string, location: NonNullablePaths<Location, `locationType`>): Promise<NonNullablePaths<GetMultiServiceAvailabilityTimeSlotResponse, {
1211
- [P in TimeSlotNonNullablePaths]: `timeSlot.${P}`;
1212
- }[TimeSlotNonNullablePaths]>>;
1213
- export {};