@wix/auto_sdk_calendar_schedule-time-frames 1.0.14 → 1.0.16
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/{internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.universal.d.ts → calendar-v3-schedule-time-frame-schedule-time-frames.universal-Bmaxv3bl.d.mts} +56 -163
- package/build/{cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.universal.d.ts → calendar-v3-schedule-time-frame-schedule-time-frames.universal-Bmaxv3bl.d.ts} +56 -163
- package/build/index.d.mts +40 -0
- package/build/index.d.ts +40 -0
- package/build/index.js +290 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +259 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{es/src/calendar-v3-schedule-time-frame-schedule-time-frames.universal.d.ts → calendar-v3-schedule-time-frame-schedule-time-frames.universal-Bmaxv3bl.d.mts} +56 -163
- package/build/{es/src/calendar-v3-schedule-time-frame-schedule-time-frames.universal.d.ts → internal/calendar-v3-schedule-time-frame-schedule-time-frames.universal-Bmaxv3bl.d.ts} +56 -163
- package/build/internal/index.d.mts +40 -0
- package/build/internal/index.d.ts +40 -0
- package/build/internal/index.js +290 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +259 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +156 -0
- package/build/internal/meta.d.ts +156 -0
- package/build/internal/meta.js +172 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +144 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +156 -0
- package/build/meta.d.ts +156 -0
- package/build/meta.js +172 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +144 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.context.d.ts +0 -14
- package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.context.js +0 -22
- package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.context.js.map +0 -1
- package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.http.d.ts +0 -10
- package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.http.js +0 -113
- package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.http.js.map +0 -1
- package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.meta.d.ts +0 -16
- package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.meta.js +0 -66
- package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.meta.js.map +0 -1
- package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.public.d.ts +0 -31
- package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.public.js +0 -40
- package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.public.js.map +0 -1
- package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.types.d.ts +0 -559
- package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.types.js +0 -46
- package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.types.js.map +0 -1
- package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.universal.js +0 -195
- package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.context.d.ts +0 -14
- package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.context.js +0 -14
- package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.context.js.map +0 -1
- package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.http.d.ts +0 -10
- package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.http.js +0 -108
- package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.http.js.map +0 -1
- package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.meta.d.ts +0 -16
- package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.meta.js +0 -38
- package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.meta.js.map +0 -1
- package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.public.d.ts +0 -31
- package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.public.js +0 -30
- package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.public.js.map +0 -1
- package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.types.d.ts +0 -559
- package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.types.js +0 -43
- package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.types.js.map +0 -1
- package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.universal.js +0 -167
- package/build/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.context.d.ts +0 -14
- package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.context.js +0 -22
- package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.context.js.map +0 -1
- package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.http.d.ts +0 -10
- package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.http.js +0 -113
- package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.http.js.map +0 -1
- package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.meta.d.ts +0 -16
- package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.meta.js +0 -66
- package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.meta.js.map +0 -1
- package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.public.d.ts +0 -31
- package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.public.js +0 -40
- package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.public.js.map +0 -1
- package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.types.d.ts +0 -559
- package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.types.js +0 -46
- package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.types.js.map +0 -1
- package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.universal.js +0 -195
- package/build/internal/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.context.d.ts +0 -14
- package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.context.js +0 -14
- package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.context.js.map +0 -1
- package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.http.d.ts +0 -10
- package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.http.js +0 -108
- package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.http.js.map +0 -1
- package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.meta.d.ts +0 -16
- package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.meta.js +0 -38
- package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.meta.js.map +0 -1
- package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.public.d.ts +0 -31
- package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.public.js +0 -30
- package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.public.js.map +0 -1
- package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.types.d.ts +0 -559
- package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.types.js +0 -43
- package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.types.js.map +0 -1
- package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.universal.js +0 -167
- package/build/internal/es/src/calendar-v3-schedule-time-frame-schedule-time-frames.universal.js.map +0 -1
|
@@ -1,11 +1,10 @@
|
|
|
1
|
-
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
1
|
/**
|
|
3
2
|
* Information about the start and end dates of the first and last
|
|
4
3
|
* [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction)
|
|
5
4
|
* that belong to a [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction)
|
|
6
5
|
* and whether any events follow an unlimited repetition pattern.
|
|
7
6
|
*/
|
|
8
|
-
|
|
7
|
+
interface ScheduleTimeFrame {
|
|
9
8
|
/**
|
|
10
9
|
* ID of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
|
|
11
10
|
* to which the time frame belongs.
|
|
@@ -61,7 +60,7 @@ export interface ScheduleTimeFrame {
|
|
|
61
60
|
*/
|
|
62
61
|
revision?: string | null;
|
|
63
62
|
}
|
|
64
|
-
|
|
63
|
+
declare enum Status {
|
|
65
64
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
66
65
|
/** No [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object) that belong to the schedule. */
|
|
67
66
|
NONE = "NONE",
|
|
@@ -71,9 +70,9 @@ export declare enum Status {
|
|
|
71
70
|
INFINITE = "INFINITE"
|
|
72
71
|
}
|
|
73
72
|
/** @enumType */
|
|
74
|
-
|
|
73
|
+
type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'NONE' | 'FINITE' | 'INFINITE';
|
|
75
74
|
/** A date time with a time zone, having the UTC offset and date determined by the server. */
|
|
76
|
-
|
|
75
|
+
interface ZonedDate {
|
|
77
76
|
/**
|
|
78
77
|
* Local date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
|
|
79
78
|
* For example, `2024-01-30T13:30:00`.
|
|
@@ -96,7 +95,7 @@ export interface ZonedDate {
|
|
|
96
95
|
*/
|
|
97
96
|
utcDate?: Date | null;
|
|
98
97
|
}
|
|
99
|
-
|
|
98
|
+
interface GetScheduleTimeFrameRequest {
|
|
100
99
|
/**
|
|
101
100
|
* [Schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
|
|
102
101
|
* ID for which to retrieve the schedule time frame.
|
|
@@ -110,11 +109,11 @@ export interface GetScheduleTimeFrameRequest {
|
|
|
110
109
|
*/
|
|
111
110
|
timeZone?: string | null;
|
|
112
111
|
}
|
|
113
|
-
|
|
112
|
+
interface GetScheduleTimeFrameResponse {
|
|
114
113
|
/** Retrieved schedule time frame. */
|
|
115
114
|
scheduleTimeFrame?: ScheduleTimeFrame;
|
|
116
115
|
}
|
|
117
|
-
|
|
116
|
+
interface ListScheduleTimeFramesRequest {
|
|
118
117
|
/**
|
|
119
118
|
* IDs of the schedules for which to retrieve schedule time frames.
|
|
120
119
|
*
|
|
@@ -132,12 +131,12 @@ export interface ListScheduleTimeFramesRequest {
|
|
|
132
131
|
*/
|
|
133
132
|
timeZone?: string | null;
|
|
134
133
|
}
|
|
135
|
-
|
|
134
|
+
interface ListScheduleTimeFramesResponse {
|
|
136
135
|
/** Retrieved schedule time frames. */
|
|
137
136
|
scheduleTimeFrames?: ScheduleTimeFrame[];
|
|
138
137
|
}
|
|
139
138
|
/** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
|
|
140
|
-
|
|
139
|
+
interface SitePropertiesNotification {
|
|
141
140
|
/** The site ID for which this update notification applies. */
|
|
142
141
|
metasiteId?: string;
|
|
143
142
|
/** The actual update event. */
|
|
@@ -151,7 +150,7 @@ export interface SitePropertiesNotification {
|
|
|
151
150
|
changeContext?: ChangeContext;
|
|
152
151
|
}
|
|
153
152
|
/** The actual update event for a particular notification. */
|
|
154
|
-
|
|
153
|
+
interface SitePropertiesEvent {
|
|
155
154
|
/** Version of the site's properties represented by this update. */
|
|
156
155
|
version?: number;
|
|
157
156
|
/** Set of properties that were updated - corresponds to the fields in "properties". */
|
|
@@ -159,7 +158,7 @@ export interface SitePropertiesEvent {
|
|
|
159
158
|
/** Updated properties. */
|
|
160
159
|
properties?: Properties;
|
|
161
160
|
}
|
|
162
|
-
|
|
161
|
+
interface Properties {
|
|
163
162
|
/** Site categories. */
|
|
164
163
|
categories?: Categories;
|
|
165
164
|
/** Site locale. */
|
|
@@ -215,7 +214,7 @@ export interface Properties {
|
|
|
215
214
|
/** Track clicks analytics. */
|
|
216
215
|
trackClicksAnalytics?: boolean;
|
|
217
216
|
}
|
|
218
|
-
|
|
217
|
+
interface Categories {
|
|
219
218
|
/** Primary site category. */
|
|
220
219
|
primary?: string;
|
|
221
220
|
/**
|
|
@@ -226,13 +225,13 @@ export interface Categories {
|
|
|
226
225
|
/** Business Term Id */
|
|
227
226
|
businessTermId?: string | null;
|
|
228
227
|
}
|
|
229
|
-
|
|
228
|
+
interface Locale {
|
|
230
229
|
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
231
230
|
languageCode?: string;
|
|
232
231
|
/** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
|
|
233
232
|
country?: string;
|
|
234
233
|
}
|
|
235
|
-
|
|
234
|
+
interface Address {
|
|
236
235
|
/** Street name. */
|
|
237
236
|
street?: string;
|
|
238
237
|
/** City name. */
|
|
@@ -264,29 +263,29 @@ export interface Address {
|
|
|
264
263
|
* This is used for display purposes. Used to add additional data about the address, such as "In the passage".
|
|
265
264
|
* Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
|
|
266
265
|
*/
|
|
267
|
-
|
|
266
|
+
interface AddressHint {
|
|
268
267
|
/** Extra text displayed next to, or instead of, the actual address. */
|
|
269
268
|
text?: string;
|
|
270
269
|
/** Where the extra text should be displayed. */
|
|
271
270
|
placement?: PlacementTypeWithLiterals;
|
|
272
271
|
}
|
|
273
272
|
/** Where the extra text should be displayed: before, after or instead of the actual address. */
|
|
274
|
-
|
|
273
|
+
declare enum PlacementType {
|
|
275
274
|
BEFORE = "BEFORE",
|
|
276
275
|
AFTER = "AFTER",
|
|
277
276
|
REPLACE = "REPLACE"
|
|
278
277
|
}
|
|
279
278
|
/** @enumType */
|
|
280
|
-
|
|
279
|
+
type PlacementTypeWithLiterals = PlacementType | 'BEFORE' | 'AFTER' | 'REPLACE';
|
|
281
280
|
/** Geocoordinates for a particular address. */
|
|
282
|
-
|
|
281
|
+
interface GeoCoordinates {
|
|
283
282
|
/** Latitude of the location. Must be between -90 and 90. */
|
|
284
283
|
latitude?: number;
|
|
285
284
|
/** Longitude of the location. Must be between -180 and 180. */
|
|
286
285
|
longitude?: number;
|
|
287
286
|
}
|
|
288
287
|
/** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
|
|
289
|
-
|
|
288
|
+
interface BusinessSchedule {
|
|
290
289
|
/**
|
|
291
290
|
* Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
|
|
292
291
|
* @maxSize 100
|
|
@@ -299,7 +298,7 @@ export interface BusinessSchedule {
|
|
|
299
298
|
specialHourPeriod?: SpecialHourPeriod[];
|
|
300
299
|
}
|
|
301
300
|
/** Weekly recurring time periods when the business is regularly open or the service is available. */
|
|
302
|
-
|
|
301
|
+
interface TimePeriod {
|
|
303
302
|
/** Day of the week the period starts on. */
|
|
304
303
|
openDay?: DayOfWeekWithLiterals;
|
|
305
304
|
/**
|
|
@@ -318,7 +317,7 @@ export interface TimePeriod {
|
|
|
318
317
|
closeTime?: string;
|
|
319
318
|
}
|
|
320
319
|
/** Enumerates the days of the week. */
|
|
321
|
-
|
|
320
|
+
declare enum DayOfWeek {
|
|
322
321
|
MONDAY = "MONDAY",
|
|
323
322
|
TUESDAY = "TUESDAY",
|
|
324
323
|
WEDNESDAY = "WEDNESDAY",
|
|
@@ -328,9 +327,9 @@ export declare enum DayOfWeek {
|
|
|
328
327
|
SUNDAY = "SUNDAY"
|
|
329
328
|
}
|
|
330
329
|
/** @enumType */
|
|
331
|
-
|
|
330
|
+
type DayOfWeekWithLiterals = DayOfWeek | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
|
|
332
331
|
/** Exception to the business's regular hours. The business can be open or closed during the exception. */
|
|
333
|
-
|
|
332
|
+
interface SpecialHourPeriod {
|
|
334
333
|
/** 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). */
|
|
335
334
|
startDate?: string;
|
|
336
335
|
/** 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). */
|
|
@@ -344,7 +343,7 @@ export interface SpecialHourPeriod {
|
|
|
344
343
|
/** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
|
|
345
344
|
comment?: string;
|
|
346
345
|
}
|
|
347
|
-
|
|
346
|
+
interface Multilingual {
|
|
348
347
|
/**
|
|
349
348
|
* Supported languages list.
|
|
350
349
|
* @maxSize 200
|
|
@@ -353,7 +352,7 @@ export interface Multilingual {
|
|
|
353
352
|
/** Whether to redirect to user language. */
|
|
354
353
|
autoRedirect?: boolean;
|
|
355
354
|
}
|
|
356
|
-
|
|
355
|
+
interface SupportedLanguage {
|
|
357
356
|
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
358
357
|
languageCode?: string;
|
|
359
358
|
/** Locale. */
|
|
@@ -364,15 +363,17 @@ export interface SupportedLanguage {
|
|
|
364
363
|
countryCode?: string;
|
|
365
364
|
/** How the language will be resolved. For internal use. */
|
|
366
365
|
resolutionMethod?: ResolutionMethodWithLiterals;
|
|
366
|
+
/** Whether the supported language is the primary language for site visitors. */
|
|
367
|
+
isVisitorPrimary?: boolean | null;
|
|
367
368
|
}
|
|
368
|
-
|
|
369
|
+
declare enum ResolutionMethod {
|
|
369
370
|
QUERY_PARAM = "QUERY_PARAM",
|
|
370
371
|
SUBDOMAIN = "SUBDOMAIN",
|
|
371
372
|
SUBDIRECTORY = "SUBDIRECTORY"
|
|
372
373
|
}
|
|
373
374
|
/** @enumType */
|
|
374
|
-
|
|
375
|
-
|
|
375
|
+
type ResolutionMethodWithLiterals = ResolutionMethod | 'QUERY_PARAM' | 'SUBDOMAIN' | 'SUBDIRECTORY';
|
|
376
|
+
interface ConsentPolicy {
|
|
376
377
|
/** Whether the site uses cookies that are essential to site operation. Always `true`. */
|
|
377
378
|
essential?: boolean | null;
|
|
378
379
|
/** Whether the site uses cookies that affect site performance and other functional measurements. */
|
|
@@ -385,7 +386,7 @@ export interface ConsentPolicy {
|
|
|
385
386
|
dataToThirdParty?: boolean | null;
|
|
386
387
|
}
|
|
387
388
|
/** A single mapping from the MetaSite ID to a particular service. */
|
|
388
|
-
|
|
389
|
+
interface Translation {
|
|
389
390
|
/** The service type. */
|
|
390
391
|
serviceType?: string;
|
|
391
392
|
/** The application definition ID; this only applies to services of type ThirdPartyApps. */
|
|
@@ -393,7 +394,7 @@ export interface Translation {
|
|
|
393
394
|
/** The instance ID of the service. */
|
|
394
395
|
instanceId?: string;
|
|
395
396
|
}
|
|
396
|
-
|
|
397
|
+
interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
397
398
|
/** Properties were updated. */
|
|
398
399
|
propertiesChange?: PropertiesChange;
|
|
399
400
|
/** Default properties were created on site creation. */
|
|
@@ -402,7 +403,7 @@ export interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
|
402
403
|
siteCloned?: SiteCloned;
|
|
403
404
|
}
|
|
404
405
|
/** @oneof */
|
|
405
|
-
|
|
406
|
+
interface ChangeContextPayloadOneOf {
|
|
406
407
|
/** Properties were updated. */
|
|
407
408
|
propertiesChange?: PropertiesChange;
|
|
408
409
|
/** Default properties were created on site creation. */
|
|
@@ -410,19 +411,19 @@ export interface ChangeContextPayloadOneOf {
|
|
|
410
411
|
/** Properties were cloned on site cloning. */
|
|
411
412
|
siteCloned?: SiteCloned;
|
|
412
413
|
}
|
|
413
|
-
|
|
414
|
+
interface PropertiesChange {
|
|
414
415
|
}
|
|
415
|
-
|
|
416
|
+
interface SiteCreated {
|
|
416
417
|
/** Origin template site id. */
|
|
417
418
|
originTemplateId?: string | null;
|
|
418
419
|
}
|
|
419
|
-
|
|
420
|
+
interface SiteCloned {
|
|
420
421
|
/** Origin site id. */
|
|
421
422
|
originMetaSiteId?: string;
|
|
422
423
|
}
|
|
423
|
-
|
|
424
|
+
interface Empty {
|
|
424
425
|
}
|
|
425
|
-
|
|
426
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
426
427
|
createdEvent?: EntityCreatedEvent;
|
|
427
428
|
updatedEvent?: EntityUpdatedEvent;
|
|
428
429
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -457,19 +458,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
457
458
|
entityEventSequence?: string | null;
|
|
458
459
|
}
|
|
459
460
|
/** @oneof */
|
|
460
|
-
|
|
461
|
+
interface DomainEventBodyOneOf {
|
|
461
462
|
createdEvent?: EntityCreatedEvent;
|
|
462
463
|
updatedEvent?: EntityUpdatedEvent;
|
|
463
464
|
deletedEvent?: EntityDeletedEvent;
|
|
464
465
|
actionEvent?: ActionEvent;
|
|
465
466
|
}
|
|
466
|
-
|
|
467
|
+
interface EntityCreatedEvent {
|
|
467
468
|
entity?: string;
|
|
468
469
|
}
|
|
469
|
-
|
|
470
|
+
interface RestoreInfo {
|
|
470
471
|
deletedDate?: Date | null;
|
|
471
472
|
}
|
|
472
|
-
|
|
473
|
+
interface EntityUpdatedEvent {
|
|
473
474
|
/**
|
|
474
475
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
475
476
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -477,14 +478,14 @@ export interface EntityUpdatedEvent {
|
|
|
477
478
|
*/
|
|
478
479
|
currentEntity?: string;
|
|
479
480
|
}
|
|
480
|
-
|
|
481
|
+
interface EntityDeletedEvent {
|
|
481
482
|
/** Entity that was deleted. */
|
|
482
483
|
deletedEntity?: string | null;
|
|
483
484
|
}
|
|
484
|
-
|
|
485
|
+
interface ActionEvent {
|
|
485
486
|
body?: string;
|
|
486
487
|
}
|
|
487
|
-
|
|
488
|
+
interface MessageEnvelope {
|
|
488
489
|
/**
|
|
489
490
|
* App instance ID.
|
|
490
491
|
* @format GUID
|
|
@@ -500,7 +501,7 @@ export interface MessageEnvelope {
|
|
|
500
501
|
/** Stringify payload. */
|
|
501
502
|
data?: string;
|
|
502
503
|
}
|
|
503
|
-
|
|
504
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
504
505
|
/**
|
|
505
506
|
* ID of a site visitor that has not logged in to the site.
|
|
506
507
|
* @format GUID
|
|
@@ -525,7 +526,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
525
526
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
526
527
|
}
|
|
527
528
|
/** @oneof */
|
|
528
|
-
|
|
529
|
+
interface IdentificationDataIdOneOf {
|
|
529
530
|
/**
|
|
530
531
|
* ID of a site visitor that has not logged in to the site.
|
|
531
532
|
* @format GUID
|
|
@@ -547,7 +548,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
547
548
|
*/
|
|
548
549
|
appId?: string;
|
|
549
550
|
}
|
|
550
|
-
|
|
551
|
+
declare enum WebhookIdentityType {
|
|
551
552
|
UNKNOWN = "UNKNOWN",
|
|
552
553
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
553
554
|
MEMBER = "MEMBER",
|
|
@@ -555,8 +556,8 @@ export declare enum WebhookIdentityType {
|
|
|
555
556
|
APP = "APP"
|
|
556
557
|
}
|
|
557
558
|
/** @enumType */
|
|
558
|
-
|
|
559
|
-
|
|
559
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
560
|
+
interface BaseEventMetadata {
|
|
560
561
|
/**
|
|
561
562
|
* App instance ID.
|
|
562
563
|
* @format GUID
|
|
@@ -570,7 +571,7 @@ export interface BaseEventMetadata {
|
|
|
570
571
|
/** The identification type and identity data. */
|
|
571
572
|
identity?: IdentificationData;
|
|
572
573
|
}
|
|
573
|
-
|
|
574
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
574
575
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
575
576
|
_id?: string;
|
|
576
577
|
/**
|
|
@@ -600,79 +601,11 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
600
601
|
*/
|
|
601
602
|
entityEventSequence?: string | null;
|
|
602
603
|
}
|
|
603
|
-
|
|
604
|
+
interface ScheduleTimeFrameUpdatedEnvelope {
|
|
604
605
|
entity: ScheduleTimeFrame;
|
|
605
606
|
metadata: EventMetadata;
|
|
606
607
|
}
|
|
607
|
-
|
|
608
|
-
* Triggered when a schedule's time frame is updated, indicating a new first or
|
|
609
|
-
* last event or a change in the recurrence period, such as an extension or
|
|
610
|
-
* reduction.
|
|
611
|
-
* @permissionScope Read Bookings - Public Data
|
|
612
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
613
|
-
* @permissionScope Read Calendar - Including PI
|
|
614
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
615
|
-
* @permissionScope Manage Calendars
|
|
616
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
617
|
-
* @permissionScope Manage Bookings
|
|
618
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
619
|
-
* @permissionScope Read Bookings - Including Participants
|
|
620
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
621
|
-
* @permissionScope Read Bookings - all read permissions
|
|
622
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
623
|
-
* @permissionScope Read Bookings Calendar Availability
|
|
624
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
|
|
625
|
-
* @permissionScope Read Calendar
|
|
626
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
|
|
627
|
-
* @permissionScope Manage Bookings - all permissions
|
|
628
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
629
|
-
* @permissionScope Read bookings calendar - including participants
|
|
630
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
631
|
-
* @permissionScope Read Bookings Calendar
|
|
632
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
|
|
633
|
-
* @permissionId CALENDAR.SCHEDULE_READ
|
|
634
|
-
* @webhook
|
|
635
|
-
* @eventType wix.calendar.v3.schedule_time_frame_updated
|
|
636
|
-
* @slug updated
|
|
637
|
-
*/
|
|
638
|
-
export declare function onScheduleTimeFrameUpdated(handler: (event: ScheduleTimeFrameUpdatedEnvelope) => void | Promise<void>): void;
|
|
639
|
-
type ScheduleTimeFrameNonNullablePaths = `status`;
|
|
640
|
-
/**
|
|
641
|
-
* Retrieves a schedule time frame by schedule ID.
|
|
642
|
-
* @param _id - [Schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
|
|
643
|
-
* ID for which to retrieve the schedule time frame.
|
|
644
|
-
* @public
|
|
645
|
-
* @requiredField _id
|
|
646
|
-
* @permissionId CALENDAR.SCHEDULE_READ
|
|
647
|
-
* @permissionScope Read Bookings - Public Data
|
|
648
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
649
|
-
* @permissionScope Read Calendar - Including PI
|
|
650
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
651
|
-
* @permissionScope Manage Calendars
|
|
652
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
653
|
-
* @permissionScope Manage Bookings
|
|
654
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
655
|
-
* @permissionScope Read Bookings - Including Participants
|
|
656
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
657
|
-
* @permissionScope Read Bookings - all read permissions
|
|
658
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
659
|
-
* @permissionScope Read Bookings Calendar Availability
|
|
660
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
|
|
661
|
-
* @permissionScope Read Calendar
|
|
662
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
|
|
663
|
-
* @permissionScope Manage Bookings - all permissions
|
|
664
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
665
|
-
* @permissionScope Read bookings calendar - including participants
|
|
666
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
667
|
-
* @permissionScope Read Bookings Calendar
|
|
668
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
|
|
669
|
-
* @applicableIdentity APP
|
|
670
|
-
* @applicableIdentity VISITOR
|
|
671
|
-
* @returns Retrieved schedule time frame.
|
|
672
|
-
* @fqn wix.calendar.scheduletimeframes.v3.ScheduleTimeFramesService.GetScheduleTimeFrame
|
|
673
|
-
*/
|
|
674
|
-
export declare function getScheduleTimeFrame(_id: string, options?: GetScheduleTimeFrameOptions): Promise<NonNullablePaths<ScheduleTimeFrame, ScheduleTimeFrameNonNullablePaths>>;
|
|
675
|
-
export interface GetScheduleTimeFrameOptions {
|
|
608
|
+
interface GetScheduleTimeFrameOptions {
|
|
676
609
|
/**
|
|
677
610
|
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting the times of the returned schedule time frame. For example, `America/New_York` or `UTC`.
|
|
678
611
|
*
|
|
@@ -680,48 +613,7 @@ export interface GetScheduleTimeFrameOptions {
|
|
|
680
613
|
*/
|
|
681
614
|
timeZone?: string | null;
|
|
682
615
|
}
|
|
683
|
-
|
|
684
|
-
* Retrieves a list of schedule time frames by schedule IDs.
|
|
685
|
-
*
|
|
686
|
-
*
|
|
687
|
-
* Sorted by schedule ID in ascending order.
|
|
688
|
-
* @param ids - IDs of the schedules for which to retrieve schedule time frames.
|
|
689
|
-
*
|
|
690
|
-
* Min: 1 schedule ID
|
|
691
|
-
* Max: 100 schedule IDs
|
|
692
|
-
* @public
|
|
693
|
-
* @requiredField ids
|
|
694
|
-
* @permissionId CALENDAR.SCHEDULE_READ
|
|
695
|
-
* @permissionScope Read Bookings - Public Data
|
|
696
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
697
|
-
* @permissionScope Read Calendar - Including PI
|
|
698
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
699
|
-
* @permissionScope Manage Calendars
|
|
700
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
701
|
-
* @permissionScope Manage Bookings
|
|
702
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
703
|
-
* @permissionScope Read Bookings - Including Participants
|
|
704
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
705
|
-
* @permissionScope Read Bookings - all read permissions
|
|
706
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
707
|
-
* @permissionScope Read Bookings Calendar Availability
|
|
708
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
|
|
709
|
-
* @permissionScope Read Calendar
|
|
710
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
|
|
711
|
-
* @permissionScope Manage Bookings - all permissions
|
|
712
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
713
|
-
* @permissionScope Read bookings calendar - including participants
|
|
714
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
715
|
-
* @permissionScope Read Bookings Calendar
|
|
716
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
|
|
717
|
-
* @applicableIdentity APP
|
|
718
|
-
* @applicableIdentity VISITOR
|
|
719
|
-
* @fqn wix.calendar.scheduletimeframes.v3.ScheduleTimeFramesService.ListScheduleTimeFrames
|
|
720
|
-
*/
|
|
721
|
-
export declare function listScheduleTimeFrames(ids: string[], options?: ListScheduleTimeFramesOptions): Promise<NonNullablePaths<ListScheduleTimeFramesResponse, {
|
|
722
|
-
[P in ScheduleTimeFrameNonNullablePaths]: `scheduleTimeFrames.${number}.${P}`;
|
|
723
|
-
}[ScheduleTimeFrameNonNullablePaths]>>;
|
|
724
|
-
export interface ListScheduleTimeFramesOptions {
|
|
616
|
+
interface ListScheduleTimeFramesOptions {
|
|
725
617
|
/**
|
|
726
618
|
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting the times of the returned schedule time frame. For example, `America/New_York` or `UTC`.
|
|
727
619
|
*
|
|
@@ -729,4 +621,5 @@ export interface ListScheduleTimeFramesOptions {
|
|
|
729
621
|
*/
|
|
730
622
|
timeZone?: string | null;
|
|
731
623
|
}
|
|
732
|
-
|
|
624
|
+
|
|
625
|
+
export { type Address as A, type BusinessSchedule as B, type Categories as C, DayOfWeek as D, type Empty as E, type EntityDeletedEvent as F, type GetScheduleTimeFrameOptions as G, type ActionEvent as H, type MessageEnvelope as I, type IdentificationData as J, type IdentificationDataIdOneOf as K, type ListScheduleTimeFramesOptions as L, type Multilingual as M, type BaseEventMetadata as N, type EventMetadata as O, PlacementType as P, ResolutionMethod as R, type ScheduleTimeFrame as S, type TimePeriod as T, WebhookIdentityType as W, type ZonedDate as Z, type ListScheduleTimeFramesResponse as a, type ScheduleTimeFrameUpdatedEnvelope as b, Status as c, type GetScheduleTimeFrameRequest as d, type GetScheduleTimeFrameResponse as e, type ListScheduleTimeFramesRequest as f, type SitePropertiesNotification as g, type SitePropertiesEvent as h, type Properties as i, type Locale as j, type AddressHint as k, type GeoCoordinates as l, type SpecialHourPeriod as m, type SupportedLanguage as n, type ConsentPolicy as o, type Translation as p, type ChangeContext as q, type ChangeContextPayloadOneOf as r, type PropertiesChange as s, type SiteCreated as t, type SiteCloned as u, type DomainEvent as v, type DomainEventBodyOneOf as w, type EntityCreatedEvent as x, type RestoreInfo as y, type EntityUpdatedEvent as z };
|