/** Schedule item describes the schedule within an event. Each event may contain multiple schedule items. */ export interface ScheduleItem { /** * Schedule item ID. * @readonly */ _id?: string; /** Whether a schedule item is hidden from guests. */ hidden?: boolean; /** Schedule item name. */ name?: string; /** Time slot of a schedule item. */ timeSlot?: TimeInterval; /** Rich text schedule item description. */ description?: string; /** Stage or room name in which the session takes place. */ stageName?: string; /** Schedule item tags. They're used to organize the items to a theme. */ tags?: string[]; /** * Schedule item status. Possible values: * - `SCHEDULED`: An item is scheduled. * - `CANCELED`: An item is canceled. */ status?: ScheduleStatus; /** * Date and time when the schedule item was created. * @readonly */ _createdDate?: Date | null; /** * Date and time when the schedule item was updated. * @readonly */ _updatedDate?: Date | null; /** * Event ID to which the schedule belongs. * @readonly */ eventId?: string; /** * Whether the schedule item is draft. * @readonly */ draft?: boolean; } /** Time interval on the timeline between two points in time. */ export interface TimeInterval { /** Start of the interval. Inclusive. */ start?: Date | null; /** End of the interval. Non-inclusive. */ end?: Date | null; /** * Time zone ID in the [TZ database](https://www.iana.org/time-zones) format. For example, `EST`, `America/Los_Angeles`. * Default: `Etc/UTC`. */ timeZoneId?: string | null; } export declare enum ScheduleStatus { /** Item is scheduled for a future date. */ SCHEDULED = "SCHEDULED", /** Item is canceled. */ CANCELED = "CANCELED" } export interface ListScheduleItemsRequest { /** Event ID to which the schedule belongs. */ eventId?: string[]; /** * Schedule item state filter. Possible values: * - `PUBLISHED`: The schedule item is published. * - `DRAFT`: The schedule item is in the draft. You need the "WIX_EVENTS.MANAGE_AGENDA" permissions to change this state. * - `VISIBLE`: The schedule item is visible to guests. * - `HIDDEN`: The schedule item is hidden from guests. You need the "WIX_EVENTS.MANAGE_AGENDA" permissions to change this state. * Default: Filters by the `PUBLISHED` and `VISIBLE` states. */ state?: StateFilter[]; /** Filters schedule items starting on or after specified point in time. Inclusive. */ startingFrom?: Date | null; /** Filters schedule items starting before specified point in time. Non-inclusive. */ startingBefore?: Date | null; /** * Deprecated, use `paging`. * Number of items to skip. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). * @deprecated */ offset?: number; /** * Deprecated, use `paging`. * Number of items to load per page. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). * @deprecated */ limit?: number; /** * Filter facets. * 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). */ facet?: string[]; /** Schedule item ID. */ itemId?: string[]; /** Schedule item tags. They're used to organize the items to a theme. */ tag?: string[]; /** Stage or room name in which the session takes place. */ stageName?: string[]; /** * Pointer to page of results using offset. * See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */ paging?: Paging; } export declare enum StateFilter { /** Schedule item is published. */ PUBLISHED = "PUBLISHED", /** Opposite of `PUBLISHED`. Requires `WIX_EVENTS.READ_HIDDEN_AGENDA` permission. */ DRAFT = "DRAFT", /** Schedule item is visible to the public. */ VISIBLE = "VISIBLE", /** Opposite of `VISIBLE`. Requires `WIX_EVENTS.READ_HIDDEN_AGENDA` permission. */ HIDDEN = "HIDDEN" } export interface Paging { /** Number of items to load per page. */ limit?: number | null; /** Number of items to skip in the current sort order. */ offset?: number | null; } export interface ListScheduleItemsResponse { /** * Deprecated, use `paging_metadata.total`. * Total schedule items matching the given filters. * @readonly * @deprecated */ total?: number; /** * Deprecated. * Limit. * @deprecated */ limit?: number; /** * Deprecated, use `paging_metadata.offset`. * Offset. * @deprecated */ offset?: number; /** Schedule items. */ items?: ScheduleItem[]; /** * Facets. * @readonly */ facets?: Record; /** * Whether there are draft changes which have not been published yet. * Returned only when filtering by single `event_id` with `WIX_EVENTS.MANAGE_AGENDA` permission. * @readonly */ draftNotPublished?: boolean | null; /** Paging metadata. */ pagingMetadata?: PagingMetadataV2; } export interface FacetCounts { /** Facet counts aggregated per value. */ counts?: Record; } export interface PagingMetadataV2 { /** Number of items returned in the response. */ count?: number | null; /** Offset that was requested. */ offset?: number | null; /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */ total?: number | null; /** Flag that indicates the server failed to calculate the `total` field. */ tooManyToCount?: boolean | null; /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */ cursors?: Cursors; } export interface Cursors { /** Cursor string pointing to the next page in the list of results. */ next?: string | null; /** Cursor pointing to the previous page in the list of results. */ prev?: string | null; } export interface QueryScheduleItemsRequest { query?: QueryV2; } export interface QueryV2 extends QueryV2PagingMethodOneOf { /** * Pointer to page of results using offset. * See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */ paging?: Paging; /** 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). */ filter?: Record | null; /** * Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] * 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). */ sort?: Sorting[]; } /** @oneof */ export interface QueryV2PagingMethodOneOf { /** * Pointer to page of results using offset. * See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */ paging?: Paging; } export interface Sorting { /** Name of the field to sort by */ fieldName?: string; /** Sort order (ASC/DESC). Defaults to ASC */ order?: SortOrder; } export declare enum SortOrder { ASC = "ASC", DESC = "DESC" } export interface QueryScheduleItemsResponse { pagingMetadata?: PagingMetadataV2; /** Schedule items. */ items?: ScheduleItem[]; } export interface GetScheduleItemRequest { /** Event ID to which the schedule belongs. */ eventId?: string; /** Schedule item ID. */ itemId?: string; /** Whether to include draft schedules in the response. */ includeDraft?: boolean; } export interface GetScheduleItemResponse { /** Schedule item. */ item?: ScheduleItem; /** Draft of the Schedule item. */ draft?: ScheduleItem; } export interface AddScheduleItemRequest { /** Event ID to which the schedule belongs. */ eventId?: string; /** Schedule item. */ item?: ScheduleItemData; } /** Schedule item describes the schedule within an event. Each event may contain multiple schedule items. */ export interface ScheduleItemData { /** Whether a schedule item is hidden from guests. */ hidden?: boolean; /** Schedule item name. */ name?: string; /** Time slot of a schedule item. */ timeSlot?: TimeInterval; /** Rich text schedule item description. */ description?: string; /** Stage or room name in which the session takes place. */ stageName?: string; /** Schedule item tags. They're used to organize the items to a theme. */ tags?: string[]; /** * Schedule item status. Possible values: * - `SCHEDULED`: An item is scheduled. * - `CANCELED`: An item is canceled. */ status?: ScheduleStatus; } export interface AddScheduleItemResponse { /** Schedule item. */ item?: ScheduleItem; } export interface UpdateScheduleItemRequest { /** Event ID to which the schedule belongs. */ eventId?: string; /** Schedule item ID. */ itemId?: string; /** Schedule item. */ item?: ScheduleItemData; /** * Set of field paths to update. * When fields are empty, request is interpreted as full update. * Behavior follows [google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask) semantics. */ fields?: string[]; } export interface UpdateScheduleItemResponse { /** Schedule item. */ item?: ScheduleItem; } export interface DeleteScheduleItemRequest { /** Event ID to which the schedule belongs. */ eventId?: string; /** Schedule items to delete. */ itemIds?: string[]; } export interface DeleteScheduleItemResponse { } export interface DiscardDraftRequest { /** Event ID to which the schedule belongs. */ eventId?: string; } export interface DiscardDraftResponse { } export interface PublishDraftRequest { /** Event ID to which the schedule belongs. */ eventId?: string; } export interface PublishDraftResponse { } export interface RescheduleDraftRequest { /** Event ID to which the schedule belongs. */ eventId?: string; /** * Time zone ID in the [TZ database](https://www.iana.org/time-zones) format. For example, `EST`, `America/Los_Angeles`. * Default: `Etc/UTC`. */ timeZoneId?: string; /** Offset added or subtracted from the start and end times of schedule items. */ timeSlotOffset?: GoogleProtoDuration; } export interface RescheduleDraftResponse { } export interface ListBookmarksRequest { /** Event ID to which the schedule belongs. */ eventId: string; } export interface ListBookmarksResponse { /** Schedule items. */ items?: ScheduleItem[]; } export interface CreateBookmarkRequest { /** Event ID to which the schedule belongs. */ eventId: string; /** Schedule item ID. */ itemId: string; } export interface CreateBookmarkResponse { } export interface DeleteBookmarkRequest { /** Event ID to which the schedule belongs. */ eventId: string; /** Schedule item ID. */ itemId: string; } export interface DeleteBookmarkResponse { } interface ScheduleItemNonNullableFields { _id: string; hidden: boolean; name: string; description: string; stageName: string; tags: string[]; status: ScheduleStatus; eventId: string; draft: boolean; } export interface ListBookmarksResponseNonNullableFields { items: ScheduleItemNonNullableFields[]; } type GoogleProtoDuration = any; /** * Retrieves a list of bookmarked schedule items for a currently logged-in member. * @public * @requiredField eventId * @param eventId - Event ID to which the schedule belongs. * @permissionId WIX_EVENTS.READ_AGENDA_BOOKMARKS * @applicableIdentity MEMBER * @fqn wix.events.schedule.BookmarkManagement.ListBookmarks */ export declare function listBookmarks(eventId: string): Promise; /** * Bookmarks a schedule item for a currently logged-in member. * @param itemId - Schedule item ID. * @public * @requiredField eventId * @requiredField itemId * @param eventId - Event ID to which the schedule belongs. * @permissionId WIX_EVENTS.MANAGE_AGENDA_BOOKMARKS * @applicableIdentity MEMBER * @fqn wix.events.schedule.BookmarkManagement.CreateBookmark */ export declare function createBookmark(itemId: string, eventId: string): Promise; /** * Removes a schedule item bookmark for a currently logged-in member. * @param itemId - Schedule item ID. * @public * @requiredField eventId * @requiredField itemId * @param eventId - Event ID to which the schedule belongs. * @permissionId WIX_EVENTS.MANAGE_AGENDA_BOOKMARKS * @applicableIdentity MEMBER * @fqn wix.events.schedule.BookmarkManagement.DeleteBookmark */ export declare function deleteBookmark(itemId: string, eventId: string): Promise; export {};