@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
package/build/index.d.mts DELETED
@@ -1,105 +0,0 @@
1
- import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
2
- import { G as GetScheduleOptions, S as Schedule, Q as QuerySchedulesOptions, a as SchedulesQueryBuilder, C as CreateScheduleOptions, U as UpdateSchedule, b as UpdateScheduleOptions, c as CancelScheduleOptions, d as CancelScheduleResponse } from './calendar-v3-schedule-schedules.universal-D3nvGK6W.mjs';
3
- export { aI as ActionEvent, an as Address, ao as AddressHint, _ as Asset, aM as BaseEventMetadata, aq as BusinessSchedule, V as CancelScheduleRequest, al as Categories, ax as ChangeContext, ay as ChangeContextPayloadOneOf, K as CloneScheduleRequest, M as CloneScheduleResponse, o as CommonIdentificationData, p as CommonIdentificationDataIdOneOf, m as ConferencingDetails, av as ConsentPolicy, z as CreateScheduleRequest, A as CreateScheduleResponse, v as CursorPaging, x as CursorPagingMetadata, t as CursorQuery, u as CursorQueryPagingMethodOneOf, y as Cursors, j as DayOfWeek, a2 as DeleteContext, D as DeleteStatus, aC as DomainEvent, aD as DomainEventBodyOneOf, ah as Empty, aE as EntityCreatedEvent, aH as EntityDeletedEvent, aG as EntityUpdatedEvent, aN as EventMetadata, E as ExtendedFields, ap as GeoCoordinates, q as GetScheduleRequest, r as GetScheduleResponse, aK as IdentificationData, aL as IdentificationDataIdOneOf, I as IdentityType, am as Locale, l as Location, L as LocationType, aJ as MessageEnvelope, Y as MetaSiteSpecialEvent, Z as MetaSiteSpecialEventPayloadOneOf, at as Multilingual, N as Namespace, ac as NamespaceChanged, F as ParticipantNotification, n as Permission, P as PlacementType, ak as Properties, az as PropertiesChange, s as QuerySchedulesRequest, w as QuerySchedulesResponse, f as RequestedFields, k as ResolutionMethod, aF as RestoreInfo, R as Role, X as ScheduleCancelled, aO as ScheduleCancelledEnvelope, O as ScheduleCloned, aP as ScheduleClonedEnvelope, aQ as ScheduleCreatedEnvelope, aR as ScheduleUpdatedEnvelope, J as ScheduleUpdatedWithMetadata, aS as SchedulesQueryResult, a8 as ServiceProvisioned, a9 as ServiceRemoved, aB as SiteCloned, $ as SiteCreated, i as SiteCreatedContext, a1 as SiteDeleted, ab as SiteHardDeleted, a6 as SiteMarkedAsTemplate, a7 as SiteMarkedAsWixSite, aj as SitePropertiesEvent, ai as SitePropertiesNotification, a4 as SitePublished, ag as SitePurgedExternally, aa as SiteRenamed, a0 as SiteTransferred, a3 as SiteUndeleted, a5 as SiteUnpublished, af as SiteUrlChanged, as as SpecialHourPeriod, h as State, e as Status, ad as StudioAssigned, ae as StudioUnassigned, au as SupportedLanguage, ar as TimePeriod, aw as Translation, g as Trigger, T as Type, B as UpdateScheduleRequest, H as UpdateScheduleResponse, aA as V4SiteCreated, W as WebhookIdentityType } from './calendar-v3-schedule-schedules.universal-D3nvGK6W.mjs';
4
- import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
5
-
6
- declare function getSchedule$1(httpClient: HttpClient): GetScheduleSignature;
7
- interface GetScheduleSignature {
8
- /**
9
- * Retrieves a schedule.
10
- * @param - ID of the schedule to retrieve.
11
- * @returns Retrieved schedule.
12
- */
13
- (scheduleId: string, options?: GetScheduleOptions | undefined): Promise<Schedule>;
14
- }
15
- declare function querySchedules$1(httpClient: HttpClient): QuerySchedulesSignature;
16
- interface QuerySchedulesSignature {
17
- /**
18
- * Creates a query to retrieve a list of schedules.
19
- *
20
- * The `querySchedules()` function builds a query to retrieve a list of tip settings and returns a `SchedulesQueryBuilder` object.
21
- *
22
- * 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.
23
- *
24
- * 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.
25
- *
26
- * `querySchedules()` runs with the following `SchedulesQueryBuilder` default that you can override:
27
- *
28
- * + `limit` is `50`.
29
- * + Sorted by `id` in ascending order.
30
- *
31
- * 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"`.
32
- *
33
- * 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`.
34
- */
35
- (options?: QuerySchedulesOptions | undefined): SchedulesQueryBuilder;
36
- }
37
- declare function createSchedule$1(httpClient: HttpClient): CreateScheduleSignature;
38
- interface CreateScheduleSignature {
39
- /**
40
- * Creates a schedule.
41
- *
42
- *
43
- * If you want the schedule's events to appear in the
44
- * [Bookings calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar),
45
- * you must set `appId` to the ID of the Wix Bookings app by providing
46
- * `{"appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97"}`.
47
- * @param - Schedule to create.
48
- * @returns Created schedule.
49
- */
50
- (schedule: Schedule, options?: CreateScheduleOptions | undefined): Promise<Schedule>;
51
- }
52
- declare function updateSchedule$1(httpClient: HttpClient): UpdateScheduleSignature;
53
- interface UpdateScheduleSignature {
54
- /**
55
- * Updates a schedule.
56
- *
57
- *
58
- * Each time the schedule is updated,
59
- * `revision` increments by 1.
60
- * The current `revision` must be passed when updating the schedule.
61
- * This ensures you're working with the latest schedule
62
- * and prevents unintended overwrites.
63
- * @param - Schedule ID.
64
- * @returns Updated schedule.
65
- */
66
- (_id: string, schedule: UpdateSchedule, options?: UpdateScheduleOptions | undefined): Promise<Schedule>;
67
- }
68
- declare function cancelSchedule$1(httpClient: HttpClient): CancelScheduleSignature;
69
- interface CancelScheduleSignature {
70
- /**
71
- * Sets a schedule's `status` to `CANCELLED`.
72
- *
73
- *
74
- * Also cancels future events belonging to the schedule.
75
- *
76
- * Once a schedule is marked as `CANCELLED`, you can't reactivate it, update it,
77
- * or assign new events.
78
- * @param - ID of the schedule to cancel.
79
- */
80
- (scheduleId: string, options?: CancelScheduleOptions | undefined): Promise<CancelScheduleResponse>;
81
- }
82
-
83
- declare const getSchedule: MaybeContext<BuildRESTFunction<typeof getSchedule$1> & typeof getSchedule$1>;
84
- declare const querySchedules: MaybeContext<BuildRESTFunction<typeof querySchedules$1> & typeof querySchedules$1>;
85
- declare const createSchedule: MaybeContext<BuildRESTFunction<typeof createSchedule$1> & typeof createSchedule$1>;
86
- declare const updateSchedule: MaybeContext<BuildRESTFunction<typeof updateSchedule$1> & typeof updateSchedule$1>;
87
- declare const cancelSchedule: MaybeContext<BuildRESTFunction<typeof cancelSchedule$1> & typeof cancelSchedule$1>;
88
- /**
89
- * Triggered when a schedule is canceled.
90
- */
91
- declare const onScheduleCancelled: ReturnType<typeof createEventModule<typeof publicOnScheduleCancelled>>;
92
- /**
93
- * Triggered when a schedule is cloned.
94
- */
95
- declare const onScheduleCloned: ReturnType<typeof createEventModule<typeof publicOnScheduleCloned>>;
96
- /**
97
- * Triggered when a schedule is created.
98
- */
99
- declare const onScheduleCreated: ReturnType<typeof createEventModule<typeof publicOnScheduleCreated>>;
100
- /**
101
- * Triggered when a schedule is updated.
102
- */
103
- declare const onScheduleUpdated: ReturnType<typeof createEventModule<typeof publicOnScheduleUpdated>>;
104
-
105
- export { CancelScheduleOptions, CancelScheduleResponse, CreateScheduleOptions, GetScheduleOptions, QuerySchedulesOptions, Schedule, SchedulesQueryBuilder, UpdateSchedule, UpdateScheduleOptions, cancelSchedule, createSchedule, getSchedule, onScheduleCancelled, onScheduleCloned, onScheduleCreated, onScheduleUpdated, querySchedules, updateSchedule };
package/build/index.d.ts DELETED
@@ -1,105 +0,0 @@
1
- import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
2
- import { G as GetScheduleOptions, S as Schedule, Q as QuerySchedulesOptions, a as SchedulesQueryBuilder, C as CreateScheduleOptions, U as UpdateSchedule, b as UpdateScheduleOptions, c as CancelScheduleOptions, d as CancelScheduleResponse } from './calendar-v3-schedule-schedules.universal-D3nvGK6W.js';
3
- export { aI as ActionEvent, an as Address, ao as AddressHint, _ as Asset, aM as BaseEventMetadata, aq as BusinessSchedule, V as CancelScheduleRequest, al as Categories, ax as ChangeContext, ay as ChangeContextPayloadOneOf, K as CloneScheduleRequest, M as CloneScheduleResponse, o as CommonIdentificationData, p as CommonIdentificationDataIdOneOf, m as ConferencingDetails, av as ConsentPolicy, z as CreateScheduleRequest, A as CreateScheduleResponse, v as CursorPaging, x as CursorPagingMetadata, t as CursorQuery, u as CursorQueryPagingMethodOneOf, y as Cursors, j as DayOfWeek, a2 as DeleteContext, D as DeleteStatus, aC as DomainEvent, aD as DomainEventBodyOneOf, ah as Empty, aE as EntityCreatedEvent, aH as EntityDeletedEvent, aG as EntityUpdatedEvent, aN as EventMetadata, E as ExtendedFields, ap as GeoCoordinates, q as GetScheduleRequest, r as GetScheduleResponse, aK as IdentificationData, aL as IdentificationDataIdOneOf, I as IdentityType, am as Locale, l as Location, L as LocationType, aJ as MessageEnvelope, Y as MetaSiteSpecialEvent, Z as MetaSiteSpecialEventPayloadOneOf, at as Multilingual, N as Namespace, ac as NamespaceChanged, F as ParticipantNotification, n as Permission, P as PlacementType, ak as Properties, az as PropertiesChange, s as QuerySchedulesRequest, w as QuerySchedulesResponse, f as RequestedFields, k as ResolutionMethod, aF as RestoreInfo, R as Role, X as ScheduleCancelled, aO as ScheduleCancelledEnvelope, O as ScheduleCloned, aP as ScheduleClonedEnvelope, aQ as ScheduleCreatedEnvelope, aR as ScheduleUpdatedEnvelope, J as ScheduleUpdatedWithMetadata, aS as SchedulesQueryResult, a8 as ServiceProvisioned, a9 as ServiceRemoved, aB as SiteCloned, $ as SiteCreated, i as SiteCreatedContext, a1 as SiteDeleted, ab as SiteHardDeleted, a6 as SiteMarkedAsTemplate, a7 as SiteMarkedAsWixSite, aj as SitePropertiesEvent, ai as SitePropertiesNotification, a4 as SitePublished, ag as SitePurgedExternally, aa as SiteRenamed, a0 as SiteTransferred, a3 as SiteUndeleted, a5 as SiteUnpublished, af as SiteUrlChanged, as as SpecialHourPeriod, h as State, e as Status, ad as StudioAssigned, ae as StudioUnassigned, au as SupportedLanguage, ar as TimePeriod, aw as Translation, g as Trigger, T as Type, B as UpdateScheduleRequest, H as UpdateScheduleResponse, aA as V4SiteCreated, W as WebhookIdentityType } from './calendar-v3-schedule-schedules.universal-D3nvGK6W.js';
4
- import { createEventModule } from '@wix/sdk-runtime/event-definition-modules';
5
-
6
- declare function getSchedule$1(httpClient: HttpClient): GetScheduleSignature;
7
- interface GetScheduleSignature {
8
- /**
9
- * Retrieves a schedule.
10
- * @param - ID of the schedule to retrieve.
11
- * @returns Retrieved schedule.
12
- */
13
- (scheduleId: string, options?: GetScheduleOptions | undefined): Promise<Schedule>;
14
- }
15
- declare function querySchedules$1(httpClient: HttpClient): QuerySchedulesSignature;
16
- interface QuerySchedulesSignature {
17
- /**
18
- * Creates a query to retrieve a list of schedules.
19
- *
20
- * The `querySchedules()` function builds a query to retrieve a list of tip settings and returns a `SchedulesQueryBuilder` object.
21
- *
22
- * 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.
23
- *
24
- * 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.
25
- *
26
- * `querySchedules()` runs with the following `SchedulesQueryBuilder` default that you can override:
27
- *
28
- * + `limit` is `50`.
29
- * + Sorted by `id` in ascending order.
30
- *
31
- * 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"`.
32
- *
33
- * 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`.
34
- */
35
- (options?: QuerySchedulesOptions | undefined): SchedulesQueryBuilder;
36
- }
37
- declare function createSchedule$1(httpClient: HttpClient): CreateScheduleSignature;
38
- interface CreateScheduleSignature {
39
- /**
40
- * Creates a schedule.
41
- *
42
- *
43
- * If you want the schedule's events to appear in the
44
- * [Bookings calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar),
45
- * you must set `appId` to the ID of the Wix Bookings app by providing
46
- * `{"appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97"}`.
47
- * @param - Schedule to create.
48
- * @returns Created schedule.
49
- */
50
- (schedule: Schedule, options?: CreateScheduleOptions | undefined): Promise<Schedule>;
51
- }
52
- declare function updateSchedule$1(httpClient: HttpClient): UpdateScheduleSignature;
53
- interface UpdateScheduleSignature {
54
- /**
55
- * Updates a schedule.
56
- *
57
- *
58
- * Each time the schedule is updated,
59
- * `revision` increments by 1.
60
- * The current `revision` must be passed when updating the schedule.
61
- * This ensures you're working with the latest schedule
62
- * and prevents unintended overwrites.
63
- * @param - Schedule ID.
64
- * @returns Updated schedule.
65
- */
66
- (_id: string, schedule: UpdateSchedule, options?: UpdateScheduleOptions | undefined): Promise<Schedule>;
67
- }
68
- declare function cancelSchedule$1(httpClient: HttpClient): CancelScheduleSignature;
69
- interface CancelScheduleSignature {
70
- /**
71
- * Sets a schedule's `status` to `CANCELLED`.
72
- *
73
- *
74
- * Also cancels future events belonging to the schedule.
75
- *
76
- * Once a schedule is marked as `CANCELLED`, you can't reactivate it, update it,
77
- * or assign new events.
78
- * @param - ID of the schedule to cancel.
79
- */
80
- (scheduleId: string, options?: CancelScheduleOptions | undefined): Promise<CancelScheduleResponse>;
81
- }
82
-
83
- declare const getSchedule: MaybeContext<BuildRESTFunction<typeof getSchedule$1> & typeof getSchedule$1>;
84
- declare const querySchedules: MaybeContext<BuildRESTFunction<typeof querySchedules$1> & typeof querySchedules$1>;
85
- declare const createSchedule: MaybeContext<BuildRESTFunction<typeof createSchedule$1> & typeof createSchedule$1>;
86
- declare const updateSchedule: MaybeContext<BuildRESTFunction<typeof updateSchedule$1> & typeof updateSchedule$1>;
87
- declare const cancelSchedule: MaybeContext<BuildRESTFunction<typeof cancelSchedule$1> & typeof cancelSchedule$1>;
88
- /**
89
- * Triggered when a schedule is canceled.
90
- */
91
- declare const onScheduleCancelled: ReturnType<typeof createEventModule<typeof publicOnScheduleCancelled>>;
92
- /**
93
- * Triggered when a schedule is cloned.
94
- */
95
- declare const onScheduleCloned: ReturnType<typeof createEventModule<typeof publicOnScheduleCloned>>;
96
- /**
97
- * Triggered when a schedule is created.
98
- */
99
- declare const onScheduleCreated: ReturnType<typeof createEventModule<typeof publicOnScheduleCreated>>;
100
- /**
101
- * Triggered when a schedule is updated.
102
- */
103
- declare const onScheduleUpdated: ReturnType<typeof createEventModule<typeof publicOnScheduleUpdated>>;
104
-
105
- export { CancelScheduleOptions, CancelScheduleResponse, CreateScheduleOptions, GetScheduleOptions, QuerySchedulesOptions, Schedule, SchedulesQueryBuilder, UpdateSchedule, UpdateScheduleOptions, cancelSchedule, createSchedule, getSchedule, onScheduleCancelled, onScheduleCloned, onScheduleCreated, onScheduleUpdated, querySchedules, updateSchedule };