@wix/auto_sdk_calendar_schedule-time-frames 1.0.0

package/build/cjs/src/calendar-v3-schedule-time-frame-schedule-time-frames.universal.d.ts

@@ -0,0 +1,671 @@
+/**
+ * Information about the start and end dates of the first and last
+ * [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction)
+ * that belong to a [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction)
+ * and whether any events follow an unlimited repetition pattern.
+ */
+export interface ScheduleTimeFrame {
+    /**
+     * ID of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
+     * to which the time frame belongs.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Information about the presence of recurring events within the schedule.
+     *
+     * Supported values:
+     * + `NONE`: No [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction) are scheduled within the schedule.
+     * + `FINITE`: All recurring events within the schedule have a defined end date, or there are no recurring events.
+     * + `INFINITE`: At least one recurring event within the schedule has no end date, meaning it follows an unlimited repetition pattern.
+     * @readonly
+     */
+    status?: Status;
+    /**
+     * Start date of the first [event](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
+     * within the schedule. Identical to `event.start.localDate`. Available only if
+     * `status` is set to `FINITE` or `INFINITE`.
+     * @readonly
+     */
+    firstEventStartDate?: ZonedDate;
+    /**
+     * End date of the last [event](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
+     * belonging to the schedule. Identical to `event.end.localDate`. Available only if
+     * `status` is set to `FINITE`.
+     * @readonly
+     */
+    lastEventEndDate?: ZonedDate;
+    /**
+     * Start date of the first [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
+     * belonging to the schedule, adjusted to `timeZone` of the
+     * [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
+     * or the `timeZone` specified in the request.
+     * Identical to `event.adjustedStart.localDate`.
+     * @readonly
+     */
+    adjustedFirstEventStartDate?: ZonedDate;
+    /**
+     * End date of the last [event](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
+     * belonging to the schedule, adjusted to `timeZone` of the
+     * [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
+     * or the `timeZone` specified in the request.
+     * Identical to `event.adjustedEnd.localDate`.
+     * @readonly
+     */
+    adjustedLastEventEndDate?: ZonedDate;
+    /**
+     * Revision number, which increments by 1 each time the schedule time frame is updated.
+     * @readonly
+     */
+    revision?: string | null;
+}
+export declare enum Status {
+    UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    /** No [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object) that belong to the schedule. */
+    NONE = "NONE",
+    /** There are no recurring events or all recurring events belonging to the schedule have a defined end date. */
+    FINITE = "FINITE",
+    /** At least one recurring event belonging to the schedule has an unlimited repetition pattern (no end date). */
+    INFINITE = "INFINITE"
+}
+/** A date time with a time zone, having the UTC offset and date determined by the server. */
+export interface ZonedDate {
+    /**
+     * Local date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
+     * For example, `2024-01-30T13:30:00`.
+     * Wix Calendar APIs ignore seconds.
+     */
+    localDate?: string | null;
+    /**
+     * Time zone in
+     * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
+     * For example, `America/New_York`.
+     * @readonly
+     */
+    timeZone?: string | null;
+    /**
+     * UTC date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
+     * For example, `2024-01-30T13:30:00`.
+     * Not available for adjusted date fields.
+     * @readonly
+     */
+    utcDate?: Date | null;
+}
+/** Deprecated. Use the standard ScheduleTimeFrameUpdated event instead, which also includes the modified fields. */
+export interface ScheduleTimeFrameUpdatedWithMetadata {
+    /** Updated schedule time frame. */
+    scheduleTimeFrame?: ScheduleTimeFrame;
+}
+export interface GetScheduleTimeFrameRequest {
+    /**
+     * [Schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
+     * ID for which to retrieve the schedule time frame.
+     */
+    _id: string | null;
+    /**
+     * Time zone for adjusting the times of the returned schedule time frame.
+     *
+     * Default: `timeZone` of the [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
+     */
+    timeZone?: string | null;
+}
+export interface GetScheduleTimeFrameResponse {
+    /** Retrieved schedule time frame. */
+    scheduleTimeFrame?: ScheduleTimeFrame;
+}
+export interface ListScheduleTimeFramesRequest {
+    /**
+     * IDs of the schedules for which to retrieve schedule time frames.
+     *
+     * Min: 1 schedule ID
+     * Max: 100 schedule IDs
+     */
+    ids: string[];
+    /**
+     * Time zone for adjusting the times of the returned schedule time frames.
+     *
+     * Default: `timeZone` of the [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
+     */
+    timeZone?: string | null;
+}
+export interface ListScheduleTimeFramesResponse {
+    /** Retrieved schedule time frames. */
+    scheduleTimeFrames?: ScheduleTimeFrame[];
+}
+/** 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?: SiteCreated;
+    /** 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?: SiteCreated;
+    /** Properties were cloned on site cloning. */
+    siteCloned?: SiteCloned;
+}
+export interface PropertiesChange {
+}
+export interface SiteCreated {
+    /** Origin template site id. */
+    originTemplateId?: string | null;
+}
+export interface SiteCloned {
+    /** Origin site id. */
+    originMetaSiteId?: string;
+}
+export interface Empty {
+}
+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"
+}
+export interface ScheduleTimeFrameNonNullableFields {
+    status: Status;
+}
+export interface GetScheduleTimeFrameResponseNonNullableFields {
+    scheduleTimeFrame?: ScheduleTimeFrameNonNullableFields;
+}
+export interface ListScheduleTimeFramesResponseNonNullableFields {
+    scheduleTimeFrames: ScheduleTimeFrameNonNullableFields[];
+}
+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 ScheduleTimeFrameUpdatedEnvelope {
+    entity: ScheduleTimeFrame;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a schedule's time frame is updated, indicating a new first or
+ * last event or a change in the recurrence period, such as an extension or
+ * reduction.
+ * @permissionScope Read Bookings - Public Data
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
+ * @permissionScope Read Calendar - Including PI
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
+ * @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
+ * @permissionId CALENDAR.SCHEDULE_READ
+ * @webhook
+ * @eventType wix.calendar.v3.schedule_time_frame_updated
+ * @documentationMaturity preview
+ */
+export declare function onScheduleTimeFrameUpdated(handler: (event: ScheduleTimeFrameUpdatedEnvelope) => void | Promise<void>): void;
+/**
+ * Retrieves a schedule time frame by schedule ID.
+ * @param _id - [Schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
+ * ID for which to retrieve the schedule time frame.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @permissionId CALENDAR.SCHEDULE_READ
+ * @permissionScope Read Bookings - Public Data
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
+ * @permissionScope Read Calendar - Including PI
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
+ * @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
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @returns Retrieved schedule time frame.
+ * @fqn wix.calendar.scheduletimeframes.v3.ScheduleTimeFramesService.GetScheduleTimeFrame
+ */
+export declare function getScheduleTimeFrame(_id: string | null, options?: GetScheduleTimeFrameOptions): Promise<ScheduleTimeFrame & ScheduleTimeFrameNonNullableFields>;
+export interface GetScheduleTimeFrameOptions {
+    /**
+     * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting the times of the returned schedule time frame. For example, `America/New_York` or `UTC`.
+     *
+     * Default: `timeZone` of the [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
+     */
+    timeZone?: string | null;
+}
+/**
+ * Retrieves a list of schedule time frames by schedule IDs.
+ *
+ *
+ * Sorted by schedule ID in ascending order.
+ * @param ids - IDs of the schedules for which to retrieve schedule time frames.
+ *
+ * Min: 1 schedule ID
+ * Max: 100 schedule IDs
+ * @public
+ * @documentationMaturity preview
+ * @requiredField ids
+ * @permissionId CALENDAR.SCHEDULE_READ
+ * @permissionScope Read Bookings - Public Data
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
+ * @permissionScope Read Calendar - Including PI
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
+ * @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
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn wix.calendar.scheduletimeframes.v3.ScheduleTimeFramesService.ListScheduleTimeFrames
+ */
+export declare function listScheduleTimeFrames(ids: string[], options?: ListScheduleTimeFramesOptions): Promise<ListScheduleTimeFramesResponse & ListScheduleTimeFramesResponseNonNullableFields>;
+export interface ListScheduleTimeFramesOptions {
+    /**
+     * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting the times of the returned schedule time frame. For example, `America/New_York` or `UTC`.
+     *
+     * Default: `timeZone` of the [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
+     */
+    timeZone?: string | null;
+}