@wix/events 1.0.12 → 1.0.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +2 -0
- package/build/cjs/index.js +3 -1
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.public.d.ts +6 -0
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.public.js +27 -0
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.public.js.map +1 -0
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.universal.d.ts +353 -0
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.universal.js +237 -0
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule-bookmarks.universal.js.map +1 -0
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule.public.d.ts +13 -0
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule.public.js +63 -0
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule.public.js.map +1 -0
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule.universal.d.ts +490 -0
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule.universal.js +600 -0
- package/build/cjs/src/events-schedule-v1-schedule-item-schedule.universal.js.map +1 -0
- package/build/cjs/src/events-schedule-v1-schedule-item.http.d.ts +49 -0
- package/build/cjs/src/events-schedule-v1-schedule-item.http.js +485 -0
- package/build/cjs/src/events-schedule-v1-schedule-item.http.js.map +1 -0
- package/build/cjs/src/events-schedule-v1-schedule-item.types.d.ts +318 -0
- package/build/cjs/src/events-schedule-v1-schedule-item.types.js +27 -0
- package/build/cjs/src/events-schedule-v1-schedule-item.types.js.map +1 -0
- package/build/es/index.d.ts +2 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -1
- package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.public.d.ts +6 -0
- package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.public.js +18 -0
- package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.public.js.map +1 -0
- package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.universal.d.ts +353 -0
- package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.universal.js +212 -0
- package/build/es/src/events-schedule-v1-schedule-item-schedule-bookmarks.universal.js.map +1 -0
- package/build/es/src/events-schedule-v1-schedule-item-schedule.public.d.ts +13 -0
- package/build/es/src/events-schedule-v1-schedule-item-schedule.public.js +48 -0
- package/build/es/src/events-schedule-v1-schedule-item-schedule.public.js.map +1 -0
- package/build/es/src/events-schedule-v1-schedule-item-schedule.universal.d.ts +490 -0
- package/build/es/src/events-schedule-v1-schedule-item-schedule.universal.js +569 -0
- package/build/es/src/events-schedule-v1-schedule-item-schedule.universal.js.map +1 -0
- package/build/es/src/events-schedule-v1-schedule-item.http.d.ts +49 -0
- package/build/es/src/events-schedule-v1-schedule-item.http.js +470 -0
- package/build/es/src/events-schedule-v1-schedule-item.http.js.map +1 -0
- package/build/es/src/events-schedule-v1-schedule-item.types.d.ts +318 -0
- package/build/es/src/events-schedule-v1-schedule-item.types.js +24 -0
- package/build/es/src/events-schedule-v1-schedule-item.types.js.map +1 -0
- package/package.json +2 -2
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { HttpClient } from '@wix/sdk-types';
|
|
2
|
+
import { AddScheduleItemOptions, DeleteScheduleItemOptions, GetScheduleItemOptions, ListScheduleItemsOptions, QueryScheduleItemsOptions, RescheduleDraftOptions, UpdateScheduleItemOptions } from './events-schedule-v1-schedule-item-schedule.universal';
|
|
3
|
+
export declare function listScheduleItems(httpClient: HttpClient): (options?: ListScheduleItemsOptions | undefined) => Promise<import("./events-schedule-v1-schedule-item-schedule.universal").ListScheduleItemsResponse>;
|
|
4
|
+
export declare function queryScheduleItems(httpClient: HttpClient): (options?: QueryScheduleItemsOptions | undefined) => Promise<import("./events-schedule-v1-schedule-item-schedule.universal").QueryScheduleItemsResponse>;
|
|
5
|
+
export declare function getScheduleItem(httpClient: HttpClient): (itemId: string, options?: GetScheduleItemOptions | undefined) => Promise<import("./events-schedule-v1-schedule-item-schedule.universal").GetScheduleItemResponse>;
|
|
6
|
+
export declare function addScheduleItem(httpClient: HttpClient): (eventId: string, options?: AddScheduleItemOptions | undefined) => Promise<import("./events-schedule-v1-schedule-item-schedule.universal").AddScheduleItemResponse>;
|
|
7
|
+
export declare function updateScheduleItem(httpClient: HttpClient): (itemId: string, eventId: string, options?: UpdateScheduleItemOptions | undefined) => Promise<import("./events-schedule-v1-schedule-item-schedule.universal").UpdateScheduleItemResponse>;
|
|
8
|
+
export declare function deleteScheduleItem(httpClient: HttpClient): (eventId: string, options?: DeleteScheduleItemOptions | undefined) => Promise<void>;
|
|
9
|
+
export declare function discardDraft(httpClient: HttpClient): (eventId: string) => Promise<void>;
|
|
10
|
+
export declare function publishDraft(httpClient: HttpClient): (eventId: string) => Promise<void>;
|
|
11
|
+
export declare function rescheduleDraft(httpClient: HttpClient): (eventId: string, options?: RescheduleDraftOptions | undefined) => Promise<void>;
|
|
12
|
+
export { ScheduleStatus, StateFilter, SortOrder, } from './events-schedule-v1-schedule-item-schedule.universal';
|
|
13
|
+
export { ScheduleItem, TimeInterval, ListScheduleItemsRequest, Paging, ListScheduleItemsResponse, FacetCounts, PagingMetadataV2, Cursors, QueryScheduleItemsRequest, QueryV2, QueryV2PagingMethodOneOf, Sorting, QueryScheduleItemsResponse, GetScheduleItemRequest, GetScheduleItemResponse, AddScheduleItemRequest, ScheduleItemData, AddScheduleItemResponse, UpdateScheduleItemRequest, UpdateScheduleItemResponse, DeleteScheduleItemRequest, DeleteScheduleItemResponse, DiscardDraftRequest, DiscardDraftResponse, PublishDraftRequest, PublishDraftResponse, RescheduleDraftRequest, RescheduleDraftResponse, ListBookmarksRequest, ListBookmarksResponse, CreateBookmarkRequest, CreateBookmarkResponse, DeleteBookmarkRequest, DeleteBookmarkResponse, ListScheduleItemsOptions, QueryScheduleItemsOptions, GetScheduleItemOptions, AddScheduleItemOptions, UpdateScheduleItemOptions, DeleteScheduleItemOptions, RescheduleDraftOptions, } from './events-schedule-v1-schedule-item-schedule.universal';
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.SortOrder = exports.StateFilter = exports.ScheduleStatus = exports.rescheduleDraft = exports.publishDraft = exports.discardDraft = exports.deleteScheduleItem = exports.updateScheduleItem = exports.addScheduleItem = exports.getScheduleItem = exports.queryScheduleItems = exports.listScheduleItems = void 0;
|
|
4
|
+
const events_schedule_v1_schedule_item_schedule_universal_1 = require("./events-schedule-v1-schedule-item-schedule.universal");
|
|
5
|
+
function listScheduleItems(httpClient) {
|
|
6
|
+
return (options) => events_schedule_v1_schedule_item_schedule_universal_1.listScheduleItems(options,
|
|
7
|
+
// @ts-ignore
|
|
8
|
+
{ httpClient });
|
|
9
|
+
}
|
|
10
|
+
exports.listScheduleItems = listScheduleItems;
|
|
11
|
+
function queryScheduleItems(httpClient) {
|
|
12
|
+
return (options) => events_schedule_v1_schedule_item_schedule_universal_1.queryScheduleItems(options,
|
|
13
|
+
// @ts-ignore
|
|
14
|
+
{ httpClient });
|
|
15
|
+
}
|
|
16
|
+
exports.queryScheduleItems = queryScheduleItems;
|
|
17
|
+
function getScheduleItem(httpClient) {
|
|
18
|
+
return (itemId, options) => events_schedule_v1_schedule_item_schedule_universal_1.getScheduleItem(itemId, options,
|
|
19
|
+
// @ts-ignore
|
|
20
|
+
{ httpClient });
|
|
21
|
+
}
|
|
22
|
+
exports.getScheduleItem = getScheduleItem;
|
|
23
|
+
function addScheduleItem(httpClient) {
|
|
24
|
+
return (eventId, options) => events_schedule_v1_schedule_item_schedule_universal_1.addScheduleItem(eventId, options,
|
|
25
|
+
// @ts-ignore
|
|
26
|
+
{ httpClient });
|
|
27
|
+
}
|
|
28
|
+
exports.addScheduleItem = addScheduleItem;
|
|
29
|
+
function updateScheduleItem(httpClient) {
|
|
30
|
+
return (itemId, eventId, options) => events_schedule_v1_schedule_item_schedule_universal_1.updateScheduleItem(itemId, eventId, options,
|
|
31
|
+
// @ts-ignore
|
|
32
|
+
{ httpClient });
|
|
33
|
+
}
|
|
34
|
+
exports.updateScheduleItem = updateScheduleItem;
|
|
35
|
+
function deleteScheduleItem(httpClient) {
|
|
36
|
+
return (eventId, options) => events_schedule_v1_schedule_item_schedule_universal_1.deleteScheduleItem(eventId, options,
|
|
37
|
+
// @ts-ignore
|
|
38
|
+
{ httpClient });
|
|
39
|
+
}
|
|
40
|
+
exports.deleteScheduleItem = deleteScheduleItem;
|
|
41
|
+
function discardDraft(httpClient) {
|
|
42
|
+
return (eventId) => events_schedule_v1_schedule_item_schedule_universal_1.discardDraft(eventId,
|
|
43
|
+
// @ts-ignore
|
|
44
|
+
{ httpClient });
|
|
45
|
+
}
|
|
46
|
+
exports.discardDraft = discardDraft;
|
|
47
|
+
function publishDraft(httpClient) {
|
|
48
|
+
return (eventId) => events_schedule_v1_schedule_item_schedule_universal_1.publishDraft(eventId,
|
|
49
|
+
// @ts-ignore
|
|
50
|
+
{ httpClient });
|
|
51
|
+
}
|
|
52
|
+
exports.publishDraft = publishDraft;
|
|
53
|
+
function rescheduleDraft(httpClient) {
|
|
54
|
+
return (eventId, options) => events_schedule_v1_schedule_item_schedule_universal_1.rescheduleDraft(eventId, options,
|
|
55
|
+
// @ts-ignore
|
|
56
|
+
{ httpClient });
|
|
57
|
+
}
|
|
58
|
+
exports.rescheduleDraft = rescheduleDraft;
|
|
59
|
+
var events_schedule_v1_schedule_item_schedule_universal_2 = require("./events-schedule-v1-schedule-item-schedule.universal");
|
|
60
|
+
Object.defineProperty(exports, "ScheduleStatus", { enumerable: true, get: function () { return events_schedule_v1_schedule_item_schedule_universal_2.ScheduleStatus; } });
|
|
61
|
+
Object.defineProperty(exports, "StateFilter", { enumerable: true, get: function () { return events_schedule_v1_schedule_item_schedule_universal_2.StateFilter; } });
|
|
62
|
+
Object.defineProperty(exports, "SortOrder", { enumerable: true, get: function () { return events_schedule_v1_schedule_item_schedule_universal_2.SortOrder; } });
|
|
63
|
+
//# sourceMappingURL=events-schedule-v1-schedule-item-schedule.public.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"events-schedule-v1-schedule-item-schedule.public.js","sourceRoot":"","sources":["../../../src/events-schedule-v1-schedule-item-schedule.public.ts"],"names":[],"mappings":";;;AACA,+HAiB+D;AAE/D,SAAgB,iBAAiB,CAAC,UAAsB;IACtD,OAAO,CAAC,OAAkC,EAAE,EAAE,CAC5C,uEAA0B,CACxB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,8CAOC;AAED,SAAgB,kBAAkB,CAAC,UAAsB;IACvD,OAAO,CAAC,OAAmC,EAAE,EAAE,CAC7C,wEAA2B,CACzB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,gDAOC;AAED,SAAgB,eAAe,CAAC,UAAsB;IACpD,OAAO,CAAC,MAAc,EAAE,OAAgC,EAAE,EAAE,CAC1D,qEAAwB,CACtB,MAAM,EACN,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,0CAQC;AAED,SAAgB,eAAe,CAAC,UAAsB;IACpD,OAAO,CAAC,OAAe,EAAE,OAAgC,EAAE,EAAE,CAC3D,qEAAwB,CACtB,OAAO,EACP,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,0CAQC;AAED,SAAgB,kBAAkB,CAAC,UAAsB;IACvD,OAAO,CACL,MAAc,EACd,OAAe,EACf,OAAmC,EACnC,EAAE,CACF,wEAA2B,CACzB,MAAM,EACN,OAAO,EACP,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAbD,gDAaC;AAED,SAAgB,kBAAkB,CAAC,UAAsB;IACvD,OAAO,CAAC,OAAe,EAAE,OAAmC,EAAE,EAAE,CAC9D,wEAA2B,CACzB,OAAO,EACP,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,gDAQC;AAED,SAAgB,YAAY,CAAC,UAAsB;IACjD,OAAO,CAAC,OAAe,EAAE,EAAE,CACzB,kEAAqB,CACnB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,oCAOC;AAED,SAAgB,YAAY,CAAC,UAAsB;IACjD,OAAO,CAAC,OAAe,EAAE,EAAE,CACzB,kEAAqB,CACnB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,oCAOC;AAED,SAAgB,eAAe,CAAC,UAAsB;IACpD,OAAO,CAAC,OAAe,EAAE,OAAgC,EAAE,EAAE,CAC3D,qEAAwB,CACtB,OAAO,EACP,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,0CAQC;AAED,6HAI+D;AAH7D,qJAAA,cAAc,OAAA;AACd,kJAAA,WAAW,OAAA;AACX,gJAAA,SAAS,OAAA"}
|
|
@@ -0,0 +1,490 @@
|
|
|
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
|
+
/** Time interval on the timeline between two points in time. */
|
|
45
|
+
export interface TimeInterval {
|
|
46
|
+
/** Start of the interval. Inclusive. */
|
|
47
|
+
start?: Date;
|
|
48
|
+
/** End of the interval. Non-inclusive. */
|
|
49
|
+
end?: Date;
|
|
50
|
+
/**
|
|
51
|
+
* Time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`.
|
|
52
|
+
* Defaults to `Etc/UTC` when not set.
|
|
53
|
+
*/
|
|
54
|
+
timeZoneId?: string | null;
|
|
55
|
+
}
|
|
56
|
+
export declare enum ScheduleStatus {
|
|
57
|
+
/** Item is scheduled for a future date */
|
|
58
|
+
SCHEDULED = "SCHEDULED",
|
|
59
|
+
/** Item was canceled */
|
|
60
|
+
CANCELED = "CANCELED"
|
|
61
|
+
}
|
|
62
|
+
export interface ListScheduleItemsRequest {
|
|
63
|
+
/** Event ID. */
|
|
64
|
+
eventId?: string[];
|
|
65
|
+
/**
|
|
66
|
+
* Schedule item state filter.
|
|
67
|
+
* Defaults to `[PUBLISHED, VISIBLE]` when no filters are specified.
|
|
68
|
+
* If neither `PUBLISHED` nor `DRAFT` are specified, assumes `PUBLISHED`, for example: `[HIDDEN]` becomes `[HIDDEN, PUBLISHED]`.
|
|
69
|
+
* If neither `VISIBLE` nor `HIDDEN` are specified, assumes `VISIBLE`, for example: `[DRAFT]` becomes `[DRAFT, VISIBLE]`.
|
|
70
|
+
*/
|
|
71
|
+
state?: StateFilter[];
|
|
72
|
+
/** Filters schedule items starting on or after specified point in time. Inclusive. */
|
|
73
|
+
startingFrom?: Date;
|
|
74
|
+
/** Filters schedule items starting before specified point in time. Non-inclusive. */
|
|
75
|
+
startingBefore?: Date;
|
|
76
|
+
/**
|
|
77
|
+
* Deprecated, use `paging`.
|
|
78
|
+
* Number of items to skip. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
|
|
79
|
+
*/
|
|
80
|
+
offset?: number;
|
|
81
|
+
/**
|
|
82
|
+
* Deprecated, use `paging`.
|
|
83
|
+
* Number of items to load per page. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
|
|
84
|
+
*/
|
|
85
|
+
limit?: number;
|
|
86
|
+
/**
|
|
87
|
+
* Filter facets.
|
|
88
|
+
* 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).
|
|
89
|
+
*/
|
|
90
|
+
facet?: string[];
|
|
91
|
+
/** Item IDs filter. */
|
|
92
|
+
itemId?: string[];
|
|
93
|
+
/** Tags filter. */
|
|
94
|
+
tag?: string[];
|
|
95
|
+
/** Stage names filter. */
|
|
96
|
+
stageName?: string[];
|
|
97
|
+
/**
|
|
98
|
+
* Pointer to page of results using offset.
|
|
99
|
+
* See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
|
|
100
|
+
*/
|
|
101
|
+
paging?: Paging;
|
|
102
|
+
}
|
|
103
|
+
export declare enum StateFilter {
|
|
104
|
+
/** Schedule item is published. */
|
|
105
|
+
PUBLISHED = "PUBLISHED",
|
|
106
|
+
/** Opposite of `PUBLISHED`. Requires `WIX_EVENTS.MANAGE_AGENDA` permission. */
|
|
107
|
+
DRAFT = "DRAFT",
|
|
108
|
+
/** Schedule item is visible to the public. */
|
|
109
|
+
VISIBLE = "VISIBLE",
|
|
110
|
+
/** Opposite of `VISIBLE`. Requires `WIX_EVENTS.MANAGE_AGENDA` permission. */
|
|
111
|
+
HIDDEN = "HIDDEN"
|
|
112
|
+
}
|
|
113
|
+
export interface Paging {
|
|
114
|
+
/** Number of items to load per page. */
|
|
115
|
+
limit?: number | null;
|
|
116
|
+
/** Number of items to skip in the current sort order. */
|
|
117
|
+
offset?: number | null;
|
|
118
|
+
}
|
|
119
|
+
export interface ListScheduleItemsResponse {
|
|
120
|
+
/**
|
|
121
|
+
* Deprecated, use `paging_metadata.total`.
|
|
122
|
+
* Total schedule items matching the given filters.
|
|
123
|
+
* @readonly
|
|
124
|
+
*/
|
|
125
|
+
total?: number;
|
|
126
|
+
/**
|
|
127
|
+
* Deprecated.
|
|
128
|
+
* Limit.
|
|
129
|
+
*/
|
|
130
|
+
limit?: number;
|
|
131
|
+
/**
|
|
132
|
+
* Deprecated, use `paging_metadata.offset`.
|
|
133
|
+
* Offset.
|
|
134
|
+
*/
|
|
135
|
+
offset?: number;
|
|
136
|
+
/** Schedule items. */
|
|
137
|
+
items?: ScheduleItem[];
|
|
138
|
+
/**
|
|
139
|
+
* Facets.
|
|
140
|
+
* @readonly
|
|
141
|
+
*/
|
|
142
|
+
facets?: Record<string, FacetCounts>;
|
|
143
|
+
/**
|
|
144
|
+
* Whether there are draft changes which have not been published yet.
|
|
145
|
+
* Returned only when filtering by single `event_id` with `WIX_EVENTS.MANAGE_AGENDA` permission.
|
|
146
|
+
* @readonly
|
|
147
|
+
*/
|
|
148
|
+
draftNotPublished?: boolean | null;
|
|
149
|
+
pagingMetadata?: PagingMetadataV2;
|
|
150
|
+
}
|
|
151
|
+
export interface FacetCounts {
|
|
152
|
+
/** Facet counts aggregated per value */
|
|
153
|
+
counts?: Record<string, number>;
|
|
154
|
+
}
|
|
155
|
+
export interface PagingMetadataV2 {
|
|
156
|
+
/** Number of items returned in the response. */
|
|
157
|
+
count?: number | null;
|
|
158
|
+
/** Offset that was requested. */
|
|
159
|
+
offset?: number | null;
|
|
160
|
+
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
161
|
+
total?: number | null;
|
|
162
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
163
|
+
tooManyToCount?: boolean | null;
|
|
164
|
+
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
165
|
+
cursors?: Cursors;
|
|
166
|
+
}
|
|
167
|
+
export interface Cursors {
|
|
168
|
+
/** Cursor pointing to next page in the list of results. */
|
|
169
|
+
next?: string | null;
|
|
170
|
+
/** Cursor pointing to previous page in the list of results. */
|
|
171
|
+
prev?: string | null;
|
|
172
|
+
}
|
|
173
|
+
export interface QueryScheduleItemsRequest {
|
|
174
|
+
query?: QueryV2;
|
|
175
|
+
}
|
|
176
|
+
export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
177
|
+
/** 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). */
|
|
178
|
+
filter?: Record<string, any> | null;
|
|
179
|
+
/**
|
|
180
|
+
* Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
|
|
181
|
+
* 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).
|
|
182
|
+
*/
|
|
183
|
+
sort?: Sorting[];
|
|
184
|
+
/**
|
|
185
|
+
* Pointer to page of results using offset.
|
|
186
|
+
* See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
|
|
187
|
+
*/
|
|
188
|
+
paging?: Paging;
|
|
189
|
+
}
|
|
190
|
+
/** @oneof */
|
|
191
|
+
export interface QueryV2PagingMethodOneOf {
|
|
192
|
+
/**
|
|
193
|
+
* Pointer to page of results using offset.
|
|
194
|
+
* See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
|
|
195
|
+
*/
|
|
196
|
+
paging?: Paging;
|
|
197
|
+
}
|
|
198
|
+
export interface Sorting {
|
|
199
|
+
/** Name of the field to sort by */
|
|
200
|
+
fieldName?: string;
|
|
201
|
+
/** Sort order (ASC/DESC). Defaults to ASC */
|
|
202
|
+
order?: SortOrder;
|
|
203
|
+
}
|
|
204
|
+
export declare enum SortOrder {
|
|
205
|
+
ASC = "ASC",
|
|
206
|
+
DESC = "DESC"
|
|
207
|
+
}
|
|
208
|
+
export interface QueryScheduleItemsResponse {
|
|
209
|
+
pagingMetadata?: PagingMetadataV2;
|
|
210
|
+
/** Schedule items. */
|
|
211
|
+
items?: ScheduleItem[];
|
|
212
|
+
}
|
|
213
|
+
export interface GetScheduleItemRequest {
|
|
214
|
+
/** Event ID. */
|
|
215
|
+
eventId?: string;
|
|
216
|
+
/** Schedule item ID. */
|
|
217
|
+
itemId: string;
|
|
218
|
+
includeDraft?: boolean;
|
|
219
|
+
}
|
|
220
|
+
export interface GetScheduleItemResponse {
|
|
221
|
+
/** Schedule item. */
|
|
222
|
+
item?: ScheduleItem;
|
|
223
|
+
/** Draft of the Schedule item. */
|
|
224
|
+
draft?: ScheduleItem;
|
|
225
|
+
}
|
|
226
|
+
export interface AddScheduleItemRequest {
|
|
227
|
+
/** Event ID. */
|
|
228
|
+
eventId: string;
|
|
229
|
+
/** Schedule item. */
|
|
230
|
+
item?: ScheduleItemData;
|
|
231
|
+
}
|
|
232
|
+
/** Schedule item describes the schedule within an event. Each event may contain multiple schedule items. */
|
|
233
|
+
export interface ScheduleItemData {
|
|
234
|
+
/** Whether schedule item is hidden from guests. */
|
|
235
|
+
hidden?: boolean;
|
|
236
|
+
/** Schedule item name. */
|
|
237
|
+
name?: string;
|
|
238
|
+
timeSlot?: TimeInterval;
|
|
239
|
+
/** Rich-text content displayed in Wix UI when viewing schedule item details (HTML). */
|
|
240
|
+
description?: string;
|
|
241
|
+
/** Stage or room name in which session takes place. */
|
|
242
|
+
stageName?: string;
|
|
243
|
+
/** Tags are used to organize schedule items by assigning them to a general theme or field of study. */
|
|
244
|
+
tags?: string[];
|
|
245
|
+
/** Schedule item status. */
|
|
246
|
+
status?: ScheduleStatus;
|
|
247
|
+
}
|
|
248
|
+
export interface AddScheduleItemResponse {
|
|
249
|
+
/** Schedule item. */
|
|
250
|
+
item?: ScheduleItem;
|
|
251
|
+
}
|
|
252
|
+
export interface UpdateScheduleItemRequest {
|
|
253
|
+
/** Event ID. */
|
|
254
|
+
eventId: string;
|
|
255
|
+
/** Schedule item ID. */
|
|
256
|
+
itemId: string;
|
|
257
|
+
/** Schedule item. */
|
|
258
|
+
item?: ScheduleItemData;
|
|
259
|
+
/**
|
|
260
|
+
* Set of field paths to update.
|
|
261
|
+
* When fields are empty, request is interpreted as full update.
|
|
262
|
+
* Behavior follows [google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask) semantics.
|
|
263
|
+
*/
|
|
264
|
+
fields?: string[];
|
|
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
|
+
declare type GoogleProtoDuration = any;
|
|
325
|
+
/**
|
|
326
|
+
* Retrieves a list of up to 100 schedule items, with basic filter support.
|
|
327
|
+
* @public
|
|
328
|
+
* @documentationMaturity preview
|
|
329
|
+
*/
|
|
330
|
+
export declare function listScheduleItems(options?: ListScheduleItemsOptions): Promise<ListScheduleItemsResponse>;
|
|
331
|
+
export interface ListScheduleItemsOptions {
|
|
332
|
+
/** Event ID. */
|
|
333
|
+
eventId?: string[];
|
|
334
|
+
/**
|
|
335
|
+
* Schedule item state filter.
|
|
336
|
+
* Defaults to `[PUBLISHED, VISIBLE]` when no filters are specified.
|
|
337
|
+
* If neither `PUBLISHED` nor `DRAFT` are specified, assumes `PUBLISHED`, for example: `[HIDDEN]` becomes `[HIDDEN, PUBLISHED]`.
|
|
338
|
+
* If neither `VISIBLE` nor `HIDDEN` are specified, assumes `VISIBLE`, for example: `[DRAFT]` becomes `[DRAFT, VISIBLE]`.
|
|
339
|
+
*/
|
|
340
|
+
state?: StateFilter[];
|
|
341
|
+
/** Filters schedule items starting on or after specified point in time. Inclusive. */
|
|
342
|
+
startingFrom?: Date;
|
|
343
|
+
/** Filters schedule items starting before specified point in time. Non-inclusive. */
|
|
344
|
+
startingBefore?: Date;
|
|
345
|
+
/**
|
|
346
|
+
* Deprecated, use `paging`.
|
|
347
|
+
* Number of items to skip. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
|
|
348
|
+
*/
|
|
349
|
+
offset?: number;
|
|
350
|
+
/**
|
|
351
|
+
* Deprecated, use `paging`.
|
|
352
|
+
* Number of items to load per page. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
|
|
353
|
+
*/
|
|
354
|
+
limit?: number;
|
|
355
|
+
/**
|
|
356
|
+
* Filter facets.
|
|
357
|
+
* 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).
|
|
358
|
+
*/
|
|
359
|
+
facet?: string[];
|
|
360
|
+
/** Item IDs filter. */
|
|
361
|
+
itemId?: string[];
|
|
362
|
+
/** Tags filter. */
|
|
363
|
+
tag?: string[];
|
|
364
|
+
/** Stage names filter. */
|
|
365
|
+
stageName?: string[];
|
|
366
|
+
/**
|
|
367
|
+
* Pointer to page of results using offset.
|
|
368
|
+
* See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
|
|
369
|
+
*/
|
|
370
|
+
paging?: Paging;
|
|
371
|
+
}
|
|
372
|
+
/**
|
|
373
|
+
* 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).
|
|
374
|
+
*
|
|
375
|
+
* ** Important **:
|
|
376
|
+
* - All results are for one specific business, resolved from the request context.
|
|
377
|
+
*
|
|
378
|
+
* Query object support:
|
|
379
|
+
* - `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).
|
|
380
|
+
* - `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).
|
|
381
|
+
* - `paging` - supported, see [paging](https://dev.wix.com/api/rest/getting-started/pagination).
|
|
382
|
+
* - `fields` - not supported.
|
|
383
|
+
* - `fieldsets` - not supported.
|
|
384
|
+
* - `cursorPaging` - not supported, use offset pagination instead.
|
|
385
|
+
*
|
|
386
|
+
* Defaults:
|
|
387
|
+
* - When filter is not specified, returns all schedule items that caller is authorized to read.
|
|
388
|
+
* - When sorting is not specified, defaults to `time_slot.start` and `time_slot.end` in `ASC` order.
|
|
389
|
+
* @public
|
|
390
|
+
* @documentationMaturity preview
|
|
391
|
+
*/
|
|
392
|
+
export declare function queryScheduleItems(options?: QueryScheduleItemsOptions): Promise<QueryScheduleItemsResponse>;
|
|
393
|
+
export interface QueryScheduleItemsOptions {
|
|
394
|
+
query?: QueryV2;
|
|
395
|
+
}
|
|
396
|
+
/**
|
|
397
|
+
* Retrieves schedule item by ID.
|
|
398
|
+
* @param itemId - Schedule item ID.
|
|
399
|
+
* @public
|
|
400
|
+
* @documentationMaturity preview
|
|
401
|
+
* @requiredField itemId
|
|
402
|
+
*/
|
|
403
|
+
export declare function getScheduleItem(itemId: string, options?: GetScheduleItemOptions): Promise<GetScheduleItemResponse>;
|
|
404
|
+
export interface GetScheduleItemOptions {
|
|
405
|
+
/** Event ID. */
|
|
406
|
+
eventId?: string;
|
|
407
|
+
includeDraft?: boolean;
|
|
408
|
+
}
|
|
409
|
+
/**
|
|
410
|
+
* Adds schedule item to the draft schedule. Draft items are not publicly available unless published.
|
|
411
|
+
* @param eventId - Event ID.
|
|
412
|
+
* @public
|
|
413
|
+
* @documentationMaturity preview
|
|
414
|
+
* @requiredField eventId
|
|
415
|
+
* @requiredField options.item.name
|
|
416
|
+
* @requiredField options.item.timeSlot
|
|
417
|
+
* @requiredField options.item.timeSlot.end
|
|
418
|
+
* @requiredField options.item.timeSlot.start
|
|
419
|
+
*/
|
|
420
|
+
export declare function addScheduleItem(eventId: string, options?: AddScheduleItemOptions): Promise<AddScheduleItemResponse>;
|
|
421
|
+
export interface AddScheduleItemOptions {
|
|
422
|
+
/** Schedule item. */
|
|
423
|
+
item?: ScheduleItemData;
|
|
424
|
+
}
|
|
425
|
+
/**
|
|
426
|
+
* Updates existing schedule item.
|
|
427
|
+
* All modifications are performed on a draft schedule, even if schedule item has already been published.
|
|
428
|
+
* @param itemId - Schedule item ID.
|
|
429
|
+
* @param eventId - Event ID.
|
|
430
|
+
* @public
|
|
431
|
+
* @documentationMaturity preview
|
|
432
|
+
* @requiredField eventId
|
|
433
|
+
* @requiredField itemId
|
|
434
|
+
*/
|
|
435
|
+
export declare function updateScheduleItem(itemId: string, eventId: string, options?: UpdateScheduleItemOptions): Promise<UpdateScheduleItemResponse>;
|
|
436
|
+
export interface UpdateScheduleItemOptions {
|
|
437
|
+
/** Schedule item. */
|
|
438
|
+
item?: ScheduleItemData;
|
|
439
|
+
/**
|
|
440
|
+
* Set of field paths to update.
|
|
441
|
+
* When fields are empty, request is interpreted as full update.
|
|
442
|
+
* Behavior follows [google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask) semantics.
|
|
443
|
+
*/
|
|
444
|
+
fields?: string[];
|
|
445
|
+
}
|
|
446
|
+
/**
|
|
447
|
+
* Deletes schedule item from draft schedule.
|
|
448
|
+
* @param eventId - Event ID.
|
|
449
|
+
* @public
|
|
450
|
+
* @documentationMaturity preview
|
|
451
|
+
* @requiredField eventId
|
|
452
|
+
*/
|
|
453
|
+
export declare function deleteScheduleItem(eventId: string, options?: DeleteScheduleItemOptions): Promise<void>;
|
|
454
|
+
export interface DeleteScheduleItemOptions {
|
|
455
|
+
/** Schedule items to delete. */
|
|
456
|
+
itemIds?: string[];
|
|
457
|
+
}
|
|
458
|
+
/**
|
|
459
|
+
* Clears all changes to the draft schedule.
|
|
460
|
+
* (Does not affect the published schedule.)
|
|
461
|
+
* @param eventId - Event ID.
|
|
462
|
+
* @public
|
|
463
|
+
* @documentationMaturity preview
|
|
464
|
+
* @requiredField eventId
|
|
465
|
+
*/
|
|
466
|
+
export declare function discardDraft(eventId: string): Promise<void>;
|
|
467
|
+
/**
|
|
468
|
+
* Publishes the draft schedule.
|
|
469
|
+
* @param eventId - Event ID.
|
|
470
|
+
* @public
|
|
471
|
+
* @documentationMaturity preview
|
|
472
|
+
* @requiredField eventId
|
|
473
|
+
*/
|
|
474
|
+
export declare function publishDraft(eventId: string): Promise<void>;
|
|
475
|
+
/**
|
|
476
|
+
* Adjusts time of all draft schedule items (per event).
|
|
477
|
+
* @param eventId - Event ID.
|
|
478
|
+
* @public
|
|
479
|
+
* @documentationMaturity preview
|
|
480
|
+
* @requiredField eventId
|
|
481
|
+
* @requiredField options.timeZoneId
|
|
482
|
+
*/
|
|
483
|
+
export declare function rescheduleDraft(eventId: string, options?: RescheduleDraftOptions): Promise<void>;
|
|
484
|
+
export interface RescheduleDraftOptions {
|
|
485
|
+
/** Time zone ID in TZ database format, e.g., `EST`, `America/Los_Angeles`. */
|
|
486
|
+
timeZoneId: string;
|
|
487
|
+
/** Offset added or subtracted from schedule item start & end times. */
|
|
488
|
+
timeSlotOffset?: GoogleProtoDuration;
|
|
489
|
+
}
|
|
490
|
+
export {};
|