@wix/auto_sdk_calendar_schedules 1.0.32 → 1.0.34
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-D3nvGK6W.d.mts} +111 -426
- package/build/{cjs/src/calendar-v3-schedule-schedules.universal.d.ts → calendar-v3-schedule-schedules.universal-D3nvGK6W.d.ts} +111 -426
- package/build/index.d.mts +105 -0
- package/build/index.d.ts +105 -0
- package/build/index.js +700 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +653 -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-D3nvGK6W.d.mts} +111 -426
- package/build/{es/src/calendar-v3-schedule-schedules.universal.d.ts → internal/calendar-v3-schedule-schedules.universal-D3nvGK6W.d.ts} +111 -426
- package/build/internal/index.d.mts +105 -0
- package/build/internal/index.d.ts +105 -0
- package/build/internal/index.js +700 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +653 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +487 -0
- package/build/internal/meta.d.ts +487 -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 +487 -0
- package/build/meta.d.ts +487 -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 +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-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 -1362
- 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 -596
- 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 -1362
- 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 -565
- 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 -1362
- 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 -596
- 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 -1362
- 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 -565
- 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,14 +131,14 @@ 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",
|
|
139
138
|
/** You can't add events to the schedule or update its fields. */
|
|
140
139
|
CANCELLED = "CANCELLED"
|
|
141
140
|
}
|
|
142
|
-
|
|
141
|
+
interface Location {
|
|
143
142
|
/**
|
|
144
143
|
* [Location](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction)
|
|
145
144
|
* ID. Available only for `BUSINESS` locations.
|
|
@@ -175,7 +174,7 @@ export interface Location {
|
|
|
175
174
|
*/
|
|
176
175
|
address?: string | null;
|
|
177
176
|
}
|
|
178
|
-
|
|
177
|
+
declare enum LocationType {
|
|
179
178
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
180
179
|
/** The event is held at a business location. */
|
|
181
180
|
BUSINESS = "BUSINESS",
|
|
@@ -184,7 +183,7 @@ export declare enum LocationType {
|
|
|
184
183
|
/** The event is held at an address or venue not tied to the business or customer. */
|
|
185
184
|
CUSTOM = "CUSTOM"
|
|
186
185
|
}
|
|
187
|
-
|
|
186
|
+
interface ConferencingDetails {
|
|
188
187
|
/** Conference type. For example, `Zoom`. */
|
|
189
188
|
type?: Type;
|
|
190
189
|
/**
|
|
@@ -224,12 +223,12 @@ export interface ConferencingDetails {
|
|
|
224
223
|
*/
|
|
225
224
|
externalId?: string | null;
|
|
226
225
|
}
|
|
227
|
-
|
|
226
|
+
declare enum Type {
|
|
228
227
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
229
228
|
ZOOM = "ZOOM",
|
|
230
229
|
CUSTOM = "CUSTOM"
|
|
231
230
|
}
|
|
232
|
-
|
|
231
|
+
interface Permission {
|
|
233
232
|
/**
|
|
234
233
|
* [Wix user](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-users)
|
|
235
234
|
* granted the permission.
|
|
@@ -244,7 +243,7 @@ export interface Permission {
|
|
|
244
243
|
*/
|
|
245
244
|
role?: Role;
|
|
246
245
|
}
|
|
247
|
-
|
|
246
|
+
interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
|
|
248
247
|
/**
|
|
249
248
|
* ID of a Wix user. For example, the site owner or a
|
|
250
249
|
* [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
|
|
@@ -253,7 +252,7 @@ export interface CommonIdentificationData extends CommonIdentificationDataIdOneO
|
|
|
253
252
|
wixUserId?: string;
|
|
254
253
|
}
|
|
255
254
|
/** @oneof */
|
|
256
|
-
|
|
255
|
+
interface CommonIdentificationDataIdOneOf {
|
|
257
256
|
/**
|
|
258
257
|
* ID of a Wix user. For example, the site owner or a
|
|
259
258
|
* [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
|
|
@@ -261,18 +260,18 @@ export interface CommonIdentificationDataIdOneOf {
|
|
|
261
260
|
*/
|
|
262
261
|
wixUserId?: string;
|
|
263
262
|
}
|
|
264
|
-
|
|
263
|
+
declare enum IdentityType {
|
|
265
264
|
UNKNOWN = "UNKNOWN",
|
|
266
265
|
WIX_USER = "WIX_USER"
|
|
267
266
|
}
|
|
268
|
-
|
|
267
|
+
declare enum Role {
|
|
269
268
|
UNKNOWN_ROLE = "UNKNOWN_ROLE",
|
|
270
269
|
/** Full read and write access. */
|
|
271
270
|
WRITER = "WRITER",
|
|
272
271
|
/** Full read access, write access limited to `event.notes`. */
|
|
273
272
|
COMMENTER = "COMMENTER"
|
|
274
273
|
}
|
|
275
|
-
|
|
274
|
+
interface ExtendedFields {
|
|
276
275
|
/**
|
|
277
276
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
278
277
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -283,7 +282,7 @@ export interface ExtendedFields {
|
|
|
283
282
|
*/
|
|
284
283
|
namespaces?: Record<string, Record<string, any>>;
|
|
285
284
|
}
|
|
286
|
-
|
|
285
|
+
interface GetScheduleRequest {
|
|
287
286
|
/**
|
|
288
287
|
* ID of the schedule to retrieve.
|
|
289
288
|
* @format GUID
|
|
@@ -304,18 +303,18 @@ export interface GetScheduleRequest {
|
|
|
304
303
|
*/
|
|
305
304
|
fields?: RequestedFields[];
|
|
306
305
|
}
|
|
307
|
-
|
|
306
|
+
declare enum RequestedFields {
|
|
308
307
|
UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
|
|
309
308
|
/** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
|
|
310
309
|
PI_FIELDS = "PI_FIELDS",
|
|
311
310
|
/** Returns only fields containing your own personal data. */
|
|
312
311
|
OWN_PI_FIELDS = "OWN_PI_FIELDS"
|
|
313
312
|
}
|
|
314
|
-
|
|
313
|
+
interface GetScheduleResponse {
|
|
315
314
|
/** Retrieved schedule. */
|
|
316
315
|
schedule?: Schedule;
|
|
317
316
|
}
|
|
318
|
-
|
|
317
|
+
interface QuerySchedulesRequest {
|
|
319
318
|
/** Query containing filters and paging. */
|
|
320
319
|
query?: CursorQuery;
|
|
321
320
|
/**
|
|
@@ -334,7 +333,7 @@ export interface QuerySchedulesRequest {
|
|
|
334
333
|
fields?: RequestedFields[];
|
|
335
334
|
}
|
|
336
335
|
/** TODO Diverge */
|
|
337
|
-
|
|
336
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
338
337
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
339
338
|
cursorPaging?: CursorPaging;
|
|
340
339
|
/**
|
|
@@ -349,12 +348,12 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
349
348
|
filter?: Record<string, any> | null;
|
|
350
349
|
}
|
|
351
350
|
/** @oneof */
|
|
352
|
-
|
|
351
|
+
interface CursorQueryPagingMethodOneOf {
|
|
353
352
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
354
353
|
cursorPaging?: CursorPaging;
|
|
355
354
|
}
|
|
356
355
|
/** TODO Diverge */
|
|
357
|
-
|
|
356
|
+
interface CursorPaging {
|
|
358
357
|
/**
|
|
359
358
|
* Number of schedules to return.
|
|
360
359
|
*
|
|
@@ -374,14 +373,14 @@ export interface CursorPaging {
|
|
|
374
373
|
*/
|
|
375
374
|
cursor?: string | null;
|
|
376
375
|
}
|
|
377
|
-
|
|
376
|
+
interface QuerySchedulesResponse {
|
|
378
377
|
/** Retrieved schedules matching the provided query. */
|
|
379
378
|
schedules?: Schedule[];
|
|
380
379
|
/** Paging metadata. */
|
|
381
380
|
pagingMetadata?: CursorPagingMetadata;
|
|
382
381
|
}
|
|
383
382
|
/** TODO Diverge */
|
|
384
|
-
|
|
383
|
+
interface CursorPagingMetadata {
|
|
385
384
|
/** Number of schedules returned in the current page of the response. */
|
|
386
385
|
count?: number | null;
|
|
387
386
|
/** 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). */
|
|
@@ -393,13 +392,13 @@ export interface CursorPagingMetadata {
|
|
|
393
392
|
*/
|
|
394
393
|
hasNext?: boolean | null;
|
|
395
394
|
}
|
|
396
|
-
|
|
395
|
+
interface Cursors {
|
|
397
396
|
/** Cursor pointing to next page in the list of results. */
|
|
398
397
|
next?: string | null;
|
|
399
398
|
/** Cursor pointing to previous page in the list of results. */
|
|
400
399
|
prev?: string | null;
|
|
401
400
|
}
|
|
402
|
-
|
|
401
|
+
interface CreateScheduleRequest {
|
|
403
402
|
/** Schedule to create. */
|
|
404
403
|
schedule: Schedule;
|
|
405
404
|
/**
|
|
@@ -409,11 +408,11 @@ export interface CreateScheduleRequest {
|
|
|
409
408
|
*/
|
|
410
409
|
idempotencyKey?: string | null;
|
|
411
410
|
}
|
|
412
|
-
|
|
411
|
+
interface CreateScheduleResponse {
|
|
413
412
|
/** Created schedule. */
|
|
414
413
|
schedule?: Schedule;
|
|
415
414
|
}
|
|
416
|
-
|
|
415
|
+
interface UpdateScheduleRequest {
|
|
417
416
|
/** Schedule to update. */
|
|
418
417
|
schedule: Schedule;
|
|
419
418
|
/**
|
|
@@ -422,7 +421,7 @@ export interface UpdateScheduleRequest {
|
|
|
422
421
|
*/
|
|
423
422
|
participantNotification?: ParticipantNotification;
|
|
424
423
|
}
|
|
425
|
-
|
|
424
|
+
interface ParticipantNotification {
|
|
426
425
|
/**
|
|
427
426
|
* Whether to notify the participants about changes made to the schedule or event.
|
|
428
427
|
*
|
|
@@ -439,18 +438,18 @@ export interface ParticipantNotification {
|
|
|
439
438
|
*/
|
|
440
439
|
message?: string | null;
|
|
441
440
|
}
|
|
442
|
-
|
|
441
|
+
interface UpdateScheduleResponse {
|
|
443
442
|
/** Updated schedule. */
|
|
444
443
|
schedule?: Schedule;
|
|
445
444
|
}
|
|
446
445
|
/** `PRIVATE` until we'll have standard events metadata from Infra. */
|
|
447
|
-
|
|
446
|
+
interface ScheduleUpdatedWithMetadata {
|
|
448
447
|
/** The updated schedule. */
|
|
449
448
|
schedule?: Schedule;
|
|
450
449
|
/** Whether to notify participants regarding the changes. */
|
|
451
450
|
participantNotification?: ParticipantNotification;
|
|
452
451
|
}
|
|
453
|
-
|
|
452
|
+
interface CloneScheduleRequest {
|
|
454
453
|
/**
|
|
455
454
|
* ID of the schedule to clone.
|
|
456
455
|
* @format GUID
|
|
@@ -459,11 +458,11 @@ export interface CloneScheduleRequest {
|
|
|
459
458
|
/** Fields to override in the cloned schedule. */
|
|
460
459
|
schedule?: Schedule;
|
|
461
460
|
}
|
|
462
|
-
|
|
461
|
+
interface CloneScheduleResponse {
|
|
463
462
|
/** Cloned schedule. */
|
|
464
463
|
schedule?: Schedule;
|
|
465
464
|
}
|
|
466
|
-
|
|
465
|
+
interface ScheduleCloned {
|
|
467
466
|
/** New cloned schedule. */
|
|
468
467
|
schedule?: Schedule;
|
|
469
468
|
/** The clone trigger. */
|
|
@@ -479,7 +478,7 @@ export interface ScheduleCloned {
|
|
|
479
478
|
*/
|
|
480
479
|
originalScheduleId?: string | null;
|
|
481
480
|
}
|
|
482
|
-
|
|
481
|
+
declare enum Trigger {
|
|
483
482
|
/** Schedule cloned using the `CloneSchedule` API. */
|
|
484
483
|
SCHEDULE_CLONED = "SCHEDULE_CLONED",
|
|
485
484
|
/** Site duplicated from the same account. */
|
|
@@ -491,7 +490,7 @@ export declare enum Trigger {
|
|
|
491
490
|
/** Other. */
|
|
492
491
|
OTHER = "OTHER"
|
|
493
492
|
}
|
|
494
|
-
|
|
493
|
+
interface CancelScheduleRequest {
|
|
495
494
|
/**
|
|
496
495
|
* ID of the schedule to cancel.
|
|
497
496
|
* @format GUID
|
|
@@ -508,17 +507,17 @@ export interface CancelScheduleRequest {
|
|
|
508
507
|
*/
|
|
509
508
|
participantNotification?: ParticipantNotification;
|
|
510
509
|
}
|
|
511
|
-
|
|
510
|
+
interface CancelScheduleResponse {
|
|
512
511
|
/** Canceled schedule. */
|
|
513
512
|
schedule?: Schedule;
|
|
514
513
|
}
|
|
515
|
-
|
|
514
|
+
interface ScheduleCancelled {
|
|
516
515
|
/** Canceled schedule. */
|
|
517
516
|
schedule?: Schedule;
|
|
518
517
|
/** Whether future events with participants were preserved. */
|
|
519
518
|
preserveFutureEventsWithParticipants?: boolean | null;
|
|
520
519
|
}
|
|
521
|
-
|
|
520
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
522
521
|
/** Emitted on a meta site creation. */
|
|
523
522
|
siteCreated?: SiteCreated;
|
|
524
523
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -576,7 +575,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
576
575
|
assets?: Asset[];
|
|
577
576
|
}
|
|
578
577
|
/** @oneof */
|
|
579
|
-
|
|
578
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
580
579
|
/** Emitted on a meta site creation. */
|
|
581
580
|
siteCreated?: SiteCreated;
|
|
582
581
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -618,7 +617,7 @@ export interface MetaSiteSpecialEventPayloadOneOf {
|
|
|
618
617
|
/** Site is marked as PurgedExternally */
|
|
619
618
|
sitePurgedExternally?: SitePurgedExternally;
|
|
620
619
|
}
|
|
621
|
-
|
|
620
|
+
interface Asset {
|
|
622
621
|
/**
|
|
623
622
|
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
624
623
|
* @maxLength 36
|
|
@@ -632,14 +631,14 @@ export interface Asset {
|
|
|
632
631
|
/** An application state. */
|
|
633
632
|
state?: State;
|
|
634
633
|
}
|
|
635
|
-
|
|
634
|
+
declare enum State {
|
|
636
635
|
UNKNOWN = "UNKNOWN",
|
|
637
636
|
ENABLED = "ENABLED",
|
|
638
637
|
DISABLED = "DISABLED",
|
|
639
638
|
PENDING = "PENDING",
|
|
640
639
|
DEMO = "DEMO"
|
|
641
640
|
}
|
|
642
|
-
|
|
641
|
+
interface SiteCreated {
|
|
643
642
|
/**
|
|
644
643
|
* A template identifier (empty if not created from a template).
|
|
645
644
|
* @maxLength 36
|
|
@@ -668,7 +667,7 @@ export interface SiteCreated {
|
|
|
668
667
|
/** A namespace. */
|
|
669
668
|
namespace?: Namespace;
|
|
670
669
|
}
|
|
671
|
-
|
|
670
|
+
declare enum SiteCreatedContext {
|
|
672
671
|
/** A valid option, we don't expose all reasons why site might be created. */
|
|
673
672
|
OTHER = "OTHER",
|
|
674
673
|
/** A meta site was created from template. */
|
|
@@ -682,7 +681,7 @@ export declare enum SiteCreatedContext {
|
|
|
682
681
|
/** deprecated A meta site was created for Flash editor. */
|
|
683
682
|
FLASH = "FLASH"
|
|
684
683
|
}
|
|
685
|
-
|
|
684
|
+
declare enum Namespace {
|
|
686
685
|
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
687
686
|
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
688
687
|
WIX = "WIX",
|
|
@@ -765,7 +764,7 @@ export declare enum Namespace {
|
|
|
765
764
|
MIMIR = "MIMIR"
|
|
766
765
|
}
|
|
767
766
|
/** Site transferred to another user. */
|
|
768
|
-
|
|
767
|
+
interface SiteTransferred {
|
|
769
768
|
/**
|
|
770
769
|
* A previous owner id (user that transfers meta site).
|
|
771
770
|
* @format GUID
|
|
@@ -778,11 +777,11 @@ export interface SiteTransferred {
|
|
|
778
777
|
newOwnerId?: string;
|
|
779
778
|
}
|
|
780
779
|
/** Soft deletion of the meta site. Could be restored. */
|
|
781
|
-
|
|
780
|
+
interface SiteDeleted {
|
|
782
781
|
/** A deletion context. */
|
|
783
782
|
deleteContext?: DeleteContext;
|
|
784
783
|
}
|
|
785
|
-
|
|
784
|
+
interface DeleteContext {
|
|
786
785
|
/** When the meta site was deleted. */
|
|
787
786
|
dateDeleted?: Date | null;
|
|
788
787
|
/** A status. */
|
|
@@ -798,7 +797,7 @@ export interface DeleteContext {
|
|
|
798
797
|
*/
|
|
799
798
|
initiatorId?: string | null;
|
|
800
799
|
}
|
|
801
|
-
|
|
800
|
+
declare enum DeleteStatus {
|
|
802
801
|
UNKNOWN = "UNKNOWN",
|
|
803
802
|
TRASH = "TRASH",
|
|
804
803
|
DELETED = "DELETED",
|
|
@@ -806,12 +805,12 @@ export declare enum DeleteStatus {
|
|
|
806
805
|
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
807
806
|
}
|
|
808
807
|
/** Restoration of the meta site. */
|
|
809
|
-
|
|
808
|
+
interface SiteUndeleted {
|
|
810
809
|
}
|
|
811
810
|
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
812
|
-
|
|
811
|
+
interface SitePublished {
|
|
813
812
|
}
|
|
814
|
-
|
|
813
|
+
interface SiteUnpublished {
|
|
815
814
|
/**
|
|
816
815
|
* A list of URLs previously associated with the meta site.
|
|
817
816
|
* @maxLength 4000
|
|
@@ -819,9 +818,9 @@ export interface SiteUnpublished {
|
|
|
819
818
|
*/
|
|
820
819
|
urls?: string[];
|
|
821
820
|
}
|
|
822
|
-
|
|
821
|
+
interface SiteMarkedAsTemplate {
|
|
823
822
|
}
|
|
824
|
-
|
|
823
|
+
interface SiteMarkedAsWixSite {
|
|
825
824
|
}
|
|
826
825
|
/**
|
|
827
826
|
* Represents a service provisioned a site.
|
|
@@ -838,7 +837,7 @@ export interface SiteMarkedAsWixSite {
|
|
|
838
837
|
* changes made to the original template afterward.
|
|
839
838
|
* To ensure this, the TPA on the template gets a new instance_id.
|
|
840
839
|
*/
|
|
841
|
-
|
|
840
|
+
interface ServiceProvisioned {
|
|
842
841
|
/**
|
|
843
842
|
* Either UUID or EmbeddedServiceType.
|
|
844
843
|
* @maxLength 36
|
|
@@ -865,7 +864,7 @@ export interface ServiceProvisioned {
|
|
|
865
864
|
*/
|
|
866
865
|
originMetaSiteId?: string | null;
|
|
867
866
|
}
|
|
868
|
-
|
|
867
|
+
interface ServiceRemoved {
|
|
869
868
|
/**
|
|
870
869
|
* Either UUID or EmbeddedServiceType.
|
|
871
870
|
* @maxLength 36
|
|
@@ -883,7 +882,7 @@ export interface ServiceRemoved {
|
|
|
883
882
|
version?: string | null;
|
|
884
883
|
}
|
|
885
884
|
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
886
|
-
|
|
885
|
+
interface SiteRenamed {
|
|
887
886
|
/**
|
|
888
887
|
* A new meta site name (URL slug).
|
|
889
888
|
* @maxLength 20
|
|
@@ -900,21 +899,21 @@ export interface SiteRenamed {
|
|
|
900
899
|
*
|
|
901
900
|
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
902
901
|
*/
|
|
903
|
-
|
|
902
|
+
interface SiteHardDeleted {
|
|
904
903
|
/** A deletion context. */
|
|
905
904
|
deleteContext?: DeleteContext;
|
|
906
905
|
}
|
|
907
|
-
|
|
906
|
+
interface NamespaceChanged {
|
|
908
907
|
/** A previous namespace. */
|
|
909
908
|
oldNamespace?: Namespace;
|
|
910
909
|
/** A new namespace. */
|
|
911
910
|
newNamespace?: Namespace;
|
|
912
911
|
}
|
|
913
912
|
/** Assigned Studio editor */
|
|
914
|
-
|
|
913
|
+
interface StudioAssigned {
|
|
915
914
|
}
|
|
916
915
|
/** Unassigned Studio editor */
|
|
917
|
-
|
|
916
|
+
interface StudioUnassigned {
|
|
918
917
|
}
|
|
919
918
|
/**
|
|
920
919
|
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
@@ -924,13 +923,13 @@ export interface StudioUnassigned {
|
|
|
924
923
|
*
|
|
925
924
|
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
926
925
|
*/
|
|
927
|
-
|
|
926
|
+
interface SiteUrlChanged {
|
|
928
927
|
}
|
|
929
928
|
/**
|
|
930
929
|
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
931
930
|
* Consumed by other teams to remove relevant data.
|
|
932
931
|
*/
|
|
933
|
-
|
|
932
|
+
interface SitePurgedExternally {
|
|
934
933
|
/**
|
|
935
934
|
* @maxLength 2048
|
|
936
935
|
* @maxSize 100
|
|
@@ -939,10 +938,10 @@ export interface SitePurgedExternally {
|
|
|
939
938
|
*/
|
|
940
939
|
appDefId?: string[];
|
|
941
940
|
}
|
|
942
|
-
|
|
941
|
+
interface Empty {
|
|
943
942
|
}
|
|
944
943
|
/** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
|
|
945
|
-
|
|
944
|
+
interface SitePropertiesNotification {
|
|
946
945
|
/** The site ID for which this update notification applies. */
|
|
947
946
|
metasiteId?: string;
|
|
948
947
|
/** The actual update event. */
|
|
@@ -956,7 +955,7 @@ export interface SitePropertiesNotification {
|
|
|
956
955
|
changeContext?: ChangeContext;
|
|
957
956
|
}
|
|
958
957
|
/** The actual update event for a particular notification. */
|
|
959
|
-
|
|
958
|
+
interface SitePropertiesEvent {
|
|
960
959
|
/** Version of the site's properties represented by this update. */
|
|
961
960
|
version?: number;
|
|
962
961
|
/** Set of properties that were updated - corresponds to the fields in "properties". */
|
|
@@ -964,7 +963,7 @@ export interface SitePropertiesEvent {
|
|
|
964
963
|
/** Updated properties. */
|
|
965
964
|
properties?: Properties;
|
|
966
965
|
}
|
|
967
|
-
|
|
966
|
+
interface Properties {
|
|
968
967
|
/** Site categories. */
|
|
969
968
|
categories?: Categories;
|
|
970
969
|
/** Site locale. */
|
|
@@ -1020,7 +1019,7 @@ export interface Properties {
|
|
|
1020
1019
|
/** Track clicks analytics. */
|
|
1021
1020
|
trackClicksAnalytics?: boolean;
|
|
1022
1021
|
}
|
|
1023
|
-
|
|
1022
|
+
interface Categories {
|
|
1024
1023
|
/** Primary site category. */
|
|
1025
1024
|
primary?: string;
|
|
1026
1025
|
/**
|
|
@@ -1031,13 +1030,13 @@ export interface Categories {
|
|
|
1031
1030
|
/** Business Term Id */
|
|
1032
1031
|
businessTermId?: string | null;
|
|
1033
1032
|
}
|
|
1034
|
-
|
|
1033
|
+
interface Locale {
|
|
1035
1034
|
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
1036
1035
|
languageCode?: string;
|
|
1037
1036
|
/** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
|
|
1038
1037
|
country?: string;
|
|
1039
1038
|
}
|
|
1040
|
-
|
|
1039
|
+
interface Address {
|
|
1041
1040
|
/** Street name. */
|
|
1042
1041
|
street?: string;
|
|
1043
1042
|
/** City name. */
|
|
@@ -1069,27 +1068,27 @@ export interface Address {
|
|
|
1069
1068
|
* This is used for display purposes. Used to add additional data about the address, such as "In the passage".
|
|
1070
1069
|
* Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
|
|
1071
1070
|
*/
|
|
1072
|
-
|
|
1071
|
+
interface AddressHint {
|
|
1073
1072
|
/** Extra text displayed next to, or instead of, the actual address. */
|
|
1074
1073
|
text?: string;
|
|
1075
1074
|
/** Where the extra text should be displayed. */
|
|
1076
1075
|
placement?: PlacementType;
|
|
1077
1076
|
}
|
|
1078
1077
|
/** Where the extra text should be displayed: before, after or instead of the actual address. */
|
|
1079
|
-
|
|
1078
|
+
declare enum PlacementType {
|
|
1080
1079
|
BEFORE = "BEFORE",
|
|
1081
1080
|
AFTER = "AFTER",
|
|
1082
1081
|
REPLACE = "REPLACE"
|
|
1083
1082
|
}
|
|
1084
1083
|
/** Geocoordinates for a particular address. */
|
|
1085
|
-
|
|
1084
|
+
interface GeoCoordinates {
|
|
1086
1085
|
/** Latitude of the location. Must be between -90 and 90. */
|
|
1087
1086
|
latitude?: number;
|
|
1088
1087
|
/** Longitude of the location. Must be between -180 and 180. */
|
|
1089
1088
|
longitude?: number;
|
|
1090
1089
|
}
|
|
1091
1090
|
/** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
|
|
1092
|
-
|
|
1091
|
+
interface BusinessSchedule {
|
|
1093
1092
|
/**
|
|
1094
1093
|
* Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
|
|
1095
1094
|
* @maxSize 100
|
|
@@ -1102,7 +1101,7 @@ export interface BusinessSchedule {
|
|
|
1102
1101
|
specialHourPeriod?: SpecialHourPeriod[];
|
|
1103
1102
|
}
|
|
1104
1103
|
/** Weekly recurring time periods when the business is regularly open or the service is available. */
|
|
1105
|
-
|
|
1104
|
+
interface TimePeriod {
|
|
1106
1105
|
/** Day of the week the period starts on. */
|
|
1107
1106
|
openDay?: DayOfWeek;
|
|
1108
1107
|
/**
|
|
@@ -1121,7 +1120,7 @@ export interface TimePeriod {
|
|
|
1121
1120
|
closeTime?: string;
|
|
1122
1121
|
}
|
|
1123
1122
|
/** Enumerates the days of the week. */
|
|
1124
|
-
|
|
1123
|
+
declare enum DayOfWeek {
|
|
1125
1124
|
MONDAY = "MONDAY",
|
|
1126
1125
|
TUESDAY = "TUESDAY",
|
|
1127
1126
|
WEDNESDAY = "WEDNESDAY",
|
|
@@ -1131,7 +1130,7 @@ export declare enum DayOfWeek {
|
|
|
1131
1130
|
SUNDAY = "SUNDAY"
|
|
1132
1131
|
}
|
|
1133
1132
|
/** Exception to the business's regular hours. The business can be open or closed during the exception. */
|
|
1134
|
-
|
|
1133
|
+
interface SpecialHourPeriod {
|
|
1135
1134
|
/** 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). */
|
|
1136
1135
|
startDate?: string;
|
|
1137
1136
|
/** 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). */
|
|
@@ -1145,7 +1144,7 @@ export interface SpecialHourPeriod {
|
|
|
1145
1144
|
/** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
|
|
1146
1145
|
comment?: string;
|
|
1147
1146
|
}
|
|
1148
|
-
|
|
1147
|
+
interface Multilingual {
|
|
1149
1148
|
/**
|
|
1150
1149
|
* Supported languages list.
|
|
1151
1150
|
* @maxSize 200
|
|
@@ -1154,7 +1153,7 @@ export interface Multilingual {
|
|
|
1154
1153
|
/** Whether to redirect to user language. */
|
|
1155
1154
|
autoRedirect?: boolean;
|
|
1156
1155
|
}
|
|
1157
|
-
|
|
1156
|
+
interface SupportedLanguage {
|
|
1158
1157
|
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
1159
1158
|
languageCode?: string;
|
|
1160
1159
|
/** Locale. */
|
|
@@ -1166,12 +1165,12 @@ export interface SupportedLanguage {
|
|
|
1166
1165
|
/** How the language will be resolved. For internal use. */
|
|
1167
1166
|
resolutionMethod?: ResolutionMethod;
|
|
1168
1167
|
}
|
|
1169
|
-
|
|
1168
|
+
declare enum ResolutionMethod {
|
|
1170
1169
|
QUERY_PARAM = "QUERY_PARAM",
|
|
1171
1170
|
SUBDOMAIN = "SUBDOMAIN",
|
|
1172
1171
|
SUBDIRECTORY = "SUBDIRECTORY"
|
|
1173
1172
|
}
|
|
1174
|
-
|
|
1173
|
+
interface ConsentPolicy {
|
|
1175
1174
|
/** Whether the site uses cookies that are essential to site operation. Always `true`. */
|
|
1176
1175
|
essential?: boolean | null;
|
|
1177
1176
|
/** Whether the site uses cookies that affect site performance and other functional measurements. */
|
|
@@ -1184,7 +1183,7 @@ export interface ConsentPolicy {
|
|
|
1184
1183
|
dataToThirdParty?: boolean | null;
|
|
1185
1184
|
}
|
|
1186
1185
|
/** A single mapping from the MetaSite ID to a particular service. */
|
|
1187
|
-
|
|
1186
|
+
interface Translation {
|
|
1188
1187
|
/** The service type. */
|
|
1189
1188
|
serviceType?: string;
|
|
1190
1189
|
/** The application definition ID; this only applies to services of type ThirdPartyApps. */
|
|
@@ -1192,7 +1191,7 @@ export interface Translation {
|
|
|
1192
1191
|
/** The instance ID of the service. */
|
|
1193
1192
|
instanceId?: string;
|
|
1194
1193
|
}
|
|
1195
|
-
|
|
1194
|
+
interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
1196
1195
|
/** Properties were updated. */
|
|
1197
1196
|
propertiesChange?: PropertiesChange;
|
|
1198
1197
|
/** Default properties were created on site creation. */
|
|
@@ -1201,7 +1200,7 @@ export interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
|
1201
1200
|
siteCloned?: SiteCloned;
|
|
1202
1201
|
}
|
|
1203
1202
|
/** @oneof */
|
|
1204
|
-
|
|
1203
|
+
interface ChangeContextPayloadOneOf {
|
|
1205
1204
|
/** Properties were updated. */
|
|
1206
1205
|
propertiesChange?: PropertiesChange;
|
|
1207
1206
|
/** Default properties were created on site creation. */
|
|
@@ -1209,17 +1208,17 @@ export interface ChangeContextPayloadOneOf {
|
|
|
1209
1208
|
/** Properties were cloned on site cloning. */
|
|
1210
1209
|
siteCloned?: SiteCloned;
|
|
1211
1210
|
}
|
|
1212
|
-
|
|
1211
|
+
interface PropertiesChange {
|
|
1213
1212
|
}
|
|
1214
|
-
|
|
1213
|
+
interface V4SiteCreated {
|
|
1215
1214
|
/** Origin template site id. */
|
|
1216
1215
|
originTemplateId?: string | null;
|
|
1217
1216
|
}
|
|
1218
|
-
|
|
1217
|
+
interface SiteCloned {
|
|
1219
1218
|
/** Origin site id. */
|
|
1220
1219
|
originMetaSiteId?: string;
|
|
1221
1220
|
}
|
|
1222
|
-
|
|
1221
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1223
1222
|
createdEvent?: EntityCreatedEvent;
|
|
1224
1223
|
updatedEvent?: EntityUpdatedEvent;
|
|
1225
1224
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -1262,19 +1261,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1262
1261
|
entityEventSequence?: string | null;
|
|
1263
1262
|
}
|
|
1264
1263
|
/** @oneof */
|
|
1265
|
-
|
|
1264
|
+
interface DomainEventBodyOneOf {
|
|
1266
1265
|
createdEvent?: EntityCreatedEvent;
|
|
1267
1266
|
updatedEvent?: EntityUpdatedEvent;
|
|
1268
1267
|
deletedEvent?: EntityDeletedEvent;
|
|
1269
1268
|
actionEvent?: ActionEvent;
|
|
1270
1269
|
}
|
|
1271
|
-
|
|
1270
|
+
interface EntityCreatedEvent {
|
|
1272
1271
|
entity?: string;
|
|
1273
1272
|
}
|
|
1274
|
-
|
|
1273
|
+
interface RestoreInfo {
|
|
1275
1274
|
deletedDate?: Date | null;
|
|
1276
1275
|
}
|
|
1277
|
-
|
|
1276
|
+
interface EntityUpdatedEvent {
|
|
1278
1277
|
/**
|
|
1279
1278
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1280
1279
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -1282,14 +1281,14 @@ export interface EntityUpdatedEvent {
|
|
|
1282
1281
|
*/
|
|
1283
1282
|
currentEntity?: string;
|
|
1284
1283
|
}
|
|
1285
|
-
|
|
1284
|
+
interface EntityDeletedEvent {
|
|
1286
1285
|
/** Entity that was deleted */
|
|
1287
1286
|
deletedEntity?: string | null;
|
|
1288
1287
|
}
|
|
1289
|
-
|
|
1288
|
+
interface ActionEvent {
|
|
1290
1289
|
body?: string;
|
|
1291
1290
|
}
|
|
1292
|
-
|
|
1291
|
+
interface MessageEnvelope {
|
|
1293
1292
|
/**
|
|
1294
1293
|
* App instance ID.
|
|
1295
1294
|
* @format GUID
|
|
@@ -1305,7 +1304,7 @@ export interface MessageEnvelope {
|
|
|
1305
1304
|
/** Stringify payload. */
|
|
1306
1305
|
data?: string;
|
|
1307
1306
|
}
|
|
1308
|
-
|
|
1307
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1309
1308
|
/**
|
|
1310
1309
|
* ID of a site visitor that has not logged in to the site.
|
|
1311
1310
|
* @format GUID
|
|
@@ -1330,7 +1329,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1330
1329
|
identityType?: WebhookIdentityType;
|
|
1331
1330
|
}
|
|
1332
1331
|
/** @oneof */
|
|
1333
|
-
|
|
1332
|
+
interface IdentificationDataIdOneOf {
|
|
1334
1333
|
/**
|
|
1335
1334
|
* ID of a site visitor that has not logged in to the site.
|
|
1336
1335
|
* @format GUID
|
|
@@ -1352,14 +1351,14 @@ export interface IdentificationDataIdOneOf {
|
|
|
1352
1351
|
*/
|
|
1353
1352
|
appId?: string;
|
|
1354
1353
|
}
|
|
1355
|
-
|
|
1354
|
+
declare enum WebhookIdentityType {
|
|
1356
1355
|
UNKNOWN = "UNKNOWN",
|
|
1357
1356
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1358
1357
|
MEMBER = "MEMBER",
|
|
1359
1358
|
WIX_USER = "WIX_USER",
|
|
1360
1359
|
APP = "APP"
|
|
1361
1360
|
}
|
|
1362
|
-
|
|
1361
|
+
interface BaseEventMetadata {
|
|
1363
1362
|
/**
|
|
1364
1363
|
* App instance ID.
|
|
1365
1364
|
* @format GUID
|
|
@@ -1373,7 +1372,7 @@ export interface BaseEventMetadata {
|
|
|
1373
1372
|
/** The identification type and identity data. */
|
|
1374
1373
|
identity?: IdentificationData;
|
|
1375
1374
|
}
|
|
1376
|
-
|
|
1375
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
1377
1376
|
/**
|
|
1378
1377
|
* Unique event ID.
|
|
1379
1378
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -1411,182 +1410,23 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
1411
1410
|
*/
|
|
1412
1411
|
entityEventSequence?: string | null;
|
|
1413
1412
|
}
|
|
1414
|
-
|
|
1413
|
+
interface ScheduleCancelledEnvelope {
|
|
1415
1414
|
data: ScheduleCancelled;
|
|
1416
1415
|
metadata: EventMetadata;
|
|
1417
1416
|
}
|
|
1418
|
-
|
|
1419
|
-
* Triggered when a schedule is canceled.
|
|
1420
|
-
* @permissionScope Read Calendar - Including PI
|
|
1421
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1422
|
-
* @permissionScope Manage Calendars
|
|
1423
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1424
|
-
* @permissionScope Manage Bookings
|
|
1425
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1426
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1427
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1428
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1429
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1430
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1431
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1432
|
-
* @permissionScope Read bookings calendar - including participants
|
|
1433
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1434
|
-
* @permissionScope Picasso private app mega scope
|
|
1435
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1436
|
-
* @permissionId CALENDAR.SCHEDULE_READ_PI
|
|
1437
|
-
* @webhook
|
|
1438
|
-
* @eventType wix.calendar.v3.schedule_cancelled
|
|
1439
|
-
* @serviceIdentifier wix.calendar.schedules.v3.SchedulesService
|
|
1440
|
-
* @slug cancelled
|
|
1441
|
-
* @documentationMaturity preview
|
|
1442
|
-
*/
|
|
1443
|
-
export declare function onScheduleCancelled(handler: (event: ScheduleCancelledEnvelope) => void | Promise<void>): void;
|
|
1444
|
-
export interface ScheduleClonedEnvelope {
|
|
1417
|
+
interface ScheduleClonedEnvelope {
|
|
1445
1418
|
data: ScheduleCloned;
|
|
1446
1419
|
metadata: EventMetadata;
|
|
1447
1420
|
}
|
|
1448
|
-
|
|
1449
|
-
* Triggered when a schedule is cloned.
|
|
1450
|
-
* @permissionScope Read Calendar - Including PI
|
|
1451
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1452
|
-
* @permissionScope Manage Calendars
|
|
1453
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1454
|
-
* @permissionScope Manage Bookings
|
|
1455
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1456
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1457
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1458
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1459
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1460
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1461
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1462
|
-
* @permissionScope Read bookings calendar - including participants
|
|
1463
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1464
|
-
* @permissionScope Picasso private app mega scope
|
|
1465
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1466
|
-
* @permissionId CALENDAR.SCHEDULE_READ_PI
|
|
1467
|
-
* @webhook
|
|
1468
|
-
* @eventType wix.calendar.v3.schedule_cloned
|
|
1469
|
-
* @serviceIdentifier wix.calendar.schedules.v3.SchedulesService
|
|
1470
|
-
* @slug cloned
|
|
1471
|
-
* @documentationMaturity preview
|
|
1472
|
-
*/
|
|
1473
|
-
export declare function onScheduleCloned(handler: (event: ScheduleClonedEnvelope) => void | Promise<void>): void;
|
|
1474
|
-
export interface ScheduleCreatedEnvelope {
|
|
1421
|
+
interface ScheduleCreatedEnvelope {
|
|
1475
1422
|
entity: Schedule;
|
|
1476
1423
|
metadata: EventMetadata;
|
|
1477
1424
|
}
|
|
1478
|
-
|
|
1479
|
-
* Triggered when a schedule is created.
|
|
1480
|
-
* @permissionScope Read Calendar - Including PI
|
|
1481
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1482
|
-
* @permissionScope Manage Calendars
|
|
1483
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1484
|
-
* @permissionScope Manage Bookings
|
|
1485
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1486
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1487
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1488
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1489
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1490
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1491
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1492
|
-
* @permissionScope Read bookings calendar - including participants
|
|
1493
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1494
|
-
* @permissionScope Picasso private app mega scope
|
|
1495
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1496
|
-
* @permissionId CALENDAR.SCHEDULE_READ_PI
|
|
1497
|
-
* @webhook
|
|
1498
|
-
* @eventType wix.calendar.v3.schedule_created
|
|
1499
|
-
* @serviceIdentifier wix.calendar.schedules.v3.SchedulesService
|
|
1500
|
-
* @slug created
|
|
1501
|
-
* @documentationMaturity preview
|
|
1502
|
-
*/
|
|
1503
|
-
export declare function onScheduleCreated(handler: (event: ScheduleCreatedEnvelope) => void | Promise<void>): void;
|
|
1504
|
-
export interface ScheduleUpdatedEnvelope {
|
|
1425
|
+
interface ScheduleUpdatedEnvelope {
|
|
1505
1426
|
entity: Schedule;
|
|
1506
1427
|
metadata: EventMetadata;
|
|
1507
1428
|
}
|
|
1508
|
-
|
|
1509
|
-
* Triggered when a schedule is updated.
|
|
1510
|
-
* @permissionScope Read Calendar - Including PI
|
|
1511
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1512
|
-
* @permissionScope Manage Calendars
|
|
1513
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1514
|
-
* @permissionScope Manage Bookings
|
|
1515
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1516
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1517
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1518
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1519
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1520
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1521
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1522
|
-
* @permissionScope Read bookings calendar - including participants
|
|
1523
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1524
|
-
* @permissionScope Picasso private app mega scope
|
|
1525
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1526
|
-
* @permissionId CALENDAR.SCHEDULE_READ_PI
|
|
1527
|
-
* @webhook
|
|
1528
|
-
* @eventType wix.calendar.v3.schedule_updated
|
|
1529
|
-
* @serviceIdentifier wix.calendar.schedules.v3.SchedulesService
|
|
1530
|
-
* @slug updated
|
|
1531
|
-
* @documentationMaturity preview
|
|
1532
|
-
*/
|
|
1533
|
-
export declare function onScheduleUpdated(handler: (event: ScheduleUpdatedEnvelope) => void | Promise<void>): void;
|
|
1534
|
-
type ScheduleNonNullablePaths = `status` | `defaultLocation.type` | `defaultConferencingDetails.type` | `permissions` | `permissions.${number}.identity.wixUserId` | `permissions.${number}.role`;
|
|
1535
|
-
/**
|
|
1536
|
-
* Retrieves a schedule.
|
|
1537
|
-
* @param scheduleId - ID of the schedule to retrieve.
|
|
1538
|
-
* @public
|
|
1539
|
-
* @documentationMaturity preview
|
|
1540
|
-
* @requiredField scheduleId
|
|
1541
|
-
* @permissionId CALENDAR.SCHEDULE_READ
|
|
1542
|
-
* @permissionId CALENDAR.SCHEDULE_READ_PI
|
|
1543
|
-
* @permissionScope Read Bookings - Public Data
|
|
1544
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
1545
|
-
* @permissionScope Read Calendar - Including PI
|
|
1546
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1547
|
-
* @permissionScope Manage Calendars
|
|
1548
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1549
|
-
* @permissionScope Manage Bookings
|
|
1550
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1551
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1552
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1553
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1554
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1555
|
-
* @permissionScope Read Bookings Calendar Availability
|
|
1556
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
|
|
1557
|
-
* @permissionScope Read Calendar
|
|
1558
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
|
|
1559
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1560
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1561
|
-
* @permissionScope Read bookings calendar - including participants
|
|
1562
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1563
|
-
* @permissionScope Read Bookings Calendar
|
|
1564
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
|
|
1565
|
-
* @permissionScope Picasso private app mega scope
|
|
1566
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1567
|
-
* @permissionScope Read Calendar - Including PI
|
|
1568
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1569
|
-
* @permissionScope Manage Calendars
|
|
1570
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1571
|
-
* @permissionScope Manage Bookings
|
|
1572
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1573
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1574
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1575
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1576
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1577
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1578
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1579
|
-
* @permissionScope Read bookings calendar - including participants
|
|
1580
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1581
|
-
* @permissionScope Picasso private app mega scope
|
|
1582
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1583
|
-
* @applicableIdentity APP
|
|
1584
|
-
* @applicableIdentity VISITOR
|
|
1585
|
-
* @returns Retrieved schedule.
|
|
1586
|
-
* @fqn wix.calendar.schedules.v3.SchedulesService.GetSchedule
|
|
1587
|
-
*/
|
|
1588
|
-
export declare function getSchedule(scheduleId: string, options?: GetScheduleOptions): Promise<NonNullablePaths<Schedule, ScheduleNonNullablePaths>>;
|
|
1589
|
-
export interface GetScheduleOptions {
|
|
1429
|
+
interface GetScheduleOptions {
|
|
1590
1430
|
/**
|
|
1591
1431
|
* Information about which fields containing personal data to return. Refer to the
|
|
1592
1432
|
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
|
|
@@ -1602,73 +1442,7 @@ export interface GetScheduleOptions {
|
|
|
1602
1442
|
*/
|
|
1603
1443
|
fields?: RequestedFields[];
|
|
1604
1444
|
}
|
|
1605
|
-
|
|
1606
|
-
* Creates a query to retrieve a list of schedules.
|
|
1607
|
-
*
|
|
1608
|
-
* The `querySchedules()` function builds a query to retrieve a list of tip settings and returns a `SchedulesQueryBuilder` object.
|
|
1609
|
-
*
|
|
1610
|
-
* 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.
|
|
1611
|
-
*
|
|
1612
|
-
* 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.
|
|
1613
|
-
*
|
|
1614
|
-
* `querySchedules()` runs with the following `SchedulesQueryBuilder` default that you can override:
|
|
1615
|
-
*
|
|
1616
|
-
* + `limit` is `50`.
|
|
1617
|
-
* + Sorted by `id` in ascending order.
|
|
1618
|
-
*
|
|
1619
|
-
* 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"`.
|
|
1620
|
-
*
|
|
1621
|
-
* 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`.
|
|
1622
|
-
* @public
|
|
1623
|
-
* @documentationMaturity preview
|
|
1624
|
-
* @permissionScope Read Bookings - Public Data
|
|
1625
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
1626
|
-
* @permissionScope Read Calendar - Including PI
|
|
1627
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1628
|
-
* @permissionScope Manage Calendars
|
|
1629
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1630
|
-
* @permissionScope Manage Bookings
|
|
1631
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1632
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1633
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1634
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1635
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1636
|
-
* @permissionScope Read Bookings Calendar Availability
|
|
1637
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
|
|
1638
|
-
* @permissionScope Read Calendar
|
|
1639
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
|
|
1640
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1641
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1642
|
-
* @permissionScope Read bookings calendar - including participants
|
|
1643
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1644
|
-
* @permissionScope Read Bookings Calendar
|
|
1645
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
|
|
1646
|
-
* @permissionScope Picasso private app mega scope
|
|
1647
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1648
|
-
* @permissionScope Read Calendar - Including PI
|
|
1649
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1650
|
-
* @permissionScope Manage Calendars
|
|
1651
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1652
|
-
* @permissionScope Manage Bookings
|
|
1653
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1654
|
-
* @permissionScope Read Bookings - Including Participants
|
|
1655
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1656
|
-
* @permissionScope Read Bookings - all read permissions
|
|
1657
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1658
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1659
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1660
|
-
* @permissionScope Read bookings calendar - including participants
|
|
1661
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1662
|
-
* @permissionScope Picasso private app mega scope
|
|
1663
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1664
|
-
* @permissionId CALENDAR.SCHEDULE_READ
|
|
1665
|
-
* @permissionId CALENDAR.SCHEDULE_READ_PI
|
|
1666
|
-
* @applicableIdentity APP
|
|
1667
|
-
* @applicableIdentity VISITOR
|
|
1668
|
-
* @fqn wix.calendar.schedules.v3.SchedulesService.QuerySchedules
|
|
1669
|
-
*/
|
|
1670
|
-
export declare function querySchedules(options?: QuerySchedulesOptions): SchedulesQueryBuilder;
|
|
1671
|
-
export interface QuerySchedulesOptions {
|
|
1445
|
+
interface QuerySchedulesOptions {
|
|
1672
1446
|
/**
|
|
1673
1447
|
* Information about which fields containing personal data to return. Refer to the
|
|
1674
1448
|
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
|
|
@@ -1691,13 +1465,13 @@ interface QueryCursorResult {
|
|
|
1691
1465
|
length: number;
|
|
1692
1466
|
pageSize: number;
|
|
1693
1467
|
}
|
|
1694
|
-
|
|
1468
|
+
interface SchedulesQueryResult extends QueryCursorResult {
|
|
1695
1469
|
items: Schedule[];
|
|
1696
1470
|
query: SchedulesQueryBuilder;
|
|
1697
1471
|
next: () => Promise<SchedulesQueryResult>;
|
|
1698
1472
|
prev: () => Promise<SchedulesQueryResult>;
|
|
1699
1473
|
}
|
|
1700
|
-
|
|
1474
|
+
interface SchedulesQueryBuilder {
|
|
1701
1475
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1702
1476
|
* @param value - Value to compare against.
|
|
1703
1477
|
* @documentationMaturity preview
|
|
@@ -1716,39 +1490,7 @@ export interface SchedulesQueryBuilder {
|
|
|
1716
1490
|
/** @documentationMaturity preview */
|
|
1717
1491
|
find: () => Promise<SchedulesQueryResult>;
|
|
1718
1492
|
}
|
|
1719
|
-
|
|
1720
|
-
* Creates a schedule.
|
|
1721
|
-
*
|
|
1722
|
-
*
|
|
1723
|
-
* If you want the schedule's events to appear in the
|
|
1724
|
-
* [Bookings calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar),
|
|
1725
|
-
* you must set `appId` to the ID of the Wix Bookings app by providing
|
|
1726
|
-
* `{"appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97"}`.
|
|
1727
|
-
* @param schedule - Schedule to create.
|
|
1728
|
-
* @public
|
|
1729
|
-
* @documentationMaturity preview
|
|
1730
|
-
* @requiredField schedule
|
|
1731
|
-
* @requiredField schedule.defaultConferencingDetails.guestUrl
|
|
1732
|
-
* @requiredField schedule.defaultConferencingDetails.hostUrl
|
|
1733
|
-
* @requiredField schedule.defaultConferencingDetails.type
|
|
1734
|
-
* @requiredField schedule.defaultLocation.type
|
|
1735
|
-
* @requiredField schedule.permissions.identity
|
|
1736
|
-
* @requiredField schedule.permissions.role
|
|
1737
|
-
* @permissionId CALENDAR.SCHEDULE_CREATE
|
|
1738
|
-
* @permissionScope Manage Calendars
|
|
1739
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1740
|
-
* @permissionScope Manage Bookings
|
|
1741
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1742
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1743
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1744
|
-
* @permissionScope Picasso private app mega scope
|
|
1745
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
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 {
|
|
1493
|
+
interface CreateScheduleOptions {
|
|
1752
1494
|
/**
|
|
1753
1495
|
* Idempotency key guaranteeing that you don't create the same schedule more
|
|
1754
1496
|
* than once.
|
|
@@ -1756,38 +1498,7 @@ export interface CreateScheduleOptions {
|
|
|
1756
1498
|
*/
|
|
1757
1499
|
idempotencyKey?: string | null;
|
|
1758
1500
|
}
|
|
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
|
-
* @documentationMaturity preview
|
|
1771
|
-
* @requiredField _id
|
|
1772
|
-
* @requiredField schedule
|
|
1773
|
-
* @requiredField schedule.permissions.identity
|
|
1774
|
-
* @requiredField schedule.permissions.role
|
|
1775
|
-
* @requiredField schedule.revision
|
|
1776
|
-
* @permissionId CALENDAR.SCHEDULE_UPDATE
|
|
1777
|
-
* @permissionScope Manage Calendars
|
|
1778
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1779
|
-
* @permissionScope Manage Bookings
|
|
1780
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1781
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1782
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1783
|
-
* @permissionScope Picasso private app mega scope
|
|
1784
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1785
|
-
* @applicableIdentity APP
|
|
1786
|
-
* @returns Updated schedule.
|
|
1787
|
-
* @fqn wix.calendar.schedules.v3.SchedulesService.UpdateSchedule
|
|
1788
|
-
*/
|
|
1789
|
-
export declare function updateSchedule(_id: string, schedule: NonNullablePaths<UpdateSchedule, `permissions.${number}.identity` | `permissions.${number}.role` | `revision`>, options?: UpdateScheduleOptions): Promise<NonNullablePaths<Schedule, ScheduleNonNullablePaths>>;
|
|
1790
|
-
export interface UpdateSchedule {
|
|
1501
|
+
interface UpdateSchedule {
|
|
1791
1502
|
/**
|
|
1792
1503
|
* Schedule ID.
|
|
1793
1504
|
* @format GUID
|
|
@@ -1912,41 +1623,14 @@ export interface UpdateSchedule {
|
|
|
1912
1623
|
*/
|
|
1913
1624
|
_updatedDate?: Date | null;
|
|
1914
1625
|
}
|
|
1915
|
-
|
|
1626
|
+
interface UpdateScheduleOptions {
|
|
1916
1627
|
/**
|
|
1917
1628
|
* Information about whether participants of the schedule's updated events are
|
|
1918
1629
|
* notified and the message they receive.
|
|
1919
1630
|
*/
|
|
1920
1631
|
participantNotification?: ParticipantNotification;
|
|
1921
1632
|
}
|
|
1922
|
-
|
|
1923
|
-
* Sets a schedule's `status` to `CANCELLED`.
|
|
1924
|
-
*
|
|
1925
|
-
*
|
|
1926
|
-
* Also cancels future events belonging to the schedule.
|
|
1927
|
-
*
|
|
1928
|
-
* Once a schedule is marked as `CANCELLED`, you can't reactivate it, update it,
|
|
1929
|
-
* or assign new events.
|
|
1930
|
-
* @param scheduleId - ID of the schedule to cancel.
|
|
1931
|
-
* @public
|
|
1932
|
-
* @documentationMaturity preview
|
|
1933
|
-
* @requiredField scheduleId
|
|
1934
|
-
* @permissionId CALENDAR.SCHEDULE_CANCEL
|
|
1935
|
-
* @permissionScope Manage Calendars
|
|
1936
|
-
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1937
|
-
* @permissionScope Manage Bookings
|
|
1938
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1939
|
-
* @permissionScope Manage Bookings - all permissions
|
|
1940
|
-
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1941
|
-
* @permissionScope Picasso private app mega scope
|
|
1942
|
-
* @permissionScopeId SCOPE.TEST.MEGA-PICASSO-MANAGE-SITE
|
|
1943
|
-
* @applicableIdentity APP
|
|
1944
|
-
* @fqn wix.calendar.schedules.v3.SchedulesService.CancelSchedule
|
|
1945
|
-
*/
|
|
1946
|
-
export declare function cancelSchedule(scheduleId: string, options?: CancelScheduleOptions): Promise<NonNullablePaths<CancelScheduleResponse, {
|
|
1947
|
-
[P in ScheduleNonNullablePaths]: `schedule.${P}`;
|
|
1948
|
-
}[ScheduleNonNullablePaths]>>;
|
|
1949
|
-
export interface CancelScheduleOptions {
|
|
1633
|
+
interface CancelScheduleOptions {
|
|
1950
1634
|
/**
|
|
1951
1635
|
* Whether to preserve future events with participants.
|
|
1952
1636
|
* Default: `false`.
|
|
@@ -1958,4 +1642,5 @@ export interface CancelScheduleOptions {
|
|
|
1958
1642
|
*/
|
|
1959
1643
|
participantNotification?: ParticipantNotification;
|
|
1960
1644
|
}
|
|
1961
|
-
|
|
1645
|
+
|
|
1646
|
+
export { type SiteCreated as $, type CreateScheduleResponse as A, type UpdateScheduleRequest as B, type CreateScheduleOptions as C, DeleteStatus as D, type ExtendedFields as E, type ParticipantNotification as F, type GetScheduleOptions as G, type UpdateScheduleResponse as H, IdentityType as I, type ScheduleUpdatedWithMetadata as J, type CloneScheduleRequest as K, LocationType as L, type CloneScheduleResponse as M, Namespace as N, type ScheduleCloned as O, PlacementType as P, type QuerySchedulesOptions as Q, Role as R, type Schedule as S, Type as T, type UpdateSchedule as U, type CancelScheduleRequest as V, WebhookIdentityType as W, type ScheduleCancelled as X, type MetaSiteSpecialEvent as Y, type MetaSiteSpecialEventPayloadOneOf as Z, type Asset as _, type SchedulesQueryBuilder as a, type SiteTransferred as a0, type SiteDeleted as a1, type DeleteContext as a2, type SiteUndeleted as a3, type SitePublished as a4, type SiteUnpublished as a5, type SiteMarkedAsTemplate as a6, type SiteMarkedAsWixSite as a7, type ServiceProvisioned as a8, type ServiceRemoved as a9, type V4SiteCreated as aA, type SiteCloned as aB, type DomainEvent as aC, type DomainEventBodyOneOf as aD, type EntityCreatedEvent as aE, type RestoreInfo as aF, type EntityUpdatedEvent as aG, type EntityDeletedEvent as aH, type ActionEvent as aI, type MessageEnvelope as aJ, type IdentificationData as aK, type IdentificationDataIdOneOf as aL, type BaseEventMetadata as aM, type EventMetadata as aN, type ScheduleCancelledEnvelope as aO, type ScheduleClonedEnvelope as aP, type ScheduleCreatedEnvelope as aQ, type ScheduleUpdatedEnvelope as aR, type SchedulesQueryResult as aS, type SiteRenamed as aa, type SiteHardDeleted as ab, type NamespaceChanged as ac, type StudioAssigned as ad, type StudioUnassigned as ae, type SiteUrlChanged as af, type SitePurgedExternally as ag, type Empty as ah, type SitePropertiesNotification as ai, type SitePropertiesEvent as aj, type Properties as ak, type Categories as al, type Locale as am, type Address as an, type AddressHint as ao, type GeoCoordinates as ap, type BusinessSchedule as aq, type TimePeriod as ar, type SpecialHourPeriod as as, type Multilingual as at, type SupportedLanguage as au, type ConsentPolicy as av, type Translation as aw, type ChangeContext as ax, type ChangeContextPayloadOneOf as ay, type PropertiesChange as az, type UpdateScheduleOptions as b, type CancelScheduleOptions as c, type CancelScheduleResponse as d, Status as e, RequestedFields as f, Trigger as g, State as h, SiteCreatedContext as i, DayOfWeek as j, ResolutionMethod as k, type Location as l, type ConferencingDetails as m, type Permission as n, type CommonIdentificationData as o, type CommonIdentificationDataIdOneOf as p, type GetScheduleRequest as q, type GetScheduleResponse as r, type QuerySchedulesRequest as s, type CursorQuery as t, type CursorQueryPagingMethodOneOf as u, type CursorPaging as v, type QuerySchedulesResponse as w, type CursorPagingMetadata as x, type Cursors as y, type CreateScheduleRequest as z };
|