@wix/auto_sdk_calendar_schedules 1.0.44 → 1.0.46
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-schedules.universal.d.ts → calendar-v3-schedule-schedules.universal-Cy_4Hg5X.d.mts} +129 -403
- package/build/{cjs/src/calendar-v3-schedule-schedules.universal.d.ts → calendar-v3-schedule-schedules.universal-Cy_4Hg5X.d.ts} +129 -403
- package/build/index.d.mts +108 -0
- package/build/index.d.ts +108 -0
- package/build/index.js +703 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +656 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{es/src/calendar-v3-schedule-schedules.universal.d.ts → calendar-v3-schedule-schedules.universal-Cy_4Hg5X.d.mts} +129 -403
- package/build/{es/src/calendar-v3-schedule-schedules.universal.d.ts → internal/calendar-v3-schedule-schedules.universal-Cy_4Hg5X.d.ts} +129 -403
- package/build/internal/index.d.mts +108 -0
- package/build/internal/index.d.ts +108 -0
- package/build/internal/index.js +703 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +656 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +497 -0
- package/build/internal/meta.d.ts +497 -0
- package/build/internal/meta.js +331 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +300 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +497 -0
- package/build/meta.d.ts +497 -0
- package/build/meta.js +331 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +300 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +12 -11
- 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-schedules.context.d.ts +0 -30
- package/build/cjs/src/calendar-v3-schedule-schedules.context.js +0 -48
- package/build/cjs/src/calendar-v3-schedule-schedules.context.js.map +0 -1
- package/build/cjs/src/calendar-v3-schedule-schedules.http.d.ts +0 -53
- package/build/cjs/src/calendar-v3-schedule-schedules.http.js +0 -255
- package/build/cjs/src/calendar-v3-schedule-schedules.http.js.map +0 -1
- package/build/cjs/src/calendar-v3-schedule-schedules.meta.d.ts +0 -23
- package/build/cjs/src/calendar-v3-schedule-schedules.meta.js +0 -123
- package/build/cjs/src/calendar-v3-schedule-schedules.meta.js.map +0 -1
- package/build/cjs/src/calendar-v3-schedule-schedules.public.d.ts +0 -86
- package/build/cjs/src/calendar-v3-schedule-schedules.public.js +0 -96
- package/build/cjs/src/calendar-v3-schedule-schedules.public.js.map +0 -1
- package/build/cjs/src/calendar-v3-schedule-schedules.types.d.ts +0 -1414
- package/build/cjs/src/calendar-v3-schedule-schedules.types.js +0 -208
- package/build/cjs/src/calendar-v3-schedule-schedules.types.js.map +0 -1
- package/build/cjs/src/calendar-v3-schedule-schedules.universal.js +0 -575
- package/build/cjs/src/calendar-v3-schedule-schedules.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-schedules.context.d.ts +0 -30
- package/build/es/src/calendar-v3-schedule-schedules.context.js +0 -30
- package/build/es/src/calendar-v3-schedule-schedules.context.js.map +0 -1
- package/build/es/src/calendar-v3-schedule-schedules.http.d.ts +0 -53
- package/build/es/src/calendar-v3-schedule-schedules.http.js +0 -247
- package/build/es/src/calendar-v3-schedule-schedules.http.js.map +0 -1
- package/build/es/src/calendar-v3-schedule-schedules.meta.d.ts +0 -23
- package/build/es/src/calendar-v3-schedule-schedules.meta.js +0 -92
- package/build/es/src/calendar-v3-schedule-schedules.meta.js.map +0 -1
- package/build/es/src/calendar-v3-schedule-schedules.public.d.ts +0 -86
- package/build/es/src/calendar-v3-schedule-schedules.public.js +0 -73
- package/build/es/src/calendar-v3-schedule-schedules.public.js.map +0 -1
- package/build/es/src/calendar-v3-schedule-schedules.types.d.ts +0 -1414
- package/build/es/src/calendar-v3-schedule-schedules.types.js +0 -205
- package/build/es/src/calendar-v3-schedule-schedules.types.js.map +0 -1
- package/build/es/src/calendar-v3-schedule-schedules.universal.js +0 -544
- package/build/es/src/calendar-v3-schedule-schedules.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-schedules.context.d.ts +0 -30
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.context.js +0 -48
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.context.js.map +0 -1
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.http.d.ts +0 -53
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.http.js +0 -255
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.http.js.map +0 -1
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.meta.d.ts +0 -23
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.meta.js +0 -123
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.meta.js.map +0 -1
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.public.d.ts +0 -86
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.public.js +0 -96
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.public.js.map +0 -1
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.types.d.ts +0 -1414
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.types.js +0 -208
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.types.js.map +0 -1
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.universal.js +0 -575
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.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-schedules.context.d.ts +0 -30
- package/build/internal/es/src/calendar-v3-schedule-schedules.context.js +0 -30
- package/build/internal/es/src/calendar-v3-schedule-schedules.context.js.map +0 -1
- package/build/internal/es/src/calendar-v3-schedule-schedules.http.d.ts +0 -53
- package/build/internal/es/src/calendar-v3-schedule-schedules.http.js +0 -247
- package/build/internal/es/src/calendar-v3-schedule-schedules.http.js.map +0 -1
- package/build/internal/es/src/calendar-v3-schedule-schedules.meta.d.ts +0 -23
- package/build/internal/es/src/calendar-v3-schedule-schedules.meta.js +0 -92
- package/build/internal/es/src/calendar-v3-schedule-schedules.meta.js.map +0 -1
- package/build/internal/es/src/calendar-v3-schedule-schedules.public.d.ts +0 -86
- package/build/internal/es/src/calendar-v3-schedule-schedules.public.js +0 -73
- package/build/internal/es/src/calendar-v3-schedule-schedules.public.js.map +0 -1
- package/build/internal/es/src/calendar-v3-schedule-schedules.types.d.ts +0 -1414
- package/build/internal/es/src/calendar-v3-schedule-schedules.types.js +0 -205
- package/build/internal/es/src/calendar-v3-schedule-schedules.types.js.map +0 -1
- package/build/internal/es/src/calendar-v3-schedule-schedules.universal.js +0 -544
- package/build/internal/es/src/calendar-v3-schedule-schedules.universal.js.map +0 -1
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
1
|
/**
|
|
3
2
|
* A collection of [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
|
|
4
3
|
* associated with a specific entity, such as a
|
|
@@ -7,7 +6,7 @@ import { NonNullablePaths } from '@wix/sdk-types';
|
|
|
7
6
|
* Schedules can also serve as templates for the events they manage, setting
|
|
8
7
|
* default values like a default location.
|
|
9
8
|
*/
|
|
10
|
-
|
|
9
|
+
interface Schedule {
|
|
11
10
|
/**
|
|
12
11
|
* Schedule ID.
|
|
13
12
|
* @format GUID
|
|
@@ -132,7 +131,7 @@ export interface Schedule {
|
|
|
132
131
|
*/
|
|
133
132
|
_updatedDate?: Date | null;
|
|
134
133
|
}
|
|
135
|
-
|
|
134
|
+
declare enum Status {
|
|
136
135
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
137
136
|
/** You can add events to the schedule or update its fields. */
|
|
138
137
|
ACTIVE = "ACTIVE",
|
|
@@ -140,8 +139,8 @@ export declare enum Status {
|
|
|
140
139
|
CANCELLED = "CANCELLED"
|
|
141
140
|
}
|
|
142
141
|
/** @enumType */
|
|
143
|
-
|
|
144
|
-
|
|
142
|
+
type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'ACTIVE' | 'CANCELLED';
|
|
143
|
+
interface Location {
|
|
145
144
|
/**
|
|
146
145
|
* [Location](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction)
|
|
147
146
|
* ID. Available only for `BUSINESS` locations.
|
|
@@ -177,7 +176,7 @@ export interface Location {
|
|
|
177
176
|
*/
|
|
178
177
|
address?: string | null;
|
|
179
178
|
}
|
|
180
|
-
|
|
179
|
+
declare enum LocationType {
|
|
181
180
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
182
181
|
/** The event is held at a business location. */
|
|
183
182
|
BUSINESS = "BUSINESS",
|
|
@@ -187,8 +186,8 @@ export declare enum LocationType {
|
|
|
187
186
|
CUSTOM = "CUSTOM"
|
|
188
187
|
}
|
|
189
188
|
/** @enumType */
|
|
190
|
-
|
|
191
|
-
|
|
189
|
+
type LocationTypeWithLiterals = LocationType | 'UNKNOWN_TYPE' | 'BUSINESS' | 'CUSTOMER' | 'CUSTOM';
|
|
190
|
+
interface ConferencingDetails {
|
|
192
191
|
/** Conference type. For example, `Zoom`. */
|
|
193
192
|
type?: TypeWithLiterals;
|
|
194
193
|
/**
|
|
@@ -228,14 +227,14 @@ export interface ConferencingDetails {
|
|
|
228
227
|
*/
|
|
229
228
|
externalId?: string | null;
|
|
230
229
|
}
|
|
231
|
-
|
|
230
|
+
declare enum Type {
|
|
232
231
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
233
232
|
ZOOM = "ZOOM",
|
|
234
233
|
CUSTOM = "CUSTOM"
|
|
235
234
|
}
|
|
236
235
|
/** @enumType */
|
|
237
|
-
|
|
238
|
-
|
|
236
|
+
type TypeWithLiterals = Type | 'UNKNOWN_TYPE' | 'ZOOM' | 'CUSTOM';
|
|
237
|
+
interface Permission {
|
|
239
238
|
/**
|
|
240
239
|
* [Wix user](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-users)
|
|
241
240
|
* granted the permission.
|
|
@@ -250,7 +249,7 @@ export interface Permission {
|
|
|
250
249
|
*/
|
|
251
250
|
role?: RoleWithLiterals;
|
|
252
251
|
}
|
|
253
|
-
|
|
252
|
+
interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
|
|
254
253
|
/**
|
|
255
254
|
* ID of a Wix user. For example, the site owner or a
|
|
256
255
|
* [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
|
|
@@ -259,7 +258,7 @@ export interface CommonIdentificationData extends CommonIdentificationDataIdOneO
|
|
|
259
258
|
wixUserId?: string;
|
|
260
259
|
}
|
|
261
260
|
/** @oneof */
|
|
262
|
-
|
|
261
|
+
interface CommonIdentificationDataIdOneOf {
|
|
263
262
|
/**
|
|
264
263
|
* ID of a Wix user. For example, the site owner or a
|
|
265
264
|
* [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
|
|
@@ -267,13 +266,11 @@ export interface CommonIdentificationDataIdOneOf {
|
|
|
267
266
|
*/
|
|
268
267
|
wixUserId?: string;
|
|
269
268
|
}
|
|
270
|
-
|
|
269
|
+
declare enum IdentityType {
|
|
271
270
|
UNKNOWN = "UNKNOWN",
|
|
272
271
|
WIX_USER = "WIX_USER"
|
|
273
272
|
}
|
|
274
|
-
|
|
275
|
-
export type IdentityTypeWithLiterals = IdentityType | 'UNKNOWN' | 'WIX_USER';
|
|
276
|
-
export declare enum Role {
|
|
273
|
+
declare enum Role {
|
|
277
274
|
UNKNOWN_ROLE = "UNKNOWN_ROLE",
|
|
278
275
|
/** Full read and write access. */
|
|
279
276
|
WRITER = "WRITER",
|
|
@@ -281,8 +278,8 @@ export declare enum Role {
|
|
|
281
278
|
COMMENTER = "COMMENTER"
|
|
282
279
|
}
|
|
283
280
|
/** @enumType */
|
|
284
|
-
|
|
285
|
-
|
|
281
|
+
type RoleWithLiterals = Role | 'UNKNOWN_ROLE' | 'WRITER' | 'COMMENTER';
|
|
282
|
+
interface ExtendedFields {
|
|
286
283
|
/**
|
|
287
284
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
288
285
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -293,7 +290,7 @@ export interface ExtendedFields {
|
|
|
293
290
|
*/
|
|
294
291
|
namespaces?: Record<string, Record<string, any>>;
|
|
295
292
|
}
|
|
296
|
-
|
|
293
|
+
interface GetScheduleRequest {
|
|
297
294
|
/**
|
|
298
295
|
* ID of the schedule to retrieve.
|
|
299
296
|
* @format GUID
|
|
@@ -314,7 +311,7 @@ export interface GetScheduleRequest {
|
|
|
314
311
|
*/
|
|
315
312
|
fields?: RequestedFieldsWithLiterals[];
|
|
316
313
|
}
|
|
317
|
-
|
|
314
|
+
declare enum RequestedFields {
|
|
318
315
|
UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
|
|
319
316
|
/** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
|
|
320
317
|
PI_FIELDS = "PI_FIELDS",
|
|
@@ -322,12 +319,12 @@ export declare enum RequestedFields {
|
|
|
322
319
|
OWN_PI_FIELDS = "OWN_PI_FIELDS"
|
|
323
320
|
}
|
|
324
321
|
/** @enumType */
|
|
325
|
-
|
|
326
|
-
|
|
322
|
+
type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELDS' | 'PI_FIELDS' | 'OWN_PI_FIELDS';
|
|
323
|
+
interface GetScheduleResponse {
|
|
327
324
|
/** Retrieved schedule. */
|
|
328
325
|
schedule?: Schedule;
|
|
329
326
|
}
|
|
330
|
-
|
|
327
|
+
interface QuerySchedulesRequest {
|
|
331
328
|
/** Query containing filters and paging. */
|
|
332
329
|
query?: CursorQuery;
|
|
333
330
|
/**
|
|
@@ -346,7 +343,7 @@ export interface QuerySchedulesRequest {
|
|
|
346
343
|
fields?: RequestedFieldsWithLiterals[];
|
|
347
344
|
}
|
|
348
345
|
/** TODO Diverge */
|
|
349
|
-
|
|
346
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
350
347
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
351
348
|
cursorPaging?: CursorPaging;
|
|
352
349
|
/**
|
|
@@ -361,12 +358,12 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
361
358
|
filter?: Record<string, any> | null;
|
|
362
359
|
}
|
|
363
360
|
/** @oneof */
|
|
364
|
-
|
|
361
|
+
interface CursorQueryPagingMethodOneOf {
|
|
365
362
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
366
363
|
cursorPaging?: CursorPaging;
|
|
367
364
|
}
|
|
368
365
|
/** TODO Diverge */
|
|
369
|
-
|
|
366
|
+
interface CursorPaging {
|
|
370
367
|
/**
|
|
371
368
|
* Number of schedules to return.
|
|
372
369
|
*
|
|
@@ -386,14 +383,14 @@ export interface CursorPaging {
|
|
|
386
383
|
*/
|
|
387
384
|
cursor?: string | null;
|
|
388
385
|
}
|
|
389
|
-
|
|
386
|
+
interface QuerySchedulesResponse {
|
|
390
387
|
/** Retrieved schedules matching the provided query. */
|
|
391
388
|
schedules?: Schedule[];
|
|
392
389
|
/** Paging metadata. */
|
|
393
390
|
pagingMetadata?: CursorPagingMetadata;
|
|
394
391
|
}
|
|
395
392
|
/** TODO Diverge */
|
|
396
|
-
|
|
393
|
+
interface CursorPagingMetadata {
|
|
397
394
|
/** Number of schedules returned in the current page of the response. */
|
|
398
395
|
count?: number | null;
|
|
399
396
|
/** Use these cursor to paginate between results. [Read more](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging). */
|
|
@@ -405,13 +402,13 @@ export interface CursorPagingMetadata {
|
|
|
405
402
|
*/
|
|
406
403
|
hasNext?: boolean | null;
|
|
407
404
|
}
|
|
408
|
-
|
|
405
|
+
interface Cursors {
|
|
409
406
|
/** Cursor pointing to next page in the list of results. */
|
|
410
407
|
next?: string | null;
|
|
411
408
|
/** Cursor pointing to previous page in the list of results. */
|
|
412
409
|
prev?: string | null;
|
|
413
410
|
}
|
|
414
|
-
|
|
411
|
+
interface CreateScheduleRequest {
|
|
415
412
|
/** Schedule to create. */
|
|
416
413
|
schedule: Schedule;
|
|
417
414
|
/**
|
|
@@ -421,11 +418,11 @@ export interface CreateScheduleRequest {
|
|
|
421
418
|
*/
|
|
422
419
|
idempotencyKey?: string | null;
|
|
423
420
|
}
|
|
424
|
-
|
|
421
|
+
interface CreateScheduleResponse {
|
|
425
422
|
/** Created schedule. */
|
|
426
423
|
schedule?: Schedule;
|
|
427
424
|
}
|
|
428
|
-
|
|
425
|
+
interface UpdateScheduleRequest {
|
|
429
426
|
/** Schedule to update. */
|
|
430
427
|
schedule: Schedule;
|
|
431
428
|
/**
|
|
@@ -434,7 +431,7 @@ export interface UpdateScheduleRequest {
|
|
|
434
431
|
*/
|
|
435
432
|
participantNotification?: ParticipantNotification;
|
|
436
433
|
}
|
|
437
|
-
|
|
434
|
+
interface ParticipantNotification {
|
|
438
435
|
/**
|
|
439
436
|
* Whether to notify the participants about changes made to the schedule or event.
|
|
440
437
|
*
|
|
@@ -451,18 +448,18 @@ export interface ParticipantNotification {
|
|
|
451
448
|
*/
|
|
452
449
|
message?: string | null;
|
|
453
450
|
}
|
|
454
|
-
|
|
451
|
+
interface UpdateScheduleResponse {
|
|
455
452
|
/** Updated schedule. */
|
|
456
453
|
schedule?: Schedule;
|
|
457
454
|
}
|
|
458
455
|
/** `PRIVATE` until we'll have standard events metadata from Infra. */
|
|
459
|
-
|
|
456
|
+
interface ScheduleUpdatedWithMetadata {
|
|
460
457
|
/** The updated schedule. */
|
|
461
458
|
schedule?: Schedule;
|
|
462
459
|
/** Whether to notify participants regarding the changes. */
|
|
463
460
|
participantNotification?: ParticipantNotification;
|
|
464
461
|
}
|
|
465
|
-
|
|
462
|
+
interface CloneScheduleRequest {
|
|
466
463
|
/**
|
|
467
464
|
* ID of the schedule to clone.
|
|
468
465
|
* @format GUID
|
|
@@ -471,11 +468,11 @@ export interface CloneScheduleRequest {
|
|
|
471
468
|
/** Fields to override in the cloned schedule. */
|
|
472
469
|
schedule?: Schedule;
|
|
473
470
|
}
|
|
474
|
-
|
|
471
|
+
interface CloneScheduleResponse {
|
|
475
472
|
/** Cloned schedule. */
|
|
476
473
|
schedule?: Schedule;
|
|
477
474
|
}
|
|
478
|
-
|
|
475
|
+
interface ScheduleCloned {
|
|
479
476
|
/** New cloned schedule. */
|
|
480
477
|
schedule?: Schedule;
|
|
481
478
|
/** The clone trigger. */
|
|
@@ -491,7 +488,7 @@ export interface ScheduleCloned {
|
|
|
491
488
|
*/
|
|
492
489
|
originalScheduleId?: string | null;
|
|
493
490
|
}
|
|
494
|
-
|
|
491
|
+
declare enum Trigger {
|
|
495
492
|
/** Schedule cloned using the `CloneSchedule` API. */
|
|
496
493
|
SCHEDULE_CLONED = "SCHEDULE_CLONED",
|
|
497
494
|
/** Site duplicated from the same account. */
|
|
@@ -504,8 +501,8 @@ export declare enum Trigger {
|
|
|
504
501
|
OTHER = "OTHER"
|
|
505
502
|
}
|
|
506
503
|
/** @enumType */
|
|
507
|
-
|
|
508
|
-
|
|
504
|
+
type TriggerWithLiterals = Trigger | 'SCHEDULE_CLONED' | 'SITE_DUPLICATED_FROM_SAME_ACCOUNT' | 'SITE_DUPLICATED_FROM_DIFFERENT_ACCOUNT' | 'SITE_CREATED_FROM_TEMPLATE' | 'OTHER';
|
|
505
|
+
interface CancelScheduleRequest {
|
|
509
506
|
/**
|
|
510
507
|
* ID of the schedule to cancel.
|
|
511
508
|
* @format GUID
|
|
@@ -522,17 +519,17 @@ export interface CancelScheduleRequest {
|
|
|
522
519
|
*/
|
|
523
520
|
participantNotification?: ParticipantNotification;
|
|
524
521
|
}
|
|
525
|
-
|
|
522
|
+
interface CancelScheduleResponse {
|
|
526
523
|
/** Canceled schedule. */
|
|
527
524
|
schedule?: Schedule;
|
|
528
525
|
}
|
|
529
|
-
|
|
526
|
+
interface ScheduleCancelled {
|
|
530
527
|
/** Canceled schedule. */
|
|
531
528
|
schedule?: Schedule;
|
|
532
529
|
/** Whether future events with participants were preserved. */
|
|
533
530
|
preserveFutureEventsWithParticipants?: boolean | null;
|
|
534
531
|
}
|
|
535
|
-
|
|
532
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
536
533
|
/** Emitted on a meta site creation. */
|
|
537
534
|
siteCreated?: SiteCreated;
|
|
538
535
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -598,7 +595,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
598
595
|
assets?: Asset[];
|
|
599
596
|
}
|
|
600
597
|
/** @oneof */
|
|
601
|
-
|
|
598
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
602
599
|
/** Emitted on a meta site creation. */
|
|
603
600
|
siteCreated?: SiteCreated;
|
|
604
601
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -648,7 +645,7 @@ export interface MetaSiteSpecialEventPayloadOneOf {
|
|
|
648
645
|
/** Emitted when Picasso is detached. */
|
|
649
646
|
picassoUnassigned?: PicassoUnassigned;
|
|
650
647
|
}
|
|
651
|
-
|
|
648
|
+
interface Asset {
|
|
652
649
|
/**
|
|
653
650
|
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
654
651
|
* @maxLength 36
|
|
@@ -662,7 +659,7 @@ export interface Asset {
|
|
|
662
659
|
/** An application state. */
|
|
663
660
|
state?: StateWithLiterals;
|
|
664
661
|
}
|
|
665
|
-
|
|
662
|
+
declare enum State {
|
|
666
663
|
UNKNOWN = "UNKNOWN",
|
|
667
664
|
ENABLED = "ENABLED",
|
|
668
665
|
DISABLED = "DISABLED",
|
|
@@ -670,8 +667,8 @@ export declare enum State {
|
|
|
670
667
|
DEMO = "DEMO"
|
|
671
668
|
}
|
|
672
669
|
/** @enumType */
|
|
673
|
-
|
|
674
|
-
|
|
670
|
+
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
671
|
+
interface SiteCreated {
|
|
675
672
|
/**
|
|
676
673
|
* A template identifier (empty if not created from a template).
|
|
677
674
|
* @maxLength 36
|
|
@@ -700,7 +697,7 @@ export interface SiteCreated {
|
|
|
700
697
|
/** A namespace. */
|
|
701
698
|
namespace?: NamespaceWithLiterals;
|
|
702
699
|
}
|
|
703
|
-
|
|
700
|
+
declare enum SiteCreatedContext {
|
|
704
701
|
/** A valid option, we don't expose all reasons why site might be created. */
|
|
705
702
|
OTHER = "OTHER",
|
|
706
703
|
/** A meta site was created from template. */
|
|
@@ -715,8 +712,8 @@ export declare enum SiteCreatedContext {
|
|
|
715
712
|
FLASH = "FLASH"
|
|
716
713
|
}
|
|
717
714
|
/** @enumType */
|
|
718
|
-
|
|
719
|
-
|
|
715
|
+
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
716
|
+
declare enum Namespace {
|
|
720
717
|
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
721
718
|
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
722
719
|
WIX = "WIX",
|
|
@@ -799,9 +796,9 @@ export declare enum Namespace {
|
|
|
799
796
|
MIMIR = "MIMIR"
|
|
800
797
|
}
|
|
801
798
|
/** @enumType */
|
|
802
|
-
|
|
799
|
+
type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR';
|
|
803
800
|
/** Site transferred to another user. */
|
|
804
|
-
|
|
801
|
+
interface SiteTransferred {
|
|
805
802
|
/**
|
|
806
803
|
* A previous owner id (user that transfers meta site).
|
|
807
804
|
* @format GUID
|
|
@@ -814,11 +811,11 @@ export interface SiteTransferred {
|
|
|
814
811
|
newOwnerId?: string;
|
|
815
812
|
}
|
|
816
813
|
/** Soft deletion of the meta site. Could be restored. */
|
|
817
|
-
|
|
814
|
+
interface SiteDeleted {
|
|
818
815
|
/** A deletion context. */
|
|
819
816
|
deleteContext?: DeleteContext;
|
|
820
817
|
}
|
|
821
|
-
|
|
818
|
+
interface DeleteContext {
|
|
822
819
|
/** When the meta site was deleted. */
|
|
823
820
|
dateDeleted?: Date | null;
|
|
824
821
|
/** A status. */
|
|
@@ -834,7 +831,7 @@ export interface DeleteContext {
|
|
|
834
831
|
*/
|
|
835
832
|
initiatorId?: string | null;
|
|
836
833
|
}
|
|
837
|
-
|
|
834
|
+
declare enum DeleteStatus {
|
|
838
835
|
UNKNOWN = "UNKNOWN",
|
|
839
836
|
TRASH = "TRASH",
|
|
840
837
|
DELETED = "DELETED",
|
|
@@ -842,14 +839,14 @@ export declare enum DeleteStatus {
|
|
|
842
839
|
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
843
840
|
}
|
|
844
841
|
/** @enumType */
|
|
845
|
-
|
|
842
|
+
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
846
843
|
/** Restoration of the meta site. */
|
|
847
|
-
|
|
844
|
+
interface SiteUndeleted {
|
|
848
845
|
}
|
|
849
846
|
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
850
|
-
|
|
847
|
+
interface SitePublished {
|
|
851
848
|
}
|
|
852
|
-
|
|
849
|
+
interface SiteUnpublished {
|
|
853
850
|
/**
|
|
854
851
|
* A list of URLs previously associated with the meta site.
|
|
855
852
|
* @maxLength 4000
|
|
@@ -857,9 +854,9 @@ export interface SiteUnpublished {
|
|
|
857
854
|
*/
|
|
858
855
|
urls?: string[];
|
|
859
856
|
}
|
|
860
|
-
|
|
857
|
+
interface SiteMarkedAsTemplate {
|
|
861
858
|
}
|
|
862
|
-
|
|
859
|
+
interface SiteMarkedAsWixSite {
|
|
863
860
|
}
|
|
864
861
|
/**
|
|
865
862
|
* Represents a service provisioned a site.
|
|
@@ -876,7 +873,7 @@ export interface SiteMarkedAsWixSite {
|
|
|
876
873
|
* changes made to the original template afterward.
|
|
877
874
|
* To ensure this, the TPA on the template gets a new instance_id.
|
|
878
875
|
*/
|
|
879
|
-
|
|
876
|
+
interface ServiceProvisioned {
|
|
880
877
|
/**
|
|
881
878
|
* Either UUID or EmbeddedServiceType.
|
|
882
879
|
* @maxLength 36
|
|
@@ -903,7 +900,7 @@ export interface ServiceProvisioned {
|
|
|
903
900
|
*/
|
|
904
901
|
originMetaSiteId?: string | null;
|
|
905
902
|
}
|
|
906
|
-
|
|
903
|
+
interface ServiceRemoved {
|
|
907
904
|
/**
|
|
908
905
|
* Either UUID or EmbeddedServiceType.
|
|
909
906
|
* @maxLength 36
|
|
@@ -921,7 +918,7 @@ export interface ServiceRemoved {
|
|
|
921
918
|
version?: string | null;
|
|
922
919
|
}
|
|
923
920
|
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
924
|
-
|
|
921
|
+
interface SiteRenamed {
|
|
925
922
|
/**
|
|
926
923
|
* A new meta site name (URL slug).
|
|
927
924
|
* @maxLength 20
|
|
@@ -938,21 +935,21 @@ export interface SiteRenamed {
|
|
|
938
935
|
*
|
|
939
936
|
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
940
937
|
*/
|
|
941
|
-
|
|
938
|
+
interface SiteHardDeleted {
|
|
942
939
|
/** A deletion context. */
|
|
943
940
|
deleteContext?: DeleteContext;
|
|
944
941
|
}
|
|
945
|
-
|
|
942
|
+
interface NamespaceChanged {
|
|
946
943
|
/** A previous namespace. */
|
|
947
944
|
oldNamespace?: NamespaceWithLiterals;
|
|
948
945
|
/** A new namespace. */
|
|
949
946
|
newNamespace?: NamespaceWithLiterals;
|
|
950
947
|
}
|
|
951
948
|
/** Assigned Studio editor */
|
|
952
|
-
|
|
949
|
+
interface StudioAssigned {
|
|
953
950
|
}
|
|
954
951
|
/** Unassigned Studio editor */
|
|
955
|
-
|
|
952
|
+
interface StudioUnassigned {
|
|
956
953
|
}
|
|
957
954
|
/**
|
|
958
955
|
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
@@ -962,13 +959,13 @@ export interface StudioUnassigned {
|
|
|
962
959
|
*
|
|
963
960
|
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
964
961
|
*/
|
|
965
|
-
|
|
962
|
+
interface SiteUrlChanged {
|
|
966
963
|
}
|
|
967
964
|
/**
|
|
968
965
|
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
969
966
|
* Consumed by other teams to remove relevant data.
|
|
970
967
|
*/
|
|
971
|
-
|
|
968
|
+
interface SitePurgedExternally {
|
|
972
969
|
/**
|
|
973
970
|
* @maxLength 2048
|
|
974
971
|
* @maxSize 100
|
|
@@ -978,21 +975,21 @@ export interface SitePurgedExternally {
|
|
|
978
975
|
appDefId?: string[];
|
|
979
976
|
}
|
|
980
977
|
/** Assigned Odeditor */
|
|
981
|
-
|
|
978
|
+
interface OdeditorAssigned {
|
|
982
979
|
}
|
|
983
980
|
/** Unassigned Odeditor */
|
|
984
|
-
|
|
981
|
+
interface OdeditorUnassigned {
|
|
985
982
|
}
|
|
986
983
|
/** Assigned Picasso editor */
|
|
987
|
-
|
|
984
|
+
interface PicassoAssigned {
|
|
988
985
|
}
|
|
989
986
|
/** Unassigned Picasso */
|
|
990
|
-
|
|
987
|
+
interface PicassoUnassigned {
|
|
991
988
|
}
|
|
992
|
-
|
|
989
|
+
interface Empty {
|
|
993
990
|
}
|
|
994
991
|
/** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
|
|
995
|
-
|
|
992
|
+
interface SitePropertiesNotification {
|
|
996
993
|
/** The site ID for which this update notification applies. */
|
|
997
994
|
metasiteId?: string;
|
|
998
995
|
/** The actual update event. */
|
|
@@ -1006,7 +1003,7 @@ export interface SitePropertiesNotification {
|
|
|
1006
1003
|
changeContext?: ChangeContext;
|
|
1007
1004
|
}
|
|
1008
1005
|
/** The actual update event for a particular notification. */
|
|
1009
|
-
|
|
1006
|
+
interface SitePropertiesEvent {
|
|
1010
1007
|
/** Version of the site's properties represented by this update. */
|
|
1011
1008
|
version?: number;
|
|
1012
1009
|
/** Set of properties that were updated - corresponds to the fields in "properties". */
|
|
@@ -1014,7 +1011,7 @@ export interface SitePropertiesEvent {
|
|
|
1014
1011
|
/** Updated properties. */
|
|
1015
1012
|
properties?: Properties;
|
|
1016
1013
|
}
|
|
1017
|
-
|
|
1014
|
+
interface Properties {
|
|
1018
1015
|
/** Site categories. */
|
|
1019
1016
|
categories?: Categories;
|
|
1020
1017
|
/** Site locale. */
|
|
@@ -1070,7 +1067,7 @@ export interface Properties {
|
|
|
1070
1067
|
/** Track clicks analytics. */
|
|
1071
1068
|
trackClicksAnalytics?: boolean;
|
|
1072
1069
|
}
|
|
1073
|
-
|
|
1070
|
+
interface Categories {
|
|
1074
1071
|
/** Primary site category. */
|
|
1075
1072
|
primary?: string;
|
|
1076
1073
|
/**
|
|
@@ -1081,13 +1078,13 @@ export interface Categories {
|
|
|
1081
1078
|
/** Business Term Id */
|
|
1082
1079
|
businessTermId?: string | null;
|
|
1083
1080
|
}
|
|
1084
|
-
|
|
1081
|
+
interface Locale {
|
|
1085
1082
|
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
1086
1083
|
languageCode?: string;
|
|
1087
1084
|
/** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
|
|
1088
1085
|
country?: string;
|
|
1089
1086
|
}
|
|
1090
|
-
|
|
1087
|
+
interface Address {
|
|
1091
1088
|
/** Street name. */
|
|
1092
1089
|
street?: string;
|
|
1093
1090
|
/** City name. */
|
|
@@ -1119,29 +1116,29 @@ export interface Address {
|
|
|
1119
1116
|
* This is used for display purposes. Used to add additional data about the address, such as "In the passage".
|
|
1120
1117
|
* Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
|
|
1121
1118
|
*/
|
|
1122
|
-
|
|
1119
|
+
interface AddressHint {
|
|
1123
1120
|
/** Extra text displayed next to, or instead of, the actual address. */
|
|
1124
1121
|
text?: string;
|
|
1125
1122
|
/** Where the extra text should be displayed. */
|
|
1126
1123
|
placement?: PlacementTypeWithLiterals;
|
|
1127
1124
|
}
|
|
1128
1125
|
/** Where the extra text should be displayed: before, after or instead of the actual address. */
|
|
1129
|
-
|
|
1126
|
+
declare enum PlacementType {
|
|
1130
1127
|
BEFORE = "BEFORE",
|
|
1131
1128
|
AFTER = "AFTER",
|
|
1132
1129
|
REPLACE = "REPLACE"
|
|
1133
1130
|
}
|
|
1134
1131
|
/** @enumType */
|
|
1135
|
-
|
|
1132
|
+
type PlacementTypeWithLiterals = PlacementType | 'BEFORE' | 'AFTER' | 'REPLACE';
|
|
1136
1133
|
/** Geocoordinates for a particular address. */
|
|
1137
|
-
|
|
1134
|
+
interface GeoCoordinates {
|
|
1138
1135
|
/** Latitude of the location. Must be between -90 and 90. */
|
|
1139
1136
|
latitude?: number;
|
|
1140
1137
|
/** Longitude of the location. Must be between -180 and 180. */
|
|
1141
1138
|
longitude?: number;
|
|
1142
1139
|
}
|
|
1143
1140
|
/** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
|
|
1144
|
-
|
|
1141
|
+
interface BusinessSchedule {
|
|
1145
1142
|
/**
|
|
1146
1143
|
* Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
|
|
1147
1144
|
* @maxSize 100
|
|
@@ -1154,7 +1151,7 @@ export interface BusinessSchedule {
|
|
|
1154
1151
|
specialHourPeriod?: SpecialHourPeriod[];
|
|
1155
1152
|
}
|
|
1156
1153
|
/** Weekly recurring time periods when the business is regularly open or the service is available. */
|
|
1157
|
-
|
|
1154
|
+
interface TimePeriod {
|
|
1158
1155
|
/** Day of the week the period starts on. */
|
|
1159
1156
|
openDay?: DayOfWeekWithLiterals;
|
|
1160
1157
|
/**
|
|
@@ -1173,7 +1170,7 @@ export interface TimePeriod {
|
|
|
1173
1170
|
closeTime?: string;
|
|
1174
1171
|
}
|
|
1175
1172
|
/** Enumerates the days of the week. */
|
|
1176
|
-
|
|
1173
|
+
declare enum DayOfWeek {
|
|
1177
1174
|
MONDAY = "MONDAY",
|
|
1178
1175
|
TUESDAY = "TUESDAY",
|
|
1179
1176
|
WEDNESDAY = "WEDNESDAY",
|
|
@@ -1183,9 +1180,9 @@ export declare enum DayOfWeek {
|
|
|
1183
1180
|
SUNDAY = "SUNDAY"
|
|
1184
1181
|
}
|
|
1185
1182
|
/** @enumType */
|
|
1186
|
-
|
|
1183
|
+
type DayOfWeekWithLiterals = DayOfWeek | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
|
|
1187
1184
|
/** Exception to the business's regular hours. The business can be open or closed during the exception. */
|
|
1188
|
-
|
|
1185
|
+
interface SpecialHourPeriod {
|
|
1189
1186
|
/** 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). */
|
|
1190
1187
|
startDate?: string;
|
|
1191
1188
|
/** 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). */
|
|
@@ -1199,7 +1196,7 @@ export interface SpecialHourPeriod {
|
|
|
1199
1196
|
/** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
|
|
1200
1197
|
comment?: string;
|
|
1201
1198
|
}
|
|
1202
|
-
|
|
1199
|
+
interface Multilingual {
|
|
1203
1200
|
/**
|
|
1204
1201
|
* Supported languages list.
|
|
1205
1202
|
* @maxSize 200
|
|
@@ -1208,7 +1205,7 @@ export interface Multilingual {
|
|
|
1208
1205
|
/** Whether to redirect to user language. */
|
|
1209
1206
|
autoRedirect?: boolean;
|
|
1210
1207
|
}
|
|
1211
|
-
|
|
1208
|
+
interface SupportedLanguage {
|
|
1212
1209
|
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
1213
1210
|
languageCode?: string;
|
|
1214
1211
|
/** Locale. */
|
|
@@ -1222,14 +1219,14 @@ export interface SupportedLanguage {
|
|
|
1222
1219
|
/** Whether the supported language is the primary language for site visitors. */
|
|
1223
1220
|
isVisitorPrimary?: boolean | null;
|
|
1224
1221
|
}
|
|
1225
|
-
|
|
1222
|
+
declare enum ResolutionMethod {
|
|
1226
1223
|
QUERY_PARAM = "QUERY_PARAM",
|
|
1227
1224
|
SUBDOMAIN = "SUBDOMAIN",
|
|
1228
1225
|
SUBDIRECTORY = "SUBDIRECTORY"
|
|
1229
1226
|
}
|
|
1230
1227
|
/** @enumType */
|
|
1231
|
-
|
|
1232
|
-
|
|
1228
|
+
type ResolutionMethodWithLiterals = ResolutionMethod | 'QUERY_PARAM' | 'SUBDOMAIN' | 'SUBDIRECTORY';
|
|
1229
|
+
interface ConsentPolicy {
|
|
1233
1230
|
/** Whether the site uses cookies that are essential to site operation. Always `true`. */
|
|
1234
1231
|
essential?: boolean | null;
|
|
1235
1232
|
/** Whether the site uses cookies that affect site performance and other functional measurements. */
|
|
@@ -1242,7 +1239,7 @@ export interface ConsentPolicy {
|
|
|
1242
1239
|
dataToThirdParty?: boolean | null;
|
|
1243
1240
|
}
|
|
1244
1241
|
/** A single mapping from the MetaSite ID to a particular service. */
|
|
1245
|
-
|
|
1242
|
+
interface Translation {
|
|
1246
1243
|
/** The service type. */
|
|
1247
1244
|
serviceType?: string;
|
|
1248
1245
|
/** The application definition ID; this only applies to services of type ThirdPartyApps. */
|
|
@@ -1250,7 +1247,7 @@ export interface Translation {
|
|
|
1250
1247
|
/** The instance ID of the service. */
|
|
1251
1248
|
instanceId?: string;
|
|
1252
1249
|
}
|
|
1253
|
-
|
|
1250
|
+
interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
1254
1251
|
/** Properties were updated. */
|
|
1255
1252
|
propertiesChange?: PropertiesChange;
|
|
1256
1253
|
/** Default properties were created on site creation. */
|
|
@@ -1259,7 +1256,7 @@ export interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
|
1259
1256
|
siteCloned?: SiteCloned;
|
|
1260
1257
|
}
|
|
1261
1258
|
/** @oneof */
|
|
1262
|
-
|
|
1259
|
+
interface ChangeContextPayloadOneOf {
|
|
1263
1260
|
/** Properties were updated. */
|
|
1264
1261
|
propertiesChange?: PropertiesChange;
|
|
1265
1262
|
/** Default properties were created on site creation. */
|
|
@@ -1267,17 +1264,17 @@ export interface ChangeContextPayloadOneOf {
|
|
|
1267
1264
|
/** Properties were cloned on site cloning. */
|
|
1268
1265
|
siteCloned?: SiteCloned;
|
|
1269
1266
|
}
|
|
1270
|
-
|
|
1267
|
+
interface PropertiesChange {
|
|
1271
1268
|
}
|
|
1272
|
-
|
|
1269
|
+
interface V4SiteCreated {
|
|
1273
1270
|
/** Origin template site id. */
|
|
1274
1271
|
originTemplateId?: string | null;
|
|
1275
1272
|
}
|
|
1276
|
-
|
|
1273
|
+
interface SiteCloned {
|
|
1277
1274
|
/** Origin site id. */
|
|
1278
1275
|
originMetaSiteId?: string;
|
|
1279
1276
|
}
|
|
1280
|
-
|
|
1277
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1281
1278
|
createdEvent?: EntityCreatedEvent;
|
|
1282
1279
|
updatedEvent?: EntityUpdatedEvent;
|
|
1283
1280
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -1312,19 +1309,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1312
1309
|
entityEventSequence?: string | null;
|
|
1313
1310
|
}
|
|
1314
1311
|
/** @oneof */
|
|
1315
|
-
|
|
1312
|
+
interface DomainEventBodyOneOf {
|
|
1316
1313
|
createdEvent?: EntityCreatedEvent;
|
|
1317
1314
|
updatedEvent?: EntityUpdatedEvent;
|
|
1318
1315
|
deletedEvent?: EntityDeletedEvent;
|
|
1319
1316
|
actionEvent?: ActionEvent;
|
|
1320
1317
|
}
|
|
1321
|
-
|
|
1318
|
+
interface EntityCreatedEvent {
|
|
1322
1319
|
entity?: string;
|
|
1323
1320
|
}
|
|
1324
|
-
|
|
1321
|
+
interface RestoreInfo {
|
|
1325
1322
|
deletedDate?: Date | null;
|
|
1326
1323
|
}
|
|
1327
|
-
|
|
1324
|
+
interface EntityUpdatedEvent {
|
|
1328
1325
|
/**
|
|
1329
1326
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1330
1327
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -1332,14 +1329,14 @@ export interface EntityUpdatedEvent {
|
|
|
1332
1329
|
*/
|
|
1333
1330
|
currentEntity?: string;
|
|
1334
1331
|
}
|
|
1335
|
-
|
|
1332
|
+
interface EntityDeletedEvent {
|
|
1336
1333
|
/** Entity that was deleted. */
|
|
1337
1334
|
deletedEntity?: string | null;
|
|
1338
1335
|
}
|
|
1339
|
-
|
|
1336
|
+
interface ActionEvent {
|
|
1340
1337
|
body?: string;
|
|
1341
1338
|
}
|
|
1342
|
-
|
|
1339
|
+
interface MessageEnvelope {
|
|
1343
1340
|
/**
|
|
1344
1341
|
* App instance ID.
|
|
1345
1342
|
* @format GUID
|
|
@@ -1355,7 +1352,7 @@ export interface MessageEnvelope {
|
|
|
1355
1352
|
/** Stringify payload. */
|
|
1356
1353
|
data?: string;
|
|
1357
1354
|
}
|
|
1358
|
-
|
|
1355
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1359
1356
|
/**
|
|
1360
1357
|
* ID of a site visitor that has not logged in to the site.
|
|
1361
1358
|
* @format GUID
|
|
@@ -1380,7 +1377,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1380
1377
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1381
1378
|
}
|
|
1382
1379
|
/** @oneof */
|
|
1383
|
-
|
|
1380
|
+
interface IdentificationDataIdOneOf {
|
|
1384
1381
|
/**
|
|
1385
1382
|
* ID of a site visitor that has not logged in to the site.
|
|
1386
1383
|
* @format GUID
|
|
@@ -1402,7 +1399,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
1402
1399
|
*/
|
|
1403
1400
|
appId?: string;
|
|
1404
1401
|
}
|
|
1405
|
-
|
|
1402
|
+
declare enum WebhookIdentityType {
|
|
1406
1403
|
UNKNOWN = "UNKNOWN",
|
|
1407
1404
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1408
1405
|
MEMBER = "MEMBER",
|
|
@@ -1410,8 +1407,8 @@ export declare enum WebhookIdentityType {
|
|
|
1410
1407
|
APP = "APP"
|
|
1411
1408
|
}
|
|
1412
1409
|
/** @enumType */
|
|
1413
|
-
|
|
1414
|
-
|
|
1410
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1411
|
+
interface BaseEventMetadata {
|
|
1415
1412
|
/**
|
|
1416
1413
|
* App instance ID.
|
|
1417
1414
|
* @format GUID
|
|
@@ -1425,7 +1422,7 @@ export interface BaseEventMetadata {
|
|
|
1425
1422
|
/** The identification type and identity data. */
|
|
1426
1423
|
identity?: IdentificationData;
|
|
1427
1424
|
}
|
|
1428
|
-
|
|
1425
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
1429
1426
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1430
1427
|
_id?: string;
|
|
1431
1428
|
/**
|
|
@@ -1455,155 +1452,23 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
1455
1452
|
*/
|
|
1456
1453
|
entityEventSequence?: string | null;
|
|
1457
1454
|
}
|
|
1458
|
-
|
|
1455
|
+
interface ScheduleCancelledEnvelope {
|
|
1459
1456
|
data: ScheduleCancelled;
|
|
1460
1457
|
metadata: EventMetadata;
|
|
1461
1458
|
}
|
|
1462
|
-
|
|
1463
|
-
* Triggered when a schedule is canceled.
|
|
1464
|
-
* @permissionScope Read Calendar - Including PI
|
|
1465
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1466
|
-
* @permissionScope Manage Calendars
|
|
1467
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1468
|
-
* @permissionScope Manage Bookings
|
|
1469
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1470
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1471
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1472
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1473
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1474
|
-
* @permissionScope Read bookings calendar - including participants
|
|
1475
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1476
|
-
* @permissionId CALENDAR.SCHEDULE_READ_PI
|
|
1477
|
-
* @webhook
|
|
1478
|
-
* @eventType wix.calendar.v3.schedule_cancelled
|
|
1479
|
-
* @serviceIdentifier wix.calendar.schedules.v3.SchedulesService
|
|
1480
|
-
* @slug cancelled
|
|
1481
|
-
*/
|
|
1482
|
-
export declare function onScheduleCancelled(handler: (event: ScheduleCancelledEnvelope) => void | Promise<void>): void;
|
|
1483
|
-
export interface ScheduleClonedEnvelope {
|
|
1459
|
+
interface ScheduleClonedEnvelope {
|
|
1484
1460
|
data: ScheduleCloned;
|
|
1485
1461
|
metadata: EventMetadata;
|
|
1486
1462
|
}
|
|
1487
|
-
|
|
1488
|
-
* Triggered when a schedule is cloned.
|
|
1489
|
-
* @permissionScope Read Calendar - Including PI
|
|
1490
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1491
|
-
* @permissionScope Manage Calendars
|
|
1492
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1493
|
-
* @permissionScope Manage Bookings
|
|
1494
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1495
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1496
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1497
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1498
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1499
|
-
* @permissionScope Read bookings calendar - including participants
|
|
1500
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1501
|
-
* @permissionId CALENDAR.SCHEDULE_READ_PI
|
|
1502
|
-
* @webhook
|
|
1503
|
-
* @eventType wix.calendar.v3.schedule_cloned
|
|
1504
|
-
* @serviceIdentifier wix.calendar.schedules.v3.SchedulesService
|
|
1505
|
-
* @slug cloned
|
|
1506
|
-
*/
|
|
1507
|
-
export declare function onScheduleCloned(handler: (event: ScheduleClonedEnvelope) => void | Promise<void>): void;
|
|
1508
|
-
export interface ScheduleCreatedEnvelope {
|
|
1463
|
+
interface ScheduleCreatedEnvelope {
|
|
1509
1464
|
entity: Schedule;
|
|
1510
1465
|
metadata: EventMetadata;
|
|
1511
1466
|
}
|
|
1512
|
-
|
|
1513
|
-
* Triggered when a schedule is created.
|
|
1514
|
-
* @permissionScope Read Calendar - Including PI
|
|
1515
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1516
|
-
* @permissionScope Manage Calendars
|
|
1517
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1518
|
-
* @permissionScope Manage Bookings
|
|
1519
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1520
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1521
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1522
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1523
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1524
|
-
* @permissionScope Read bookings calendar - including participants
|
|
1525
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1526
|
-
* @permissionId CALENDAR.SCHEDULE_READ_PI
|
|
1527
|
-
* @webhook
|
|
1528
|
-
* @eventType wix.calendar.v3.schedule_created
|
|
1529
|
-
* @serviceIdentifier wix.calendar.schedules.v3.SchedulesService
|
|
1530
|
-
* @slug created
|
|
1531
|
-
*/
|
|
1532
|
-
export declare function onScheduleCreated(handler: (event: ScheduleCreatedEnvelope) => void | Promise<void>): void;
|
|
1533
|
-
export interface ScheduleUpdatedEnvelope {
|
|
1467
|
+
interface ScheduleUpdatedEnvelope {
|
|
1534
1468
|
entity: Schedule;
|
|
1535
1469
|
metadata: EventMetadata;
|
|
1536
1470
|
}
|
|
1537
|
-
|
|
1538
|
-
* Triggered when a schedule is updated.
|
|
1539
|
-
* @permissionScope Read Calendar - Including PI
|
|
1540
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1541
|
-
* @permissionScope Manage Calendars
|
|
1542
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1543
|
-
* @permissionScope Manage Bookings
|
|
1544
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1545
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1546
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1547
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1548
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1549
|
-
* @permissionScope Read bookings calendar - including participants
|
|
1550
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1551
|
-
* @permissionId CALENDAR.SCHEDULE_READ_PI
|
|
1552
|
-
* @webhook
|
|
1553
|
-
* @eventType wix.calendar.v3.schedule_updated
|
|
1554
|
-
* @serviceIdentifier wix.calendar.schedules.v3.SchedulesService
|
|
1555
|
-
* @slug updated
|
|
1556
|
-
*/
|
|
1557
|
-
export declare function onScheduleUpdated(handler: (event: ScheduleUpdatedEnvelope) => void | Promise<void>): void;
|
|
1558
|
-
type ScheduleNonNullablePaths = `status` | `defaultLocation.type` | `defaultConferencingDetails.type` | `permissions` | `permissions.${number}.identity.wixUserId` | `permissions.${number}.role`;
|
|
1559
|
-
/**
|
|
1560
|
-
* Retrieves a schedule.
|
|
1561
|
-
* @param scheduleId - ID of the schedule to retrieve.
|
|
1562
|
-
* @public
|
|
1563
|
-
* @requiredField scheduleId
|
|
1564
|
-
* @permissionId CALENDAR.SCHEDULE_READ
|
|
1565
|
-
* @permissionId CALENDAR.SCHEDULE_READ_PI
|
|
1566
|
-
* @permissionScope Read Bookings - Public Data
|
|
1567
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
1568
|
-
* @permissionScope Read Calendar - Including PI
|
|
1569
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1570
|
-
* @permissionScope Manage Calendars
|
|
1571
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1572
|
-
* @permissionScope Manage Bookings
|
|
1573
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1574
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1575
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1576
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1577
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1578
|
-
* @permissionScope Read Bookings Calendar Availability
|
|
1579
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
|
|
1580
|
-
* @permissionScope Read Calendar
|
|
1581
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
|
|
1582
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1583
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1584
|
-
* @permissionScope Read bookings calendar - including participants
|
|
1585
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1586
|
-
* @permissionScope Read Bookings Calendar
|
|
1587
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
|
|
1588
|
-
* @permissionScope Read Calendar - Including PI
|
|
1589
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1590
|
-
* @permissionScope Manage Calendars
|
|
1591
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1592
|
-
* @permissionScope Manage Bookings
|
|
1593
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1594
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1595
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1596
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1597
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1598
|
-
* @permissionScope Read bookings calendar - including participants
|
|
1599
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1600
|
-
* @applicableIdentity APP
|
|
1601
|
-
* @applicableIdentity VISITOR
|
|
1602
|
-
* @returns Retrieved schedule.
|
|
1603
|
-
* @fqn wix.calendar.schedules.v3.SchedulesService.GetSchedule
|
|
1604
|
-
*/
|
|
1605
|
-
export declare function getSchedule(scheduleId: string, options?: GetScheduleOptions): Promise<NonNullablePaths<Schedule, ScheduleNonNullablePaths>>;
|
|
1606
|
-
export interface GetScheduleOptions {
|
|
1471
|
+
interface GetScheduleOptions {
|
|
1607
1472
|
/**
|
|
1608
1473
|
* Information about which fields containing personal data to return. Refer to the
|
|
1609
1474
|
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
|
|
@@ -1619,66 +1484,7 @@ export interface GetScheduleOptions {
|
|
|
1619
1484
|
*/
|
|
1620
1485
|
fields?: RequestedFieldsWithLiterals[];
|
|
1621
1486
|
}
|
|
1622
|
-
|
|
1623
|
-
* Creates a query to retrieve a list of schedules.
|
|
1624
|
-
*
|
|
1625
|
-
* The `querySchedules()` function builds a query to retrieve a list of tip settings and returns a `SchedulesQueryBuilder` object.
|
|
1626
|
-
*
|
|
1627
|
-
* The returned object contains the query definition, which is typically used to run the query using the [find()](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/schedules-query-builder/find) function.
|
|
1628
|
-
*
|
|
1629
|
-
* You can refine the query by chaining `SchedulesQueryBuilder` functions onto the query. `SchedulesQueryBuilder` functions enable you to sort, filter, and control the results that `querySchedules()` returns.
|
|
1630
|
-
*
|
|
1631
|
-
* `querySchedules()` runs with the following `SchedulesQueryBuilder` default that you can override:
|
|
1632
|
-
*
|
|
1633
|
-
* + `limit` is `50`.
|
|
1634
|
-
* + Sorted by `id` in ascending order.
|
|
1635
|
-
*
|
|
1636
|
-
* The functions that are chained to `querySchedules()` are applied in the order they are called. For example, if you apply `ascending("status")` and then `ascending("externalId")`, the results are sorted first by the `"status"`, and then, if there are multiple results with the same `"status"`, the items are sorted by `"externalId"`.
|
|
1637
|
-
*
|
|
1638
|
-
* The following `SchedulesQueryBuilder` functions are supported for the `querySchedules()` function. For a full description of the tip settings object, see the object returned for the [items](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/schedules-query-result/items) property in `SchedulesQueryResult`.
|
|
1639
|
-
* @public
|
|
1640
|
-
* @permissionScope Read Bookings - Public Data
|
|
1641
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
1642
|
-
* @permissionScope Read Calendar - Including PI
|
|
1643
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1644
|
-
* @permissionScope Manage Calendars
|
|
1645
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1646
|
-
* @permissionScope Manage Bookings
|
|
1647
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1648
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1649
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1650
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1651
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1652
|
-
* @permissionScope Read Bookings Calendar Availability
|
|
1653
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
|
|
1654
|
-
* @permissionScope Read Calendar
|
|
1655
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
|
|
1656
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1657
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1658
|
-
* @permissionScope Read bookings calendar - including participants
|
|
1659
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1660
|
-
* @permissionScope Read Bookings Calendar
|
|
1661
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
|
|
1662
|
-
* @permissionScope Read Calendar - Including PI
|
|
1663
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1664
|
-
* @permissionScope Manage Calendars
|
|
1665
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1666
|
-
* @permissionScope Manage Bookings
|
|
1667
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1668
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1669
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1670
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1671
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1672
|
-
* @permissionScope Read bookings calendar - including participants
|
|
1673
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1674
|
-
* @permissionId CALENDAR.SCHEDULE_READ
|
|
1675
|
-
* @permissionId CALENDAR.SCHEDULE_READ_PI
|
|
1676
|
-
* @applicableIdentity APP
|
|
1677
|
-
* @applicableIdentity VISITOR
|
|
1678
|
-
* @fqn wix.calendar.schedules.v3.SchedulesService.QuerySchedules
|
|
1679
|
-
*/
|
|
1680
|
-
export declare function querySchedules(options?: QuerySchedulesOptions): SchedulesQueryBuilder;
|
|
1681
|
-
export interface QuerySchedulesOptions {
|
|
1487
|
+
interface QuerySchedulesOptions {
|
|
1682
1488
|
/**
|
|
1683
1489
|
* Information about which fields containing personal data to return. Refer to the
|
|
1684
1490
|
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
|
|
@@ -1701,13 +1507,13 @@ interface QueryCursorResult {
|
|
|
1701
1507
|
length: number;
|
|
1702
1508
|
pageSize: number;
|
|
1703
1509
|
}
|
|
1704
|
-
|
|
1510
|
+
interface SchedulesQueryResult extends QueryCursorResult {
|
|
1705
1511
|
items: Schedule[];
|
|
1706
1512
|
query: SchedulesQueryBuilder;
|
|
1707
1513
|
next: () => Promise<SchedulesQueryResult>;
|
|
1708
1514
|
prev: () => Promise<SchedulesQueryResult>;
|
|
1709
1515
|
}
|
|
1710
|
-
|
|
1516
|
+
interface SchedulesQueryBuilder {
|
|
1711
1517
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1712
1518
|
* @param value - Value to compare against.
|
|
1713
1519
|
*/
|
|
@@ -1719,36 +1525,7 @@ export interface SchedulesQueryBuilder {
|
|
|
1719
1525
|
skipTo: (cursor: string) => SchedulesQueryBuilder;
|
|
1720
1526
|
find: () => Promise<SchedulesQueryResult>;
|
|
1721
1527
|
}
|
|
1722
|
-
|
|
1723
|
-
* Creates a schedule.
|
|
1724
|
-
*
|
|
1725
|
-
*
|
|
1726
|
-
* If you want the schedule's events to appear in the
|
|
1727
|
-
* [Bookings calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar),
|
|
1728
|
-
* you must set `appId` to the ID of the Wix Bookings app by providing
|
|
1729
|
-
* `{"appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97"}`.
|
|
1730
|
-
* @param schedule - Schedule to create.
|
|
1731
|
-
* @public
|
|
1732
|
-
* @requiredField schedule
|
|
1733
|
-
* @requiredField schedule.defaultConferencingDetails.guestUrl
|
|
1734
|
-
* @requiredField schedule.defaultConferencingDetails.hostUrl
|
|
1735
|
-
* @requiredField schedule.defaultConferencingDetails.type
|
|
1736
|
-
* @requiredField schedule.defaultLocation.type
|
|
1737
|
-
* @requiredField schedule.permissions.identity
|
|
1738
|
-
* @requiredField schedule.permissions.role
|
|
1739
|
-
* @permissionId CALENDAR.SCHEDULE_CREATE
|
|
1740
|
-
* @permissionScope Manage Calendars
|
|
1741
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1742
|
-
* @permissionScope Manage Bookings
|
|
1743
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1744
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1745
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1746
|
-
* @applicableIdentity APP
|
|
1747
|
-
* @returns Created schedule.
|
|
1748
|
-
* @fqn wix.calendar.schedules.v3.SchedulesService.CreateSchedule
|
|
1749
|
-
*/
|
|
1750
|
-
export declare function createSchedule(schedule: NonNullablePaths<Schedule, `defaultConferencingDetails.guestUrl` | `defaultConferencingDetails.hostUrl` | `defaultConferencingDetails.type` | `defaultLocation.type` | `permissions.${number}.identity` | `permissions.${number}.role`>, options?: CreateScheduleOptions): Promise<NonNullablePaths<Schedule, ScheduleNonNullablePaths>>;
|
|
1751
|
-
export interface CreateScheduleOptions {
|
|
1528
|
+
interface CreateScheduleOptions {
|
|
1752
1529
|
/**
|
|
1753
1530
|
* Idempotency key guaranteeing that you don't create the same schedule more
|
|
1754
1531
|
* than once.
|
|
@@ -1756,35 +1533,7 @@ export interface CreateScheduleOptions {
|
|
|
1756
1533
|
*/
|
|
1757
1534
|
idempotencyKey?: string | null;
|
|
1758
1535
|
}
|
|
1759
|
-
|
|
1760
|
-
* Updates a schedule.
|
|
1761
|
-
*
|
|
1762
|
-
*
|
|
1763
|
-
* Each time the schedule is updated,
|
|
1764
|
-
* `revision` increments by 1.
|
|
1765
|
-
* The current `revision` must be passed when updating the schedule.
|
|
1766
|
-
* This ensures you're working with the latest schedule
|
|
1767
|
-
* and prevents unintended overwrites.
|
|
1768
|
-
* @param _id - Schedule ID.
|
|
1769
|
-
* @public
|
|
1770
|
-
* @requiredField _id
|
|
1771
|
-
* @requiredField schedule
|
|
1772
|
-
* @requiredField schedule.permissions.identity
|
|
1773
|
-
* @requiredField schedule.permissions.role
|
|
1774
|
-
* @requiredField schedule.revision
|
|
1775
|
-
* @permissionId CALENDAR.SCHEDULE_UPDATE
|
|
1776
|
-
* @permissionScope Manage Calendars
|
|
1777
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1778
|
-
* @permissionScope Manage Bookings
|
|
1779
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1780
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1781
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1782
|
-
* @applicableIdentity APP
|
|
1783
|
-
* @returns Updated schedule.
|
|
1784
|
-
* @fqn wix.calendar.schedules.v3.SchedulesService.UpdateSchedule
|
|
1785
|
-
*/
|
|
1786
|
-
export declare function updateSchedule(_id: string, schedule: NonNullablePaths<UpdateSchedule, `permissions.${number}.identity` | `permissions.${number}.role` | `revision`>, options?: UpdateScheduleOptions): Promise<NonNullablePaths<Schedule, ScheduleNonNullablePaths>>;
|
|
1787
|
-
export interface UpdateSchedule {
|
|
1536
|
+
interface UpdateSchedule {
|
|
1788
1537
|
/**
|
|
1789
1538
|
* Schedule ID.
|
|
1790
1539
|
* @format GUID
|
|
@@ -1909,38 +1658,14 @@ export interface UpdateSchedule {
|
|
|
1909
1658
|
*/
|
|
1910
1659
|
_updatedDate?: Date | null;
|
|
1911
1660
|
}
|
|
1912
|
-
|
|
1661
|
+
interface UpdateScheduleOptions {
|
|
1913
1662
|
/**
|
|
1914
1663
|
* Information about whether participants of the schedule's updated events are
|
|
1915
1664
|
* notified and the message they receive.
|
|
1916
1665
|
*/
|
|
1917
1666
|
participantNotification?: ParticipantNotification;
|
|
1918
1667
|
}
|
|
1919
|
-
|
|
1920
|
-
* Sets a schedule's `status` to `CANCELLED`.
|
|
1921
|
-
*
|
|
1922
|
-
*
|
|
1923
|
-
* Also cancels future events belonging to the schedule.
|
|
1924
|
-
*
|
|
1925
|
-
* Once a schedule is marked as `CANCELLED`, you can't reactivate it, update it,
|
|
1926
|
-
* or assign new events.
|
|
1927
|
-
* @param scheduleId - ID of the schedule to cancel.
|
|
1928
|
-
* @public
|
|
1929
|
-
* @requiredField scheduleId
|
|
1930
|
-
* @permissionId CALENDAR.SCHEDULE_CANCEL
|
|
1931
|
-
* @permissionScope Manage Calendars
|
|
1932
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1933
|
-
* @permissionScope Manage Bookings
|
|
1934
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1935
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1936
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1937
|
-
* @applicableIdentity APP
|
|
1938
|
-
* @fqn wix.calendar.schedules.v3.SchedulesService.CancelSchedule
|
|
1939
|
-
*/
|
|
1940
|
-
export declare function cancelSchedule(scheduleId: string, options?: CancelScheduleOptions): Promise<NonNullablePaths<CancelScheduleResponse, {
|
|
1941
|
-
[P in ScheduleNonNullablePaths]: `schedule.${P}`;
|
|
1942
|
-
}[ScheduleNonNullablePaths]>>;
|
|
1943
|
-
export interface CancelScheduleOptions {
|
|
1668
|
+
interface CancelScheduleOptions {
|
|
1944
1669
|
/**
|
|
1945
1670
|
* Whether to preserve future events with participants.
|
|
1946
1671
|
* Default: `false`.
|
|
@@ -1952,4 +1677,5 @@ export interface CancelScheduleOptions {
|
|
|
1952
1677
|
*/
|
|
1953
1678
|
participantNotification?: ParticipantNotification;
|
|
1954
1679
|
}
|
|
1955
|
-
|
|
1680
|
+
|
|
1681
|
+
export { type ScheduleCancelled as $, type QuerySchedulesResponse as A, type CursorPagingMetadata as B, type CreateScheduleOptions as C, DeleteStatus as D, type ExtendedFields as E, type Cursors as F, type GetScheduleOptions as G, type CreateScheduleRequest as H, IdentityType as I, type CreateScheduleResponse as J, type UpdateScheduleRequest as K, LocationType as L, type ParticipantNotification as M, Namespace as N, type UpdateScheduleResponse as O, PlacementType as P, type QuerySchedulesOptions as Q, Role as R, type Schedule as S, Type as T, type UpdateSchedule as U, type ScheduleUpdatedWithMetadata as V, WebhookIdentityType as W, type CloneScheduleRequest as X, type CloneScheduleResponse as Y, type ScheduleCloned as Z, type CancelScheduleRequest as _, type SchedulesQueryBuilder as a, type MetaSiteSpecialEvent as a0, type MetaSiteSpecialEventPayloadOneOf as a1, type Asset as a2, type SiteCreated as a3, type SiteTransferred as a4, type SiteDeleted as a5, type DeleteContext as a6, type SiteUndeleted as a7, type SitePublished as a8, type SiteUnpublished as a9, type SpecialHourPeriod as aA, type Multilingual as aB, type SupportedLanguage as aC, type ConsentPolicy as aD, type Translation as aE, type ChangeContext as aF, type ChangeContextPayloadOneOf as aG, type PropertiesChange as aH, type V4SiteCreated as aI, type SiteCloned as aJ, type DomainEvent as aK, type DomainEventBodyOneOf as aL, type EntityCreatedEvent as aM, type RestoreInfo as aN, type EntityUpdatedEvent as aO, type EntityDeletedEvent as aP, type ActionEvent as aQ, type MessageEnvelope as aR, type IdentificationData as aS, type IdentificationDataIdOneOf as aT, type BaseEventMetadata as aU, type EventMetadata as aV, type SchedulesQueryResult as aW, type SiteMarkedAsTemplate as aa, type SiteMarkedAsWixSite as ab, type ServiceProvisioned as ac, type ServiceRemoved as ad, type SiteRenamed as ae, type SiteHardDeleted as af, type NamespaceChanged as ag, type StudioAssigned as ah, type StudioUnassigned as ai, type SiteUrlChanged as aj, type SitePurgedExternally as ak, type OdeditorAssigned as al, type OdeditorUnassigned as am, type PicassoAssigned as an, type PicassoUnassigned as ao, type Empty as ap, type SitePropertiesNotification as aq, type SitePropertiesEvent as ar, type Properties as as, type Categories as at, type Locale as au, type Address as av, type AddressHint as aw, type GeoCoordinates as ax, type BusinessSchedule as ay, type TimePeriod as az, type UpdateScheduleOptions as b, type CancelScheduleOptions as c, type CancelScheduleResponse as d, type ScheduleCancelledEnvelope as e, type ScheduleClonedEnvelope as f, type ScheduleCreatedEnvelope as g, type ScheduleUpdatedEnvelope as h, Status as i, RequestedFields as j, Trigger as k, State as l, SiteCreatedContext as m, DayOfWeek as n, ResolutionMethod as o, type Location as p, type ConferencingDetails as q, type Permission as r, type CommonIdentificationData as s, type CommonIdentificationDataIdOneOf as t, type GetScheduleRequest as u, type GetScheduleResponse as v, type QuerySchedulesRequest as w, type CursorQuery as x, type CursorQueryPagingMethodOneOf as y, type CursorPaging as z };
|