@wix/events 1.0.149 → 1.0.151

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 (147) hide show
  1. package/build/cjs/index.d.ts +6 -2
  2. package/build/cjs/index.js +7 -3
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +6 -2
  5. package/build/cjs/index.typings.js +7 -3
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +6 -2
  8. package/build/cjs/meta.js +7 -3
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.http.d.ts +97 -0
  11. package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.http.js +550 -0
  12. package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.http.js.map +1 -0
  13. package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.meta.d.ts +19 -0
  14. package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.meta.js +85 -0
  15. package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.meta.js.map +1 -0
  16. package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.public.d.ts +9 -0
  17. package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.public.js +28 -0
  18. package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.public.js.map +1 -0
  19. package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.types.d.ts +410 -0
  20. package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.types.js +27 -0
  21. package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.types.js.map +1 -0
  22. package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.universal.d.ts +454 -0
  23. package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.universal.js +254 -0
  24. package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.universal.js.map +1 -0
  25. package/build/cjs/src/events-schedule-v1-schedule-item-schedule.http.d.ts +97 -0
  26. package/build/cjs/src/events-schedule-v1-schedule-item-schedule.http.js +550 -0
  27. package/build/cjs/src/events-schedule-v1-schedule-item-schedule.http.js.map +1 -0
  28. package/build/cjs/src/events-schedule-v1-schedule-item-schedule.meta.d.ts +25 -0
  29. package/build/cjs/src/events-schedule-v1-schedule-item-schedule.meta.js +199 -0
  30. package/build/cjs/src/events-schedule-v1-schedule-item-schedule.meta.js.map +1 -0
  31. package/build/cjs/src/events-schedule-v1-schedule-item-schedule.public.d.ts +26 -0
  32. package/build/cjs/src/events-schedule-v1-schedule-item-schedule.public.js +64 -0
  33. package/build/cjs/src/events-schedule-v1-schedule-item-schedule.public.js.map +1 -0
  34. package/build/cjs/src/events-schedule-v1-schedule-item-schedule.types.d.ts +410 -0
  35. package/build/cjs/src/events-schedule-v1-schedule-item-schedule.types.js +27 -0
  36. package/build/cjs/src/events-schedule-v1-schedule-item-schedule.types.js.map +1 -0
  37. package/build/cjs/src/events-schedule-v1-schedule-item-schedule.universal.d.ts +669 -0
  38. package/build/cjs/src/events-schedule-v1-schedule-item-schedule.universal.js +677 -0
  39. package/build/cjs/src/events-schedule-v1-schedule-item-schedule.universal.js.map +1 -0
  40. package/build/cjs/src/events-v1-category.http.d.ts +35 -0
  41. package/build/cjs/src/events-v1-category.http.js +570 -0
  42. package/build/cjs/src/events-v1-category.http.js.map +1 -0
  43. package/build/cjs/src/events-v1-category.meta.d.ts +37 -0
  44. package/build/cjs/src/events-v1-category.meta.js +275 -0
  45. package/build/cjs/src/events-v1-category.meta.js.map +1 -0
  46. package/build/cjs/src/events-v1-category.public.d.ts +28 -0
  47. package/build/cjs/src/events-v1-category.public.js +88 -0
  48. package/build/cjs/src/events-v1-category.public.js.map +1 -0
  49. package/build/cjs/src/events-v1-category.types.d.ts +364 -0
  50. package/build/cjs/src/events-v1-category.types.js +27 -0
  51. package/build/cjs/src/events-v1-category.types.js.map +1 -0
  52. package/build/cjs/src/events-v1-category.universal.d.ts +586 -0
  53. package/build/cjs/src/events-v1-category.universal.js +830 -0
  54. package/build/cjs/src/events-v1-category.universal.js.map +1 -0
  55. package/build/cjs/src/events-v1-order-checkout.http.js +7 -4
  56. package/build/cjs/src/events-v1-order-checkout.http.js.map +1 -1
  57. package/build/cjs/src/events-v1-order-orders.http.js +7 -4
  58. package/build/cjs/src/events-v1-order-orders.http.js.map +1 -1
  59. package/build/cjs/src/events-v1-rsvp.http.d.ts +20 -0
  60. package/build/cjs/src/events-v1-rsvp.http.js +433 -0
  61. package/build/cjs/src/events-v1-rsvp.http.js.map +1 -0
  62. package/build/cjs/src/events-v1-rsvp.meta.d.ts +25 -0
  63. package/build/cjs/src/events-v1-rsvp.meta.js +199 -0
  64. package/build/cjs/src/events-v1-rsvp.meta.js.map +1 -0
  65. package/build/cjs/src/events-v1-rsvp.public.d.ts +39 -0
  66. package/build/cjs/src/events-v1-rsvp.public.js +65 -0
  67. package/build/cjs/src/events-v1-rsvp.public.js.map +1 -0
  68. package/build/cjs/src/events-v1-rsvp.types.d.ts +804 -0
  69. package/build/cjs/src/events-v1-rsvp.types.js +44 -0
  70. package/build/cjs/src/events-v1-rsvp.types.js.map +1 -0
  71. package/build/cjs/src/events-v1-rsvp.universal.d.ts +905 -0
  72. package/build/cjs/src/events-v1-rsvp.universal.js +725 -0
  73. package/build/cjs/src/events-v1-rsvp.universal.js.map +1 -0
  74. package/build/es/index.d.ts +6 -2
  75. package/build/es/index.js +6 -2
  76. package/build/es/index.js.map +1 -1
  77. package/build/es/index.typings.d.ts +6 -2
  78. package/build/es/index.typings.js +6 -2
  79. package/build/es/index.typings.js.map +1 -1
  80. package/build/es/meta.d.ts +6 -2
  81. package/build/es/meta.js +6 -2
  82. package/build/es/meta.js.map +1 -1
  83. package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.http.d.ts +97 -0
  84. package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.http.js +535 -0
  85. package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.http.js.map +1 -0
  86. package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.meta.d.ts +19 -0
  87. package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.meta.js +56 -0
  88. package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.meta.js.map +1 -0
  89. package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.public.d.ts +9 -0
  90. package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.public.js +19 -0
  91. package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.public.js.map +1 -0
  92. package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.types.d.ts +410 -0
  93. package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.types.js +24 -0
  94. package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.types.js.map +1 -0
  95. package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.universal.d.ts +454 -0
  96. package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.universal.js +225 -0
  97. package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.universal.js.map +1 -0
  98. package/build/es/src/events-schedule-v1-schedule-item-schedule.http.d.ts +97 -0
  99. package/build/es/src/events-schedule-v1-schedule-item-schedule.http.js +535 -0
  100. package/build/es/src/events-schedule-v1-schedule-item-schedule.http.js.map +1 -0
  101. package/build/es/src/events-schedule-v1-schedule-item-schedule.meta.d.ts +25 -0
  102. package/build/es/src/events-schedule-v1-schedule-item-schedule.meta.js +164 -0
  103. package/build/es/src/events-schedule-v1-schedule-item-schedule.meta.js.map +1 -0
  104. package/build/es/src/events-schedule-v1-schedule-item-schedule.public.d.ts +26 -0
  105. package/build/es/src/events-schedule-v1-schedule-item-schedule.public.js +49 -0
  106. package/build/es/src/events-schedule-v1-schedule-item-schedule.public.js.map +1 -0
  107. package/build/es/src/events-schedule-v1-schedule-item-schedule.types.d.ts +410 -0
  108. package/build/es/src/events-schedule-v1-schedule-item-schedule.types.js +24 -0
  109. package/build/es/src/events-schedule-v1-schedule-item-schedule.types.js.map +1 -0
  110. package/build/es/src/events-schedule-v1-schedule-item-schedule.universal.d.ts +669 -0
  111. package/build/es/src/events-schedule-v1-schedule-item-schedule.universal.js +642 -0
  112. package/build/es/src/events-schedule-v1-schedule-item-schedule.universal.js.map +1 -0
  113. package/build/es/src/events-v1-category.http.d.ts +35 -0
  114. package/build/es/src/events-v1-category.http.js +554 -0
  115. package/build/es/src/events-v1-category.http.js.map +1 -0
  116. package/build/es/src/events-v1-category.meta.d.ts +37 -0
  117. package/build/es/src/events-v1-category.meta.js +236 -0
  118. package/build/es/src/events-v1-category.meta.js.map +1 -0
  119. package/build/es/src/events-v1-category.public.d.ts +28 -0
  120. package/build/es/src/events-v1-category.public.js +69 -0
  121. package/build/es/src/events-v1-category.public.js.map +1 -0
  122. package/build/es/src/events-v1-category.types.d.ts +364 -0
  123. package/build/es/src/events-v1-category.types.js +24 -0
  124. package/build/es/src/events-v1-category.types.js.map +1 -0
  125. package/build/es/src/events-v1-category.universal.d.ts +586 -0
  126. package/build/es/src/events-v1-category.universal.js +791 -0
  127. package/build/es/src/events-v1-category.universal.js.map +1 -0
  128. package/build/es/src/events-v1-order-checkout.http.js +7 -4
  129. package/build/es/src/events-v1-order-checkout.http.js.map +1 -1
  130. package/build/es/src/events-v1-order-orders.http.js +7 -4
  131. package/build/es/src/events-v1-order-orders.http.js.map +1 -1
  132. package/build/es/src/events-v1-rsvp.http.d.ts +20 -0
  133. package/build/es/src/events-v1-rsvp.http.js +421 -0
  134. package/build/es/src/events-v1-rsvp.http.js.map +1 -0
  135. package/build/es/src/events-v1-rsvp.meta.d.ts +25 -0
  136. package/build/es/src/events-v1-rsvp.meta.js +164 -0
  137. package/build/es/src/events-v1-rsvp.meta.js.map +1 -0
  138. package/build/es/src/events-v1-rsvp.public.d.ts +39 -0
  139. package/build/es/src/events-v1-rsvp.public.js +49 -0
  140. package/build/es/src/events-v1-rsvp.public.js.map +1 -0
  141. package/build/es/src/events-v1-rsvp.types.d.ts +804 -0
  142. package/build/es/src/events-v1-rsvp.types.js +41 -0
  143. package/build/es/src/events-v1-rsvp.types.js.map +1 -0
  144. package/build/es/src/events-v1-rsvp.universal.d.ts +905 -0
  145. package/build/es/src/events-v1-rsvp.universal.js +690 -0
  146. package/build/es/src/events-v1-rsvp.universal.js.map +1 -0
  147. package/package.json +2 -2
@@ -0,0 +1,669 @@
1
+ export declare const __debug: {
2
+ verboseLogging: {
3
+ on: () => boolean;
4
+ off: () => boolean;
5
+ };
6
+ };
7
+ /** Schedule item describes the schedule within an event. Each event may contain multiple schedule items. */
8
+ export interface ScheduleItem {
9
+ /**
10
+ * Schedule item ID.
11
+ * @readonly
12
+ */
13
+ _id?: string;
14
+ /** Whether schedule item is hidden from guests. */
15
+ hidden?: boolean;
16
+ /** Schedule item name. */
17
+ name?: string;
18
+ /** Time slot of an schedule item. */
19
+ timeSlot?: TimeInterval;
20
+ /** Rich-text content displayed in Wix UI when viewing schedule item details (HTML). */
21
+ description?: string;
22
+ /** Stage or room name in which session takes place. */
23
+ stageName?: string;
24
+ /** Tags are used to organize schedule items by assigning them to a general theme or field of study. */
25
+ tags?: string[];
26
+ /** Schedule item status. */
27
+ status?: ScheduleStatus;
28
+ /**
29
+ * Schedule item created timestamp.
30
+ * @readonly
31
+ */
32
+ _createdDate?: Date;
33
+ /**
34
+ * Schedule item modified timestamp.
35
+ * @readonly
36
+ */
37
+ _updatedDate?: Date;
38
+ /**
39
+ * Event ID.
40
+ * @readonly
41
+ */
42
+ eventId?: string;
43
+ /**
44
+ * Whether schedule item is draft.
45
+ * @readonly
46
+ */
47
+ draft?: boolean;
48
+ }
49
+ /** Time interval on the timeline between two points in time. */
50
+ export interface TimeInterval {
51
+ /** Start of the interval. Inclusive. */
52
+ start?: Date;
53
+ /** End of the interval. Non-inclusive. */
54
+ end?: Date;
55
+ /**
56
+ * Time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
57
+ * Defaults to `Etc/UTC` when not set.
58
+ */
59
+ timeZoneId?: string | null;
60
+ }
61
+ export declare enum ScheduleStatus {
62
+ /** Item is scheduled for a future date */
63
+ SCHEDULED = "SCHEDULED",
64
+ /** Item was canceled */
65
+ CANCELED = "CANCELED"
66
+ }
67
+ export interface ListScheduleItemsRequest {
68
+ /** Event ID. */
69
+ eventId?: string[];
70
+ /**
71
+ * Schedule item state filter.
72
+ * Defaults to `[PUBLISHED, VISIBLE]` when no filters are specified.
73
+ * If neither `PUBLISHED` nor `DRAFT` are specified, assumes `PUBLISHED`, for example: `[HIDDEN]` becomes `[HIDDEN, PUBLISHED]`.
74
+ * If neither `VISIBLE` nor `HIDDEN` are specified, assumes `VISIBLE`, for example: `[DRAFT]` becomes `[DRAFT, VISIBLE]`.
75
+ */
76
+ state?: StateFilter[];
77
+ /** Filters schedule items starting on or after specified point in time. Inclusive. */
78
+ startingFrom?: Date;
79
+ /** Filters schedule items starting before specified point in time. Non-inclusive. */
80
+ startingBefore?: Date;
81
+ /**
82
+ * Deprecated, use `paging`.
83
+ * Number of items to skip. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
84
+ */
85
+ offset?: number;
86
+ /**
87
+ * Deprecated, use `paging`.
88
+ * Number of items to load per page. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
89
+ */
90
+ limit?: number;
91
+ /**
92
+ * Filter facets.
93
+ * See [supported facets](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-schedule-items).
94
+ */
95
+ facet?: string[];
96
+ /** Item IDs filter. */
97
+ itemId?: string[];
98
+ /** Tags filter. */
99
+ tag?: string[];
100
+ /** Stage names filter. */
101
+ stageName?: string[];
102
+ /**
103
+ * Pointer to page of results using offset.
104
+ * See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
105
+ */
106
+ paging?: Paging;
107
+ }
108
+ export declare enum StateFilter {
109
+ /** Schedule item is published. */
110
+ PUBLISHED = "PUBLISHED",
111
+ /** Opposite of `PUBLISHED`. Requires `WIX_EVENTS.MANAGE_AGENDA` permission. */
112
+ DRAFT = "DRAFT",
113
+ /** Schedule item is visible to the public. */
114
+ VISIBLE = "VISIBLE",
115
+ /** Opposite of `VISIBLE`. Requires `WIX_EVENTS.MANAGE_AGENDA` permission. */
116
+ HIDDEN = "HIDDEN"
117
+ }
118
+ export interface Paging {
119
+ /** Number of items to load per page. */
120
+ limit?: number | null;
121
+ /** Number of items to skip in the current sort order. */
122
+ offset?: number | null;
123
+ }
124
+ export interface ListScheduleItemsResponse {
125
+ /**
126
+ * Deprecated, use `paging_metadata.total`.
127
+ * Total schedule items matching the given filters.
128
+ * @readonly
129
+ */
130
+ total?: number;
131
+ /**
132
+ * Deprecated.
133
+ * Limit.
134
+ */
135
+ limit?: number;
136
+ /**
137
+ * Deprecated, use `paging_metadata.offset`.
138
+ * Offset.
139
+ */
140
+ offset?: number;
141
+ /** Schedule items. */
142
+ items?: ScheduleItem[];
143
+ /**
144
+ * Facets.
145
+ * @readonly
146
+ */
147
+ facets?: Record<string, FacetCounts>;
148
+ /**
149
+ * Whether there are draft changes which have not been published yet.
150
+ * Returned only when filtering by single `event_id` with `WIX_EVENTS.MANAGE_AGENDA` permission.
151
+ * @readonly
152
+ */
153
+ draftNotPublished?: boolean | null;
154
+ pagingMetadata?: PagingMetadataV2;
155
+ }
156
+ export interface FacetCounts {
157
+ /** Facet counts aggregated per value */
158
+ counts?: Record<string, number>;
159
+ }
160
+ export interface PagingMetadataV2 {
161
+ /** Number of items returned in the response. */
162
+ count?: number | null;
163
+ /** Offset that was requested. */
164
+ offset?: number | null;
165
+ /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
166
+ total?: number | null;
167
+ /** Flag that indicates the server failed to calculate the `total` field. */
168
+ tooManyToCount?: boolean | null;
169
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
170
+ cursors?: Cursors;
171
+ }
172
+ export interface Cursors {
173
+ /** Cursor string pointing to the next page in the list of results. */
174
+ next?: string | null;
175
+ /** Cursor pointing to the previous page in the list of results. */
176
+ prev?: string | null;
177
+ }
178
+ export interface QueryScheduleItemsRequest {
179
+ query?: QueryV2;
180
+ }
181
+ export interface QueryV2 extends QueryV2PagingMethodOneOf {
182
+ /**
183
+ * Pointer to page of results using offset.
184
+ * See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
185
+ */
186
+ paging?: Paging;
187
+ /** Filter. See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events). */
188
+ filter?: Record<string, any> | null;
189
+ /**
190
+ * Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
191
+ * See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events).
192
+ */
193
+ sort?: Sorting[];
194
+ }
195
+ /** @oneof */
196
+ export interface QueryV2PagingMethodOneOf {
197
+ /**
198
+ * Pointer to page of results using offset.
199
+ * See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
200
+ */
201
+ paging?: Paging;
202
+ }
203
+ export interface Sorting {
204
+ /** Name of the field to sort by */
205
+ fieldName?: string;
206
+ /** Sort order (ASC/DESC). Defaults to ASC */
207
+ order?: SortOrder;
208
+ }
209
+ export declare enum SortOrder {
210
+ ASC = "ASC",
211
+ DESC = "DESC"
212
+ }
213
+ export interface QueryScheduleItemsResponse {
214
+ pagingMetadata?: PagingMetadataV2;
215
+ /** Schedule items. */
216
+ items?: ScheduleItem[];
217
+ }
218
+ export interface GetScheduleItemRequest {
219
+ /** Event ID. */
220
+ eventId?: string;
221
+ /** Schedule item ID. */
222
+ itemId: string;
223
+ includeDraft?: boolean;
224
+ }
225
+ export interface GetScheduleItemResponse {
226
+ /** Schedule item. */
227
+ item?: ScheduleItem;
228
+ /** Draft of the Schedule item. */
229
+ draft?: ScheduleItem;
230
+ }
231
+ export interface AddScheduleItemRequest {
232
+ /** Event ID. */
233
+ eventId: string;
234
+ /** Schedule item. */
235
+ item?: ScheduleItemData;
236
+ }
237
+ /** Schedule item describes the schedule within an event. Each event may contain multiple schedule items. */
238
+ export interface ScheduleItemData {
239
+ /** Whether schedule item is hidden from guests. */
240
+ hidden?: boolean;
241
+ /** Schedule item name. */
242
+ name?: string;
243
+ /** Time slot */
244
+ timeSlot?: TimeInterval;
245
+ /** Rich-text content displayed in Wix UI when viewing schedule item details (HTML). */
246
+ description?: string;
247
+ /** Stage or room name in which session takes place. */
248
+ stageName?: string;
249
+ /** Tags are used to organize schedule items by assigning them to a general theme or field of study. */
250
+ tags?: string[];
251
+ /** Schedule item status. */
252
+ status?: ScheduleStatus;
253
+ }
254
+ export interface AddScheduleItemResponse {
255
+ /** Schedule item. */
256
+ item?: ScheduleItem;
257
+ }
258
+ export interface UpdateScheduleItemRequest {
259
+ /** Event ID. */
260
+ eventId: string;
261
+ /** Schedule item ID. */
262
+ itemId: string;
263
+ /** Schedule item. */
264
+ item?: ScheduleItemData;
265
+ }
266
+ export interface UpdateScheduleItemResponse {
267
+ /** Schedule item. */
268
+ item?: ScheduleItem;
269
+ }
270
+ export interface DeleteScheduleItemRequest {
271
+ /** Event ID. */
272
+ eventId: string;
273
+ /** Schedule items to delete. */
274
+ itemIds?: string[];
275
+ }
276
+ export interface DeleteScheduleItemResponse {
277
+ }
278
+ export interface DiscardDraftRequest {
279
+ /** Event ID. */
280
+ eventId: string;
281
+ }
282
+ export interface DiscardDraftResponse {
283
+ }
284
+ export interface PublishDraftRequest {
285
+ /** Event ID. */
286
+ eventId: string;
287
+ }
288
+ export interface PublishDraftResponse {
289
+ }
290
+ export interface RescheduleDraftRequest {
291
+ /** Event ID. */
292
+ eventId: string;
293
+ /** Time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
294
+ timeZoneId: string;
295
+ /** Offset added or subtracted from schedule item start & end times. */
296
+ timeSlotOffset?: GoogleProtoDuration;
297
+ }
298
+ export interface RescheduleDraftResponse {
299
+ }
300
+ export interface ListBookmarksRequest {
301
+ /** Event ID. */
302
+ eventId: string;
303
+ }
304
+ export interface ListBookmarksResponse {
305
+ /** Schedule items. */
306
+ items?: ScheduleItem[];
307
+ }
308
+ export interface CreateBookmarkRequest {
309
+ /** Event ID. */
310
+ eventId: string;
311
+ /** Schedule item ID. */
312
+ itemId: string;
313
+ }
314
+ export interface CreateBookmarkResponse {
315
+ }
316
+ export interface DeleteBookmarkRequest {
317
+ /** Event ID. */
318
+ eventId: string;
319
+ /** Schedule item ID. */
320
+ itemId: string;
321
+ }
322
+ export interface DeleteBookmarkResponse {
323
+ }
324
+ export interface ListScheduleItemsResponseNonNullableFields {
325
+ total: number;
326
+ limit: number;
327
+ offset: number;
328
+ items: {
329
+ _id: string;
330
+ hidden: boolean;
331
+ name: string;
332
+ description: string;
333
+ stageName: string;
334
+ tags: string[];
335
+ status: ScheduleStatus;
336
+ eventId: string;
337
+ draft: boolean;
338
+ }[];
339
+ }
340
+ export interface QueryScheduleItemsResponseNonNullableFields {
341
+ items: {
342
+ _id: string;
343
+ hidden: boolean;
344
+ name: string;
345
+ description: string;
346
+ stageName: string;
347
+ tags: string[];
348
+ status: ScheduleStatus;
349
+ eventId: string;
350
+ draft: boolean;
351
+ }[];
352
+ }
353
+ export interface GetScheduleItemResponseNonNullableFields {
354
+ item?: {
355
+ _id: string;
356
+ hidden: boolean;
357
+ name: string;
358
+ description: string;
359
+ stageName: string;
360
+ tags: string[];
361
+ status: ScheduleStatus;
362
+ eventId: string;
363
+ draft: boolean;
364
+ };
365
+ draft?: {
366
+ _id: string;
367
+ hidden: boolean;
368
+ name: string;
369
+ description: string;
370
+ stageName: string;
371
+ tags: string[];
372
+ status: ScheduleStatus;
373
+ eventId: string;
374
+ draft: boolean;
375
+ };
376
+ }
377
+ export interface AddScheduleItemResponseNonNullableFields {
378
+ item?: {
379
+ _id: string;
380
+ hidden: boolean;
381
+ name: string;
382
+ description: string;
383
+ stageName: string;
384
+ tags: string[];
385
+ status: ScheduleStatus;
386
+ eventId: string;
387
+ draft: boolean;
388
+ };
389
+ }
390
+ export interface UpdateScheduleItemResponseNonNullableFields {
391
+ item?: {
392
+ _id: string;
393
+ hidden: boolean;
394
+ name: string;
395
+ description: string;
396
+ stageName: string;
397
+ tags: string[];
398
+ status: ScheduleStatus;
399
+ eventId: string;
400
+ draft: boolean;
401
+ };
402
+ }
403
+ export interface ListBookmarksResponseNonNullableFields {
404
+ items: {
405
+ _id: string;
406
+ hidden: boolean;
407
+ name: string;
408
+ description: string;
409
+ stageName: string;
410
+ tags: string[];
411
+ status: ScheduleStatus;
412
+ eventId: string;
413
+ draft: boolean;
414
+ }[];
415
+ }
416
+ type GoogleProtoDuration = any;
417
+ /**
418
+ * Retrieves a list of up to 100 schedule items, with basic filter support.
419
+ *
420
+ * > **Note:**
421
+ * > This endpoint is relevant only for [Headless](https://dev.wix.com/docs/go-headless/getting-started/about-headless/about-wix-headless) projects.
422
+ * @public
423
+ * @documentationMaturity preview
424
+ * @applicableIdentity MEMBER
425
+ * @applicableIdentity VISITOR
426
+ */
427
+ export declare function listScheduleItems(options?: ListScheduleItemsOptions): Promise<ListScheduleItemsResponse & ListScheduleItemsResponseNonNullableFields>;
428
+ export interface ListScheduleItemsOptions {
429
+ /** Event ID. */
430
+ eventId?: string[];
431
+ /**
432
+ * Schedule item state filter.
433
+ * Defaults to `[PUBLISHED, VISIBLE]` when no filters are specified.
434
+ * If neither `PUBLISHED` nor `DRAFT` are specified, assumes `PUBLISHED`, for example: `[HIDDEN]` becomes `[HIDDEN, PUBLISHED]`.
435
+ * If neither `VISIBLE` nor `HIDDEN` are specified, assumes `VISIBLE`, for example: `[DRAFT]` becomes `[DRAFT, VISIBLE]`.
436
+ */
437
+ state?: StateFilter[];
438
+ /** Filters schedule items starting on or after specified point in time. Inclusive. */
439
+ startingFrom?: Date;
440
+ /** Filters schedule items starting before specified point in time. Non-inclusive. */
441
+ startingBefore?: Date;
442
+ /**
443
+ * Deprecated, use `paging`.
444
+ * Number of items to skip. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
445
+ */
446
+ offset?: number;
447
+ /**
448
+ * Deprecated, use `paging`.
449
+ * Number of items to load per page. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
450
+ */
451
+ limit?: number;
452
+ /**
453
+ * Filter facets.
454
+ * See [supported facets](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-schedule-items).
455
+ */
456
+ facet?: string[];
457
+ /** Item IDs filter. */
458
+ itemId?: string[];
459
+ /** Tags filter. */
460
+ tag?: string[];
461
+ /** Stage names filter. */
462
+ stageName?: string[];
463
+ /**
464
+ * Pointer to page of results using offset.
465
+ * See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
466
+ */
467
+ paging?: Paging;
468
+ }
469
+ /**
470
+ * Retrieves a list of up to 100 schedule items, given the provided [paging](https://dev.wix.com/api/rest/getting-started/pagination), [filtering](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-schedule-items).
471
+ *
472
+ * * Important **:
473
+ * - All results are for one specific business, resolved from the request context.
474
+ *
475
+ * Query object support:
476
+ * - `filter` - supported, see [filtering and sorting](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-schedule-items).
477
+ * - `sort` - supported, see [filtering and sorting](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-schedule-items).
478
+ * - `paging` - supported, see [paging](https://dev.wix.com/api/rest/getting-started/pagination).
479
+ * - `fields` - not supported.
480
+ * - `fieldsets` - not supported.
481
+ * - `cursorPaging` - not supported, use offset pagination instead.
482
+ *
483
+ * Defaults:
484
+ * - When filter is not specified, returns all schedule items that caller is authorized to read.
485
+ * - When sorting is not specified, defaults to `time_slot.start` and `time_slot.end` in `ASC` order.
486
+ *
487
+ * > **Note:**
488
+ * > This endpoint is relevant only for [Headless](https://dev.wix.com/docs/go-headless/getting-started/about-headless/about-wix-headless) projects.
489
+ * @public
490
+ * @documentationMaturity preview
491
+ * @applicableIdentity MEMBER
492
+ * @applicableIdentity VISITOR
493
+ */
494
+ export declare function queryScheduleItems(): ItemsQueryBuilder;
495
+ interface QueryCursorResult {
496
+ cursors: Cursors;
497
+ hasNext: () => boolean;
498
+ hasPrev: () => boolean;
499
+ length: number;
500
+ pageSize: number;
501
+ }
502
+ export interface ItemsQueryResult extends QueryCursorResult {
503
+ items: ScheduleItem[];
504
+ query: ItemsQueryBuilder;
505
+ next: () => Promise<ItemsQueryResult>;
506
+ prev: () => Promise<ItemsQueryResult>;
507
+ }
508
+ export interface ItemsQueryBuilder {
509
+ /** @param propertyName - Property whose value is compared with `value`.
510
+ * @param value - Value to compare against.
511
+ * @documentationMaturity preview
512
+ */
513
+ eq: (propertyName: '_id' | 'name' | 'description' | 'stageName' | '_createdDate' | '_updatedDate' | 'eventId', value: any) => ItemsQueryBuilder;
514
+ /** @param propertyName - Property whose value is compared with `value`.
515
+ * @param value - Value to compare against.
516
+ * @documentationMaturity preview
517
+ */
518
+ ne: (propertyName: '_id' | 'name' | 'description' | 'stageName' | '_createdDate' | '_updatedDate' | 'eventId', value: any) => ItemsQueryBuilder;
519
+ /** @param propertyName - Property whose value is compared with `value`.
520
+ * @param value - Value to compare against.
521
+ * @documentationMaturity preview
522
+ */
523
+ ge: (propertyName: '_createdDate' | '_updatedDate', value: any) => ItemsQueryBuilder;
524
+ /** @param propertyName - Property whose value is compared with `value`.
525
+ * @param value - Value to compare against.
526
+ * @documentationMaturity preview
527
+ */
528
+ gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => ItemsQueryBuilder;
529
+ /** @param propertyName - Property whose value is compared with `value`.
530
+ * @param value - Value to compare against.
531
+ * @documentationMaturity preview
532
+ */
533
+ le: (propertyName: '_createdDate' | '_updatedDate', value: any) => ItemsQueryBuilder;
534
+ /** @param propertyName - Property whose value is compared with `value`.
535
+ * @param value - Value to compare against.
536
+ * @documentationMaturity preview
537
+ */
538
+ lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => ItemsQueryBuilder;
539
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
540
+ * @documentationMaturity preview
541
+ */
542
+ ascending: (...propertyNames: Array<'_id' | 'name' | 'description' | 'stageName' | '_createdDate' | '_updatedDate' | 'eventId'>) => ItemsQueryBuilder;
543
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
544
+ * @documentationMaturity preview
545
+ */
546
+ descending: (...propertyNames: Array<'_id' | 'name' | 'description' | 'stageName' | '_createdDate' | '_updatedDate' | 'eventId'>) => ItemsQueryBuilder;
547
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
548
+ * @documentationMaturity preview
549
+ */
550
+ limit: (limit: number) => ItemsQueryBuilder;
551
+ /** @param cursor - A pointer to specific record
552
+ * @documentationMaturity preview
553
+ */
554
+ skipTo: (cursor: string) => ItemsQueryBuilder;
555
+ /** @documentationMaturity preview */
556
+ find: () => Promise<ItemsQueryResult>;
557
+ }
558
+ /**
559
+ * Retrieves schedule item by ID.
560
+ *
561
+ * > **Note:**
562
+ * > This endpoint is relevant only for [Headless](https://dev.wix.com/docs/go-headless/getting-started/about-headless/about-wix-headless) projects.
563
+ * @param itemId - Schedule item ID.
564
+ * @public
565
+ * @documentationMaturity preview
566
+ * @requiredField itemId
567
+ * @applicableIdentity MEMBER
568
+ * @applicableIdentity VISITOR
569
+ * @returns Schedule item.
570
+ */
571
+ export declare function getScheduleItem(itemId: string, options?: GetScheduleItemOptions): Promise<ScheduleItem & NonNullable<GetScheduleItemResponseNonNullableFields>['item']>;
572
+ export interface GetScheduleItemOptions {
573
+ /** Event ID. */
574
+ eventId?: string;
575
+ includeDraft?: boolean;
576
+ }
577
+ /**
578
+ * Adds schedule item to the draft schedule. Draft items are not publicly available unless published.
579
+ *
580
+ * > **Note:**
581
+ * > This endpoint is relevant only for [Headless](https://dev.wix.com/docs/go-headless/getting-started/about-headless/about-wix-headless) projects.
582
+ * @param eventId - Event ID.
583
+ * @public
584
+ * @documentationMaturity preview
585
+ * @requiredField eventId
586
+ * @requiredField options.item.name
587
+ * @requiredField options.item.timeSlot
588
+ * @requiredField options.item.timeSlot.end
589
+ * @requiredField options.item.timeSlot.start
590
+ */
591
+ export declare function addScheduleItem(eventId: string, options?: AddScheduleItemOptions): Promise<AddScheduleItemResponse & AddScheduleItemResponseNonNullableFields>;
592
+ export interface AddScheduleItemOptions {
593
+ /** Schedule item. */
594
+ item?: ScheduleItemData;
595
+ }
596
+ /**
597
+ * Updates existing schedule item.
598
+ * All modifications are performed on a draft schedule, even if schedule item has already been published.
599
+ *
600
+ * > **Note:**
601
+ * > This endpoint is relevant only for [Headless](https://dev.wix.com/docs/go-headless/getting-started/about-headless/about-wix-headless) projects.
602
+ * @param itemId - Schedule item ID.
603
+ * @param eventId - Event ID.
604
+ * @public
605
+ * @documentationMaturity preview
606
+ * @requiredField eventId
607
+ * @requiredField itemId
608
+ */
609
+ export declare function updateScheduleItem(itemId: string, eventId: string, options?: UpdateScheduleItemOptions): Promise<UpdateScheduleItemResponse & UpdateScheduleItemResponseNonNullableFields>;
610
+ export interface UpdateScheduleItemOptions {
611
+ /** Schedule item. */
612
+ item?: ScheduleItemData;
613
+ }
614
+ /**
615
+ * Deletes schedule item from draft schedule.
616
+ *
617
+ * > **Note:**
618
+ * > This endpoint is relevant only for the [Headless](https://dev.wix.com/docs/go-headless/getting-started/about-headless/about-wix-headless) projects.
619
+ * @param eventId - Event ID.
620
+ * @public
621
+ * @documentationMaturity preview
622
+ * @requiredField eventId
623
+ */
624
+ export declare function deleteScheduleItem(eventId: string, options?: DeleteScheduleItemOptions): Promise<void>;
625
+ export interface DeleteScheduleItemOptions {
626
+ /** Schedule items to delete. */
627
+ itemIds?: string[];
628
+ }
629
+ /**
630
+ * Clears all changes to the draft schedule. (Does not affect the published schedule.)
631
+ *
632
+ * > **Note:**
633
+ * > This endpoint is relevant only for [Headless](https://dev.wix.com/docs/go-headless/getting-started/about-headless/about-wix-headless) projects.
634
+ * @param eventId - Event ID.
635
+ * @public
636
+ * @documentationMaturity preview
637
+ * @requiredField eventId
638
+ */
639
+ export declare function discardDraft(eventId: string): Promise<void>;
640
+ /**
641
+ * Publishes the draft schedule.
642
+ *
643
+ * > **Note:**
644
+ * > This endpoint is relevant only for the [Headless](https://dev.wix.com/docs/go-headless/getting-started/about-headless/about-wix-headless) projects.
645
+ * @param eventId - Event ID.
646
+ * @public
647
+ * @documentationMaturity preview
648
+ * @requiredField eventId
649
+ */
650
+ export declare function publishDraft(eventId: string): Promise<void>;
651
+ /**
652
+ * Adjusts time of all draft schedule items (per event).
653
+ *
654
+ * > **Note:**
655
+ * > This endpoint is relevant only for [Headless](https://dev.wix.com/docs/go-headless/getting-started/about-headless/about-wix-headless) projects.
656
+ * @param eventId - Event ID.
657
+ * @public
658
+ * @documentationMaturity preview
659
+ * @requiredField eventId
660
+ * @requiredField options.timeZoneId
661
+ */
662
+ export declare function rescheduleDraft(eventId: string, options?: RescheduleDraftOptions): Promise<void>;
663
+ export interface RescheduleDraftOptions {
664
+ /** Time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
665
+ timeZoneId: string;
666
+ /** Offset added or subtracted from schedule item start & end times. */
667
+ timeSlotOffset?: GoogleProtoDuration;
668
+ }
669
+ export {};