@wix/auto_sdk_calendar_schedules 1.0.34 → 1.0.36
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/calendar-v3-schedule-schedules.context.d.ts +30 -0
- package/build/cjs/src/calendar-v3-schedule-schedules.context.js +48 -0
- package/build/cjs/src/calendar-v3-schedule-schedules.context.js.map +1 -0
- package/build/cjs/src/calendar-v3-schedule-schedules.http.d.ts +53 -0
- package/build/cjs/src/calendar-v3-schedule-schedules.http.js +255 -0
- package/build/cjs/src/calendar-v3-schedule-schedules.http.js.map +1 -0
- package/build/cjs/src/calendar-v3-schedule-schedules.meta.d.ts +23 -0
- package/build/cjs/src/calendar-v3-schedule-schedules.meta.js +123 -0
- package/build/cjs/src/calendar-v3-schedule-schedules.meta.js.map +1 -0
- package/build/cjs/src/calendar-v3-schedule-schedules.public.d.ts +86 -0
- package/build/cjs/src/calendar-v3-schedule-schedules.public.js +96 -0
- package/build/cjs/src/calendar-v3-schedule-schedules.public.js.map +1 -0
- package/build/cjs/src/calendar-v3-schedule-schedules.types.d.ts +1390 -0
- package/build/cjs/src/calendar-v3-schedule-schedules.types.js +208 -0
- package/build/cjs/src/calendar-v3-schedule-schedules.types.js.map +1 -0
- package/build/{calendar-v3-schedule-schedules.universal-D3nvGK6W.d.mts → cjs/src/calendar-v3-schedule-schedules.universal.d.ts} +432 -111
- package/build/cjs/src/calendar-v3-schedule-schedules.universal.js +582 -0
- package/build/cjs/src/calendar-v3-schedule-schedules.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/package.json +3 -0
- package/build/es/src/calendar-v3-schedule-schedules.context.d.ts +30 -0
- package/build/es/src/calendar-v3-schedule-schedules.context.js +30 -0
- package/build/es/src/calendar-v3-schedule-schedules.context.js.map +1 -0
- package/build/es/src/calendar-v3-schedule-schedules.http.d.ts +53 -0
- package/build/es/src/calendar-v3-schedule-schedules.http.js +247 -0
- package/build/es/src/calendar-v3-schedule-schedules.http.js.map +1 -0
- package/build/es/src/calendar-v3-schedule-schedules.meta.d.ts +23 -0
- package/build/es/src/calendar-v3-schedule-schedules.meta.js +92 -0
- package/build/es/src/calendar-v3-schedule-schedules.meta.js.map +1 -0
- package/build/es/src/calendar-v3-schedule-schedules.public.d.ts +86 -0
- package/build/es/src/calendar-v3-schedule-schedules.public.js +73 -0
- package/build/es/src/calendar-v3-schedule-schedules.public.js.map +1 -0
- package/build/es/src/calendar-v3-schedule-schedules.types.d.ts +1390 -0
- package/build/es/src/calendar-v3-schedule-schedules.types.js +205 -0
- package/build/es/src/calendar-v3-schedule-schedules.types.js.map +1 -0
- package/build/{calendar-v3-schedule-schedules.universal-D3nvGK6W.d.ts → es/src/calendar-v3-schedule-schedules.universal.d.ts} +432 -111
- package/build/es/src/calendar-v3-schedule-schedules.universal.js +551 -0
- package/build/es/src/calendar-v3-schedule-schedules.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.context.d.ts +30 -0
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.context.js +48 -0
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.context.js.map +1 -0
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.http.d.ts +53 -0
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.http.js +255 -0
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.http.js.map +1 -0
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.meta.d.ts +23 -0
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.meta.js +123 -0
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.meta.js.map +1 -0
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.public.d.ts +86 -0
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.public.js +96 -0
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.public.js.map +1 -0
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.types.d.ts +1390 -0
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.types.js +208 -0
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.types.js.map +1 -0
- package/build/internal/{calendar-v3-schedule-schedules.universal-D3nvGK6W.d.mts → cjs/src/calendar-v3-schedule-schedules.universal.d.ts} +432 -111
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.universal.js +582 -0
- package/build/internal/cjs/src/calendar-v3-schedule-schedules.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/calendar-v3-schedule-schedules.context.d.ts +30 -0
- package/build/internal/es/src/calendar-v3-schedule-schedules.context.js +30 -0
- package/build/internal/es/src/calendar-v3-schedule-schedules.context.js.map +1 -0
- package/build/internal/es/src/calendar-v3-schedule-schedules.http.d.ts +53 -0
- package/build/internal/es/src/calendar-v3-schedule-schedules.http.js +247 -0
- package/build/internal/es/src/calendar-v3-schedule-schedules.http.js.map +1 -0
- package/build/internal/es/src/calendar-v3-schedule-schedules.meta.d.ts +23 -0
- package/build/internal/es/src/calendar-v3-schedule-schedules.meta.js +92 -0
- package/build/internal/es/src/calendar-v3-schedule-schedules.meta.js.map +1 -0
- package/build/internal/es/src/calendar-v3-schedule-schedules.public.d.ts +86 -0
- package/build/internal/es/src/calendar-v3-schedule-schedules.public.js +73 -0
- package/build/internal/es/src/calendar-v3-schedule-schedules.public.js.map +1 -0
- package/build/internal/es/src/calendar-v3-schedule-schedules.types.d.ts +1390 -0
- package/build/internal/es/src/calendar-v3-schedule-schedules.types.js +205 -0
- package/build/internal/es/src/calendar-v3-schedule-schedules.types.js.map +1 -0
- package/build/internal/{calendar-v3-schedule-schedules.universal-D3nvGK6W.d.ts → es/src/calendar-v3-schedule-schedules.universal.d.ts} +432 -111
- package/build/internal/es/src/calendar-v3-schedule-schedules.universal.js +551 -0
- package/build/internal/es/src/calendar-v3-schedule-schedules.universal.js.map +1 -0
- package/package.json +13 -14
- package/build/index.d.mts +0 -105
- package/build/index.d.ts +0 -105
- package/build/index.js +0 -700
- package/build/index.js.map +0 -1
- package/build/index.mjs +0 -653
- package/build/index.mjs.map +0 -1
- package/build/internal/index.d.mts +0 -105
- package/build/internal/index.d.ts +0 -105
- package/build/internal/index.js +0 -700
- package/build/internal/index.js.map +0 -1
- package/build/internal/index.mjs +0 -653
- package/build/internal/index.mjs.map +0 -1
- package/build/internal/meta.d.mts +0 -487
- package/build/internal/meta.d.ts +0 -487
- package/build/internal/meta.js +0 -331
- package/build/internal/meta.js.map +0 -1
- package/build/internal/meta.mjs +0 -300
- package/build/internal/meta.mjs.map +0 -1
- package/build/meta.d.mts +0 -487
- package/build/meta.d.ts +0 -487
- package/build/meta.js +0 -331
- package/build/meta.js.map +0 -1
- package/build/meta.mjs +0 -300
- package/build/meta.mjs.map +0 -1
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { NonNullablePaths } from '@wix/sdk-types';
|
|
1
2
|
/**
|
|
2
3
|
* A collection of [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
|
|
3
4
|
* associated with a specific entity, such as a
|
|
@@ -6,7 +7,7 @@
|
|
|
6
7
|
* Schedules can also serve as templates for the events they manage, setting
|
|
7
8
|
* default values like a default location.
|
|
8
9
|
*/
|
|
9
|
-
interface Schedule {
|
|
10
|
+
export interface Schedule {
|
|
10
11
|
/**
|
|
11
12
|
* Schedule ID.
|
|
12
13
|
* @format GUID
|
|
@@ -131,14 +132,14 @@ interface Schedule {
|
|
|
131
132
|
*/
|
|
132
133
|
_updatedDate?: Date | null;
|
|
133
134
|
}
|
|
134
|
-
declare enum Status {
|
|
135
|
+
export declare enum Status {
|
|
135
136
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
136
137
|
/** You can add events to the schedule or update its fields. */
|
|
137
138
|
ACTIVE = "ACTIVE",
|
|
138
139
|
/** You can't add events to the schedule or update its fields. */
|
|
139
140
|
CANCELLED = "CANCELLED"
|
|
140
141
|
}
|
|
141
|
-
interface Location {
|
|
142
|
+
export interface Location {
|
|
142
143
|
/**
|
|
143
144
|
* [Location](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction)
|
|
144
145
|
* ID. Available only for `BUSINESS` locations.
|
|
@@ -174,7 +175,7 @@ interface Location {
|
|
|
174
175
|
*/
|
|
175
176
|
address?: string | null;
|
|
176
177
|
}
|
|
177
|
-
declare enum LocationType {
|
|
178
|
+
export declare enum LocationType {
|
|
178
179
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
179
180
|
/** The event is held at a business location. */
|
|
180
181
|
BUSINESS = "BUSINESS",
|
|
@@ -183,7 +184,7 @@ declare enum LocationType {
|
|
|
183
184
|
/** The event is held at an address or venue not tied to the business or customer. */
|
|
184
185
|
CUSTOM = "CUSTOM"
|
|
185
186
|
}
|
|
186
|
-
interface ConferencingDetails {
|
|
187
|
+
export interface ConferencingDetails {
|
|
187
188
|
/** Conference type. For example, `Zoom`. */
|
|
188
189
|
type?: Type;
|
|
189
190
|
/**
|
|
@@ -223,12 +224,12 @@ interface ConferencingDetails {
|
|
|
223
224
|
*/
|
|
224
225
|
externalId?: string | null;
|
|
225
226
|
}
|
|
226
|
-
declare enum Type {
|
|
227
|
+
export declare enum Type {
|
|
227
228
|
UNKNOWN_TYPE = "UNKNOWN_TYPE",
|
|
228
229
|
ZOOM = "ZOOM",
|
|
229
230
|
CUSTOM = "CUSTOM"
|
|
230
231
|
}
|
|
231
|
-
interface Permission {
|
|
232
|
+
export interface Permission {
|
|
232
233
|
/**
|
|
233
234
|
* [Wix user](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-users)
|
|
234
235
|
* granted the permission.
|
|
@@ -243,7 +244,7 @@ interface Permission {
|
|
|
243
244
|
*/
|
|
244
245
|
role?: Role;
|
|
245
246
|
}
|
|
246
|
-
interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
|
|
247
|
+
export interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
|
|
247
248
|
/**
|
|
248
249
|
* ID of a Wix user. For example, the site owner or a
|
|
249
250
|
* [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
|
|
@@ -252,7 +253,7 @@ interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
|
|
|
252
253
|
wixUserId?: string;
|
|
253
254
|
}
|
|
254
255
|
/** @oneof */
|
|
255
|
-
interface CommonIdentificationDataIdOneOf {
|
|
256
|
+
export interface CommonIdentificationDataIdOneOf {
|
|
256
257
|
/**
|
|
257
258
|
* ID of a Wix user. For example, the site owner or a
|
|
258
259
|
* [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
|
|
@@ -260,18 +261,18 @@ interface CommonIdentificationDataIdOneOf {
|
|
|
260
261
|
*/
|
|
261
262
|
wixUserId?: string;
|
|
262
263
|
}
|
|
263
|
-
declare enum IdentityType {
|
|
264
|
+
export declare enum IdentityType {
|
|
264
265
|
UNKNOWN = "UNKNOWN",
|
|
265
266
|
WIX_USER = "WIX_USER"
|
|
266
267
|
}
|
|
267
|
-
declare enum Role {
|
|
268
|
+
export declare enum Role {
|
|
268
269
|
UNKNOWN_ROLE = "UNKNOWN_ROLE",
|
|
269
270
|
/** Full read and write access. */
|
|
270
271
|
WRITER = "WRITER",
|
|
271
272
|
/** Full read access, write access limited to `event.notes`. */
|
|
272
273
|
COMMENTER = "COMMENTER"
|
|
273
274
|
}
|
|
274
|
-
interface ExtendedFields {
|
|
275
|
+
export interface ExtendedFields {
|
|
275
276
|
/**
|
|
276
277
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
277
278
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -282,7 +283,7 @@ interface ExtendedFields {
|
|
|
282
283
|
*/
|
|
283
284
|
namespaces?: Record<string, Record<string, any>>;
|
|
284
285
|
}
|
|
285
|
-
interface GetScheduleRequest {
|
|
286
|
+
export interface GetScheduleRequest {
|
|
286
287
|
/**
|
|
287
288
|
* ID of the schedule to retrieve.
|
|
288
289
|
* @format GUID
|
|
@@ -303,18 +304,18 @@ interface GetScheduleRequest {
|
|
|
303
304
|
*/
|
|
304
305
|
fields?: RequestedFields[];
|
|
305
306
|
}
|
|
306
|
-
declare enum RequestedFields {
|
|
307
|
+
export declare enum RequestedFields {
|
|
307
308
|
UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
|
|
308
309
|
/** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
|
|
309
310
|
PI_FIELDS = "PI_FIELDS",
|
|
310
311
|
/** Returns only fields containing your own personal data. */
|
|
311
312
|
OWN_PI_FIELDS = "OWN_PI_FIELDS"
|
|
312
313
|
}
|
|
313
|
-
interface GetScheduleResponse {
|
|
314
|
+
export interface GetScheduleResponse {
|
|
314
315
|
/** Retrieved schedule. */
|
|
315
316
|
schedule?: Schedule;
|
|
316
317
|
}
|
|
317
|
-
interface QuerySchedulesRequest {
|
|
318
|
+
export interface QuerySchedulesRequest {
|
|
318
319
|
/** Query containing filters and paging. */
|
|
319
320
|
query?: CursorQuery;
|
|
320
321
|
/**
|
|
@@ -333,7 +334,7 @@ interface QuerySchedulesRequest {
|
|
|
333
334
|
fields?: RequestedFields[];
|
|
334
335
|
}
|
|
335
336
|
/** TODO Diverge */
|
|
336
|
-
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
337
|
+
export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
337
338
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
338
339
|
cursorPaging?: CursorPaging;
|
|
339
340
|
/**
|
|
@@ -348,12 +349,12 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
348
349
|
filter?: Record<string, any> | null;
|
|
349
350
|
}
|
|
350
351
|
/** @oneof */
|
|
351
|
-
interface CursorQueryPagingMethodOneOf {
|
|
352
|
+
export interface CursorQueryPagingMethodOneOf {
|
|
352
353
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
|
|
353
354
|
cursorPaging?: CursorPaging;
|
|
354
355
|
}
|
|
355
356
|
/** TODO Diverge */
|
|
356
|
-
interface CursorPaging {
|
|
357
|
+
export interface CursorPaging {
|
|
357
358
|
/**
|
|
358
359
|
* Number of schedules to return.
|
|
359
360
|
*
|
|
@@ -373,14 +374,14 @@ interface CursorPaging {
|
|
|
373
374
|
*/
|
|
374
375
|
cursor?: string | null;
|
|
375
376
|
}
|
|
376
|
-
interface QuerySchedulesResponse {
|
|
377
|
+
export interface QuerySchedulesResponse {
|
|
377
378
|
/** Retrieved schedules matching the provided query. */
|
|
378
379
|
schedules?: Schedule[];
|
|
379
380
|
/** Paging metadata. */
|
|
380
381
|
pagingMetadata?: CursorPagingMetadata;
|
|
381
382
|
}
|
|
382
383
|
/** TODO Diverge */
|
|
383
|
-
interface CursorPagingMetadata {
|
|
384
|
+
export interface CursorPagingMetadata {
|
|
384
385
|
/** Number of schedules returned in the current page of the response. */
|
|
385
386
|
count?: number | null;
|
|
386
387
|
/** 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). */
|
|
@@ -392,13 +393,13 @@ interface CursorPagingMetadata {
|
|
|
392
393
|
*/
|
|
393
394
|
hasNext?: boolean | null;
|
|
394
395
|
}
|
|
395
|
-
interface Cursors {
|
|
396
|
+
export interface Cursors {
|
|
396
397
|
/** Cursor pointing to next page in the list of results. */
|
|
397
398
|
next?: string | null;
|
|
398
399
|
/** Cursor pointing to previous page in the list of results. */
|
|
399
400
|
prev?: string | null;
|
|
400
401
|
}
|
|
401
|
-
interface CreateScheduleRequest {
|
|
402
|
+
export interface CreateScheduleRequest {
|
|
402
403
|
/** Schedule to create. */
|
|
403
404
|
schedule: Schedule;
|
|
404
405
|
/**
|
|
@@ -408,11 +409,11 @@ interface CreateScheduleRequest {
|
|
|
408
409
|
*/
|
|
409
410
|
idempotencyKey?: string | null;
|
|
410
411
|
}
|
|
411
|
-
interface CreateScheduleResponse {
|
|
412
|
+
export interface CreateScheduleResponse {
|
|
412
413
|
/** Created schedule. */
|
|
413
414
|
schedule?: Schedule;
|
|
414
415
|
}
|
|
415
|
-
interface UpdateScheduleRequest {
|
|
416
|
+
export interface UpdateScheduleRequest {
|
|
416
417
|
/** Schedule to update. */
|
|
417
418
|
schedule: Schedule;
|
|
418
419
|
/**
|
|
@@ -421,7 +422,7 @@ interface UpdateScheduleRequest {
|
|
|
421
422
|
*/
|
|
422
423
|
participantNotification?: ParticipantNotification;
|
|
423
424
|
}
|
|
424
|
-
interface ParticipantNotification {
|
|
425
|
+
export interface ParticipantNotification {
|
|
425
426
|
/**
|
|
426
427
|
* Whether to notify the participants about changes made to the schedule or event.
|
|
427
428
|
*
|
|
@@ -438,18 +439,18 @@ interface ParticipantNotification {
|
|
|
438
439
|
*/
|
|
439
440
|
message?: string | null;
|
|
440
441
|
}
|
|
441
|
-
interface UpdateScheduleResponse {
|
|
442
|
+
export interface UpdateScheduleResponse {
|
|
442
443
|
/** Updated schedule. */
|
|
443
444
|
schedule?: Schedule;
|
|
444
445
|
}
|
|
445
446
|
/** `PRIVATE` until we'll have standard events metadata from Infra. */
|
|
446
|
-
interface ScheduleUpdatedWithMetadata {
|
|
447
|
+
export interface ScheduleUpdatedWithMetadata {
|
|
447
448
|
/** The updated schedule. */
|
|
448
449
|
schedule?: Schedule;
|
|
449
450
|
/** Whether to notify participants regarding the changes. */
|
|
450
451
|
participantNotification?: ParticipantNotification;
|
|
451
452
|
}
|
|
452
|
-
interface CloneScheduleRequest {
|
|
453
|
+
export interface CloneScheduleRequest {
|
|
453
454
|
/**
|
|
454
455
|
* ID of the schedule to clone.
|
|
455
456
|
* @format GUID
|
|
@@ -458,11 +459,11 @@ interface CloneScheduleRequest {
|
|
|
458
459
|
/** Fields to override in the cloned schedule. */
|
|
459
460
|
schedule?: Schedule;
|
|
460
461
|
}
|
|
461
|
-
interface CloneScheduleResponse {
|
|
462
|
+
export interface CloneScheduleResponse {
|
|
462
463
|
/** Cloned schedule. */
|
|
463
464
|
schedule?: Schedule;
|
|
464
465
|
}
|
|
465
|
-
interface ScheduleCloned {
|
|
466
|
+
export interface ScheduleCloned {
|
|
466
467
|
/** New cloned schedule. */
|
|
467
468
|
schedule?: Schedule;
|
|
468
469
|
/** The clone trigger. */
|
|
@@ -478,7 +479,7 @@ interface ScheduleCloned {
|
|
|
478
479
|
*/
|
|
479
480
|
originalScheduleId?: string | null;
|
|
480
481
|
}
|
|
481
|
-
declare enum Trigger {
|
|
482
|
+
export declare enum Trigger {
|
|
482
483
|
/** Schedule cloned using the `CloneSchedule` API. */
|
|
483
484
|
SCHEDULE_CLONED = "SCHEDULE_CLONED",
|
|
484
485
|
/** Site duplicated from the same account. */
|
|
@@ -490,7 +491,7 @@ declare enum Trigger {
|
|
|
490
491
|
/** Other. */
|
|
491
492
|
OTHER = "OTHER"
|
|
492
493
|
}
|
|
493
|
-
interface CancelScheduleRequest {
|
|
494
|
+
export interface CancelScheduleRequest {
|
|
494
495
|
/**
|
|
495
496
|
* ID of the schedule to cancel.
|
|
496
497
|
* @format GUID
|
|
@@ -507,17 +508,17 @@ interface CancelScheduleRequest {
|
|
|
507
508
|
*/
|
|
508
509
|
participantNotification?: ParticipantNotification;
|
|
509
510
|
}
|
|
510
|
-
interface CancelScheduleResponse {
|
|
511
|
+
export interface CancelScheduleResponse {
|
|
511
512
|
/** Canceled schedule. */
|
|
512
513
|
schedule?: Schedule;
|
|
513
514
|
}
|
|
514
|
-
interface ScheduleCancelled {
|
|
515
|
+
export interface ScheduleCancelled {
|
|
515
516
|
/** Canceled schedule. */
|
|
516
517
|
schedule?: Schedule;
|
|
517
518
|
/** Whether future events with participants were preserved. */
|
|
518
519
|
preserveFutureEventsWithParticipants?: boolean | null;
|
|
519
520
|
}
|
|
520
|
-
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
521
|
+
export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
521
522
|
/** Emitted on a meta site creation. */
|
|
522
523
|
siteCreated?: SiteCreated;
|
|
523
524
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -558,6 +559,14 @@ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
558
559
|
urlChanged?: SiteUrlChanged;
|
|
559
560
|
/** Site is marked as PurgedExternally */
|
|
560
561
|
sitePurgedExternally?: SitePurgedExternally;
|
|
562
|
+
/** Emitted when Odeditor is attached. */
|
|
563
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
564
|
+
/** Emitted when Odeditor is detached. */
|
|
565
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
566
|
+
/** Emitted when Picasso is attached. */
|
|
567
|
+
picassoAssigned?: PicassoAssigned;
|
|
568
|
+
/** Emitted when Picasso is detached. */
|
|
569
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
561
570
|
/**
|
|
562
571
|
* A meta site id.
|
|
563
572
|
* @format GUID
|
|
@@ -575,7 +584,7 @@ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
575
584
|
assets?: Asset[];
|
|
576
585
|
}
|
|
577
586
|
/** @oneof */
|
|
578
|
-
interface MetaSiteSpecialEventPayloadOneOf {
|
|
587
|
+
export interface MetaSiteSpecialEventPayloadOneOf {
|
|
579
588
|
/** Emitted on a meta site creation. */
|
|
580
589
|
siteCreated?: SiteCreated;
|
|
581
590
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -616,8 +625,16 @@ interface MetaSiteSpecialEventPayloadOneOf {
|
|
|
616
625
|
urlChanged?: SiteUrlChanged;
|
|
617
626
|
/** Site is marked as PurgedExternally */
|
|
618
627
|
sitePurgedExternally?: SitePurgedExternally;
|
|
628
|
+
/** Emitted when Odeditor is attached. */
|
|
629
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
630
|
+
/** Emitted when Odeditor is detached. */
|
|
631
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
632
|
+
/** Emitted when Picasso is attached. */
|
|
633
|
+
picassoAssigned?: PicassoAssigned;
|
|
634
|
+
/** Emitted when Picasso is detached. */
|
|
635
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
619
636
|
}
|
|
620
|
-
interface Asset {
|
|
637
|
+
export interface Asset {
|
|
621
638
|
/**
|
|
622
639
|
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
623
640
|
* @maxLength 36
|
|
@@ -631,14 +648,14 @@ interface Asset {
|
|
|
631
648
|
/** An application state. */
|
|
632
649
|
state?: State;
|
|
633
650
|
}
|
|
634
|
-
declare enum State {
|
|
651
|
+
export declare enum State {
|
|
635
652
|
UNKNOWN = "UNKNOWN",
|
|
636
653
|
ENABLED = "ENABLED",
|
|
637
654
|
DISABLED = "DISABLED",
|
|
638
655
|
PENDING = "PENDING",
|
|
639
656
|
DEMO = "DEMO"
|
|
640
657
|
}
|
|
641
|
-
interface SiteCreated {
|
|
658
|
+
export interface SiteCreated {
|
|
642
659
|
/**
|
|
643
660
|
* A template identifier (empty if not created from a template).
|
|
644
661
|
* @maxLength 36
|
|
@@ -667,7 +684,7 @@ interface SiteCreated {
|
|
|
667
684
|
/** A namespace. */
|
|
668
685
|
namespace?: Namespace;
|
|
669
686
|
}
|
|
670
|
-
declare enum SiteCreatedContext {
|
|
687
|
+
export declare enum SiteCreatedContext {
|
|
671
688
|
/** A valid option, we don't expose all reasons why site might be created. */
|
|
672
689
|
OTHER = "OTHER",
|
|
673
690
|
/** A meta site was created from template. */
|
|
@@ -681,7 +698,7 @@ declare enum SiteCreatedContext {
|
|
|
681
698
|
/** deprecated A meta site was created for Flash editor. */
|
|
682
699
|
FLASH = "FLASH"
|
|
683
700
|
}
|
|
684
|
-
declare enum Namespace {
|
|
701
|
+
export declare enum Namespace {
|
|
685
702
|
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
686
703
|
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
687
704
|
WIX = "WIX",
|
|
@@ -764,7 +781,7 @@ declare enum Namespace {
|
|
|
764
781
|
MIMIR = "MIMIR"
|
|
765
782
|
}
|
|
766
783
|
/** Site transferred to another user. */
|
|
767
|
-
interface SiteTransferred {
|
|
784
|
+
export interface SiteTransferred {
|
|
768
785
|
/**
|
|
769
786
|
* A previous owner id (user that transfers meta site).
|
|
770
787
|
* @format GUID
|
|
@@ -777,11 +794,11 @@ interface SiteTransferred {
|
|
|
777
794
|
newOwnerId?: string;
|
|
778
795
|
}
|
|
779
796
|
/** Soft deletion of the meta site. Could be restored. */
|
|
780
|
-
interface SiteDeleted {
|
|
797
|
+
export interface SiteDeleted {
|
|
781
798
|
/** A deletion context. */
|
|
782
799
|
deleteContext?: DeleteContext;
|
|
783
800
|
}
|
|
784
|
-
interface DeleteContext {
|
|
801
|
+
export interface DeleteContext {
|
|
785
802
|
/** When the meta site was deleted. */
|
|
786
803
|
dateDeleted?: Date | null;
|
|
787
804
|
/** A status. */
|
|
@@ -797,7 +814,7 @@ interface DeleteContext {
|
|
|
797
814
|
*/
|
|
798
815
|
initiatorId?: string | null;
|
|
799
816
|
}
|
|
800
|
-
declare enum DeleteStatus {
|
|
817
|
+
export declare enum DeleteStatus {
|
|
801
818
|
UNKNOWN = "UNKNOWN",
|
|
802
819
|
TRASH = "TRASH",
|
|
803
820
|
DELETED = "DELETED",
|
|
@@ -805,12 +822,12 @@ declare enum DeleteStatus {
|
|
|
805
822
|
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
806
823
|
}
|
|
807
824
|
/** Restoration of the meta site. */
|
|
808
|
-
interface SiteUndeleted {
|
|
825
|
+
export interface SiteUndeleted {
|
|
809
826
|
}
|
|
810
827
|
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
811
|
-
interface SitePublished {
|
|
828
|
+
export interface SitePublished {
|
|
812
829
|
}
|
|
813
|
-
interface SiteUnpublished {
|
|
830
|
+
export interface SiteUnpublished {
|
|
814
831
|
/**
|
|
815
832
|
* A list of URLs previously associated with the meta site.
|
|
816
833
|
* @maxLength 4000
|
|
@@ -818,9 +835,9 @@ interface SiteUnpublished {
|
|
|
818
835
|
*/
|
|
819
836
|
urls?: string[];
|
|
820
837
|
}
|
|
821
|
-
interface SiteMarkedAsTemplate {
|
|
838
|
+
export interface SiteMarkedAsTemplate {
|
|
822
839
|
}
|
|
823
|
-
interface SiteMarkedAsWixSite {
|
|
840
|
+
export interface SiteMarkedAsWixSite {
|
|
824
841
|
}
|
|
825
842
|
/**
|
|
826
843
|
* Represents a service provisioned a site.
|
|
@@ -837,7 +854,7 @@ interface SiteMarkedAsWixSite {
|
|
|
837
854
|
* changes made to the original template afterward.
|
|
838
855
|
* To ensure this, the TPA on the template gets a new instance_id.
|
|
839
856
|
*/
|
|
840
|
-
interface ServiceProvisioned {
|
|
857
|
+
export interface ServiceProvisioned {
|
|
841
858
|
/**
|
|
842
859
|
* Either UUID or EmbeddedServiceType.
|
|
843
860
|
* @maxLength 36
|
|
@@ -864,7 +881,7 @@ interface ServiceProvisioned {
|
|
|
864
881
|
*/
|
|
865
882
|
originMetaSiteId?: string | null;
|
|
866
883
|
}
|
|
867
|
-
interface ServiceRemoved {
|
|
884
|
+
export interface ServiceRemoved {
|
|
868
885
|
/**
|
|
869
886
|
* Either UUID or EmbeddedServiceType.
|
|
870
887
|
* @maxLength 36
|
|
@@ -882,7 +899,7 @@ interface ServiceRemoved {
|
|
|
882
899
|
version?: string | null;
|
|
883
900
|
}
|
|
884
901
|
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
885
|
-
interface SiteRenamed {
|
|
902
|
+
export interface SiteRenamed {
|
|
886
903
|
/**
|
|
887
904
|
* A new meta site name (URL slug).
|
|
888
905
|
* @maxLength 20
|
|
@@ -899,21 +916,21 @@ interface SiteRenamed {
|
|
|
899
916
|
*
|
|
900
917
|
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
901
918
|
*/
|
|
902
|
-
interface SiteHardDeleted {
|
|
919
|
+
export interface SiteHardDeleted {
|
|
903
920
|
/** A deletion context. */
|
|
904
921
|
deleteContext?: DeleteContext;
|
|
905
922
|
}
|
|
906
|
-
interface NamespaceChanged {
|
|
923
|
+
export interface NamespaceChanged {
|
|
907
924
|
/** A previous namespace. */
|
|
908
925
|
oldNamespace?: Namespace;
|
|
909
926
|
/** A new namespace. */
|
|
910
927
|
newNamespace?: Namespace;
|
|
911
928
|
}
|
|
912
929
|
/** Assigned Studio editor */
|
|
913
|
-
interface StudioAssigned {
|
|
930
|
+
export interface StudioAssigned {
|
|
914
931
|
}
|
|
915
932
|
/** Unassigned Studio editor */
|
|
916
|
-
interface StudioUnassigned {
|
|
933
|
+
export interface StudioUnassigned {
|
|
917
934
|
}
|
|
918
935
|
/**
|
|
919
936
|
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
@@ -923,13 +940,13 @@ interface StudioUnassigned {
|
|
|
923
940
|
*
|
|
924
941
|
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
925
942
|
*/
|
|
926
|
-
interface SiteUrlChanged {
|
|
943
|
+
export interface SiteUrlChanged {
|
|
927
944
|
}
|
|
928
945
|
/**
|
|
929
946
|
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
930
947
|
* Consumed by other teams to remove relevant data.
|
|
931
948
|
*/
|
|
932
|
-
interface SitePurgedExternally {
|
|
949
|
+
export interface SitePurgedExternally {
|
|
933
950
|
/**
|
|
934
951
|
* @maxLength 2048
|
|
935
952
|
* @maxSize 100
|
|
@@ -938,10 +955,22 @@ interface SitePurgedExternally {
|
|
|
938
955
|
*/
|
|
939
956
|
appDefId?: string[];
|
|
940
957
|
}
|
|
941
|
-
|
|
958
|
+
/** Assigned Odeditor */
|
|
959
|
+
export interface OdeditorAssigned {
|
|
960
|
+
}
|
|
961
|
+
/** Unassigned Odeditor */
|
|
962
|
+
export interface OdeditorUnassigned {
|
|
963
|
+
}
|
|
964
|
+
/** Assigned Picasso editor */
|
|
965
|
+
export interface PicassoAssigned {
|
|
966
|
+
}
|
|
967
|
+
/** Unassigned Picasso */
|
|
968
|
+
export interface PicassoUnassigned {
|
|
969
|
+
}
|
|
970
|
+
export interface Empty {
|
|
942
971
|
}
|
|
943
972
|
/** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
|
|
944
|
-
interface SitePropertiesNotification {
|
|
973
|
+
export interface SitePropertiesNotification {
|
|
945
974
|
/** The site ID for which this update notification applies. */
|
|
946
975
|
metasiteId?: string;
|
|
947
976
|
/** The actual update event. */
|
|
@@ -955,7 +984,7 @@ interface SitePropertiesNotification {
|
|
|
955
984
|
changeContext?: ChangeContext;
|
|
956
985
|
}
|
|
957
986
|
/** The actual update event for a particular notification. */
|
|
958
|
-
interface SitePropertiesEvent {
|
|
987
|
+
export interface SitePropertiesEvent {
|
|
959
988
|
/** Version of the site's properties represented by this update. */
|
|
960
989
|
version?: number;
|
|
961
990
|
/** Set of properties that were updated - corresponds to the fields in "properties". */
|
|
@@ -963,7 +992,7 @@ interface SitePropertiesEvent {
|
|
|
963
992
|
/** Updated properties. */
|
|
964
993
|
properties?: Properties;
|
|
965
994
|
}
|
|
966
|
-
interface Properties {
|
|
995
|
+
export interface Properties {
|
|
967
996
|
/** Site categories. */
|
|
968
997
|
categories?: Categories;
|
|
969
998
|
/** Site locale. */
|
|
@@ -1019,7 +1048,7 @@ interface Properties {
|
|
|
1019
1048
|
/** Track clicks analytics. */
|
|
1020
1049
|
trackClicksAnalytics?: boolean;
|
|
1021
1050
|
}
|
|
1022
|
-
interface Categories {
|
|
1051
|
+
export interface Categories {
|
|
1023
1052
|
/** Primary site category. */
|
|
1024
1053
|
primary?: string;
|
|
1025
1054
|
/**
|
|
@@ -1030,13 +1059,13 @@ interface Categories {
|
|
|
1030
1059
|
/** Business Term Id */
|
|
1031
1060
|
businessTermId?: string | null;
|
|
1032
1061
|
}
|
|
1033
|
-
interface Locale {
|
|
1062
|
+
export interface Locale {
|
|
1034
1063
|
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
1035
1064
|
languageCode?: string;
|
|
1036
1065
|
/** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
|
|
1037
1066
|
country?: string;
|
|
1038
1067
|
}
|
|
1039
|
-
interface Address {
|
|
1068
|
+
export interface Address {
|
|
1040
1069
|
/** Street name. */
|
|
1041
1070
|
street?: string;
|
|
1042
1071
|
/** City name. */
|
|
@@ -1068,27 +1097,27 @@ interface Address {
|
|
|
1068
1097
|
* This is used for display purposes. Used to add additional data about the address, such as "In the passage".
|
|
1069
1098
|
* Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
|
|
1070
1099
|
*/
|
|
1071
|
-
interface AddressHint {
|
|
1100
|
+
export interface AddressHint {
|
|
1072
1101
|
/** Extra text displayed next to, or instead of, the actual address. */
|
|
1073
1102
|
text?: string;
|
|
1074
1103
|
/** Where the extra text should be displayed. */
|
|
1075
1104
|
placement?: PlacementType;
|
|
1076
1105
|
}
|
|
1077
1106
|
/** Where the extra text should be displayed: before, after or instead of the actual address. */
|
|
1078
|
-
declare enum PlacementType {
|
|
1107
|
+
export declare enum PlacementType {
|
|
1079
1108
|
BEFORE = "BEFORE",
|
|
1080
1109
|
AFTER = "AFTER",
|
|
1081
1110
|
REPLACE = "REPLACE"
|
|
1082
1111
|
}
|
|
1083
1112
|
/** Geocoordinates for a particular address. */
|
|
1084
|
-
interface GeoCoordinates {
|
|
1113
|
+
export interface GeoCoordinates {
|
|
1085
1114
|
/** Latitude of the location. Must be between -90 and 90. */
|
|
1086
1115
|
latitude?: number;
|
|
1087
1116
|
/** Longitude of the location. Must be between -180 and 180. */
|
|
1088
1117
|
longitude?: number;
|
|
1089
1118
|
}
|
|
1090
1119
|
/** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
|
|
1091
|
-
interface BusinessSchedule {
|
|
1120
|
+
export interface BusinessSchedule {
|
|
1092
1121
|
/**
|
|
1093
1122
|
* Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
|
|
1094
1123
|
* @maxSize 100
|
|
@@ -1101,7 +1130,7 @@ interface BusinessSchedule {
|
|
|
1101
1130
|
specialHourPeriod?: SpecialHourPeriod[];
|
|
1102
1131
|
}
|
|
1103
1132
|
/** Weekly recurring time periods when the business is regularly open or the service is available. */
|
|
1104
|
-
interface TimePeriod {
|
|
1133
|
+
export interface TimePeriod {
|
|
1105
1134
|
/** Day of the week the period starts on. */
|
|
1106
1135
|
openDay?: DayOfWeek;
|
|
1107
1136
|
/**
|
|
@@ -1120,7 +1149,7 @@ interface TimePeriod {
|
|
|
1120
1149
|
closeTime?: string;
|
|
1121
1150
|
}
|
|
1122
1151
|
/** Enumerates the days of the week. */
|
|
1123
|
-
declare enum DayOfWeek {
|
|
1152
|
+
export declare enum DayOfWeek {
|
|
1124
1153
|
MONDAY = "MONDAY",
|
|
1125
1154
|
TUESDAY = "TUESDAY",
|
|
1126
1155
|
WEDNESDAY = "WEDNESDAY",
|
|
@@ -1130,7 +1159,7 @@ declare enum DayOfWeek {
|
|
|
1130
1159
|
SUNDAY = "SUNDAY"
|
|
1131
1160
|
}
|
|
1132
1161
|
/** Exception to the business's regular hours. The business can be open or closed during the exception. */
|
|
1133
|
-
interface SpecialHourPeriod {
|
|
1162
|
+
export interface SpecialHourPeriod {
|
|
1134
1163
|
/** 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). */
|
|
1135
1164
|
startDate?: string;
|
|
1136
1165
|
/** 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). */
|
|
@@ -1144,7 +1173,7 @@ interface SpecialHourPeriod {
|
|
|
1144
1173
|
/** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
|
|
1145
1174
|
comment?: string;
|
|
1146
1175
|
}
|
|
1147
|
-
interface Multilingual {
|
|
1176
|
+
export interface Multilingual {
|
|
1148
1177
|
/**
|
|
1149
1178
|
* Supported languages list.
|
|
1150
1179
|
* @maxSize 200
|
|
@@ -1153,7 +1182,7 @@ interface Multilingual {
|
|
|
1153
1182
|
/** Whether to redirect to user language. */
|
|
1154
1183
|
autoRedirect?: boolean;
|
|
1155
1184
|
}
|
|
1156
|
-
interface SupportedLanguage {
|
|
1185
|
+
export interface SupportedLanguage {
|
|
1157
1186
|
/** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
|
|
1158
1187
|
languageCode?: string;
|
|
1159
1188
|
/** Locale. */
|
|
@@ -1165,12 +1194,12 @@ interface SupportedLanguage {
|
|
|
1165
1194
|
/** How the language will be resolved. For internal use. */
|
|
1166
1195
|
resolutionMethod?: ResolutionMethod;
|
|
1167
1196
|
}
|
|
1168
|
-
declare enum ResolutionMethod {
|
|
1197
|
+
export declare enum ResolutionMethod {
|
|
1169
1198
|
QUERY_PARAM = "QUERY_PARAM",
|
|
1170
1199
|
SUBDOMAIN = "SUBDOMAIN",
|
|
1171
1200
|
SUBDIRECTORY = "SUBDIRECTORY"
|
|
1172
1201
|
}
|
|
1173
|
-
interface ConsentPolicy {
|
|
1202
|
+
export interface ConsentPolicy {
|
|
1174
1203
|
/** Whether the site uses cookies that are essential to site operation. Always `true`. */
|
|
1175
1204
|
essential?: boolean | null;
|
|
1176
1205
|
/** Whether the site uses cookies that affect site performance and other functional measurements. */
|
|
@@ -1183,7 +1212,7 @@ interface ConsentPolicy {
|
|
|
1183
1212
|
dataToThirdParty?: boolean | null;
|
|
1184
1213
|
}
|
|
1185
1214
|
/** A single mapping from the MetaSite ID to a particular service. */
|
|
1186
|
-
interface Translation {
|
|
1215
|
+
export interface Translation {
|
|
1187
1216
|
/** The service type. */
|
|
1188
1217
|
serviceType?: string;
|
|
1189
1218
|
/** The application definition ID; this only applies to services of type ThirdPartyApps. */
|
|
@@ -1191,7 +1220,7 @@ interface Translation {
|
|
|
1191
1220
|
/** The instance ID of the service. */
|
|
1192
1221
|
instanceId?: string;
|
|
1193
1222
|
}
|
|
1194
|
-
interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
1223
|
+
export interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
1195
1224
|
/** Properties were updated. */
|
|
1196
1225
|
propertiesChange?: PropertiesChange;
|
|
1197
1226
|
/** Default properties were created on site creation. */
|
|
@@ -1200,7 +1229,7 @@ interface ChangeContext extends ChangeContextPayloadOneOf {
|
|
|
1200
1229
|
siteCloned?: SiteCloned;
|
|
1201
1230
|
}
|
|
1202
1231
|
/** @oneof */
|
|
1203
|
-
interface ChangeContextPayloadOneOf {
|
|
1232
|
+
export interface ChangeContextPayloadOneOf {
|
|
1204
1233
|
/** Properties were updated. */
|
|
1205
1234
|
propertiesChange?: PropertiesChange;
|
|
1206
1235
|
/** Default properties were created on site creation. */
|
|
@@ -1208,17 +1237,17 @@ interface ChangeContextPayloadOneOf {
|
|
|
1208
1237
|
/** Properties were cloned on site cloning. */
|
|
1209
1238
|
siteCloned?: SiteCloned;
|
|
1210
1239
|
}
|
|
1211
|
-
interface PropertiesChange {
|
|
1240
|
+
export interface PropertiesChange {
|
|
1212
1241
|
}
|
|
1213
|
-
interface V4SiteCreated {
|
|
1242
|
+
export interface V4SiteCreated {
|
|
1214
1243
|
/** Origin template site id. */
|
|
1215
1244
|
originTemplateId?: string | null;
|
|
1216
1245
|
}
|
|
1217
|
-
interface SiteCloned {
|
|
1246
|
+
export interface SiteCloned {
|
|
1218
1247
|
/** Origin site id. */
|
|
1219
1248
|
originMetaSiteId?: string;
|
|
1220
1249
|
}
|
|
1221
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1250
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
1222
1251
|
createdEvent?: EntityCreatedEvent;
|
|
1223
1252
|
updatedEvent?: EntityUpdatedEvent;
|
|
1224
1253
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -1261,19 +1290,19 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1261
1290
|
entityEventSequence?: string | null;
|
|
1262
1291
|
}
|
|
1263
1292
|
/** @oneof */
|
|
1264
|
-
interface DomainEventBodyOneOf {
|
|
1293
|
+
export interface DomainEventBodyOneOf {
|
|
1265
1294
|
createdEvent?: EntityCreatedEvent;
|
|
1266
1295
|
updatedEvent?: EntityUpdatedEvent;
|
|
1267
1296
|
deletedEvent?: EntityDeletedEvent;
|
|
1268
1297
|
actionEvent?: ActionEvent;
|
|
1269
1298
|
}
|
|
1270
|
-
interface EntityCreatedEvent {
|
|
1299
|
+
export interface EntityCreatedEvent {
|
|
1271
1300
|
entity?: string;
|
|
1272
1301
|
}
|
|
1273
|
-
interface RestoreInfo {
|
|
1302
|
+
export interface RestoreInfo {
|
|
1274
1303
|
deletedDate?: Date | null;
|
|
1275
1304
|
}
|
|
1276
|
-
interface EntityUpdatedEvent {
|
|
1305
|
+
export interface EntityUpdatedEvent {
|
|
1277
1306
|
/**
|
|
1278
1307
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1279
1308
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -1281,14 +1310,14 @@ interface EntityUpdatedEvent {
|
|
|
1281
1310
|
*/
|
|
1282
1311
|
currentEntity?: string;
|
|
1283
1312
|
}
|
|
1284
|
-
interface EntityDeletedEvent {
|
|
1313
|
+
export interface EntityDeletedEvent {
|
|
1285
1314
|
/** Entity that was deleted */
|
|
1286
1315
|
deletedEntity?: string | null;
|
|
1287
1316
|
}
|
|
1288
|
-
interface ActionEvent {
|
|
1317
|
+
export interface ActionEvent {
|
|
1289
1318
|
body?: string;
|
|
1290
1319
|
}
|
|
1291
|
-
interface MessageEnvelope {
|
|
1320
|
+
export interface MessageEnvelope {
|
|
1292
1321
|
/**
|
|
1293
1322
|
* App instance ID.
|
|
1294
1323
|
* @format GUID
|
|
@@ -1304,7 +1333,7 @@ interface MessageEnvelope {
|
|
|
1304
1333
|
/** Stringify payload. */
|
|
1305
1334
|
data?: string;
|
|
1306
1335
|
}
|
|
1307
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1336
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1308
1337
|
/**
|
|
1309
1338
|
* ID of a site visitor that has not logged in to the site.
|
|
1310
1339
|
* @format GUID
|
|
@@ -1329,7 +1358,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1329
1358
|
identityType?: WebhookIdentityType;
|
|
1330
1359
|
}
|
|
1331
1360
|
/** @oneof */
|
|
1332
|
-
interface IdentificationDataIdOneOf {
|
|
1361
|
+
export interface IdentificationDataIdOneOf {
|
|
1333
1362
|
/**
|
|
1334
1363
|
* ID of a site visitor that has not logged in to the site.
|
|
1335
1364
|
* @format GUID
|
|
@@ -1351,14 +1380,14 @@ interface IdentificationDataIdOneOf {
|
|
|
1351
1380
|
*/
|
|
1352
1381
|
appId?: string;
|
|
1353
1382
|
}
|
|
1354
|
-
declare enum WebhookIdentityType {
|
|
1383
|
+
export declare enum WebhookIdentityType {
|
|
1355
1384
|
UNKNOWN = "UNKNOWN",
|
|
1356
1385
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1357
1386
|
MEMBER = "MEMBER",
|
|
1358
1387
|
WIX_USER = "WIX_USER",
|
|
1359
1388
|
APP = "APP"
|
|
1360
1389
|
}
|
|
1361
|
-
interface BaseEventMetadata {
|
|
1390
|
+
export interface BaseEventMetadata {
|
|
1362
1391
|
/**
|
|
1363
1392
|
* App instance ID.
|
|
1364
1393
|
* @format GUID
|
|
@@ -1372,7 +1401,7 @@ interface BaseEventMetadata {
|
|
|
1372
1401
|
/** The identification type and identity data. */
|
|
1373
1402
|
identity?: IdentificationData;
|
|
1374
1403
|
}
|
|
1375
|
-
interface EventMetadata extends BaseEventMetadata {
|
|
1404
|
+
export interface EventMetadata extends BaseEventMetadata {
|
|
1376
1405
|
/**
|
|
1377
1406
|
* Unique event ID.
|
|
1378
1407
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -1410,23 +1439,170 @@ interface EventMetadata extends BaseEventMetadata {
|
|
|
1410
1439
|
*/
|
|
1411
1440
|
entityEventSequence?: string | null;
|
|
1412
1441
|
}
|
|
1413
|
-
interface ScheduleCancelledEnvelope {
|
|
1442
|
+
export interface ScheduleCancelledEnvelope {
|
|
1414
1443
|
data: ScheduleCancelled;
|
|
1415
1444
|
metadata: EventMetadata;
|
|
1416
1445
|
}
|
|
1417
|
-
|
|
1446
|
+
/**
|
|
1447
|
+
* Triggered when a schedule is canceled.
|
|
1448
|
+
* @permissionScope Read Calendar - Including PI
|
|
1449
|
+
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1450
|
+
* @permissionScope Manage Calendars
|
|
1451
|
+
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1452
|
+
* @permissionScope Manage Bookings
|
|
1453
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1454
|
+
* @permissionScope Read Bookings - Including Participants
|
|
1455
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1456
|
+
* @permissionScope Read Bookings - all read permissions
|
|
1457
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1458
|
+
* @permissionScope Manage Bookings - all permissions
|
|
1459
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1460
|
+
* @permissionScope Read bookings calendar - including participants
|
|
1461
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1462
|
+
* @permissionId CALENDAR.SCHEDULE_READ_PI
|
|
1463
|
+
* @webhook
|
|
1464
|
+
* @eventType wix.calendar.v3.schedule_cancelled
|
|
1465
|
+
* @serviceIdentifier wix.calendar.schedules.v3.SchedulesService
|
|
1466
|
+
* @slug cancelled
|
|
1467
|
+
* @documentationMaturity preview
|
|
1468
|
+
*/
|
|
1469
|
+
export declare function onScheduleCancelled(handler: (event: ScheduleCancelledEnvelope) => void | Promise<void>): void;
|
|
1470
|
+
export interface ScheduleClonedEnvelope {
|
|
1418
1471
|
data: ScheduleCloned;
|
|
1419
1472
|
metadata: EventMetadata;
|
|
1420
1473
|
}
|
|
1421
|
-
|
|
1474
|
+
/**
|
|
1475
|
+
* Triggered when a schedule is cloned.
|
|
1476
|
+
* @permissionScope Read Calendar - Including PI
|
|
1477
|
+
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1478
|
+
* @permissionScope Manage Calendars
|
|
1479
|
+
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1480
|
+
* @permissionScope Manage Bookings
|
|
1481
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1482
|
+
* @permissionScope Read Bookings - Including Participants
|
|
1483
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1484
|
+
* @permissionScope Read Bookings - all read permissions
|
|
1485
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1486
|
+
* @permissionScope Manage Bookings - all permissions
|
|
1487
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1488
|
+
* @permissionScope Read bookings calendar - including participants
|
|
1489
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1490
|
+
* @permissionId CALENDAR.SCHEDULE_READ_PI
|
|
1491
|
+
* @webhook
|
|
1492
|
+
* @eventType wix.calendar.v3.schedule_cloned
|
|
1493
|
+
* @serviceIdentifier wix.calendar.schedules.v3.SchedulesService
|
|
1494
|
+
* @slug cloned
|
|
1495
|
+
* @documentationMaturity preview
|
|
1496
|
+
*/
|
|
1497
|
+
export declare function onScheduleCloned(handler: (event: ScheduleClonedEnvelope) => void | Promise<void>): void;
|
|
1498
|
+
export interface ScheduleCreatedEnvelope {
|
|
1422
1499
|
entity: Schedule;
|
|
1423
1500
|
metadata: EventMetadata;
|
|
1424
1501
|
}
|
|
1425
|
-
|
|
1502
|
+
/**
|
|
1503
|
+
* Triggered when a schedule is created.
|
|
1504
|
+
* @permissionScope Read Calendar - Including PI
|
|
1505
|
+
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1506
|
+
* @permissionScope Manage Calendars
|
|
1507
|
+
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1508
|
+
* @permissionScope Manage Bookings
|
|
1509
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1510
|
+
* @permissionScope Read Bookings - Including Participants
|
|
1511
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1512
|
+
* @permissionScope Read Bookings - all read permissions
|
|
1513
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1514
|
+
* @permissionScope Manage Bookings - all permissions
|
|
1515
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1516
|
+
* @permissionScope Read bookings calendar - including participants
|
|
1517
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1518
|
+
* @permissionId CALENDAR.SCHEDULE_READ_PI
|
|
1519
|
+
* @webhook
|
|
1520
|
+
* @eventType wix.calendar.v3.schedule_created
|
|
1521
|
+
* @serviceIdentifier wix.calendar.schedules.v3.SchedulesService
|
|
1522
|
+
* @slug created
|
|
1523
|
+
* @documentationMaturity preview
|
|
1524
|
+
*/
|
|
1525
|
+
export declare function onScheduleCreated(handler: (event: ScheduleCreatedEnvelope) => void | Promise<void>): void;
|
|
1526
|
+
export interface ScheduleUpdatedEnvelope {
|
|
1426
1527
|
entity: Schedule;
|
|
1427
1528
|
metadata: EventMetadata;
|
|
1428
1529
|
}
|
|
1429
|
-
|
|
1530
|
+
/**
|
|
1531
|
+
* Triggered when a schedule is updated.
|
|
1532
|
+
* @permissionScope Read Calendar - Including PI
|
|
1533
|
+
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1534
|
+
* @permissionScope Manage Calendars
|
|
1535
|
+
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1536
|
+
* @permissionScope Manage Bookings
|
|
1537
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1538
|
+
* @permissionScope Read Bookings - Including Participants
|
|
1539
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1540
|
+
* @permissionScope Read Bookings - all read permissions
|
|
1541
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1542
|
+
* @permissionScope Manage Bookings - all permissions
|
|
1543
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1544
|
+
* @permissionScope Read bookings calendar - including participants
|
|
1545
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1546
|
+
* @permissionId CALENDAR.SCHEDULE_READ_PI
|
|
1547
|
+
* @webhook
|
|
1548
|
+
* @eventType wix.calendar.v3.schedule_updated
|
|
1549
|
+
* @serviceIdentifier wix.calendar.schedules.v3.SchedulesService
|
|
1550
|
+
* @slug updated
|
|
1551
|
+
* @documentationMaturity preview
|
|
1552
|
+
*/
|
|
1553
|
+
export declare function onScheduleUpdated(handler: (event: ScheduleUpdatedEnvelope) => void | Promise<void>): void;
|
|
1554
|
+
type ScheduleNonNullablePaths = `status` | `defaultLocation.type` | `defaultConferencingDetails.type` | `permissions` | `permissions.${number}.identity.wixUserId` | `permissions.${number}.role`;
|
|
1555
|
+
/**
|
|
1556
|
+
* Retrieves a schedule.
|
|
1557
|
+
* @param scheduleId - ID of the schedule to retrieve.
|
|
1558
|
+
* @public
|
|
1559
|
+
* @documentationMaturity preview
|
|
1560
|
+
* @requiredField scheduleId
|
|
1561
|
+
* @permissionId CALENDAR.SCHEDULE_READ
|
|
1562
|
+
* @permissionId CALENDAR.SCHEDULE_READ_PI
|
|
1563
|
+
* @permissionScope Read Bookings - Public Data
|
|
1564
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
|
|
1565
|
+
* @permissionScope Read Calendar - Including PI
|
|
1566
|
+
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1567
|
+
* @permissionScope Manage Calendars
|
|
1568
|
+
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1569
|
+
* @permissionScope Manage Bookings
|
|
1570
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1571
|
+
* @permissionScope Read Bookings - Including Participants
|
|
1572
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1573
|
+
* @permissionScope Read Bookings - all read permissions
|
|
1574
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1575
|
+
* @permissionScope Read Bookings Calendar Availability
|
|
1576
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
|
|
1577
|
+
* @permissionScope Read Calendar
|
|
1578
|
+
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
|
|
1579
|
+
* @permissionScope Manage Bookings - all permissions
|
|
1580
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1581
|
+
* @permissionScope Read bookings calendar - including participants
|
|
1582
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1583
|
+
* @permissionScope Read Bookings Calendar
|
|
1584
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
|
|
1585
|
+
* @permissionScope Read Calendar - Including PI
|
|
1586
|
+
* @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
|
|
1587
|
+
* @permissionScope Manage Calendars
|
|
1588
|
+
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1589
|
+
* @permissionScope Manage Bookings
|
|
1590
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1591
|
+
* @permissionScope Read Bookings - Including Participants
|
|
1592
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
|
|
1593
|
+
* @permissionScope Read Bookings - all read permissions
|
|
1594
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1595
|
+
* @permissionScope Manage Bookings - all permissions
|
|
1596
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1597
|
+
* @permissionScope Read bookings calendar - including participants
|
|
1598
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1599
|
+
* @applicableIdentity APP
|
|
1600
|
+
* @applicableIdentity VISITOR
|
|
1601
|
+
* @returns Retrieved schedule.
|
|
1602
|
+
* @fqn wix.calendar.schedules.v3.SchedulesService.GetSchedule
|
|
1603
|
+
*/
|
|
1604
|
+
export declare function getSchedule(scheduleId: string, options?: GetScheduleOptions): Promise<NonNullablePaths<Schedule, ScheduleNonNullablePaths>>;
|
|
1605
|
+
export interface GetScheduleOptions {
|
|
1430
1606
|
/**
|
|
1431
1607
|
* Information about which fields containing personal data to return. Refer to the
|
|
1432
1608
|
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
|
|
@@ -1442,7 +1618,69 @@ interface GetScheduleOptions {
|
|
|
1442
1618
|
*/
|
|
1443
1619
|
fields?: RequestedFields[];
|
|
1444
1620
|
}
|
|
1445
|
-
|
|
1621
|
+
/**
|
|
1622
|
+
* Creates a query to retrieve a list of schedules.
|
|
1623
|
+
*
|
|
1624
|
+
* The `querySchedules()` function builds a query to retrieve a list of tip settings and returns a `SchedulesQueryBuilder` object.
|
|
1625
|
+
*
|
|
1626
|
+
* 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.
|
|
1627
|
+
*
|
|
1628
|
+
* 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.
|
|
1629
|
+
*
|
|
1630
|
+
* `querySchedules()` runs with the following `SchedulesQueryBuilder` default that you can override:
|
|
1631
|
+
*
|
|
1632
|
+
* + `limit` is `50`.
|
|
1633
|
+
* + Sorted by `id` in ascending order.
|
|
1634
|
+
*
|
|
1635
|
+
* 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"`.
|
|
1636
|
+
*
|
|
1637
|
+
* 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`.
|
|
1638
|
+
* @public
|
|
1639
|
+
* @documentationMaturity preview
|
|
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 Read Bookings - all read permissions
|
|
1671
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
|
|
1672
|
+
* @permissionScope Manage Bookings - all permissions
|
|
1673
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1674
|
+
* @permissionScope Read bookings calendar - including participants
|
|
1675
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
|
|
1676
|
+
* @permissionId CALENDAR.SCHEDULE_READ
|
|
1677
|
+
* @permissionId CALENDAR.SCHEDULE_READ_PI
|
|
1678
|
+
* @applicableIdentity APP
|
|
1679
|
+
* @applicableIdentity VISITOR
|
|
1680
|
+
* @fqn wix.calendar.schedules.v3.SchedulesService.QuerySchedules
|
|
1681
|
+
*/
|
|
1682
|
+
export declare function querySchedules(options?: QuerySchedulesOptions): SchedulesQueryBuilder;
|
|
1683
|
+
export interface QuerySchedulesOptions {
|
|
1446
1684
|
/**
|
|
1447
1685
|
* Information about which fields containing personal data to return. Refer to the
|
|
1448
1686
|
* [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
|
|
@@ -1465,13 +1703,13 @@ interface QueryCursorResult {
|
|
|
1465
1703
|
length: number;
|
|
1466
1704
|
pageSize: number;
|
|
1467
1705
|
}
|
|
1468
|
-
interface SchedulesQueryResult extends QueryCursorResult {
|
|
1706
|
+
export interface SchedulesQueryResult extends QueryCursorResult {
|
|
1469
1707
|
items: Schedule[];
|
|
1470
1708
|
query: SchedulesQueryBuilder;
|
|
1471
1709
|
next: () => Promise<SchedulesQueryResult>;
|
|
1472
1710
|
prev: () => Promise<SchedulesQueryResult>;
|
|
1473
1711
|
}
|
|
1474
|
-
interface SchedulesQueryBuilder {
|
|
1712
|
+
export interface SchedulesQueryBuilder {
|
|
1475
1713
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1476
1714
|
* @param value - Value to compare against.
|
|
1477
1715
|
* @documentationMaturity preview
|
|
@@ -1490,7 +1728,37 @@ interface SchedulesQueryBuilder {
|
|
|
1490
1728
|
/** @documentationMaturity preview */
|
|
1491
1729
|
find: () => Promise<SchedulesQueryResult>;
|
|
1492
1730
|
}
|
|
1493
|
-
|
|
1731
|
+
/**
|
|
1732
|
+
* Creates a schedule.
|
|
1733
|
+
*
|
|
1734
|
+
*
|
|
1735
|
+
* If you want the schedule's events to appear in the
|
|
1736
|
+
* [Bookings calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar),
|
|
1737
|
+
* you must set `appId` to the ID of the Wix Bookings app by providing
|
|
1738
|
+
* `{"appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97"}`.
|
|
1739
|
+
* @param schedule - Schedule to create.
|
|
1740
|
+
* @public
|
|
1741
|
+
* @documentationMaturity preview
|
|
1742
|
+
* @requiredField schedule
|
|
1743
|
+
* @requiredField schedule.defaultConferencingDetails.guestUrl
|
|
1744
|
+
* @requiredField schedule.defaultConferencingDetails.hostUrl
|
|
1745
|
+
* @requiredField schedule.defaultConferencingDetails.type
|
|
1746
|
+
* @requiredField schedule.defaultLocation.type
|
|
1747
|
+
* @requiredField schedule.permissions.identity
|
|
1748
|
+
* @requiredField schedule.permissions.role
|
|
1749
|
+
* @permissionId CALENDAR.SCHEDULE_CREATE
|
|
1750
|
+
* @permissionScope Manage Calendars
|
|
1751
|
+
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1752
|
+
* @permissionScope Manage Bookings
|
|
1753
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1754
|
+
* @permissionScope Manage Bookings - all permissions
|
|
1755
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1756
|
+
* @applicableIdentity APP
|
|
1757
|
+
* @returns Created schedule.
|
|
1758
|
+
* @fqn wix.calendar.schedules.v3.SchedulesService.CreateSchedule
|
|
1759
|
+
*/
|
|
1760
|
+
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>>;
|
|
1761
|
+
export interface CreateScheduleOptions {
|
|
1494
1762
|
/**
|
|
1495
1763
|
* Idempotency key guaranteeing that you don't create the same schedule more
|
|
1496
1764
|
* than once.
|
|
@@ -1498,7 +1766,36 @@ interface CreateScheduleOptions {
|
|
|
1498
1766
|
*/
|
|
1499
1767
|
idempotencyKey?: string | null;
|
|
1500
1768
|
}
|
|
1501
|
-
|
|
1769
|
+
/**
|
|
1770
|
+
* Updates a schedule.
|
|
1771
|
+
*
|
|
1772
|
+
*
|
|
1773
|
+
* Each time the schedule is updated,
|
|
1774
|
+
* `revision` increments by 1.
|
|
1775
|
+
* The current `revision` must be passed when updating the schedule.
|
|
1776
|
+
* This ensures you're working with the latest schedule
|
|
1777
|
+
* and prevents unintended overwrites.
|
|
1778
|
+
* @param _id - Schedule ID.
|
|
1779
|
+
* @public
|
|
1780
|
+
* @documentationMaturity preview
|
|
1781
|
+
* @requiredField _id
|
|
1782
|
+
* @requiredField schedule
|
|
1783
|
+
* @requiredField schedule.permissions.identity
|
|
1784
|
+
* @requiredField schedule.permissions.role
|
|
1785
|
+
* @requiredField schedule.revision
|
|
1786
|
+
* @permissionId CALENDAR.SCHEDULE_UPDATE
|
|
1787
|
+
* @permissionScope Manage Calendars
|
|
1788
|
+
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1789
|
+
* @permissionScope Manage Bookings
|
|
1790
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1791
|
+
* @permissionScope Manage Bookings - all permissions
|
|
1792
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1793
|
+
* @applicableIdentity APP
|
|
1794
|
+
* @returns Updated schedule.
|
|
1795
|
+
* @fqn wix.calendar.schedules.v3.SchedulesService.UpdateSchedule
|
|
1796
|
+
*/
|
|
1797
|
+
export declare function updateSchedule(_id: string, schedule: NonNullablePaths<UpdateSchedule, `permissions.${number}.identity` | `permissions.${number}.role` | `revision`>, options?: UpdateScheduleOptions): Promise<NonNullablePaths<Schedule, ScheduleNonNullablePaths>>;
|
|
1798
|
+
export interface UpdateSchedule {
|
|
1502
1799
|
/**
|
|
1503
1800
|
* Schedule ID.
|
|
1504
1801
|
* @format GUID
|
|
@@ -1623,14 +1920,39 @@ interface UpdateSchedule {
|
|
|
1623
1920
|
*/
|
|
1624
1921
|
_updatedDate?: Date | null;
|
|
1625
1922
|
}
|
|
1626
|
-
interface UpdateScheduleOptions {
|
|
1923
|
+
export interface UpdateScheduleOptions {
|
|
1627
1924
|
/**
|
|
1628
1925
|
* Information about whether participants of the schedule's updated events are
|
|
1629
1926
|
* notified and the message they receive.
|
|
1630
1927
|
*/
|
|
1631
1928
|
participantNotification?: ParticipantNotification;
|
|
1632
1929
|
}
|
|
1633
|
-
|
|
1930
|
+
/**
|
|
1931
|
+
* Sets a schedule's `status` to `CANCELLED`.
|
|
1932
|
+
*
|
|
1933
|
+
*
|
|
1934
|
+
* Also cancels future events belonging to the schedule.
|
|
1935
|
+
*
|
|
1936
|
+
* Once a schedule is marked as `CANCELLED`, you can't reactivate it, update it,
|
|
1937
|
+
* or assign new events.
|
|
1938
|
+
* @param scheduleId - ID of the schedule to cancel.
|
|
1939
|
+
* @public
|
|
1940
|
+
* @documentationMaturity preview
|
|
1941
|
+
* @requiredField scheduleId
|
|
1942
|
+
* @permissionId CALENDAR.SCHEDULE_CANCEL
|
|
1943
|
+
* @permissionScope Manage Calendars
|
|
1944
|
+
* @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
|
|
1945
|
+
* @permissionScope Manage Bookings
|
|
1946
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
|
|
1947
|
+
* @permissionScope Manage Bookings - all permissions
|
|
1948
|
+
* @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
|
|
1949
|
+
* @applicableIdentity APP
|
|
1950
|
+
* @fqn wix.calendar.schedules.v3.SchedulesService.CancelSchedule
|
|
1951
|
+
*/
|
|
1952
|
+
export declare function cancelSchedule(scheduleId: string, options?: CancelScheduleOptions): Promise<NonNullablePaths<CancelScheduleResponse, {
|
|
1953
|
+
[P in ScheduleNonNullablePaths]: `schedule.${P}`;
|
|
1954
|
+
}[ScheduleNonNullablePaths]>>;
|
|
1955
|
+
export interface CancelScheduleOptions {
|
|
1634
1956
|
/**
|
|
1635
1957
|
* Whether to preserve future events with participants.
|
|
1636
1958
|
* Default: `false`.
|
|
@@ -1642,5 +1964,4 @@ interface CancelScheduleOptions {
|
|
|
1642
1964
|
*/
|
|
1643
1965
|
participantNotification?: ParticipantNotification;
|
|
1644
1966
|
}
|
|
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 };
|
|
1967
|
+
export {};
|