@wix/auto_sdk_calendar_schedules 1.0.34 → 1.0.35

package/build/internal/meta.d.ts

@@ -1,487 +0,0 @@
-import { q as GetScheduleRequest$1, r as GetScheduleResponse$1, s as QuerySchedulesRequest$1, w as QuerySchedulesResponse$1, z as CreateScheduleRequest$1, A as CreateScheduleResponse$1, B as UpdateScheduleRequest$1, H as UpdateScheduleResponse$1, V as CancelScheduleRequest$1, d as CancelScheduleResponse$1 } from './calendar-v3-schedule-schedules.universal-D3nvGK6W.js';
-
-/**
- * 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.
- */
-interface Schedule {
-    /**
-     * Schedule ID.
-     * @format GUID
-     * @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/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object).
-     * If the schedule belongs to a Bookings service, identical to the ID of
-     * the [service](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/service-object).
-     * @format GUID
-     * @immutable
-     */
-    externalId?: string | null;
-    /**
-     * Schedule name.
-     *
-     * Min: 1 character
-     * Max: 200 characters
-     * @minLength 1
-     * @maxLength 200
-     */
-    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/rest/business-management/site-properties/properties/get-site-properties).
-     *
-     * Min: 1 character
-     * Max: 150 characters
-     * @minLength 1
-     * @maxLength 150
-     */
-    timeZone?: string | null;
-    /**
-     * Whether the schedule's `timeZone` is automatically synced from
-     * `timeZone` of the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
-     *
-     * Default: `true`
-     */
-    businessTimeZoneEnabled?: boolean | null;
-    /**
-     * Default `title` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
-     * that are added to the schedule.
-     *
-     * Min: 1 character
-     * Max: 200 characters
-     * @minLength 1
-     * @maxLength 200
-     */
-    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/rest/business-management/calendar/events-v3/event-object)
-     * that are added to the schedule.
-     *
-     * Min: `0`
-     */
-    defaultCapacity?: number | null;
-    /**
-     * Default `conferencingDetails` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
-     * that are added to the schedule.
-     * Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/rest/business-management/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](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
-     * `13d21c63-b5ec-5912-8397-c3a5ddb27a97`.
-     * @format GUID
-     * @immutable
-     */
-    appId?: string | null;
-    /**
-     * List of permissions associated with the schedule. Refer to the
-     * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#roles)
-     * for more information.
-     *
-     * Max: 1 permission
-     * @maxSize 1
-     */
-    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;
-}
-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"
-}
-interface Location {
-    /**
-     * [Location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
-     * ID. Available only for `BUSINESS` locations.
-     * @format GUID
-     */
-    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/rest/business-management/locations/location-object)
-     * `name`.
-     *
-     * Min: 1 character
-     * Max: 150 characters
-     * @minLength 1
-     * @maxLength 150
-     */
-    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`.
-     * @minLength 1
-     * @maxLength 300
-     */
-    address?: string | null;
-}
-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"
-}
-interface ConferencingDetails {
-    /** Conference type. For example, `Zoom`. */
-    type?: Type;
-    /**
-     * URL used by the host to start the conference.
-     *
-     * Min: 1 character
-     * Max: 2000 characters
-     * @minLength 1
-     * @maxLength 2000
-     */
-    hostUrl?: string | null;
-    /**
-     * URL used by a guest to join the conference.
-     *
-     * Min: 1 character
-     * Max: 2000 characters
-     * @minLength 1
-     * @maxLength 2000
-     */
-    guestUrl?: string | null;
-    /**
-     * Conference password.
-     *
-     * Min: 1 character
-     * Max: 100 characters
-     * @minLength 1
-     * @maxLength 100
-     */
-    password?: string | null;
-    /**
-     * Conference ID in an external system.
-     *
-     * Min: 1 character
-     * Max: 150 characters
-     * @minLength 1
-     * @maxLength 150
-     */
-    externalId?: string | null;
-}
-declare enum Type {
-    UNKNOWN_TYPE = "UNKNOWN_TYPE",
-    ZOOM = "ZOOM",
-    CUSTOM = "CUSTOM"
-}
-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;
-}
-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).
-     * @format GUID
-     */
-    wixUserId?: string;
-}
-/** @oneof */
-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).
-     * @format GUID
-     */
-    wixUserId?: string;
-}
-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"
-}
-interface ExtendedFields {
-    /**
-     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
-     * The value of each key is structured according to the schema defined when the extended fields were configured.
-     *
-     * You can only access fields for which you have the appropriate permissions.
-     *
-     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
-     */
-    namespaces?: Record<string, Record<string, any>>;
-}
-interface GetScheduleRequest {
-    /**
-     * ID of the schedule to retrieve.
-     * @format GUID
-     */
-    scheduleId: string | null;
-    /**
-     * Information about which fields containing personal data to return. Refer to the
-     * [permissions article](https://dev.wix.com/docs/rest/business-management/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.
-     * @maxSize 1
-     */
-    fields?: RequestedFields[];
-}
-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"
-}
-interface GetScheduleResponse {
-    /** Retrieved schedule. */
-    schedule?: Schedule;
-}
-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/rest/business-management/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.
-     * @maxSize 1
-     */
-    fields?: RequestedFields[];
-}
-/** TODO Diverge */
-interface CursorQuery extends CursorQueryPagingMethodOneOf {
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
-    cursorPaging?: CursorPaging;
-    /**
-     * Filter object.
-     * See [API Query Language](https://dev.wix.com/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 */
-interface CursorQueryPagingMethodOneOf {
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
-    cursorPaging?: CursorPaging;
-}
-/** TODO Diverge */
-interface CursorPaging {
-    /**
-     * Number of schedules to return.
-     *
-     * Min: `1`
-     * Max: `100`
-     * Default: `50`
-     * @min 1
-     * @max 100
-     */
-    limit?: number | null;
-    /**
-     * Pointer to the next or previous page in the list of results.
-     *
-     * You can get the relevant cursor token
-     * from the `pagingMetadata` object in the previous call's response.
-     * Not relevant for the first request.
-     */
-    cursor?: string | null;
-}
-interface QuerySchedulesResponse {
-    /** Retrieved schedules matching the provided query. */
-    schedules?: Schedule[];
-    /** Paging metadata. */
-    pagingMetadata?: CursorPagingMetadata;
-}
-/** TODO Diverge */
-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;
-}
-interface Cursors {
-    /** Cursor pointing to next page in the list of results. */
-    next?: string | null;
-    /** Cursor pointing to previous page in the list of results. */
-    prev?: string | null;
-}
-interface CreateScheduleRequest {
-    /** Schedule to create. */
-    schedule: Schedule;
-    /**
-     * Idempotency key guaranteeing that you don't create the same schedule more
-     * than once.
-     * @format GUID
-     */
-    idempotencyKey?: string | null;
-}
-interface CreateScheduleResponse {
-    /** Created schedule. */
-    schedule?: Schedule;
-}
-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;
-}
-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
-     * @minLength 1
-     * @maxLength 5000
-     */
-    message?: string | null;
-}
-interface UpdateScheduleResponse {
-    /** Updated schedule. */
-    schedule?: Schedule;
-}
-interface CancelScheduleRequest {
-    /**
-     * ID of the schedule to cancel.
-     * @format GUID
-     */
-    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;
-}
-interface CancelScheduleResponse {
-    /** Canceled schedule. */
-    schedule?: Schedule;
-}
-
-type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
-    getUrl: (context: any) => string;
-    httpMethod: K;
-    path: string;
-    pathParams: M;
-    __requestType: T;
-    __originalRequestType: S;
-    __responseType: Q;
-    __originalResponseType: R;
-};
-declare function getSchedule(): __PublicMethodMetaInfo<'GET', {
-    scheduleId: string;
-}, GetScheduleRequest$1, GetScheduleRequest, GetScheduleResponse$1, GetScheduleResponse>;
-declare function querySchedules(): __PublicMethodMetaInfo<'POST', {}, QuerySchedulesRequest$1, QuerySchedulesRequest, QuerySchedulesResponse$1, QuerySchedulesResponse>;
-declare function createSchedule(): __PublicMethodMetaInfo<'POST', {}, CreateScheduleRequest$1, CreateScheduleRequest, CreateScheduleResponse$1, CreateScheduleResponse>;
-declare function updateSchedule(): __PublicMethodMetaInfo<'PATCH', {
-    scheduleId: string;
-}, UpdateScheduleRequest$1, UpdateScheduleRequest, UpdateScheduleResponse$1, UpdateScheduleResponse>;
-declare function cancelSchedule(): __PublicMethodMetaInfo<'POST', {
-    scheduleId: string;
-}, CancelScheduleRequest$1, CancelScheduleRequest, CancelScheduleResponse$1, CancelScheduleResponse>;
-
-export { type __PublicMethodMetaInfo, cancelSchedule, createSchedule, getSchedule, querySchedules, updateSchedule };