@wix/calendar 1.0.0

package/type-bundles/context.bundle.d.ts

@@ -0,0 +1,1519 @@
+interface Schedule {
+    /**
+     * The schedule ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Optional external ID. Cannot change.
+     *
+     * For instance, might be the ID of the Bookings Resource or Service.
+     */
+    externalId?: string | null;
+    /**
+     * The name of the schedule.
+     *
+     * For instance, might be the name of the Bookings Resource or Service.
+     */
+    name?: string | null;
+    /**
+     * The schedule status.
+     *
+     * The possible values are:
+     * - `"ACTIVE"` Schedule is active. Default value.
+     * - `"CANCELLED"` Schedule has been cancelled.
+     * @readonly
+     */
+    status?: Status;
+    /**
+     * The schedule time zone, formatted according to the IANA time zone format.
+     * Must be a regional time zone (Area/Location) or UTC.
+     *
+     * By default the time zone is derived from the Wix Business, and can be overridden by setting `businessTimeZoneEnabled` to false.
+     */
+    timeZone?: string | null;
+    /**
+     * Whether to use the time zone of the Wix Business.
+     * Default is true.
+     */
+    businessTimeZoneEnabled?: boolean | null;
+    /** Default title for the schedule's events. */
+    defaultTitle?: string | null;
+    /** Default location for the schedule's events. */
+    defaultLocation?: Location;
+    /**
+     * Default capacity for the schedule's events.
+     *
+     * The capacity of an event is the max number of participants that can participate in an event.
+     */
+    defaultCapacity?: number | null;
+    /** Default conferencing details for the schedule's events. */
+    defaultConferencingDetails?: ConferencingDetails;
+    /**
+     * Optional ID of the Wix app owning the schedule.
+     * Cannot change once set.
+     *
+     * For example, to create a schedule in the Wix Bookings App Calendar, provide `13d21c63-b5ec-5912-8397-c3a5ddb27a97`.
+     */
+    appId?: string | null;
+    /**
+     * List of granted permissions for this schedule.
+     *
+     * E.g, a Bookings Staff Member has full write access to its schedule and limited access to events it provides.
+     */
+    permissions?: Permission[];
+    /** Extensions enabling applications or users to save custom data related to the schedule. */
+    extendedFields?: ExtendedFields;
+    /**
+     * The schedule revision number, which incremented on updates.
+     *
+     * The current revision should be provided on updates to prevent conflicting changes.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date the schedule was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Date the schedule was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+}
+declare enum Status {
+    UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    /** Schedule is active. Default value. */
+    ACTIVE = "ACTIVE",
+    /** Schedule has been cancelled. */
+    CANCELLED = "CANCELLED"
+}
+interface Location {
+    /**
+     * The location ID. Optional.
+     * Currently only supported for locations of type `BUSINESS`, and used to reference the Wix Business Location.
+     */
+    _id?: string | null;
+    /**
+     * The location type.
+     * The possible values are:
+     * - `"BUSINESS"` event takes place at the business location.
+     * - `"CUSTOM"` event takes place at the custom location.
+     */
+    type?: LocationType;
+    /**
+     * The location name. Optional.
+     * Derived from the Wix Business Location if the location is of type `BUSINESS`.
+     */
+    name?: string | null;
+    /**
+     * The location address. Optional.
+     * Derived from the Wix Business Location if the location is of type `BUSINESS`.
+     */
+    address?: string | null;
+}
+declare enum LocationType {
+    UNKNOWN_TYPE = "UNKNOWN_TYPE",
+    /** The event takes place at the business location. */
+    BUSINESS = "BUSINESS",
+    /** The event takes place at the customer location. */
+    CUSTOMER = "CUSTOMER",
+    /** The event takes place at the custom location. */
+    CUSTOM = "CUSTOM"
+}
+interface ConferencingDetails {
+    /** World known conference type, such as Zoom. */
+    type?: Type;
+    /** URL used by the host to start the conference. */
+    hostUrl?: string | null;
+    /** URL used by a guest to join the conference. */
+    guestUrl?: string | null;
+    /** Optional conference password. */
+    password?: string | null;
+    /** Optional conference ID in an external system. */
+    externalId?: string | null;
+}
+declare enum Type {
+    UNKNOWN_TYPE = "UNKNOWN_TYPE",
+    ZOOM = "ZOOM",
+    CUSTOM = "CUSTOM"
+}
+interface Permission {
+    /** The identity granted the permission. */
+    identity?: CommonIdentificationData;
+    /**
+     * The permission role.
+     *
+     * The possible values are:
+     * - `"WRITER"` Role grants full write and read access.
+     * - `"COMMENTER"` Role grants full read access and permission to edit notes.
+     */
+    role?: Role;
+}
+interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+}
+/** @oneof */
+interface CommonIdentificationDataIdOneOf {
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+}
+declare enum IdentityType {
+    UNKNOWN = "UNKNOWN",
+    WIX_USER = "WIX_USER"
+}
+declare enum Role {
+    UNKNOWN_ROLE = "UNKNOWN_ROLE",
+    /** Role grants full write and read access. */
+    WRITER = "WRITER",
+    /** Role grants full read access and permission to edit notes. */
+    COMMENTER = "COMMENTER"
+}
+interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+interface GetScheduleRequest {
+    /** The ID of the schedule to retrieve. */
+    scheduleId: string | null;
+    /** List of additional fields to be included in the response. */
+    fields?: RequestedFields[];
+}
+declare enum RequestedFields {
+    UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
+    /**
+     * Include fields containing personal information.
+     * Requires the `CALENDAR.SCHEDULE_READ_PI` additional permission.
+     */
+    PI_FIELDS = "PI_FIELDS",
+    /**
+     * Include fields containing personal information for schedules the current caller has access to.
+     * See `schedule.permissions` for more details.
+     */
+    OWN_PI_FIELDS = "OWN_PI_FIELDS"
+}
+interface GetScheduleResponse {
+    /** The schedule. */
+    schedule?: Schedule;
+}
+interface QuerySchedulesRequest {
+    /** Query containing filters and paging. */
+    query?: CursorQuery;
+    /** List of additional fields to be included in the response. */
+    fields?: RequestedFields[];
+}
+/** TODO Diverge */
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
+     * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
+     * for more information.
+     *
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
+     *
+     * For a detailed list of supported filters, see Supported Filters.
+     */
+    filter?: Record<string, any> | null;
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
+    cursorPaging?: CursorPaging;
+}
+/** TODO Diverge */
+interface CursorPaging {
+    /**
+     * Number of events to return.
+     * Defaults to `50`. Maximum `1000`.
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get the relevant cursor token
+     * from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+interface QuerySchedulesResponse {
+    /** The schedules matching the provided query. */
+    schedules?: Schedule[];
+    /** Paging metadata. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+/** TODO Diverge */
+interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Use these cursor to paginate between results. [Read more](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging). */
+    cursors?: Cursors;
+    /**
+     * Indicates if there are more results after the current page.
+     * If `true`, another page of results can be retrieved.
+     * If `false`, this is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /** Cursor pointing to next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
+}
+interface CreateScheduleRequest {
+    /** The schedule to create. */
+    schedule: Schedule;
+    /** Optional Idempotency key. */
+    idempotencyKey?: string | null;
+}
+interface CreateScheduleResponse {
+    /** The created schedule. */
+    schedule?: Schedule;
+}
+interface UpdateScheduleRequest {
+    /** The schedule to update. */
+    schedule: Schedule;
+    /** Whether to notify participants regarding the changes. */
+    participantNotification?: ParticipantNotification;
+}
+interface ParticipantNotification {
+    /**
+     * Whether to notify the participant/s about changes made to the schedule or event.
+     * Default is false.
+     */
+    notifyParticipants?: boolean | null;
+    /** Optional custom message to send. */
+    message?: string | null;
+}
+interface UpdateScheduleResponse {
+    /** The updated schedule. */
+    schedule?: Schedule;
+}
+/** `PRIVATE` until we'll have standard events metadata from Infra. */
+interface ScheduleUpdatedWithMetadata {
+    /** The updated schedule. */
+    schedule?: Schedule;
+    /** Whether to notify participants regarding the changes. */
+    participantNotification?: ParticipantNotification;
+}
+interface CloneScheduleRequest {
+    /** The ID of the schedule to clone. */
+    scheduleId: string | null;
+    /** Optional values to override. */
+    schedule?: Schedule;
+}
+interface CloneScheduleResponse {
+    /** The new cloned schedule. */
+    schedule?: Schedule;
+}
+interface ScheduleCloned {
+    /** The new cloned schedule. */
+    schedule?: Schedule;
+    /** The clone trigger. */
+    trigger?: Trigger;
+    /** The original Meta Site ID if different. */
+    originalMetaSiteId?: string | null;
+    /** The original schedule ID if different. */
+    originalScheduleId?: string | null;
+}
+declare enum Trigger {
+    UNKNOWN_TRIGGER = "UNKNOWN_TRIGGER",
+    /** Schedule cloned using the `CloneSchedule` API. */
+    SCHEDULE_CLONED = "SCHEDULE_CLONED",
+    /** Site duplicated from the same account. */
+    SITE_DUPLICATED_FROM_SAME_ACCOUNT = "SITE_DUPLICATED_FROM_SAME_ACCOUNT",
+    /** Site duplicated from a different account. */
+    SITE_DUPLICATED_FROM_DIFFERENT_ACCOUNT = "SITE_DUPLICATED_FROM_DIFFERENT_ACCOUNT",
+    /** Site created from template. */
+    SITE_CREATED_FROM_TEMPLATE = "SITE_CREATED_FROM_TEMPLATE",
+    /** Other. */
+    OTHER = "OTHER"
+}
+interface CancelScheduleRequest {
+    /** The ID of the schedule to cancel. */
+    scheduleId: string | null;
+    /**
+     * Whether to preserve future events with participants.
+     * Default is false.
+     */
+    preserveFutureEventsWithParticipants?: boolean | null;
+    /** Whether to notify participants regarding the changes. */
+    participantNotification?: ParticipantNotification;
+}
+interface CancelScheduleResponse {
+    /** The cancelled schedule. */
+    schedule?: Schedule;
+}
+interface ScheduleCancelled {
+    /** The cancelled schedule. */
+    schedule?: Schedule;
+    /** Whether to preserve future events with participants. */
+    preserveFutureEventsWithParticipants?: boolean | null;
+}
+interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
+    /** Emitted on a meta site creation. */
+    siteCreated?: SiteCreated;
+    /** Emitted on a meta site transfer completion. */
+    siteTransferred?: SiteTransferred;
+    /** Emitted on a meta site deletion. */
+    siteDeleted?: SiteDeleted;
+    /** Emitted on a meta site restoration. */
+    siteUndeleted?: SiteUndeleted;
+    /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
+    sitePublished?: SitePublished;
+    /** Emitted on a meta site unpublish. */
+    siteUnpublished?: SiteUnpublished;
+    /** Emitted when meta site is marked as template. */
+    siteMarkedAsTemplate?: SiteMarkedAsTemplate;
+    /** Emitted when meta site is marked as a WixSite. */
+    siteMarkedAsWixSite?: SiteMarkedAsWixSite;
+    /** Emitted when an application is provisioned (installed). */
+    serviceProvisioned?: ServiceProvisioned;
+    /** Emitted when an application is removed (uninstalled). */
+    serviceRemoved?: ServiceRemoved;
+    /** Emitted when meta site name (URL slug) is changed. */
+    siteRenamedPayload?: SiteRenamed;
+    /** Emitted when meta site was permanently deleted. */
+    hardDeleted?: SiteHardDeleted;
+    /** Emitted on a namespace change. */
+    namespaceChanged?: NamespaceChanged;
+    /** Emitted when Studio is attached. */
+    studioAssigned?: StudioAssigned;
+    /** Emitted when Studio is detached. */
+    studioUnassigned?: StudioUnassigned;
+    /** A meta site id. */
+    metaSiteId?: string;
+    /** A meta site version. Monotonically increasing. */
+    version?: string;
+    /** A timestamp of the event. */
+    timestamp?: string;
+    /** A list of "assets" (applications). The same as MetaSiteContext. */
+    assets?: Asset[];
+}
+/** @oneof */
+interface MetaSiteSpecialEventPayloadOneOf {
+    /** Emitted on a meta site creation. */
+    siteCreated?: SiteCreated;
+    /** Emitted on a meta site transfer completion. */
+    siteTransferred?: SiteTransferred;
+    /** Emitted on a meta site deletion. */
+    siteDeleted?: SiteDeleted;
+    /** Emitted on a meta site restoration. */
+    siteUndeleted?: SiteUndeleted;
+    /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
+    sitePublished?: SitePublished;
+    /** Emitted on a meta site unpublish. */
+    siteUnpublished?: SiteUnpublished;
+    /** Emitted when meta site is marked as template. */
+    siteMarkedAsTemplate?: SiteMarkedAsTemplate;
+    /** Emitted when meta site is marked as a WixSite. */
+    siteMarkedAsWixSite?: SiteMarkedAsWixSite;
+    /** Emitted when an application is provisioned (installed). */
+    serviceProvisioned?: ServiceProvisioned;
+    /** Emitted when an application is removed (uninstalled). */
+    serviceRemoved?: ServiceRemoved;
+    /** Emitted when meta site name (URL slug) is changed. */
+    siteRenamedPayload?: SiteRenamed;
+    /** Emitted when meta site was permanently deleted. */
+    hardDeleted?: SiteHardDeleted;
+    /** Emitted on a namespace change. */
+    namespaceChanged?: NamespaceChanged;
+    /** Emitted when Studio is attached. */
+    studioAssigned?: StudioAssigned;
+    /** Emitted when Studio is detached. */
+    studioUnassigned?: StudioUnassigned;
+}
+interface Asset {
+    /** An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum). */
+    appDefId?: string;
+    /** An instance id. For legacy reasons may be UUID or a string. */
+    instanceId?: string;
+    /** An application state. */
+    state?: State;
+}
+declare enum State {
+    UNKNOWN = "UNKNOWN",
+    ENABLED = "ENABLED",
+    DISABLED = "DISABLED",
+    PENDING = "PENDING",
+    DEMO = "DEMO"
+}
+interface SiteCreated {
+    /** A template identifier (empty if not created from a template). */
+    originTemplateId?: string;
+    /** An account id of the owner. */
+    ownerId?: string;
+    /** A context in which meta site was created. */
+    context?: SiteCreatedContext;
+    /**
+     * A meta site id from which this site was created.
+     *
+     * In case of a creation from a template it's a template id.
+     * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
+     */
+    originMetaSiteId?: string | null;
+    /** A meta site name (URL slug). */
+    siteName?: string;
+    /** A namespace. */
+    namespace?: Namespace;
+}
+declare enum SiteCreatedContext {
+    /** A valid option, we don't expose all reasons why site might be created. */
+    OTHER = "OTHER",
+    /** A meta site was created from template. */
+    FROM_TEMPLATE = "FROM_TEMPLATE",
+    /** A meta site was created by copying of the transfferred meta site. */
+    DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
+    /** A copy of existing meta site. */
+    DUPLICATE = "DUPLICATE",
+    /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
+    OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
+    /** deprecated A meta site was created for Flash editor. */
+    FLASH = "FLASH"
+}
+declare enum Namespace {
+    UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
+    /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
+    WIX = "WIX",
+    /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    SHOUT_OUT = "SHOUT_OUT",
+    /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    ALBUMS = "ALBUMS",
+    /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
+    /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    HOTELS = "HOTELS",
+    /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    CLUBS = "CLUBS",
+    /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
+    /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    DEV_SITE = "DEV_SITE",
+    /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    LOGOS = "LOGOS",
+    /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    VIDEO_MAKER = "VIDEO_MAKER",
+    /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
+    /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
+    /**
+     * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
+     *
+     * Meta site with this namespace will *not* be shown in a user's site list by default.
+     */
+    HTML_DRAFT = "HTML_DRAFT",
+    /**
+     * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
+     * Will be accessible from Site List and will not have a website app.
+     * Once the user attaches a site, the site will become a regular wixsite.
+     */
+    SITELESS_BUSINESS = "SITELESS_BUSINESS",
+    /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
+    CREATOR_ECONOMY = "CREATOR_ECONOMY",
+    /** It is to be used in the Business First efforts. */
+    DASHBOARD_FIRST = "DASHBOARD_FIRST",
+    /** Bookings business flow with no site. */
+    ANYWHERE = "ANYWHERE",
+    /** Namespace for Headless Backoffice with no editor */
+    HEADLESS = "HEADLESS",
+    /**
+     * Namespace for master site that will exist in parent account that will be referenced by subaccounts
+     * The site will be used for account level CSM feature for enterprise
+     */
+    ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
+    /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
+    RISE = "RISE",
+    /**
+     * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
+     * There's a blank site behind the scene but it's blank).
+     * The Mobile company will be the owner of this namespace.
+     */
+    BRANDED_FIRST = "BRANDED_FIRST"
+}
+/** Site transferred to another user. */
+interface SiteTransferred {
+    /** A previous owner id (user that transfers meta site). */
+    oldOwnerId?: string;
+    /** A new owner id (user that accepts meta site). */
+    newOwnerId?: string;
+}
+/** Soft deletion of the meta site. Could be restored. */
+interface SiteDeleted {
+    /** A deletion context. */
+    deleteContext?: DeleteContext;
+}
+interface DeleteContext {
+    /** When the meta site was deleted. */
+    dateDeleted?: Date;
+    /** A status. */
+    deleteStatus?: DeleteStatus;
+    /** A reason (flow). */
+    deleteOrigin?: string;
+    /** A service that deleted it. */
+    initiatorId?: string | null;
+}
+declare enum DeleteStatus {
+    UNKNOWN = "UNKNOWN",
+    TRASH = "TRASH",
+    DELETED = "DELETED",
+    PENDING_PURGE = "PENDING_PURGE"
+}
+/** Restoration of the meta site. */
+interface SiteUndeleted {
+}
+/** First publish of a meta site. Or subsequent publish after unpublish. */
+interface SitePublished {
+}
+interface SiteUnpublished {
+    /** A list of URLs previously associated with the meta site. */
+    urls?: string[];
+}
+interface SiteMarkedAsTemplate {
+}
+interface SiteMarkedAsWixSite {
+}
+interface ServiceProvisioned {
+    /** Either UUID or EmbeddedServiceType. */
+    appDefId?: string;
+    /** Not only UUID. Something here could be something weird. */
+    instanceId?: string;
+    /** An instance id from which this instance is originated. */
+    originInstanceId?: string;
+    /** A version. */
+    version?: string | null;
+}
+interface ServiceRemoved {
+    /** Either UUID or EmbeddedServiceType. */
+    appDefId?: string;
+    /** Not only UUID. Something here could be something weird. */
+    instanceId?: string;
+    /** A version. */
+    version?: string | null;
+}
+/** Rename of the site. Meaning, free public url has been changed as well. */
+interface SiteRenamed {
+    /** A new meta site name (URL slug). */
+    newSiteName?: string;
+    /** A previous meta site name (URL slug). */
+    oldSiteName?: string;
+}
+/**
+ * Hard deletion of the meta site.
+ *
+ * Could not be restored. Therefore it's desirable to cleanup data.
+ */
+interface SiteHardDeleted {
+    /** A deletion context. */
+    deleteContext?: DeleteContext;
+}
+interface NamespaceChanged {
+    /** A previous namespace. */
+    oldNamespace?: Namespace;
+    /** A new namespace. */
+    newNamespace?: Namespace;
+}
+/** Assigned Studio editor */
+interface StudioAssigned {
+}
+/** Unassigned Studio editor */
+interface StudioUnassigned {
+}
+interface Empty {
+}
+/** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
+interface SitePropertiesNotification {
+    /** The site ID for which this update notification applies. */
+    metasiteId?: string;
+    /** The actual update event. */
+    event?: SitePropertiesEvent;
+    /** A convenience set of mappings from the MetaSite ID to its constituent services. */
+    translations?: Translation[];
+    /** Context of the notification */
+    changeContext?: ChangeContext;
+}
+/** The actual update event for a particular notification. */
+interface SitePropertiesEvent {
+    /** Version of the site's properties represented by this update. */
+    version?: number;
+    /** Updated properties. */
+    properties?: Properties;
+}
+interface Properties {
+    /** Site categories. */
+    categories?: Categories;
+    /** Site locale. */
+    locale?: Locale;
+    /**
+     * Site language.
+     *
+     * Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
+     */
+    language?: string | null;
+    /**
+     * Site currency format used to bill customers.
+     *
+     * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     */
+    paymentCurrency?: string | null;
+    /** Timezone in `America/New_York` format. */
+    timeZone?: string | null;
+    /** Email address. */
+    email?: string | null;
+    /** Phone number. */
+    phone?: string | null;
+    /** Fax number. */
+    fax?: string | null;
+    /** Address. */
+    address?: Address;
+    /** Site display name. */
+    siteDisplayName?: string | null;
+    /** Business name. */
+    businessName?: string | null;
+    /** Path to the site's logo in Wix Media (without Wix Media base URL). */
+    logo?: string | null;
+    /** Site description. */
+    description?: string | null;
+    /**
+     * Business schedule. Regular and exceptional time periods when the business is open or the service is available.
+     *
+     * __Note:__ Not supported by Wix Bookings.
+     */
+    businessSchedule?: BusinessSchedule;
+    /** Supported languages of a site and the primary language. */
+    multilingual?: Multilingual;
+    /** Cookie policy the site owner defined for their site (before the users interacts with/limits it). */
+    consentPolicy?: ConsentPolicy;
+    /**
+     * Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.
+     *
+     * Site business type.
+     */
+    businessConfig?: string | null;
+    /** External site url that uses Wix as its headless business solution */
+    externalSiteUrl?: string | null;
+    /** Track clicks analytics */
+    trackClicksAnalytics?: boolean;
+}
+interface Categories {
+    /** Primary site category. */
+    primary?: string;
+    /** Secondary site category. */
+    secondary?: string[];
+    /** Business Term Id */
+    businessTermId?: string | null;
+}
+interface Locale {
+    /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
+    languageCode?: string;
+    /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
+    country?: string;
+}
+interface Address {
+    /** Street name. */
+    street?: string;
+    /** City name. */
+    city?: string;
+    /** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
+    country?: string;
+    /** State. */
+    state?: string;
+    /** Zip or postal code. */
+    zip?: string;
+    /** Extra information to be displayed in the address. */
+    hint?: AddressHint;
+    /** Whether this address represents a physical location. */
+    isPhysical?: boolean;
+    /** Google-formatted version of this address. */
+    googleFormattedAddress?: string;
+    /** Street number. */
+    streetNumber?: string;
+    /** Apartment number. */
+    apartmentNumber?: string;
+    /** Geographic coordinates of location. */
+    coordinates?: GeoCoordinates;
+}
+/**
+ * Extra information on displayed addresses.
+ * This is used for display purposes. Used to add additional data about the address, such as "In the passage".
+ * Free text. In addition the user can state where he wants that additional description - before, after, or instead
+ * the address string.
+ */
+interface AddressHint {
+    /** Extra text displayed next to, or instead of, the actual address. */
+    text?: string;
+    /** Where the extra text should be displayed. */
+    placement?: PlacementType;
+}
+/** Where the extra text should be displayed: before, after or instead of the actual address. */
+declare enum PlacementType {
+    BEFORE = "BEFORE",
+    AFTER = "AFTER",
+    REPLACE = "REPLACE"
+}
+/** Geocoordinates for a particular address. */
+interface GeoCoordinates {
+    /** Latitude of the location. Must be between -90 and 90. */
+    latitude?: number;
+    /** Longitude of the location. Must be between -180 and 180. */
+    longitude?: number;
+}
+/** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
+interface BusinessSchedule {
+    /** Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods. */
+    periods?: TimePeriod[];
+    /** Exceptions to the business's regular hours. The business can be open or closed during the exception. */
+    specialHourPeriod?: SpecialHourPeriod[];
+}
+/** Weekly recurring time periods when the business is regularly open or the service is available. */
+interface TimePeriod {
+    /** Day of the week the period starts on. */
+    openDay?: DayOfWeek;
+    /**
+     * Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
+     * midnight at the end of the specified day.
+     */
+    openTime?: string;
+    /** Day of the week the period ends on. */
+    closeDay?: DayOfWeek;
+    /**
+     * Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
+     * midnight at the end of the specified day.
+     *
+     * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
+     */
+    closeTime?: string;
+}
+/** Enumerates the days of the week. */
+declare enum DayOfWeek {
+    MONDAY = "MONDAY",
+    TUESDAY = "TUESDAY",
+    WEDNESDAY = "WEDNESDAY",
+    THURSDAY = "THURSDAY",
+    FRIDAY = "FRIDAY",
+    SATURDAY = "SATURDAY",
+    SUNDAY = "SUNDAY"
+}
+/** Exception to the business's regular hours. The business can be open or closed during the exception. */
+interface SpecialHourPeriod {
+    /** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
+    startDate?: string;
+    /** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
+    endDate?: string;
+    /**
+     * Whether the business is closed (or the service is not available) during the exception.
+     *
+     * Default: `true`.
+     */
+    isClosed?: boolean;
+    /** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
+    comment?: string;
+}
+interface Multilingual {
+    /** Supported languages list. */
+    supportedLanguages?: SupportedLanguage[];
+    /** Whether to redirect to user language. */
+    autoRedirect?: boolean;
+}
+interface SupportedLanguage {
+    /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
+    languageCode?: string;
+    /** Locale. */
+    locale?: Locale;
+    /** Whether the supported language is the primary language for the site. */
+    isPrimary?: boolean;
+    /** Language icon. */
+    countryCode?: string;
+    /** How the language will be resolved. For internal use. */
+    resolutionMethod?: ResolutionMethod;
+}
+declare enum ResolutionMethod {
+    QUERY_PARAM = "QUERY_PARAM",
+    SUBDOMAIN = "SUBDOMAIN",
+    SUBDIRECTORY = "SUBDIRECTORY"
+}
+interface ConsentPolicy {
+    /** Whether the site uses cookies that are essential to site operation. */
+    essential?: boolean | null;
+    /** Whether the site uses cookies that affect site performance and other functional measurements. */
+    functional?: boolean | null;
+    /** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */
+    analytics?: boolean | null;
+    /** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */
+    advertising?: boolean | null;
+    /** CCPA compliance flag. */
+    dataToThirdParty?: boolean | null;
+}
+/** A single mapping from the MetaSite ID to a particular service. */
+interface Translation {
+    /** The service type. */
+    serviceType?: string;
+    /** The application definition ID; this only applies to services of type ThirdPartyApps. */
+    appDefId?: string;
+    /** The instance ID of the service. */
+    instanceId?: string;
+}
+interface ChangeContext extends ChangeContextPayloadOneOf {
+    /** Properties were updated. */
+    propertiesChange?: PropertiesChange;
+    /** Default properties were created on site creation. */
+    siteCreated?: V4SiteCreated;
+    /** Properties were cloned on site cloning. */
+    siteCloned?: SiteCloned;
+}
+/** @oneof */
+interface ChangeContextPayloadOneOf {
+    /** Properties were updated. */
+    propertiesChange?: PropertiesChange;
+    /** Default properties were created on site creation. */
+    siteCreated?: V4SiteCreated;
+    /** Properties were cloned on site cloning. */
+    siteCloned?: SiteCloned;
+}
+interface PropertiesChange {
+}
+interface V4SiteCreated {
+    /** Origin template site id. */
+    originTemplateId?: string | null;
+}
+interface SiteCloned {
+    /** Origin site id. */
+    originMetaSiteId?: string;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp. */
+    eventTime?: Date;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface GetScheduleResponseNonNullableFields {
+    schedule?: {
+        status: Status;
+        defaultLocation?: {
+            type: LocationType;
+        };
+        defaultConferencingDetails?: {
+            type: Type;
+        };
+        permissions: {
+            identity?: {
+                wixUserId: string;
+            };
+            role: Role;
+        }[];
+    };
+}
+interface QuerySchedulesResponseNonNullableFields {
+    schedules: {
+        status: Status;
+        defaultLocation?: {
+            type: LocationType;
+        };
+        defaultConferencingDetails?: {
+            type: Type;
+        };
+        permissions: {
+            identity?: {
+                wixUserId: string;
+            };
+            role: Role;
+        }[];
+    }[];
+}
+interface CreateScheduleResponseNonNullableFields {
+    schedule?: {
+        status: Status;
+        defaultLocation?: {
+            type: LocationType;
+        };
+        defaultConferencingDetails?: {
+            type: Type;
+        };
+        permissions: {
+            identity?: {
+                wixUserId: string;
+            };
+            role: Role;
+        }[];
+    };
+}
+interface UpdateScheduleResponseNonNullableFields {
+    schedule?: {
+        status: Status;
+        defaultLocation?: {
+            type: LocationType;
+        };
+        defaultConferencingDetails?: {
+            type: Type;
+        };
+        permissions: {
+            identity?: {
+                wixUserId: string;
+            };
+            role: Role;
+        }[];
+    };
+}
+interface CloneScheduleResponseNonNullableFields {
+    schedule?: {
+        status: Status;
+        defaultLocation?: {
+            type: LocationType;
+        };
+        defaultConferencingDetails?: {
+            type: Type;
+        };
+        permissions: {
+            identity?: {
+                wixUserId: string;
+            };
+            role: Role;
+        }[];
+    };
+}
+interface CancelScheduleResponseNonNullableFields {
+    schedule?: {
+        status: Status;
+        defaultLocation?: {
+            type: LocationType;
+        };
+        defaultConferencingDetails?: {
+            type: Type;
+        };
+        permissions: {
+            identity?: {
+                wixUserId: string;
+            };
+            role: Role;
+        }[];
+    };
+}
+interface BaseEventMetadata {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp. */
+    eventTime?: Date;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+interface ScheduleCreatedEnvelope {
+    entity: Schedule;
+    metadata: EventMetadata;
+}
+interface ScheduleUpdatedEnvelope {
+    entity: Schedule;
+    metadata: EventMetadata;
+}
+interface ScheduleClonedEnvelope {
+    data: ScheduleCloned;
+    metadata: EventMetadata;
+}
+interface ScheduleCancelledEnvelope {
+    data: ScheduleCancelled;
+    metadata: EventMetadata;
+}
+interface GetScheduleOptions {
+    /** List of additional fields to be included in the response. */
+    fields?: RequestedFields[];
+}
+interface QuerySchedulesOptions {
+    /** List of additional fields to be included in the response. */
+    fields?: RequestedFields[] | undefined;
+}
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface SchedulesQueryResult extends QueryCursorResult {
+    items: Schedule[];
+    query: SchedulesQueryBuilder;
+    next: () => Promise<SchedulesQueryResult>;
+    prev: () => Promise<SchedulesQueryResult>;
+}
+interface SchedulesQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | 'status' | 'appId', value: any) => SchedulesQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | 'status' | 'appId', value: any) => SchedulesQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: 'defaultLocation' | 'defaultConferencingDetails', value: boolean) => SchedulesQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => SchedulesQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => SchedulesQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<SchedulesQueryResult>;
+}
+interface CreateScheduleOptions {
+    /** Optional Idempotency key. */
+    idempotencyKey?: string | null;
+}
+interface UpdateSchedule {
+    /**
+     * The schedule ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Optional external ID. Cannot change.
+     *
+     * For instance, might be the ID of the Bookings Resource or Service.
+     */
+    externalId?: string | null;
+    /**
+     * The name of the schedule.
+     *
+     * For instance, might be the name of the Bookings Resource or Service.
+     */
+    name?: string | null;
+    /**
+     * The schedule status.
+     *
+     * The possible values are:
+     * - `"ACTIVE"` Schedule is active. Default value.
+     * - `"CANCELLED"` Schedule has been cancelled.
+     * @readonly
+     */
+    status?: Status;
+    /**
+     * The schedule time zone, formatted according to the IANA time zone format.
+     * Must be a regional time zone (Area/Location) or UTC.
+     *
+     * By default the time zone is derived from the Wix Business, and can be overridden by setting `businessTimeZoneEnabled` to false.
+     */
+    timeZone?: string | null;
+    /**
+     * Whether to use the time zone of the Wix Business.
+     * Default is true.
+     */
+    businessTimeZoneEnabled?: boolean | null;
+    /** Default title for the schedule's events. */
+    defaultTitle?: string | null;
+    /** Default location for the schedule's events. */
+    defaultLocation?: Location;
+    /**
+     * Default capacity for the schedule's events.
+     *
+     * The capacity of an event is the max number of participants that can participate in an event.
+     */
+    defaultCapacity?: number | null;
+    /** Default conferencing details for the schedule's events. */
+    defaultConferencingDetails?: ConferencingDetails;
+    /**
+     * Optional ID of the Wix app owning the schedule.
+     * Cannot change once set.
+     *
+     * For example, to create a schedule in the Wix Bookings App Calendar, provide `13d21c63-b5ec-5912-8397-c3a5ddb27a97`.
+     */
+    appId?: string | null;
+    /**
+     * List of granted permissions for this schedule.
+     *
+     * E.g, a Bookings Staff Member has full write access to its schedule and limited access to events it provides.
+     */
+    permissions?: Permission[];
+    /** Extensions enabling applications or users to save custom data related to the schedule. */
+    extendedFields?: ExtendedFields;
+    /**
+     * The schedule revision number, which incremented on updates.
+     *
+     * The current revision should be provided on updates to prevent conflicting changes.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date the schedule was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Date the schedule was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+}
+interface UpdateScheduleOptions {
+    /** Whether to notify participants regarding the changes. */
+    participantNotification?: ParticipantNotification;
+}
+interface CloneScheduleOptions {
+    /** Optional values to override. */
+    schedule?: Schedule;
+}
+interface CancelScheduleOptions {
+    /**
+     * Whether to preserve future events with participants.
+     * Default is false.
+     */
+    preserveFutureEventsWithParticipants?: boolean | null;
+    /** Whether to notify participants regarding the changes. */
+    participantNotification?: ParticipantNotification;
+}
+
+type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+    fetchWithAuth: typeof fetch;
+    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+type EventDefinition<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: (envelope: unknown) => Payload;
+    __payload: Payload;
+};
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
+type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
+declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
+
+declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
+
+declare const getSchedule: ReturnType<typeof createRESTModule<typeof publicGetSchedule>>;
+declare const querySchedules: ReturnType<typeof createRESTModule<typeof publicQuerySchedules>>;
+declare const createSchedule: ReturnType<typeof createRESTModule<typeof publicCreateSchedule>>;
+declare const updateSchedule: ReturnType<typeof createRESTModule<typeof publicUpdateSchedule>>;
+declare const cloneSchedule: ReturnType<typeof createRESTModule<typeof publicCloneSchedule>>;
+declare const cancelSchedule: ReturnType<typeof createRESTModule<typeof publicCancelSchedule>>;
+declare const onScheduleCreated: ReturnType<typeof createEventModule<typeof publicOnScheduleCreated>>;
+declare const onScheduleUpdated: ReturnType<typeof createEventModule<typeof publicOnScheduleUpdated>>;
+declare const onScheduleCloned: ReturnType<typeof createEventModule<typeof publicOnScheduleCloned>>;
+declare const onScheduleCancelled: ReturnType<typeof createEventModule<typeof publicOnScheduleCancelled>>;
+
+type context_ActionEvent = ActionEvent;
+type context_Address = Address;
+type context_AddressHint = AddressHint;
+type context_Asset = Asset;
+type context_BaseEventMetadata = BaseEventMetadata;
+type context_BusinessSchedule = BusinessSchedule;
+type context_CancelScheduleOptions = CancelScheduleOptions;
+type context_CancelScheduleRequest = CancelScheduleRequest;
+type context_CancelScheduleResponse = CancelScheduleResponse;
+type context_CancelScheduleResponseNonNullableFields = CancelScheduleResponseNonNullableFields;
+type context_Categories = Categories;
+type context_ChangeContext = ChangeContext;
+type context_ChangeContextPayloadOneOf = ChangeContextPayloadOneOf;
+type context_CloneScheduleOptions = CloneScheduleOptions;
+type context_CloneScheduleRequest = CloneScheduleRequest;
+type context_CloneScheduleResponse = CloneScheduleResponse;
+type context_CloneScheduleResponseNonNullableFields = CloneScheduleResponseNonNullableFields;
+type context_CommonIdentificationData = CommonIdentificationData;
+type context_CommonIdentificationDataIdOneOf = CommonIdentificationDataIdOneOf;
+type context_ConferencingDetails = ConferencingDetails;
+type context_ConsentPolicy = ConsentPolicy;
+type context_CreateScheduleOptions = CreateScheduleOptions;
+type context_CreateScheduleRequest = CreateScheduleRequest;
+type context_CreateScheduleResponse = CreateScheduleResponse;
+type context_CreateScheduleResponseNonNullableFields = CreateScheduleResponseNonNullableFields;
+type context_CursorPaging = CursorPaging;
+type context_CursorPagingMetadata = CursorPagingMetadata;
+type context_CursorQuery = CursorQuery;
+type context_CursorQueryPagingMethodOneOf = CursorQueryPagingMethodOneOf;
+type context_Cursors = Cursors;
+type context_DayOfWeek = DayOfWeek;
+declare const context_DayOfWeek: typeof DayOfWeek;
+type context_DeleteContext = DeleteContext;
+type context_DeleteStatus = DeleteStatus;
+declare const context_DeleteStatus: typeof DeleteStatus;
+type context_DomainEvent = DomainEvent;
+type context_DomainEventBodyOneOf = DomainEventBodyOneOf;
+type context_Empty = Empty;
+type context_EntityCreatedEvent = EntityCreatedEvent;
+type context_EntityDeletedEvent = EntityDeletedEvent;
+type context_EntityUpdatedEvent = EntityUpdatedEvent;
+type context_EventMetadata = EventMetadata;
+type context_ExtendedFields = ExtendedFields;
+type context_GeoCoordinates = GeoCoordinates;
+type context_GetScheduleOptions = GetScheduleOptions;
+type context_GetScheduleRequest = GetScheduleRequest;
+type context_GetScheduleResponse = GetScheduleResponse;
+type context_GetScheduleResponseNonNullableFields = GetScheduleResponseNonNullableFields;
+type context_IdentificationData = IdentificationData;
+type context_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
+type context_IdentityType = IdentityType;
+declare const context_IdentityType: typeof IdentityType;
+type context_Locale = Locale;
+type context_Location = Location;
+type context_LocationType = LocationType;
+declare const context_LocationType: typeof LocationType;
+type context_MessageEnvelope = MessageEnvelope;
+type context_MetaSiteSpecialEvent = MetaSiteSpecialEvent;
+type context_MetaSiteSpecialEventPayloadOneOf = MetaSiteSpecialEventPayloadOneOf;
+type context_Multilingual = Multilingual;
+type context_Namespace = Namespace;
+declare const context_Namespace: typeof Namespace;
+type context_NamespaceChanged = NamespaceChanged;
+type context_ParticipantNotification = ParticipantNotification;
+type context_Permission = Permission;
+type context_PlacementType = PlacementType;
+declare const context_PlacementType: typeof PlacementType;
+type context_Properties = Properties;
+type context_PropertiesChange = PropertiesChange;
+type context_QuerySchedulesOptions = QuerySchedulesOptions;
+type context_QuerySchedulesRequest = QuerySchedulesRequest;
+type context_QuerySchedulesResponse = QuerySchedulesResponse;
+type context_QuerySchedulesResponseNonNullableFields = QuerySchedulesResponseNonNullableFields;
+type context_RequestedFields = RequestedFields;
+declare const context_RequestedFields: typeof RequestedFields;
+type context_ResolutionMethod = ResolutionMethod;
+declare const context_ResolutionMethod: typeof ResolutionMethod;
+type context_RestoreInfo = RestoreInfo;
+type context_Role = Role;
+declare const context_Role: typeof Role;
+type context_Schedule = Schedule;
+type context_ScheduleCancelled = ScheduleCancelled;
+type context_ScheduleCancelledEnvelope = ScheduleCancelledEnvelope;
+type context_ScheduleCloned = ScheduleCloned;
+type context_ScheduleClonedEnvelope = ScheduleClonedEnvelope;
+type context_ScheduleCreatedEnvelope = ScheduleCreatedEnvelope;
+type context_ScheduleUpdatedEnvelope = ScheduleUpdatedEnvelope;
+type context_ScheduleUpdatedWithMetadata = ScheduleUpdatedWithMetadata;
+type context_SchedulesQueryBuilder = SchedulesQueryBuilder;
+type context_SchedulesQueryResult = SchedulesQueryResult;
+type context_ServiceProvisioned = ServiceProvisioned;
+type context_ServiceRemoved = ServiceRemoved;
+type context_SiteCloned = SiteCloned;
+type context_SiteCreated = SiteCreated;
+type context_SiteCreatedContext = SiteCreatedContext;
+declare const context_SiteCreatedContext: typeof SiteCreatedContext;
+type context_SiteDeleted = SiteDeleted;
+type context_SiteHardDeleted = SiteHardDeleted;
+type context_SiteMarkedAsTemplate = SiteMarkedAsTemplate;
+type context_SiteMarkedAsWixSite = SiteMarkedAsWixSite;
+type context_SitePropertiesEvent = SitePropertiesEvent;
+type context_SitePropertiesNotification = SitePropertiesNotification;
+type context_SitePublished = SitePublished;
+type context_SiteRenamed = SiteRenamed;
+type context_SiteTransferred = SiteTransferred;
+type context_SiteUndeleted = SiteUndeleted;
+type context_SiteUnpublished = SiteUnpublished;
+type context_SpecialHourPeriod = SpecialHourPeriod;
+type context_State = State;
+declare const context_State: typeof State;
+type context_Status = Status;
+declare const context_Status: typeof Status;
+type context_StudioAssigned = StudioAssigned;
+type context_StudioUnassigned = StudioUnassigned;
+type context_SupportedLanguage = SupportedLanguage;
+type context_TimePeriod = TimePeriod;
+type context_Translation = Translation;
+type context_Trigger = Trigger;
+declare const context_Trigger: typeof Trigger;
+type context_Type = Type;
+declare const context_Type: typeof Type;
+type context_UpdateSchedule = UpdateSchedule;
+type context_UpdateScheduleOptions = UpdateScheduleOptions;
+type context_UpdateScheduleRequest = UpdateScheduleRequest;
+type context_UpdateScheduleResponse = UpdateScheduleResponse;
+type context_UpdateScheduleResponseNonNullableFields = UpdateScheduleResponseNonNullableFields;
+type context_V4SiteCreated = V4SiteCreated;
+type context_WebhookIdentityType = WebhookIdentityType;
+declare const context_WebhookIdentityType: typeof WebhookIdentityType;
+declare const context_cancelSchedule: typeof cancelSchedule;
+declare const context_cloneSchedule: typeof cloneSchedule;
+declare const context_createSchedule: typeof createSchedule;
+declare const context_getSchedule: typeof getSchedule;
+declare const context_onScheduleCancelled: typeof onScheduleCancelled;
+declare const context_onScheduleCloned: typeof onScheduleCloned;
+declare const context_onScheduleCreated: typeof onScheduleCreated;
+declare const context_onScheduleUpdated: typeof onScheduleUpdated;
+declare const context_querySchedules: typeof querySchedules;
+declare const context_updateSchedule: typeof updateSchedule;
+declare namespace context {
+  export { type context_ActionEvent as ActionEvent, type context_Address as Address, type context_AddressHint as AddressHint, type context_Asset as Asset, type context_BaseEventMetadata as BaseEventMetadata, type context_BusinessSchedule as BusinessSchedule, type context_CancelScheduleOptions as CancelScheduleOptions, type context_CancelScheduleRequest as CancelScheduleRequest, type context_CancelScheduleResponse as CancelScheduleResponse, type context_CancelScheduleResponseNonNullableFields as CancelScheduleResponseNonNullableFields, type context_Categories as Categories, type context_ChangeContext as ChangeContext, type context_ChangeContextPayloadOneOf as ChangeContextPayloadOneOf, type context_CloneScheduleOptions as CloneScheduleOptions, type context_CloneScheduleRequest as CloneScheduleRequest, type context_CloneScheduleResponse as CloneScheduleResponse, type context_CloneScheduleResponseNonNullableFields as CloneScheduleResponseNonNullableFields, type context_CommonIdentificationData as CommonIdentificationData, type context_CommonIdentificationDataIdOneOf as CommonIdentificationDataIdOneOf, type context_ConferencingDetails as ConferencingDetails, type context_ConsentPolicy as ConsentPolicy, type context_CreateScheduleOptions as CreateScheduleOptions, type context_CreateScheduleRequest as CreateScheduleRequest, type context_CreateScheduleResponse as CreateScheduleResponse, type context_CreateScheduleResponseNonNullableFields as CreateScheduleResponseNonNullableFields, type context_CursorPaging as CursorPaging, type context_CursorPagingMetadata as CursorPagingMetadata, type context_CursorQuery as CursorQuery, type context_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf, type context_Cursors as Cursors, context_DayOfWeek as DayOfWeek, type context_DeleteContext as DeleteContext, context_DeleteStatus as DeleteStatus, type context_DomainEvent as DomainEvent, type context_DomainEventBodyOneOf as DomainEventBodyOneOf, type context_Empty as Empty, type context_EntityCreatedEvent as EntityCreatedEvent, type context_EntityDeletedEvent as EntityDeletedEvent, type context_EntityUpdatedEvent as EntityUpdatedEvent, type context_EventMetadata as EventMetadata, type context_ExtendedFields as ExtendedFields, type context_GeoCoordinates as GeoCoordinates, type context_GetScheduleOptions as GetScheduleOptions, type context_GetScheduleRequest as GetScheduleRequest, type context_GetScheduleResponse as GetScheduleResponse, type context_GetScheduleResponseNonNullableFields as GetScheduleResponseNonNullableFields, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, context_IdentityType as IdentityType, type context_Locale as Locale, type context_Location as Location, context_LocationType as LocationType, type context_MessageEnvelope as MessageEnvelope, type context_MetaSiteSpecialEvent as MetaSiteSpecialEvent, type context_MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOf, type context_Multilingual as Multilingual, context_Namespace as Namespace, type context_NamespaceChanged as NamespaceChanged, type context_ParticipantNotification as ParticipantNotification, type context_Permission as Permission, context_PlacementType as PlacementType, type context_Properties as Properties, type context_PropertiesChange as PropertiesChange, type context_QuerySchedulesOptions as QuerySchedulesOptions, type context_QuerySchedulesRequest as QuerySchedulesRequest, type context_QuerySchedulesResponse as QuerySchedulesResponse, type context_QuerySchedulesResponseNonNullableFields as QuerySchedulesResponseNonNullableFields, context_RequestedFields as RequestedFields, context_ResolutionMethod as ResolutionMethod, type context_RestoreInfo as RestoreInfo, context_Role as Role, type context_Schedule as Schedule, type context_ScheduleCancelled as ScheduleCancelled, type context_ScheduleCancelledEnvelope as ScheduleCancelledEnvelope, type context_ScheduleCloned as ScheduleCloned, type context_ScheduleClonedEnvelope as ScheduleClonedEnvelope, type context_ScheduleCreatedEnvelope as ScheduleCreatedEnvelope, type context_ScheduleUpdatedEnvelope as ScheduleUpdatedEnvelope, type context_ScheduleUpdatedWithMetadata as ScheduleUpdatedWithMetadata, type context_SchedulesQueryBuilder as SchedulesQueryBuilder, type context_SchedulesQueryResult as SchedulesQueryResult, type context_ServiceProvisioned as ServiceProvisioned, type context_ServiceRemoved as ServiceRemoved, type context_SiteCloned as SiteCloned, type context_SiteCreated as SiteCreated, context_SiteCreatedContext as SiteCreatedContext, type context_SiteDeleted as SiteDeleted, type context_SiteHardDeleted as SiteHardDeleted, type context_SiteMarkedAsTemplate as SiteMarkedAsTemplate, type context_SiteMarkedAsWixSite as SiteMarkedAsWixSite, type context_SitePropertiesEvent as SitePropertiesEvent, type context_SitePropertiesNotification as SitePropertiesNotification, type context_SitePublished as SitePublished, type context_SiteRenamed as SiteRenamed, type context_SiteTransferred as SiteTransferred, type context_SiteUndeleted as SiteUndeleted, type context_SiteUnpublished as SiteUnpublished, type context_SpecialHourPeriod as SpecialHourPeriod, context_State as State, context_Status as Status, type context_StudioAssigned as StudioAssigned, type context_StudioUnassigned as StudioUnassigned, type context_SupportedLanguage as SupportedLanguage, type context_TimePeriod as TimePeriod, type context_Translation as Translation, context_Trigger as Trigger, context_Type as Type, type context_UpdateSchedule as UpdateSchedule, type context_UpdateScheduleOptions as UpdateScheduleOptions, type context_UpdateScheduleRequest as UpdateScheduleRequest, type context_UpdateScheduleResponse as UpdateScheduleResponse, type context_UpdateScheduleResponseNonNullableFields as UpdateScheduleResponseNonNullableFields, type context_V4SiteCreated as V4SiteCreated, context_WebhookIdentityType as WebhookIdentityType, context_cancelSchedule as cancelSchedule, context_cloneSchedule as cloneSchedule, context_createSchedule as createSchedule, context_getSchedule as getSchedule, context_onScheduleCancelled as onScheduleCancelled, context_onScheduleCloned as onScheduleCloned, context_onScheduleCreated as onScheduleCreated, context_onScheduleUpdated as onScheduleUpdated, context_querySchedules as querySchedules, context_updateSchedule as updateSchedule };
+}
+
+export { context as schedules };