@wix/auto_sdk_calendar_schedules 1.0.0

package/build/es/src/calendar-v3-schedule-schedules.universal.d.ts

@@ -0,0 +1,1716 @@
+/**
+ * A collection of [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
+ * associated with a specific entity, such as a
+ * [Bookings service](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/service-object),
+ * or [Bookings resource](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object).
+ * Schedules can also serve as templates for the events they manage, setting
+ * default values like a default location.
+ */
+export interface Schedule {
+    /**
+     * Schedule ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * External ID. You can't update the external ID.
+     *
+     * If the schedule belongs to a Bookings staff member, identical to the ID of
+     * the [resource](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction).
+     * If the schedule belongs to a Bookings service, identical to the ID of
+     * the [service](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/setup).
+     */
+    externalId?: string | null;
+    /**
+     * Schedule name.
+     *
+     * Min: 1 character
+     * Max: 200 characters
+     */
+    name?: string | null;
+    /**
+     * Schedule status.
+     *
+     * Supported values:
+     * - `ACTIVE`: You can add events to the schedule or update its fields.
+     * - `CANCELLED`: You can't add events to the schedule or update its fields.
+     *
+     * Default: `ACTIVE`
+     * @readonly
+     */
+    status?: Status;
+    /**
+     * Time zone the schedule is associated with in
+     * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
+     * For example, `America/New_York`.
+     *
+     * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
+     *
+     * Min: 1 character
+     * Max: 150 characters
+     */
+    timeZone?: string | null;
+    /**
+     * Whether the schedule's `timeZone` is automatically synced from
+     * `timeZone` of the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
+     *
+     * Default: `true`
+     */
+    businessTimeZoneEnabled?: boolean | null;
+    /**
+     * Default `title` for [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
+     * that are added to the schedule.
+     *
+     * Min: 1 character
+     * Max: 200 characters
+     */
+    defaultTitle?: string | null;
+    /**
+     * Default `location` for [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
+     * that are added to the schedule.
+     */
+    defaultLocation?: Location;
+    /**
+     * Default `totalCapacity` for [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
+     * that are added to the schedule.
+     *
+     * Min: `0`
+     */
+    defaultCapacity?: number | null;
+    /**
+     * Default `conferencingDetails` for [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
+     * that are added to the schedule.
+     * Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#retrieve-personal-information).
+     */
+    defaultConferencingDetails?: ConferencingDetails;
+    /**
+     * ID of the app that's associated with the schedule. You can't update `appId`.
+     * If you want to create a schedule and ensure its associated events appear
+     * in the [Bookings calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar),
+     * you must provide the Wix Bookings app ID
+     * `13d21c63-b5ec-5912-8397-c3a5ddb27a97`.
+     */
+    appId?: string | null;
+    /**
+     * List of permissions associated with the schedule. Refer to the
+     * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#roles)
+     * for more information.
+     *
+     * Max: 1 permission
+     */
+    permissions?: Permission[];
+    /** Extensions enabling applications or users to save custom data related to the schedule. */
+    extendedFields?: ExtendedFields;
+    /**
+     * Revision number, which increments by 1 each time the schedule is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the schedule.
+     * Ignored when creating a schedule.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date the schedule was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date the schedule was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+}
+export declare enum Status {
+    UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    /** You can add events to the schedule or update its fields. */
+    ACTIVE = "ACTIVE",
+    /** You can't add events to the schedule or update its fields. */
+    CANCELLED = "CANCELLED"
+}
+export interface Location {
+    /**
+     * [Location](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction)
+     * ID. Available only for `BUSINESS` locations.
+     */
+    _id?: string | null;
+    /**
+     * Location type.
+     *
+     * Supported values:
+     * + `BUSINESS`: The event is held at a business location.
+     * + `CUSTOMER`: The event is held at the customer's location, such as their home or office.
+     * + `CUSTOM`: The event is held at an address or venue not tied to the business or customer.
+     */
+    type?: LocationType;
+    /**
+     * Location name. For `BUSINESS` locations, it's identical to the
+     * [location](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction)
+     * `name`.
+     *
+     * Min: 1 character
+     * Max: 150 characters
+     */
+    name?: string | null;
+    /**
+     * Location address. For `BUSINESS` locations, it's identical to the
+     * [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)'s
+     * `formattedAddress`.
+     */
+    address?: string | null;
+}
+export declare enum LocationType {
+    UNKNOWN_TYPE = "UNKNOWN_TYPE",
+    /** The event is held at a business location. */
+    BUSINESS = "BUSINESS",
+    /** The event is held at the customer's location, such as their home or office. */
+    CUSTOMER = "CUSTOMER",
+    /** The event is held at an address or venue not tied to the business or customer. */
+    CUSTOM = "CUSTOM"
+}
+export interface ConferencingDetails {
+    /** Conference type. For example, `Zoom`. */
+    type?: Type;
+    /**
+     * URL used by the host to start the conference.
+     *
+     * Min: 1 character
+     * Max: 2000 characters
+     */
+    hostUrl?: string | null;
+    /**
+     * URL used by a guest to join the conference.
+     *
+     * Min: 1 character
+     * Max: 2000 characters
+     */
+    guestUrl?: string | null;
+    /**
+     * Conference password.
+     *
+     * Min: 1 character
+     * Max: 100 characters
+     */
+    password?: string | null;
+    /**
+     * Conference ID in an external system.
+     *
+     * Min: 1 character
+     * Max: 150 characters
+     */
+    externalId?: string | null;
+}
+export declare enum Type {
+    UNKNOWN_TYPE = "UNKNOWN_TYPE",
+    ZOOM = "ZOOM",
+    CUSTOM = "CUSTOM"
+}
+export interface Permission {
+    /**
+     * [Wix user](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-users)
+     * granted the permission.
+     */
+    identity?: CommonIdentificationData;
+    /**
+     * Permission role.
+     *
+     * Supported values:
+     * + `WRITER`: Full read and write access.
+     * + `COMMENTER`: Full read access, write access limited to `event.notes`.
+     */
+    role?: Role;
+}
+export interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
+    /**
+     * ID of a Wix user. For example, the site owner or a
+     * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
+     */
+    wixUserId?: string;
+}
+/** @oneof */
+export interface CommonIdentificationDataIdOneOf {
+    /**
+     * ID of a Wix user. For example, the site owner or a
+     * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
+     */
+    wixUserId?: string;
+}
+export declare enum IdentityType {
+    UNKNOWN = "UNKNOWN",
+    WIX_USER = "WIX_USER"
+}
+export declare enum Role {
+    UNKNOWN_ROLE = "UNKNOWN_ROLE",
+    /** Full read and write access. */
+    WRITER = "WRITER",
+    /** Full read access, write access limited to `event.notes`. */
+    COMMENTER = "COMMENTER"
+}
+export 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>>;
+}
+export interface GetScheduleRequest {
+    /** ID of the schedule to retrieve. */
+    scheduleId: string | null;
+    /**
+     * Information about which fields containing personal data to return. Refer to the
+     * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
+     * for more information.
+     *
+     * Supported values:
+     * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
+     * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
+     *
+     * Max: 1 field
+     * Default: No personal data is returned.
+     */
+    fields?: RequestedFields[];
+}
+export declare enum RequestedFields {
+    UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
+    /** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
+    PI_FIELDS = "PI_FIELDS",
+    /** Returns only fields containing your own personal data. */
+    OWN_PI_FIELDS = "OWN_PI_FIELDS"
+}
+export interface GetScheduleResponse {
+    /** Retrieved schedule. */
+    schedule?: Schedule;
+}
+export interface QuerySchedulesRequest {
+    /** Query containing filters and paging. */
+    query?: CursorQuery;
+    /**
+     * Information about which fields containing personal data to return. Refer to the
+     * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
+     * for more information.
+     *
+     * Supported values:
+     * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
+     * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
+     *
+     * Max: 1 field
+     * Default: No personal data is returned.
+     */
+    fields?: RequestedFields[];
+}
+/** TODO Diverge */
+export 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/docs/rest/articles/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 */
+export 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 */
+export interface CursorPaging {
+    /**
+     * Number of schedules to return.
+     *
+     * Min: `1`
+     * Max: `100`
+     * Default: `50`
+     */
+    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;
+}
+export interface QuerySchedulesResponse {
+    /** Retrieved schedules matching the provided query. */
+    schedules?: Schedule[];
+    /** Paging metadata. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+/** TODO Diverge */
+export interface CursorPagingMetadata {
+    /** Number of schedules returned in the current page of 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;
+}
+export 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;
+}
+export interface CreateScheduleRequest {
+    /** Schedule to create. */
+    schedule: Schedule;
+    /**
+     * Idempotency key guaranteeing that you don't create the same schedule more
+     * than once.
+     */
+    idempotencyKey?: string | null;
+}
+export interface CreateScheduleResponse {
+    /** Created schedule. */
+    schedule?: Schedule;
+}
+export interface UpdateScheduleRequest {
+    /** Schedule to update. */
+    schedule: Schedule;
+    /**
+     * Information about whether participants of the schedule's updated events are
+     * notified and the message they receive.
+     */
+    participantNotification?: ParticipantNotification;
+}
+export interface ParticipantNotification {
+    /**
+     * Whether to notify the participants about changes made to the schedule or event.
+     *
+     * Default: `false`
+     */
+    notifyParticipants?: boolean | null;
+    /**
+     * Message to send.
+     *
+     * Min: 1 character
+     * Max: 5000 characters
+     */
+    message?: string | null;
+}
+export interface UpdateScheduleResponse {
+    /** Updated schedule. */
+    schedule?: Schedule;
+}
+/** `PRIVATE` until we'll have standard events metadata from Infra. */
+export interface ScheduleUpdatedWithMetadata {
+    /** The updated schedule. */
+    schedule?: Schedule;
+    /** Whether to notify participants regarding the changes. */
+    participantNotification?: ParticipantNotification;
+}
+export interface CloneScheduleRequest {
+    /** ID of the schedule to clone. */
+    scheduleId?: string | null;
+    /** Fields to override in the cloned schedule. */
+    schedule?: Schedule;
+}
+export interface CloneScheduleResponse {
+    /** Cloned schedule. */
+    schedule?: Schedule;
+}
+export interface ScheduleCloned {
+    /** 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;
+}
+export declare enum 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"
+}
+export interface CancelScheduleRequest {
+    /** ID of the schedule to cancel. */
+    scheduleId: string | null;
+    /**
+     * Whether to preserve future events with participants.
+     * Default: `false`.
+     */
+    preserveFutureEventsWithParticipants?: boolean | null;
+    /**
+     * Information about whether participants of the schedule's updated events are
+     * notified and the message they receive.
+     */
+    participantNotification?: ParticipantNotification;
+}
+export interface CancelScheduleResponse {
+    /** Canceled schedule. */
+    schedule?: Schedule;
+}
+export interface ScheduleCancelled {
+    /** Canceled schedule. */
+    schedule?: Schedule;
+    /** Whether future events with participants were preserved. */
+    preserveFutureEventsWithParticipants?: boolean | null;
+}
+export 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;
+    /**
+     * TODO(meta-site): Change validation once validations are disabled for consumers
+     * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
+     */
+    assets?: Asset[];
+}
+/** @oneof */
+export 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;
+}
+export 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;
+}
+export declare enum State {
+    UNKNOWN = "UNKNOWN",
+    ENABLED = "ENABLED",
+    DISABLED = "DISABLED",
+    PENDING = "PENDING",
+    DEMO = "DEMO"
+}
+export 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;
+}
+export 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"
+}
+export 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",
+    /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
+    NOWNIA = "NOWNIA",
+    /**
+     * UGC Templates are templates that are created by users for personal use and to sale to other users.
+     * The Partners company owns this namespace.
+     */
+    UGC_TEMPLATE = "UGC_TEMPLATE",
+    /** Codux Headless Sites */
+    CODUX = "CODUX",
+    /** Bobb - AI Design Creator. */
+    MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
+    /**
+     * Shared Blog Site is a unique single site across Enterprise account,
+     * This site will hold all Blog posts related to the Marketing product.
+     */
+    SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE"
+}
+/** Site transferred to another user. */
+export 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. */
+export interface SiteDeleted {
+    /** A deletion context. */
+    deleteContext?: DeleteContext;
+}
+export interface DeleteContext {
+    /** When the meta site was deleted. */
+    dateDeleted?: Date | null;
+    /** A status. */
+    deleteStatus?: DeleteStatus;
+    /** A reason (flow). */
+    deleteOrigin?: string;
+    /** A service that deleted it. */
+    initiatorId?: string | null;
+}
+export declare enum DeleteStatus {
+    UNKNOWN = "UNKNOWN",
+    TRASH = "TRASH",
+    DELETED = "DELETED",
+    PENDING_PURGE = "PENDING_PURGE"
+}
+/** Restoration of the meta site. */
+export interface SiteUndeleted {
+}
+/** First publish of a meta site. Or subsequent publish after unpublish. */
+export interface SitePublished {
+}
+export interface SiteUnpublished {
+    /** A list of URLs previously associated with the meta site. */
+    urls?: string[];
+}
+export interface SiteMarkedAsTemplate {
+}
+export interface SiteMarkedAsWixSite {
+}
+/**
+ * Represents a service provisioned a site.
+ *
+ * Note on `origin_instance_id`:
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
+ * This is because of the following scenario:
+ *
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
+ * such as a product catalog. When you create a site from this template, you inherit this
+ * default product catalog. However, if the template's product catalog is modified,
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
+ * your site remains consistent with what you initially received and does not include any
+ * changes made to the original template afterward.
+ * To ensure this, the TPA on the template gets a new instance_id.
+ */
+export 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;
+    /** The origin meta site id */
+    originMetaSiteId?: string | null;
+}
+export 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. */
+export 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.
+ */
+export interface SiteHardDeleted {
+    /** A deletion context. */
+    deleteContext?: DeleteContext;
+}
+export interface NamespaceChanged {
+    /** A previous namespace. */
+    oldNamespace?: Namespace;
+    /** A new namespace. */
+    newNamespace?: Namespace;
+}
+/** Assigned Studio editor */
+export interface StudioAssigned {
+}
+/** Unassigned Studio editor */
+export interface StudioUnassigned {
+}
+export interface Empty {
+}
+/** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
+export 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. */
+export interface SitePropertiesEvent {
+    /** Version of the site's properties represented by this update. */
+    version?: number;
+    /** Set of properties that were updated - corresponds to the fields in "properties". */
+    fields?: string[];
+    /** Updated properties. */
+    properties?: Properties;
+}
+export 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 Wix user defined for their site (before the site visitor 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;
+}
+export interface Categories {
+    /** Primary site category. */
+    primary?: string;
+    /** Secondary site category. */
+    secondary?: string[];
+    /** Business Term Id */
+    businessTermId?: string | null;
+}
+export 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;
+}
+export 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 to display the additional description - before, after, or instead of the address string.
+ */
+export 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. */
+export declare enum PlacementType {
+    BEFORE = "BEFORE",
+    AFTER = "AFTER",
+    REPLACE = "REPLACE"
+}
+/** Geocoordinates for a particular address. */
+export 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. */
+export 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. */
+export 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. */
+export 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. */
+export 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;
+}
+export interface Multilingual {
+    /** Supported languages list. */
+    supportedLanguages?: SupportedLanguage[];
+    /** Whether to redirect to user language. */
+    autoRedirect?: boolean;
+}
+export 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;
+}
+export declare enum ResolutionMethod {
+    QUERY_PARAM = "QUERY_PARAM",
+    SUBDOMAIN = "SUBDOMAIN",
+    SUBDIRECTORY = "SUBDIRECTORY"
+}
+export interface ConsentPolicy {
+    /** Whether the site uses cookies that are essential to site operation. Always `true`. */
+    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. */
+export 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;
+}
+export 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 */
+export interface ChangeContextPayloadOneOf {
+    /** Properties were updated. */
+    propertiesChange?: PropertiesChange;
+    /** Default properties were created on site creation. */
+    siteCreated?: V4SiteCreated;
+    /** Properties were cloned on site cloning. */
+    siteCloned?: SiteCloned;
+}
+export interface PropertiesChange {
+}
+export interface V4SiteCreated {
+    /** Origin template site id. */
+    originTemplateId?: string | null;
+}
+export interface SiteCloned {
+    /** Origin site id. */
+    originMetaSiteId?: string;
+}
+export 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 in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date | null;
+    /**
+     * 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 */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entity?: string;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+export 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;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntity?: string | null;
+}
+export interface ActionEvent {
+    body?: string;
+}
+export interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export 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 */
+export 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;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface LocationNonNullableFields {
+    type: LocationType;
+}
+interface ConferencingDetailsNonNullableFields {
+    type: Type;
+}
+interface CommonIdentificationDataNonNullableFields {
+    wixUserId: string;
+    identityType: IdentityType;
+}
+interface PermissionNonNullableFields {
+    identity?: CommonIdentificationDataNonNullableFields;
+    role: Role;
+}
+export interface ScheduleNonNullableFields {
+    status: Status;
+    defaultLocation?: LocationNonNullableFields;
+    defaultConferencingDetails?: ConferencingDetailsNonNullableFields;
+    permissions: PermissionNonNullableFields[];
+}
+export interface GetScheduleResponseNonNullableFields {
+    schedule?: ScheduleNonNullableFields;
+}
+export interface QuerySchedulesResponseNonNullableFields {
+    schedules: ScheduleNonNullableFields[];
+}
+export interface CreateScheduleResponseNonNullableFields {
+    schedule?: ScheduleNonNullableFields;
+}
+export interface UpdateScheduleResponseNonNullableFields {
+    schedule?: ScheduleNonNullableFields;
+}
+export interface CancelScheduleResponseNonNullableFields {
+    schedule?: ScheduleNonNullableFields;
+}
+export interface BaseEventMetadata {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+export 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 in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date | null;
+    /**
+     * 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;
+}
+export interface ScheduleCancelledEnvelope {
+    data: ScheduleCancelled;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a schedule is canceled.
+ * @permissionScope Read Calendar - Including PI
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
+ * @permissionScope Manage Calendars
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
+ * @permissionScope Manage Bookings
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
+ * @permissionScope Read Bookings - Including Participants
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
+ * @permissionScope Manage Bookings - all permissions
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
+ * @permissionScope Read bookings calendar - including participants
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
+ * @permissionId CALENDAR.SCHEDULE_READ_PI
+ * @webhook
+ * @eventType wix.calendar.v3.schedule_cancelled
+ * @documentationMaturity preview
+ */
+export declare function onScheduleCancelled(handler: (event: ScheduleCancelledEnvelope) => void | Promise<void>): void;
+export interface ScheduleClonedEnvelope {
+    data: ScheduleCloned;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a schedule is cloned.
+ * @permissionScope Read Calendar - Including PI
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
+ * @permissionScope Manage Calendars
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
+ * @permissionScope Manage Bookings
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
+ * @permissionScope Read Bookings - Including Participants
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
+ * @permissionScope Manage Bookings - all permissions
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
+ * @permissionScope Read bookings calendar - including participants
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
+ * @permissionId CALENDAR.SCHEDULE_READ_PI
+ * @webhook
+ * @eventType wix.calendar.v3.schedule_cloned
+ * @documentationMaturity preview
+ */
+export declare function onScheduleCloned(handler: (event: ScheduleClonedEnvelope) => void | Promise<void>): void;
+export interface ScheduleCreatedEnvelope {
+    entity: Schedule;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a schedule is created.
+ * @permissionScope Read Calendar - Including PI
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
+ * @permissionScope Manage Calendars
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
+ * @permissionScope Manage Bookings
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
+ * @permissionScope Read Bookings - Including Participants
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
+ * @permissionScope Manage Bookings - all permissions
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
+ * @permissionScope Read bookings calendar - including participants
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
+ * @permissionId CALENDAR.SCHEDULE_READ_PI
+ * @webhook
+ * @eventType wix.calendar.v3.schedule_created
+ * @documentationMaturity preview
+ */
+export declare function onScheduleCreated(handler: (event: ScheduleCreatedEnvelope) => void | Promise<void>): void;
+export interface ScheduleUpdatedEnvelope {
+    entity: Schedule;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a schedule is updated.
+ * @permissionScope Read Calendar - Including PI
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
+ * @permissionScope Manage Calendars
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
+ * @permissionScope Manage Bookings
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
+ * @permissionScope Read Bookings - Including Participants
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
+ * @permissionScope Manage Bookings - all permissions
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
+ * @permissionScope Read bookings calendar - including participants
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
+ * @permissionId CALENDAR.SCHEDULE_READ_PI
+ * @webhook
+ * @eventType wix.calendar.v3.schedule_updated
+ * @documentationMaturity preview
+ */
+export declare function onScheduleUpdated(handler: (event: ScheduleUpdatedEnvelope) => void | Promise<void>): void;
+/**
+ * Retrieves a schedule.
+ * @param scheduleId - ID of the schedule to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField scheduleId
+ * @permissionId CALENDAR.SCHEDULE_READ
+ * @permissionId CALENDAR.SCHEDULE_READ_PI
+ * @permissionScope Read Bookings - Public Data
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
+ * @permissionScope Read Calendar - Including PI
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
+ * @permissionScope Manage Calendars
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
+ * @permissionScope Manage Bookings
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
+ * @permissionScope Read Bookings - Including Participants
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
+ * @permissionScope Read Bookings - all read permissions
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
+ * @permissionScope Read Bookings Calendar Availability
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
+ * @permissionScope Read Calendar
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
+ * @permissionScope Manage Bookings - all permissions
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
+ * @permissionScope Read bookings calendar - including participants
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
+ * @permissionScope Read Bookings Calendar
+ * @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
+ * @permissionScope Read Calendar - Including PI
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
+ * @permissionScope Manage Calendars
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
+ * @permissionScope Manage Bookings
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
+ * @permissionScope Read Bookings - Including Participants
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
+ * @permissionScope Manage Bookings - all permissions
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
+ * @permissionScope Read bookings calendar - including participants
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @returns Retrieved schedule.
+ * @fqn wix.calendar.schedules.v3.SchedulesService.GetSchedule
+ */
+export declare function getSchedule(scheduleId: string | null, options?: GetScheduleOptions): Promise<Schedule & ScheduleNonNullableFields>;
+export interface GetScheduleOptions {
+    /**
+     * Information about which fields containing personal data to return. Refer to the
+     * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
+     * for more information.
+     *
+     * Supported values:
+     * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
+     * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
+     *
+     * Max: 1 field
+     * Default: No personal data is returned.
+     */
+    fields?: RequestedFields[];
+}
+/**
+ * Creates a query to retrieve a list of schedules.
+ *
+ * The `querySchedules()` function builds a query to retrieve a list of tip settings and returns a `SchedulesQueryBuilder` object.
+ *
+ * The returned object contains the query definition, which is typically used to run the query using the [find()](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/schedules-query-builder/find) function.
+ *
+ * You can refine the query by chaining `SchedulesQueryBuilder` functions onto the query. `SchedulesQueryBuilder` functions enable you to sort, filter, and control the results that `querySchedules()` returns.
+ *
+ * `querySchedules()` runs with the following `SchedulesQueryBuilder` default that you can override:
+ *
+ * + `limit` is `50`.
+ * + Sorted by `id` in ascending order.
+ *
+ * The functions that are chained to `querySchedules()` are applied in the order they are called. For example, if you apply `ascending("status")` and then `ascending("externalId")`, the results are sorted first by the `"status"`, and then, if there are multiple results with the same `"status"`, the items are sorted by `"externalId"`.
+ *
+ * The following `SchedulesQueryBuilder` functions are supported for the `querySchedules()` function. For a full description of the tip settings object, see the object returned for the [items](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/schedules-query-result/items) property in `SchedulesQueryResult`.
+ * @public
+ * @documentationMaturity preview
+ * @permissionScope Read Bookings - Public Data
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
+ * @permissionScope Read Calendar - Including PI
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
+ * @permissionScope Manage Calendars
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
+ * @permissionScope Manage Bookings
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
+ * @permissionScope Read Bookings - Including Participants
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
+ * @permissionScope Read Bookings - all read permissions
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
+ * @permissionScope Read Bookings Calendar Availability
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
+ * @permissionScope Read Calendar
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
+ * @permissionScope Manage Bookings - all permissions
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
+ * @permissionScope Read bookings calendar - including participants
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
+ * @permissionScope Read Bookings Calendar
+ * @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
+ * @permissionScope Read Calendar - Including PI
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
+ * @permissionScope Manage Calendars
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
+ * @permissionScope Manage Bookings
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
+ * @permissionScope Read Bookings - Including Participants
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
+ * @permissionScope Manage Bookings - all permissions
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
+ * @permissionScope Read bookings calendar - including participants
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
+ * @permissionId CALENDAR.SCHEDULE_READ
+ * @permissionId CALENDAR.SCHEDULE_READ_PI
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn wix.calendar.schedules.v3.SchedulesService.QuerySchedules
+ */
+export declare function querySchedules(options?: QuerySchedulesOptions): SchedulesQueryBuilder;
+export interface QuerySchedulesOptions {
+    /**
+     * Information about which fields containing personal data to return. Refer to the
+     * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
+     * for more information.
+     *
+     * Supported values:
+     * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
+     * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
+     *
+     * Max: 1 field
+     * Default: No personal data is returned.
+     */
+    fields?: RequestedFields[] | undefined;
+}
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+export interface SchedulesQueryResult extends QueryCursorResult {
+    items: Schedule[];
+    query: SchedulesQueryBuilder;
+    next: () => Promise<SchedulesQueryResult>;
+    prev: () => Promise<SchedulesQueryResult>;
+}
+export interface SchedulesQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | 'externalId' | 'status' | 'appId', value: any) => SchedulesQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | 'externalId' | 'status' | 'appId', value: any) => 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>;
+}
+/**
+ * Creates a schedule.
+ *
+ *
+ * If you want the schedule's events to appear in the
+ * [Bookings calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar),
+ * you must set `appId` to the ID of the Wix Bookings app by providing
+ * `{"appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97"}`.
+ * @param schedule - Schedule to create.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField schedule
+ * @requiredField schedule.defaultConferencingDetails.guestUrl
+ * @requiredField schedule.defaultConferencingDetails.hostUrl
+ * @requiredField schedule.defaultConferencingDetails.type
+ * @requiredField schedule.defaultLocation.type
+ * @requiredField schedule.permissions.identity
+ * @requiredField schedule.permissions.role
+ * @permissionId CALENDAR.SCHEDULE_CREATE
+ * @permissionScope Manage Calendars
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
+ * @permissionScope Manage Bookings
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
+ * @permissionScope Manage Bookings - all permissions
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
+ * @applicableIdentity APP
+ * @returns Created schedule.
+ * @fqn wix.calendar.schedules.v3.SchedulesService.CreateSchedule
+ */
+export declare function createSchedule(schedule: Schedule, options?: CreateScheduleOptions): Promise<Schedule & ScheduleNonNullableFields>;
+export interface CreateScheduleOptions {
+    /**
+     * Idempotency key guaranteeing that you don't create the same schedule more
+     * than once.
+     */
+    idempotencyKey?: string | null;
+}
+/**
+ * Updates a schedule.
+ *
+ *
+ * Each time the schedule is updated,
+ * `revision` increments by 1.
+ * The current `revision` must be passed when updating the schedule.
+ * This ensures you're working with the latest schedule
+ * and prevents unintended overwrites.
+ * @param _id - Schedule ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField schedule
+ * @requiredField schedule.permissions.identity
+ * @requiredField schedule.permissions.role
+ * @requiredField schedule.revision
+ * @permissionId CALENDAR.SCHEDULE_UPDATE
+ * @permissionScope Manage Calendars
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
+ * @permissionScope Manage Bookings
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
+ * @permissionScope Manage Bookings - all permissions
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
+ * @applicableIdentity APP
+ * @returns Updated schedule.
+ * @fqn wix.calendar.schedules.v3.SchedulesService.UpdateSchedule
+ */
+export declare function updateSchedule(_id: string | null, schedule: UpdateSchedule, options?: UpdateScheduleOptions): Promise<Schedule & ScheduleNonNullableFields>;
+export interface UpdateSchedule {
+    /**
+     * Schedule ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * External ID. You can't update the external ID.
+     *
+     * If the schedule belongs to a Bookings staff member, identical to the ID of
+     * the [resource](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction).
+     * If the schedule belongs to a Bookings service, identical to the ID of
+     * the [service](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/setup).
+     */
+    externalId?: string | null;
+    /**
+     * Schedule name.
+     *
+     * Min: 1 character
+     * Max: 200 characters
+     */
+    name?: string | null;
+    /**
+     * Schedule status.
+     *
+     * Supported values:
+     * - `ACTIVE`: You can add events to the schedule or update its fields.
+     * - `CANCELLED`: You can't add events to the schedule or update its fields.
+     *
+     * Default: `ACTIVE`
+     * @readonly
+     */
+    status?: Status;
+    /**
+     * Time zone the schedule is associated with in
+     * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
+     * For example, `America/New_York`.
+     *
+     * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
+     *
+     * Min: 1 character
+     * Max: 150 characters
+     */
+    timeZone?: string | null;
+    /**
+     * Whether the schedule's `timeZone` is automatically synced from
+     * `timeZone` of the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
+     *
+     * Default: `true`
+     */
+    businessTimeZoneEnabled?: boolean | null;
+    /**
+     * Default `title` for [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
+     * that are added to the schedule.
+     *
+     * Min: 1 character
+     * Max: 200 characters
+     */
+    defaultTitle?: string | null;
+    /**
+     * Default `location` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
+     * that are added to the schedule.
+     */
+    defaultLocation?: Location;
+    /**
+     * Default `totalCapacity` for [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
+     * that are added to the schedule.
+     *
+     * Min: `0`
+     */
+    defaultCapacity?: number | null;
+    /**
+     * Default `conferencingDetails` for [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
+     * that are added to the schedule.
+     * Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#retrieve-personal-information).
+     */
+    defaultConferencingDetails?: ConferencingDetails;
+    /**
+     * ID of the app that's associated with the schedule. You can't update `appId`.
+     * If you want to create a schedule and ensure its associated events appear
+     * in the [Bookings calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar),
+     * you must provide the Wix Bookings app ID
+     * `13d21c63-b5ec-5912-8397-c3a5ddb27a97`.
+     */
+    appId?: string | null;
+    /**
+     * List of permissions associated with the schedule. Refer to the
+     * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#roles)
+     * for more information.
+     *
+     * Max: 1 permission
+     */
+    permissions?: Permission[];
+    /** Extensions enabling applications or users to save custom data related to the schedule. */
+    extendedFields?: ExtendedFields;
+    /**
+     * Revision number, which increments by 1 each time the schedule is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the schedule.
+     * Ignored when creating a schedule.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date the schedule was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date the schedule was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+}
+export interface UpdateScheduleOptions {
+    /**
+     * Information about whether participants of the schedule's updated events are
+     * notified and the message they receive.
+     */
+    participantNotification?: ParticipantNotification;
+}
+/**
+ * Sets a schedule's `status` to `CANCELLED`.
+ *
+ *
+ * Also cancels future events belonging to the schedule.
+ *
+ * Once a schedule is marked as `CANCELLED`, you can't reactivate it, update it,
+ * or assign new events.
+ * @param scheduleId - ID of the schedule to cancel.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField scheduleId
+ * @permissionId CALENDAR.SCHEDULE_CANCEL
+ * @permissionScope Manage Calendars
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
+ * @permissionScope Manage Bookings
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
+ * @permissionScope Manage Bookings - all permissions
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
+ * @applicableIdentity APP
+ * @fqn wix.calendar.schedules.v3.SchedulesService.CancelSchedule
+ */
+export declare function cancelSchedule(scheduleId: string | null, options?: CancelScheduleOptions): Promise<CancelScheduleResponse & CancelScheduleResponseNonNullableFields>;
+export interface CancelScheduleOptions {
+    /**
+     * Whether to preserve future events with participants.
+     * Default: `false`.
+     */
+    preserveFutureEventsWithParticipants?: boolean | null;
+    /**
+     * Information about whether participants of the schedule's updated events are
+     * notified and the message they receive.
+     */
+    participantNotification?: ParticipantNotification;
+}
+export {};