@wix/auto_sdk_calendar_schedules 1.0.34 → 1.0.35

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (134) hide show
  1. package/build/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1 -0
  8. package/build/cjs/meta.js +18 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/src/calendar-v3-schedule-schedules.context.d.ts +30 -0
  11. package/build/cjs/src/calendar-v3-schedule-schedules.context.js +48 -0
  12. package/build/cjs/src/calendar-v3-schedule-schedules.context.js.map +1 -0
  13. package/build/cjs/src/calendar-v3-schedule-schedules.http.d.ts +53 -0
  14. package/build/cjs/src/calendar-v3-schedule-schedules.http.js +255 -0
  15. package/build/cjs/src/calendar-v3-schedule-schedules.http.js.map +1 -0
  16. package/build/cjs/src/calendar-v3-schedule-schedules.meta.d.ts +23 -0
  17. package/build/cjs/src/calendar-v3-schedule-schedules.meta.js +123 -0
  18. package/build/cjs/src/calendar-v3-schedule-schedules.meta.js.map +1 -0
  19. package/build/cjs/src/calendar-v3-schedule-schedules.public.d.ts +86 -0
  20. package/build/cjs/src/calendar-v3-schedule-schedules.public.js +96 -0
  21. package/build/cjs/src/calendar-v3-schedule-schedules.public.js.map +1 -0
  22. package/build/cjs/src/calendar-v3-schedule-schedules.types.d.ts +1362 -0
  23. package/build/cjs/src/calendar-v3-schedule-schedules.types.js +208 -0
  24. package/build/cjs/src/calendar-v3-schedule-schedules.types.js.map +1 -0
  25. package/build/{calendar-v3-schedule-schedules.universal-D3nvGK6W.d.mts → cjs/src/calendar-v3-schedule-schedules.universal.d.ts} +404 -111
  26. package/build/cjs/src/calendar-v3-schedule-schedules.universal.js +582 -0
  27. package/build/cjs/src/calendar-v3-schedule-schedules.universal.js.map +1 -0
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +2 -0
  30. package/build/es/index.js.map +1 -0
  31. package/build/es/index.typings.d.ts +1 -0
  32. package/build/es/index.typings.js +2 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/meta.d.ts +1 -0
  35. package/build/es/meta.js +2 -0
  36. package/build/es/meta.js.map +1 -0
  37. package/build/es/package.json +3 -0
  38. package/build/es/src/calendar-v3-schedule-schedules.context.d.ts +30 -0
  39. package/build/es/src/calendar-v3-schedule-schedules.context.js +30 -0
  40. package/build/es/src/calendar-v3-schedule-schedules.context.js.map +1 -0
  41. package/build/es/src/calendar-v3-schedule-schedules.http.d.ts +53 -0
  42. package/build/es/src/calendar-v3-schedule-schedules.http.js +247 -0
  43. package/build/es/src/calendar-v3-schedule-schedules.http.js.map +1 -0
  44. package/build/es/src/calendar-v3-schedule-schedules.meta.d.ts +23 -0
  45. package/build/es/src/calendar-v3-schedule-schedules.meta.js +92 -0
  46. package/build/es/src/calendar-v3-schedule-schedules.meta.js.map +1 -0
  47. package/build/es/src/calendar-v3-schedule-schedules.public.d.ts +86 -0
  48. package/build/es/src/calendar-v3-schedule-schedules.public.js +73 -0
  49. package/build/es/src/calendar-v3-schedule-schedules.public.js.map +1 -0
  50. package/build/es/src/calendar-v3-schedule-schedules.types.d.ts +1362 -0
  51. package/build/es/src/calendar-v3-schedule-schedules.types.js +205 -0
  52. package/build/es/src/calendar-v3-schedule-schedules.types.js.map +1 -0
  53. package/build/{calendar-v3-schedule-schedules.universal-D3nvGK6W.d.ts → es/src/calendar-v3-schedule-schedules.universal.d.ts} +404 -111
  54. package/build/es/src/calendar-v3-schedule-schedules.universal.js +551 -0
  55. package/build/es/src/calendar-v3-schedule-schedules.universal.js.map +1 -0
  56. package/build/internal/cjs/index.d.ts +1 -0
  57. package/build/internal/cjs/index.js +18 -0
  58. package/build/internal/cjs/index.js.map +1 -0
  59. package/build/internal/cjs/index.typings.d.ts +1 -0
  60. package/build/internal/cjs/index.typings.js +18 -0
  61. package/build/internal/cjs/index.typings.js.map +1 -0
  62. package/build/internal/cjs/meta.d.ts +1 -0
  63. package/build/internal/cjs/meta.js +18 -0
  64. package/build/internal/cjs/meta.js.map +1 -0
  65. package/build/internal/cjs/src/calendar-v3-schedule-schedules.context.d.ts +30 -0
  66. package/build/internal/cjs/src/calendar-v3-schedule-schedules.context.js +48 -0
  67. package/build/internal/cjs/src/calendar-v3-schedule-schedules.context.js.map +1 -0
  68. package/build/internal/cjs/src/calendar-v3-schedule-schedules.http.d.ts +53 -0
  69. package/build/internal/cjs/src/calendar-v3-schedule-schedules.http.js +255 -0
  70. package/build/internal/cjs/src/calendar-v3-schedule-schedules.http.js.map +1 -0
  71. package/build/internal/cjs/src/calendar-v3-schedule-schedules.meta.d.ts +23 -0
  72. package/build/internal/cjs/src/calendar-v3-schedule-schedules.meta.js +123 -0
  73. package/build/internal/cjs/src/calendar-v3-schedule-schedules.meta.js.map +1 -0
  74. package/build/internal/cjs/src/calendar-v3-schedule-schedules.public.d.ts +86 -0
  75. package/build/internal/cjs/src/calendar-v3-schedule-schedules.public.js +96 -0
  76. package/build/internal/cjs/src/calendar-v3-schedule-schedules.public.js.map +1 -0
  77. package/build/internal/cjs/src/calendar-v3-schedule-schedules.types.d.ts +1362 -0
  78. package/build/internal/cjs/src/calendar-v3-schedule-schedules.types.js +208 -0
  79. package/build/internal/cjs/src/calendar-v3-schedule-schedules.types.js.map +1 -0
  80. package/build/internal/{calendar-v3-schedule-schedules.universal-D3nvGK6W.d.mts → cjs/src/calendar-v3-schedule-schedules.universal.d.ts} +404 -111
  81. package/build/internal/cjs/src/calendar-v3-schedule-schedules.universal.js +582 -0
  82. package/build/internal/cjs/src/calendar-v3-schedule-schedules.universal.js.map +1 -0
  83. package/build/internal/es/index.d.ts +1 -0
  84. package/build/internal/es/index.js +2 -0
  85. package/build/internal/es/index.js.map +1 -0
  86. package/build/internal/es/index.typings.d.ts +1 -0
  87. package/build/internal/es/index.typings.js +2 -0
  88. package/build/internal/es/index.typings.js.map +1 -0
  89. package/build/internal/es/meta.d.ts +1 -0
  90. package/build/internal/es/meta.js +2 -0
  91. package/build/internal/es/meta.js.map +1 -0
  92. package/build/internal/es/src/calendar-v3-schedule-schedules.context.d.ts +30 -0
  93. package/build/internal/es/src/calendar-v3-schedule-schedules.context.js +30 -0
  94. package/build/internal/es/src/calendar-v3-schedule-schedules.context.js.map +1 -0
  95. package/build/internal/es/src/calendar-v3-schedule-schedules.http.d.ts +53 -0
  96. package/build/internal/es/src/calendar-v3-schedule-schedules.http.js +247 -0
  97. package/build/internal/es/src/calendar-v3-schedule-schedules.http.js.map +1 -0
  98. package/build/internal/es/src/calendar-v3-schedule-schedules.meta.d.ts +23 -0
  99. package/build/internal/es/src/calendar-v3-schedule-schedules.meta.js +92 -0
  100. package/build/internal/es/src/calendar-v3-schedule-schedules.meta.js.map +1 -0
  101. package/build/internal/es/src/calendar-v3-schedule-schedules.public.d.ts +86 -0
  102. package/build/internal/es/src/calendar-v3-schedule-schedules.public.js +73 -0
  103. package/build/internal/es/src/calendar-v3-schedule-schedules.public.js.map +1 -0
  104. package/build/internal/es/src/calendar-v3-schedule-schedules.types.d.ts +1362 -0
  105. package/build/internal/es/src/calendar-v3-schedule-schedules.types.js +205 -0
  106. package/build/internal/es/src/calendar-v3-schedule-schedules.types.js.map +1 -0
  107. package/build/internal/{calendar-v3-schedule-schedules.universal-D3nvGK6W.d.ts → es/src/calendar-v3-schedule-schedules.universal.d.ts} +404 -111
  108. package/build/internal/es/src/calendar-v3-schedule-schedules.universal.js +551 -0
  109. package/build/internal/es/src/calendar-v3-schedule-schedules.universal.js.map +1 -0
  110. package/package.json +11 -12
  111. package/build/index.d.mts +0 -105
  112. package/build/index.d.ts +0 -105
  113. package/build/index.js +0 -700
  114. package/build/index.js.map +0 -1
  115. package/build/index.mjs +0 -653
  116. package/build/index.mjs.map +0 -1
  117. package/build/internal/index.d.mts +0 -105
  118. package/build/internal/index.d.ts +0 -105
  119. package/build/internal/index.js +0 -700
  120. package/build/internal/index.js.map +0 -1
  121. package/build/internal/index.mjs +0 -653
  122. package/build/internal/index.mjs.map +0 -1
  123. package/build/internal/meta.d.mts +0 -487
  124. package/build/internal/meta.d.ts +0 -487
  125. package/build/internal/meta.js +0 -331
  126. package/build/internal/meta.js.map +0 -1
  127. package/build/internal/meta.mjs +0 -300
  128. package/build/internal/meta.mjs.map +0 -1
  129. package/build/meta.d.mts +0 -487
  130. package/build/meta.d.ts +0 -487
  131. package/build/meta.js +0 -331
  132. package/build/meta.js.map +0 -1
  133. package/build/meta.mjs +0 -300
  134. 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. */
@@ -575,7 +576,7 @@ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
575
576
  assets?: Asset[];
576
577
  }
577
578
  /** @oneof */
578
- interface MetaSiteSpecialEventPayloadOneOf {
579
+ export interface MetaSiteSpecialEventPayloadOneOf {
579
580
  /** Emitted on a meta site creation. */
580
581
  siteCreated?: SiteCreated;
581
582
  /** Emitted on a meta site transfer completion. */
@@ -617,7 +618,7 @@ interface MetaSiteSpecialEventPayloadOneOf {
617
618
  /** Site is marked as PurgedExternally */
618
619
  sitePurgedExternally?: SitePurgedExternally;
619
620
  }
620
- interface Asset {
621
+ export interface Asset {
621
622
  /**
622
623
  * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
623
624
  * @maxLength 36
@@ -631,14 +632,14 @@ interface Asset {
631
632
  /** An application state. */
632
633
  state?: State;
633
634
  }
634
- declare enum State {
635
+ export declare enum State {
635
636
  UNKNOWN = "UNKNOWN",
636
637
  ENABLED = "ENABLED",
637
638
  DISABLED = "DISABLED",
638
639
  PENDING = "PENDING",
639
640
  DEMO = "DEMO"
640
641
  }
641
- interface SiteCreated {
642
+ export interface SiteCreated {
642
643
  /**
643
644
  * A template identifier (empty if not created from a template).
644
645
  * @maxLength 36
@@ -667,7 +668,7 @@ interface SiteCreated {
667
668
  /** A namespace. */
668
669
  namespace?: Namespace;
669
670
  }
670
- declare enum SiteCreatedContext {
671
+ export declare enum SiteCreatedContext {
671
672
  /** A valid option, we don't expose all reasons why site might be created. */
672
673
  OTHER = "OTHER",
673
674
  /** A meta site was created from template. */
@@ -681,7 +682,7 @@ declare enum SiteCreatedContext {
681
682
  /** deprecated A meta site was created for Flash editor. */
682
683
  FLASH = "FLASH"
683
684
  }
684
- declare enum Namespace {
685
+ export declare enum Namespace {
685
686
  UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
686
687
  /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
687
688
  WIX = "WIX",
@@ -764,7 +765,7 @@ declare enum Namespace {
764
765
  MIMIR = "MIMIR"
765
766
  }
766
767
  /** Site transferred to another user. */
767
- interface SiteTransferred {
768
+ export interface SiteTransferred {
768
769
  /**
769
770
  * A previous owner id (user that transfers meta site).
770
771
  * @format GUID
@@ -777,11 +778,11 @@ interface SiteTransferred {
777
778
  newOwnerId?: string;
778
779
  }
779
780
  /** Soft deletion of the meta site. Could be restored. */
780
- interface SiteDeleted {
781
+ export interface SiteDeleted {
781
782
  /** A deletion context. */
782
783
  deleteContext?: DeleteContext;
783
784
  }
784
- interface DeleteContext {
785
+ export interface DeleteContext {
785
786
  /** When the meta site was deleted. */
786
787
  dateDeleted?: Date | null;
787
788
  /** A status. */
@@ -797,7 +798,7 @@ interface DeleteContext {
797
798
  */
798
799
  initiatorId?: string | null;
799
800
  }
800
- declare enum DeleteStatus {
801
+ export declare enum DeleteStatus {
801
802
  UNKNOWN = "UNKNOWN",
802
803
  TRASH = "TRASH",
803
804
  DELETED = "DELETED",
@@ -805,12 +806,12 @@ declare enum DeleteStatus {
805
806
  PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
806
807
  }
807
808
  /** Restoration of the meta site. */
808
- interface SiteUndeleted {
809
+ export interface SiteUndeleted {
809
810
  }
810
811
  /** First publish of a meta site. Or subsequent publish after unpublish. */
811
- interface SitePublished {
812
+ export interface SitePublished {
812
813
  }
813
- interface SiteUnpublished {
814
+ export interface SiteUnpublished {
814
815
  /**
815
816
  * A list of URLs previously associated with the meta site.
816
817
  * @maxLength 4000
@@ -818,9 +819,9 @@ interface SiteUnpublished {
818
819
  */
819
820
  urls?: string[];
820
821
  }
821
- interface SiteMarkedAsTemplate {
822
+ export interface SiteMarkedAsTemplate {
822
823
  }
823
- interface SiteMarkedAsWixSite {
824
+ export interface SiteMarkedAsWixSite {
824
825
  }
825
826
  /**
826
827
  * Represents a service provisioned a site.
@@ -837,7 +838,7 @@ interface SiteMarkedAsWixSite {
837
838
  * changes made to the original template afterward.
838
839
  * To ensure this, the TPA on the template gets a new instance_id.
839
840
  */
840
- interface ServiceProvisioned {
841
+ export interface ServiceProvisioned {
841
842
  /**
842
843
  * Either UUID or EmbeddedServiceType.
843
844
  * @maxLength 36
@@ -864,7 +865,7 @@ interface ServiceProvisioned {
864
865
  */
865
866
  originMetaSiteId?: string | null;
866
867
  }
867
- interface ServiceRemoved {
868
+ export interface ServiceRemoved {
868
869
  /**
869
870
  * Either UUID or EmbeddedServiceType.
870
871
  * @maxLength 36
@@ -882,7 +883,7 @@ interface ServiceRemoved {
882
883
  version?: string | null;
883
884
  }
884
885
  /** Rename of the site. Meaning, free public url has been changed as well. */
885
- interface SiteRenamed {
886
+ export interface SiteRenamed {
886
887
  /**
887
888
  * A new meta site name (URL slug).
888
889
  * @maxLength 20
@@ -899,21 +900,21 @@ interface SiteRenamed {
899
900
  *
900
901
  * Could not be restored. Therefore it's desirable to cleanup data.
901
902
  */
902
- interface SiteHardDeleted {
903
+ export interface SiteHardDeleted {
903
904
  /** A deletion context. */
904
905
  deleteContext?: DeleteContext;
905
906
  }
906
- interface NamespaceChanged {
907
+ export interface NamespaceChanged {
907
908
  /** A previous namespace. */
908
909
  oldNamespace?: Namespace;
909
910
  /** A new namespace. */
910
911
  newNamespace?: Namespace;
911
912
  }
912
913
  /** Assigned Studio editor */
913
- interface StudioAssigned {
914
+ export interface StudioAssigned {
914
915
  }
915
916
  /** Unassigned Studio editor */
916
- interface StudioUnassigned {
917
+ export interface StudioUnassigned {
917
918
  }
918
919
  /**
919
920
  * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
@@ -923,13 +924,13 @@ interface StudioUnassigned {
923
924
  *
924
925
  * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
925
926
  */
926
- interface SiteUrlChanged {
927
+ export interface SiteUrlChanged {
927
928
  }
928
929
  /**
929
930
  * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
930
931
  * Consumed by other teams to remove relevant data.
931
932
  */
932
- interface SitePurgedExternally {
933
+ export interface SitePurgedExternally {
933
934
  /**
934
935
  * @maxLength 2048
935
936
  * @maxSize 100
@@ -938,10 +939,10 @@ interface SitePurgedExternally {
938
939
  */
939
940
  appDefId?: string[];
940
941
  }
941
- interface Empty {
942
+ export interface Empty {
942
943
  }
943
944
  /** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
944
- interface SitePropertiesNotification {
945
+ export interface SitePropertiesNotification {
945
946
  /** The site ID for which this update notification applies. */
946
947
  metasiteId?: string;
947
948
  /** The actual update event. */
@@ -955,7 +956,7 @@ interface SitePropertiesNotification {
955
956
  changeContext?: ChangeContext;
956
957
  }
957
958
  /** The actual update event for a particular notification. */
958
- interface SitePropertiesEvent {
959
+ export interface SitePropertiesEvent {
959
960
  /** Version of the site's properties represented by this update. */
960
961
  version?: number;
961
962
  /** Set of properties that were updated - corresponds to the fields in "properties". */
@@ -963,7 +964,7 @@ interface SitePropertiesEvent {
963
964
  /** Updated properties. */
964
965
  properties?: Properties;
965
966
  }
966
- interface Properties {
967
+ export interface Properties {
967
968
  /** Site categories. */
968
969
  categories?: Categories;
969
970
  /** Site locale. */
@@ -1019,7 +1020,7 @@ interface Properties {
1019
1020
  /** Track clicks analytics. */
1020
1021
  trackClicksAnalytics?: boolean;
1021
1022
  }
1022
- interface Categories {
1023
+ export interface Categories {
1023
1024
  /** Primary site category. */
1024
1025
  primary?: string;
1025
1026
  /**
@@ -1030,13 +1031,13 @@ interface Categories {
1030
1031
  /** Business Term Id */
1031
1032
  businessTermId?: string | null;
1032
1033
  }
1033
- interface Locale {
1034
+ export interface Locale {
1034
1035
  /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
1035
1036
  languageCode?: string;
1036
1037
  /** 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
1038
  country?: string;
1038
1039
  }
1039
- interface Address {
1040
+ export interface Address {
1040
1041
  /** Street name. */
1041
1042
  street?: string;
1042
1043
  /** City name. */
@@ -1068,27 +1069,27 @@ interface Address {
1068
1069
  * This is used for display purposes. Used to add additional data about the address, such as "In the passage".
1069
1070
  * Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
1070
1071
  */
1071
- interface AddressHint {
1072
+ export interface AddressHint {
1072
1073
  /** Extra text displayed next to, or instead of, the actual address. */
1073
1074
  text?: string;
1074
1075
  /** Where the extra text should be displayed. */
1075
1076
  placement?: PlacementType;
1076
1077
  }
1077
1078
  /** Where the extra text should be displayed: before, after or instead of the actual address. */
1078
- declare enum PlacementType {
1079
+ export declare enum PlacementType {
1079
1080
  BEFORE = "BEFORE",
1080
1081
  AFTER = "AFTER",
1081
1082
  REPLACE = "REPLACE"
1082
1083
  }
1083
1084
  /** Geocoordinates for a particular address. */
1084
- interface GeoCoordinates {
1085
+ export interface GeoCoordinates {
1085
1086
  /** Latitude of the location. Must be between -90 and 90. */
1086
1087
  latitude?: number;
1087
1088
  /** Longitude of the location. Must be between -180 and 180. */
1088
1089
  longitude?: number;
1089
1090
  }
1090
1091
  /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
1091
- interface BusinessSchedule {
1092
+ export interface BusinessSchedule {
1092
1093
  /**
1093
1094
  * Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
1094
1095
  * @maxSize 100
@@ -1101,7 +1102,7 @@ interface BusinessSchedule {
1101
1102
  specialHourPeriod?: SpecialHourPeriod[];
1102
1103
  }
1103
1104
  /** Weekly recurring time periods when the business is regularly open or the service is available. */
1104
- interface TimePeriod {
1105
+ export interface TimePeriod {
1105
1106
  /** Day of the week the period starts on. */
1106
1107
  openDay?: DayOfWeek;
1107
1108
  /**
@@ -1120,7 +1121,7 @@ interface TimePeriod {
1120
1121
  closeTime?: string;
1121
1122
  }
1122
1123
  /** Enumerates the days of the week. */
1123
- declare enum DayOfWeek {
1124
+ export declare enum DayOfWeek {
1124
1125
  MONDAY = "MONDAY",
1125
1126
  TUESDAY = "TUESDAY",
1126
1127
  WEDNESDAY = "WEDNESDAY",
@@ -1130,7 +1131,7 @@ declare enum DayOfWeek {
1130
1131
  SUNDAY = "SUNDAY"
1131
1132
  }
1132
1133
  /** Exception to the business's regular hours. The business can be open or closed during the exception. */
1133
- interface SpecialHourPeriod {
1134
+ export interface SpecialHourPeriod {
1134
1135
  /** 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
1136
  startDate?: string;
1136
1137
  /** 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 +1145,7 @@ interface SpecialHourPeriod {
1144
1145
  /** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
1145
1146
  comment?: string;
1146
1147
  }
1147
- interface Multilingual {
1148
+ export interface Multilingual {
1148
1149
  /**
1149
1150
  * Supported languages list.
1150
1151
  * @maxSize 200
@@ -1153,7 +1154,7 @@ interface Multilingual {
1153
1154
  /** Whether to redirect to user language. */
1154
1155
  autoRedirect?: boolean;
1155
1156
  }
1156
- interface SupportedLanguage {
1157
+ export interface SupportedLanguage {
1157
1158
  /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
1158
1159
  languageCode?: string;
1159
1160
  /** Locale. */
@@ -1165,12 +1166,12 @@ interface SupportedLanguage {
1165
1166
  /** How the language will be resolved. For internal use. */
1166
1167
  resolutionMethod?: ResolutionMethod;
1167
1168
  }
1168
- declare enum ResolutionMethod {
1169
+ export declare enum ResolutionMethod {
1169
1170
  QUERY_PARAM = "QUERY_PARAM",
1170
1171
  SUBDOMAIN = "SUBDOMAIN",
1171
1172
  SUBDIRECTORY = "SUBDIRECTORY"
1172
1173
  }
1173
- interface ConsentPolicy {
1174
+ export interface ConsentPolicy {
1174
1175
  /** Whether the site uses cookies that are essential to site operation. Always `true`. */
1175
1176
  essential?: boolean | null;
1176
1177
  /** Whether the site uses cookies that affect site performance and other functional measurements. */
@@ -1183,7 +1184,7 @@ interface ConsentPolicy {
1183
1184
  dataToThirdParty?: boolean | null;
1184
1185
  }
1185
1186
  /** A single mapping from the MetaSite ID to a particular service. */
1186
- interface Translation {
1187
+ export interface Translation {
1187
1188
  /** The service type. */
1188
1189
  serviceType?: string;
1189
1190
  /** The application definition ID; this only applies to services of type ThirdPartyApps. */
@@ -1191,7 +1192,7 @@ interface Translation {
1191
1192
  /** The instance ID of the service. */
1192
1193
  instanceId?: string;
1193
1194
  }
1194
- interface ChangeContext extends ChangeContextPayloadOneOf {
1195
+ export interface ChangeContext extends ChangeContextPayloadOneOf {
1195
1196
  /** Properties were updated. */
1196
1197
  propertiesChange?: PropertiesChange;
1197
1198
  /** Default properties were created on site creation. */
@@ -1200,7 +1201,7 @@ interface ChangeContext extends ChangeContextPayloadOneOf {
1200
1201
  siteCloned?: SiteCloned;
1201
1202
  }
1202
1203
  /** @oneof */
1203
- interface ChangeContextPayloadOneOf {
1204
+ export interface ChangeContextPayloadOneOf {
1204
1205
  /** Properties were updated. */
1205
1206
  propertiesChange?: PropertiesChange;
1206
1207
  /** Default properties were created on site creation. */
@@ -1208,17 +1209,17 @@ interface ChangeContextPayloadOneOf {
1208
1209
  /** Properties were cloned on site cloning. */
1209
1210
  siteCloned?: SiteCloned;
1210
1211
  }
1211
- interface PropertiesChange {
1212
+ export interface PropertiesChange {
1212
1213
  }
1213
- interface V4SiteCreated {
1214
+ export interface V4SiteCreated {
1214
1215
  /** Origin template site id. */
1215
1216
  originTemplateId?: string | null;
1216
1217
  }
1217
- interface SiteCloned {
1218
+ export interface SiteCloned {
1218
1219
  /** Origin site id. */
1219
1220
  originMetaSiteId?: string;
1220
1221
  }
1221
- interface DomainEvent extends DomainEventBodyOneOf {
1222
+ export interface DomainEvent extends DomainEventBodyOneOf {
1222
1223
  createdEvent?: EntityCreatedEvent;
1223
1224
  updatedEvent?: EntityUpdatedEvent;
1224
1225
  deletedEvent?: EntityDeletedEvent;
@@ -1261,19 +1262,19 @@ interface DomainEvent extends DomainEventBodyOneOf {
1261
1262
  entityEventSequence?: string | null;
1262
1263
  }
1263
1264
  /** @oneof */
1264
- interface DomainEventBodyOneOf {
1265
+ export interface DomainEventBodyOneOf {
1265
1266
  createdEvent?: EntityCreatedEvent;
1266
1267
  updatedEvent?: EntityUpdatedEvent;
1267
1268
  deletedEvent?: EntityDeletedEvent;
1268
1269
  actionEvent?: ActionEvent;
1269
1270
  }
1270
- interface EntityCreatedEvent {
1271
+ export interface EntityCreatedEvent {
1271
1272
  entity?: string;
1272
1273
  }
1273
- interface RestoreInfo {
1274
+ export interface RestoreInfo {
1274
1275
  deletedDate?: Date | null;
1275
1276
  }
1276
- interface EntityUpdatedEvent {
1277
+ export interface EntityUpdatedEvent {
1277
1278
  /**
1278
1279
  * 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
1280
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
@@ -1281,14 +1282,14 @@ interface EntityUpdatedEvent {
1281
1282
  */
1282
1283
  currentEntity?: string;
1283
1284
  }
1284
- interface EntityDeletedEvent {
1285
+ export interface EntityDeletedEvent {
1285
1286
  /** Entity that was deleted */
1286
1287
  deletedEntity?: string | null;
1287
1288
  }
1288
- interface ActionEvent {
1289
+ export interface ActionEvent {
1289
1290
  body?: string;
1290
1291
  }
1291
- interface MessageEnvelope {
1292
+ export interface MessageEnvelope {
1292
1293
  /**
1293
1294
  * App instance ID.
1294
1295
  * @format GUID
@@ -1304,7 +1305,7 @@ interface MessageEnvelope {
1304
1305
  /** Stringify payload. */
1305
1306
  data?: string;
1306
1307
  }
1307
- interface IdentificationData extends IdentificationDataIdOneOf {
1308
+ export interface IdentificationData extends IdentificationDataIdOneOf {
1308
1309
  /**
1309
1310
  * ID of a site visitor that has not logged in to the site.
1310
1311
  * @format GUID
@@ -1329,7 +1330,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
1329
1330
  identityType?: WebhookIdentityType;
1330
1331
  }
1331
1332
  /** @oneof */
1332
- interface IdentificationDataIdOneOf {
1333
+ export interface IdentificationDataIdOneOf {
1333
1334
  /**
1334
1335
  * ID of a site visitor that has not logged in to the site.
1335
1336
  * @format GUID
@@ -1351,14 +1352,14 @@ interface IdentificationDataIdOneOf {
1351
1352
  */
1352
1353
  appId?: string;
1353
1354
  }
1354
- declare enum WebhookIdentityType {
1355
+ export declare enum WebhookIdentityType {
1355
1356
  UNKNOWN = "UNKNOWN",
1356
1357
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1357
1358
  MEMBER = "MEMBER",
1358
1359
  WIX_USER = "WIX_USER",
1359
1360
  APP = "APP"
1360
1361
  }
1361
- interface BaseEventMetadata {
1362
+ export interface BaseEventMetadata {
1362
1363
  /**
1363
1364
  * App instance ID.
1364
1365
  * @format GUID
@@ -1372,7 +1373,7 @@ interface BaseEventMetadata {
1372
1373
  /** The identification type and identity data. */
1373
1374
  identity?: IdentificationData;
1374
1375
  }
1375
- interface EventMetadata extends BaseEventMetadata {
1376
+ export interface EventMetadata extends BaseEventMetadata {
1376
1377
  /**
1377
1378
  * Unique event ID.
1378
1379
  * Allows clients to ignore duplicate webhooks.
@@ -1410,23 +1411,170 @@ interface EventMetadata extends BaseEventMetadata {
1410
1411
  */
1411
1412
  entityEventSequence?: string | null;
1412
1413
  }
1413
- interface ScheduleCancelledEnvelope {
1414
+ export interface ScheduleCancelledEnvelope {
1414
1415
  data: ScheduleCancelled;
1415
1416
  metadata: EventMetadata;
1416
1417
  }
1417
- interface ScheduleClonedEnvelope {
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
+ * @permissionId CALENDAR.SCHEDULE_READ_PI
1435
+ * @webhook
1436
+ * @eventType wix.calendar.v3.schedule_cancelled
1437
+ * @serviceIdentifier wix.calendar.schedules.v3.SchedulesService
1438
+ * @slug cancelled
1439
+ * @documentationMaturity preview
1440
+ */
1441
+ export declare function onScheduleCancelled(handler: (event: ScheduleCancelledEnvelope) => void | Promise<void>): void;
1442
+ export interface ScheduleClonedEnvelope {
1418
1443
  data: ScheduleCloned;
1419
1444
  metadata: EventMetadata;
1420
1445
  }
1421
- interface ScheduleCreatedEnvelope {
1446
+ /**
1447
+ * Triggered when a schedule is cloned.
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_cloned
1465
+ * @serviceIdentifier wix.calendar.schedules.v3.SchedulesService
1466
+ * @slug cloned
1467
+ * @documentationMaturity preview
1468
+ */
1469
+ export declare function onScheduleCloned(handler: (event: ScheduleClonedEnvelope) => void | Promise<void>): void;
1470
+ export interface ScheduleCreatedEnvelope {
1422
1471
  entity: Schedule;
1423
1472
  metadata: EventMetadata;
1424
1473
  }
1425
- interface ScheduleUpdatedEnvelope {
1474
+ /**
1475
+ * Triggered when a schedule is created.
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_created
1493
+ * @serviceIdentifier wix.calendar.schedules.v3.SchedulesService
1494
+ * @slug created
1495
+ * @documentationMaturity preview
1496
+ */
1497
+ export declare function onScheduleCreated(handler: (event: ScheduleCreatedEnvelope) => void | Promise<void>): void;
1498
+ export interface ScheduleUpdatedEnvelope {
1426
1499
  entity: Schedule;
1427
1500
  metadata: EventMetadata;
1428
1501
  }
1429
- interface GetScheduleOptions {
1502
+ /**
1503
+ * Triggered when a schedule is updated.
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_updated
1521
+ * @serviceIdentifier wix.calendar.schedules.v3.SchedulesService
1522
+ * @slug updated
1523
+ * @documentationMaturity preview
1524
+ */
1525
+ export declare function onScheduleUpdated(handler: (event: ScheduleUpdatedEnvelope) => void | Promise<void>): void;
1526
+ type ScheduleNonNullablePaths = `status` | `defaultLocation.type` | `defaultConferencingDetails.type` | `permissions` | `permissions.${number}.identity.wixUserId` | `permissions.${number}.role`;
1527
+ /**
1528
+ * Retrieves a schedule.
1529
+ * @param scheduleId - ID of the schedule to retrieve.
1530
+ * @public
1531
+ * @documentationMaturity preview
1532
+ * @requiredField scheduleId
1533
+ * @permissionId CALENDAR.SCHEDULE_READ
1534
+ * @permissionId CALENDAR.SCHEDULE_READ_PI
1535
+ * @permissionScope Read Bookings - Public Data
1536
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
1537
+ * @permissionScope Read Calendar - Including PI
1538
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
1539
+ * @permissionScope Manage Calendars
1540
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
1541
+ * @permissionScope Manage Bookings
1542
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
1543
+ * @permissionScope Read Bookings - Including Participants
1544
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
1545
+ * @permissionScope Read Bookings - all read permissions
1546
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
1547
+ * @permissionScope Read Bookings Calendar Availability
1548
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
1549
+ * @permissionScope Read Calendar
1550
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
1551
+ * @permissionScope Manage Bookings - all permissions
1552
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
1553
+ * @permissionScope Read bookings calendar - including participants
1554
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
1555
+ * @permissionScope Read Bookings Calendar
1556
+ * @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
1557
+ * @permissionScope Read Calendar - Including PI
1558
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
1559
+ * @permissionScope Manage Calendars
1560
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
1561
+ * @permissionScope Manage Bookings
1562
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
1563
+ * @permissionScope Read Bookings - Including Participants
1564
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
1565
+ * @permissionScope Read Bookings - all read permissions
1566
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
1567
+ * @permissionScope Manage Bookings - all permissions
1568
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
1569
+ * @permissionScope Read bookings calendar - including participants
1570
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
1571
+ * @applicableIdentity APP
1572
+ * @applicableIdentity VISITOR
1573
+ * @returns Retrieved schedule.
1574
+ * @fqn wix.calendar.schedules.v3.SchedulesService.GetSchedule
1575
+ */
1576
+ export declare function getSchedule(scheduleId: string, options?: GetScheduleOptions): Promise<NonNullablePaths<Schedule, ScheduleNonNullablePaths>>;
1577
+ export interface GetScheduleOptions {
1430
1578
  /**
1431
1579
  * Information about which fields containing personal data to return. Refer to the
1432
1580
  * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
@@ -1442,7 +1590,69 @@ interface GetScheduleOptions {
1442
1590
  */
1443
1591
  fields?: RequestedFields[];
1444
1592
  }
1445
- interface QuerySchedulesOptions {
1593
+ /**
1594
+ * Creates a query to retrieve a list of schedules.
1595
+ *
1596
+ * The `querySchedules()` function builds a query to retrieve a list of tip settings and returns a `SchedulesQueryBuilder` object.
1597
+ *
1598
+ * 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.
1599
+ *
1600
+ * 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.
1601
+ *
1602
+ * `querySchedules()` runs with the following `SchedulesQueryBuilder` default that you can override:
1603
+ *
1604
+ * + `limit` is `50`.
1605
+ * + Sorted by `id` in ascending order.
1606
+ *
1607
+ * 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"`.
1608
+ *
1609
+ * 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`.
1610
+ * @public
1611
+ * @documentationMaturity preview
1612
+ * @permissionScope Read Bookings - Public Data
1613
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
1614
+ * @permissionScope Read Calendar - Including PI
1615
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
1616
+ * @permissionScope Manage Calendars
1617
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
1618
+ * @permissionScope Manage Bookings
1619
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
1620
+ * @permissionScope Read Bookings - Including Participants
1621
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
1622
+ * @permissionScope Read Bookings - all read permissions
1623
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
1624
+ * @permissionScope Read Bookings Calendar Availability
1625
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
1626
+ * @permissionScope Read Calendar
1627
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
1628
+ * @permissionScope Manage Bookings - all permissions
1629
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
1630
+ * @permissionScope Read bookings calendar - including participants
1631
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
1632
+ * @permissionScope Read Bookings Calendar
1633
+ * @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
1634
+ * @permissionScope Read Calendar - Including PI
1635
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
1636
+ * @permissionScope Manage Calendars
1637
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
1638
+ * @permissionScope Manage Bookings
1639
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
1640
+ * @permissionScope Read Bookings - Including Participants
1641
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
1642
+ * @permissionScope Read Bookings - all read permissions
1643
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
1644
+ * @permissionScope Manage Bookings - all permissions
1645
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
1646
+ * @permissionScope Read bookings calendar - including participants
1647
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
1648
+ * @permissionId CALENDAR.SCHEDULE_READ
1649
+ * @permissionId CALENDAR.SCHEDULE_READ_PI
1650
+ * @applicableIdentity APP
1651
+ * @applicableIdentity VISITOR
1652
+ * @fqn wix.calendar.schedules.v3.SchedulesService.QuerySchedules
1653
+ */
1654
+ export declare function querySchedules(options?: QuerySchedulesOptions): SchedulesQueryBuilder;
1655
+ export interface QuerySchedulesOptions {
1446
1656
  /**
1447
1657
  * Information about which fields containing personal data to return. Refer to the
1448
1658
  * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
@@ -1465,13 +1675,13 @@ interface QueryCursorResult {
1465
1675
  length: number;
1466
1676
  pageSize: number;
1467
1677
  }
1468
- interface SchedulesQueryResult extends QueryCursorResult {
1678
+ export interface SchedulesQueryResult extends QueryCursorResult {
1469
1679
  items: Schedule[];
1470
1680
  query: SchedulesQueryBuilder;
1471
1681
  next: () => Promise<SchedulesQueryResult>;
1472
1682
  prev: () => Promise<SchedulesQueryResult>;
1473
1683
  }
1474
- interface SchedulesQueryBuilder {
1684
+ export interface SchedulesQueryBuilder {
1475
1685
  /** @param propertyName - Property whose value is compared with `value`.
1476
1686
  * @param value - Value to compare against.
1477
1687
  * @documentationMaturity preview
@@ -1490,7 +1700,37 @@ interface SchedulesQueryBuilder {
1490
1700
  /** @documentationMaturity preview */
1491
1701
  find: () => Promise<SchedulesQueryResult>;
1492
1702
  }
1493
- interface CreateScheduleOptions {
1703
+ /**
1704
+ * Creates a schedule.
1705
+ *
1706
+ *
1707
+ * If you want the schedule's events to appear in the
1708
+ * [Bookings calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar),
1709
+ * you must set `appId` to the ID of the Wix Bookings app by providing
1710
+ * `{"appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97"}`.
1711
+ * @param schedule - Schedule to create.
1712
+ * @public
1713
+ * @documentationMaturity preview
1714
+ * @requiredField schedule
1715
+ * @requiredField schedule.defaultConferencingDetails.guestUrl
1716
+ * @requiredField schedule.defaultConferencingDetails.hostUrl
1717
+ * @requiredField schedule.defaultConferencingDetails.type
1718
+ * @requiredField schedule.defaultLocation.type
1719
+ * @requiredField schedule.permissions.identity
1720
+ * @requiredField schedule.permissions.role
1721
+ * @permissionId CALENDAR.SCHEDULE_CREATE
1722
+ * @permissionScope Manage Calendars
1723
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
1724
+ * @permissionScope Manage Bookings
1725
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
1726
+ * @permissionScope Manage Bookings - all permissions
1727
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
1728
+ * @applicableIdentity APP
1729
+ * @returns Created schedule.
1730
+ * @fqn wix.calendar.schedules.v3.SchedulesService.CreateSchedule
1731
+ */
1732
+ 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>>;
1733
+ export interface CreateScheduleOptions {
1494
1734
  /**
1495
1735
  * Idempotency key guaranteeing that you don't create the same schedule more
1496
1736
  * than once.
@@ -1498,7 +1738,36 @@ interface CreateScheduleOptions {
1498
1738
  */
1499
1739
  idempotencyKey?: string | null;
1500
1740
  }
1501
- interface UpdateSchedule {
1741
+ /**
1742
+ * Updates a schedule.
1743
+ *
1744
+ *
1745
+ * Each time the schedule is updated,
1746
+ * `revision` increments by 1.
1747
+ * The current `revision` must be passed when updating the schedule.
1748
+ * This ensures you're working with the latest schedule
1749
+ * and prevents unintended overwrites.
1750
+ * @param _id - Schedule ID.
1751
+ * @public
1752
+ * @documentationMaturity preview
1753
+ * @requiredField _id
1754
+ * @requiredField schedule
1755
+ * @requiredField schedule.permissions.identity
1756
+ * @requiredField schedule.permissions.role
1757
+ * @requiredField schedule.revision
1758
+ * @permissionId CALENDAR.SCHEDULE_UPDATE
1759
+ * @permissionScope Manage Calendars
1760
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
1761
+ * @permissionScope Manage Bookings
1762
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
1763
+ * @permissionScope Manage Bookings - all permissions
1764
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
1765
+ * @applicableIdentity APP
1766
+ * @returns Updated schedule.
1767
+ * @fqn wix.calendar.schedules.v3.SchedulesService.UpdateSchedule
1768
+ */
1769
+ export declare function updateSchedule(_id: string, schedule: NonNullablePaths<UpdateSchedule, `permissions.${number}.identity` | `permissions.${number}.role` | `revision`>, options?: UpdateScheduleOptions): Promise<NonNullablePaths<Schedule, ScheduleNonNullablePaths>>;
1770
+ export interface UpdateSchedule {
1502
1771
  /**
1503
1772
  * Schedule ID.
1504
1773
  * @format GUID
@@ -1623,14 +1892,39 @@ interface UpdateSchedule {
1623
1892
  */
1624
1893
  _updatedDate?: Date | null;
1625
1894
  }
1626
- interface UpdateScheduleOptions {
1895
+ export interface UpdateScheduleOptions {
1627
1896
  /**
1628
1897
  * Information about whether participants of the schedule's updated events are
1629
1898
  * notified and the message they receive.
1630
1899
  */
1631
1900
  participantNotification?: ParticipantNotification;
1632
1901
  }
1633
- interface CancelScheduleOptions {
1902
+ /**
1903
+ * Sets a schedule's `status` to `CANCELLED`.
1904
+ *
1905
+ *
1906
+ * Also cancels future events belonging to the schedule.
1907
+ *
1908
+ * Once a schedule is marked as `CANCELLED`, you can't reactivate it, update it,
1909
+ * or assign new events.
1910
+ * @param scheduleId - ID of the schedule to cancel.
1911
+ * @public
1912
+ * @documentationMaturity preview
1913
+ * @requiredField scheduleId
1914
+ * @permissionId CALENDAR.SCHEDULE_CANCEL
1915
+ * @permissionScope Manage Calendars
1916
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
1917
+ * @permissionScope Manage Bookings
1918
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
1919
+ * @permissionScope Manage Bookings - all permissions
1920
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
1921
+ * @applicableIdentity APP
1922
+ * @fqn wix.calendar.schedules.v3.SchedulesService.CancelSchedule
1923
+ */
1924
+ export declare function cancelSchedule(scheduleId: string, options?: CancelScheduleOptions): Promise<NonNullablePaths<CancelScheduleResponse, {
1925
+ [P in ScheduleNonNullablePaths]: `schedule.${P}`;
1926
+ }[ScheduleNonNullablePaths]>>;
1927
+ export interface CancelScheduleOptions {
1634
1928
  /**
1635
1929
  * Whether to preserve future events with participants.
1636
1930
  * Default: `false`.
@@ -1642,5 +1936,4 @@ interface CancelScheduleOptions {
1642
1936
  */
1643
1937
  participantNotification?: ParticipantNotification;
1644
1938
  }
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 };
1939
+ export {};