@wix/auto_sdk_calendar_schedules 1.0.53 → 1.0.55

package/build/internal/cjs/{calendar-v3-schedule-schedules.universal-Cy_4Hg5X.d.ts → index.typings.d.ts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 /**
  * 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
@@ -270,6 +272,8 @@ declare enum IdentityType {
     UNKNOWN = "UNKNOWN",
     WIX_USER = "WIX_USER"
 }
+/** @enumType */
+type IdentityTypeWithLiterals = IdentityType | 'UNKNOWN' | 'WIX_USER';
 declare enum Role {
     UNKNOWN_ROLE = "UNKNOWN_ROLE",
     /** Full read and write access. */
@@ -1408,6 +1412,16 @@ declare enum WebhookIdentityType {
 }
 /** @enumType */
 type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+type UpdateScheduleApplicationErrors = {
+    code?: 'UPDATE_CANCELLED_SCHEDULE_NOT_ALLOWED';
+    description?: string;
+    data?: Record<string, any>;
+};
+type CancelScheduleApplicationErrors = {
+    code?: 'SCHEDULE_ALREADY_CANCELLED';
+    description?: string;
+    data?: Record<string, any>;
+};
 interface BaseEventMetadata {
     /**
      * App instance ID.
@@ -1456,18 +1470,124 @@ 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 Read Bookings - all read permissions
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
+ * @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
+ * @serviceIdentifier wix.calendar.schedules.v3.SchedulesService
+ * @slug cancelled
+ */
+declare function onScheduleCancelled(handler: (event: ScheduleCancelledEnvelope) => void | Promise<void>): void;
 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 Read Bookings - all read permissions
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
+ * @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
+ * @serviceIdentifier wix.calendar.schedules.v3.SchedulesService
+ * @slug cloned
+ */
+declare function onScheduleCloned(handler: (event: ScheduleClonedEnvelope) => void | Promise<void>): void;
 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 Read Bookings - all read permissions
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
+ * @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
+ * @serviceIdentifier wix.calendar.schedules.v3.SchedulesService
+ * @slug created
+ */
+declare function onScheduleCreated(handler: (event: ScheduleCreatedEnvelope) => void | Promise<void>): void;
 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 Read Bookings - all read permissions
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
+ * @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
+ * @serviceIdentifier wix.calendar.schedules.v3.SchedulesService
+ * @slug updated
+ */
+declare function onScheduleUpdated(handler: (event: ScheduleUpdatedEnvelope) => void | Promise<void>): void;
+type ScheduleNonNullablePaths = `status` | `defaultLocation.type` | `defaultConferencingDetails.type` | `permissions` | `permissions.${number}.identity.wixUserId` | `permissions.${number}.role`;
+/**
+ * Retrieves a schedule.
+ * @param scheduleId - ID of the schedule to retrieve.
+ * @public
+ * @requiredField scheduleId
+ * @permissionId CALENDAR.SCHEDULE_READ
+ * @permissionId CALENDAR.SCHEDULE_READ_PI
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @returns Retrieved schedule.
+ * @fqn wix.calendar.schedules.v3.SchedulesService.GetSchedule
+ */
+declare function getSchedule(scheduleId: string, options?: GetScheduleOptions): Promise<NonNullablePaths<Schedule, ScheduleNonNullablePaths>>;
 interface GetScheduleOptions {
     /**
      * Information about which fields containing personal data to return. Refer to the
@@ -1484,6 +1604,31 @@ interface GetScheduleOptions {
      */
     fields?: RequestedFieldsWithLiterals[];
 }
+/**
+ * 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
+ * @permissionId CALENDAR.SCHEDULE_READ
+ * @permissionId CALENDAR.SCHEDULE_READ_PI
+ * @applicableIdentity APP
+ * @applicableIdentity VISITOR
+ * @fqn wix.calendar.schedules.v3.SchedulesService.QuerySchedules
+ */
+declare function querySchedules(options?: QuerySchedulesOptions): SchedulesQueryBuilder;
 interface QuerySchedulesOptions {
     /**
      * Information about which fields containing personal data to return. Refer to the
@@ -1525,6 +1670,29 @@ interface SchedulesQueryBuilder {
     skipTo: (cursor: string) => SchedulesQueryBuilder;
     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
+ * @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
+ * @applicableIdentity APP
+ * @returns Created schedule.
+ * @fqn wix.calendar.schedules.v3.SchedulesService.CreateSchedule
+ */
+declare function createSchedule(schedule: NonNullablePaths<Schedule, `defaultConferencingDetails.guestUrl` | `defaultConferencingDetails.hostUrl` | `defaultConferencingDetails.type` | `defaultLocation.type` | `permissions.${number}.identity` | `permissions.${number}.role`>, options?: CreateScheduleOptions): Promise<NonNullablePaths<Schedule, ScheduleNonNullablePaths>>;
 interface CreateScheduleOptions {
     /**
      * Idempotency key guaranteeing that you don't create the same schedule more
@@ -1533,6 +1701,30 @@ interface CreateScheduleOptions {
      */
     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
+ * @requiredField _id
+ * @requiredField schedule
+ * @requiredField schedule.permissions.identity
+ * @requiredField schedule.permissions.role
+ * @requiredField schedule.revision
+ * @permissionId CALENDAR.SCHEDULE_UPDATE
+ * @applicableIdentity APP
+ * @returns Updated schedule.
+ * @fqn wix.calendar.schedules.v3.SchedulesService.UpdateSchedule
+ */
+declare function updateSchedule(_id: string, schedule: NonNullablePaths<UpdateSchedule, `permissions.${number}.identity` | `permissions.${number}.role` | `revision`>, options?: UpdateScheduleOptions): Promise<NonNullablePaths<Schedule, ScheduleNonNullablePaths> & {
+    __applicationErrorsType?: UpdateScheduleApplicationErrors;
+}>;
 interface UpdateSchedule {
     /**
      * Schedule ID.
@@ -1665,6 +1857,26 @@ interface UpdateScheduleOptions {
      */
     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
+ * @requiredField scheduleId
+ * @permissionId CALENDAR.SCHEDULE_CANCEL
+ * @applicableIdentity APP
+ * @fqn wix.calendar.schedules.v3.SchedulesService.CancelSchedule
+ */
+declare function cancelSchedule(scheduleId: string, options?: CancelScheduleOptions): Promise<NonNullablePaths<CancelScheduleResponse, {
+    [P in ScheduleNonNullablePaths]: `schedule.${P}`;
+}[ScheduleNonNullablePaths]> & {
+    __applicationErrorsType?: CancelScheduleApplicationErrors;
+}>;
 interface CancelScheduleOptions {
     /**
      * Whether to preserve future events with participants.
@@ -1678,4 +1890,4 @@ interface CancelScheduleOptions {
     participantNotification?: ParticipantNotification;
 }
 
-export { type ScheduleCancelled as $, type QuerySchedulesResponse as A, type CursorPagingMetadata as B, type CreateScheduleOptions as C, DeleteStatus as D, type ExtendedFields as E, type Cursors as F, type GetScheduleOptions as G, type CreateScheduleRequest as H, IdentityType as I, type CreateScheduleResponse as J, type UpdateScheduleRequest as K, LocationType as L, type ParticipantNotification as M, Namespace as N, type UpdateScheduleResponse as O, PlacementType as P, type QuerySchedulesOptions as Q, Role as R, type Schedule as S, Type as T, type UpdateSchedule as U, type ScheduleUpdatedWithMetadata as V, WebhookIdentityType as W, type CloneScheduleRequest as X, type CloneScheduleResponse as Y, type ScheduleCloned as Z, type CancelScheduleRequest as _, type SchedulesQueryBuilder as a, type MetaSiteSpecialEvent as a0, type MetaSiteSpecialEventPayloadOneOf as a1, type Asset as a2, type SiteCreated as a3, type SiteTransferred as a4, type SiteDeleted as a5, type DeleteContext as a6, type SiteUndeleted as a7, type SitePublished as a8, type SiteUnpublished as a9, type SpecialHourPeriod as aA, type Multilingual as aB, type SupportedLanguage as aC, type ConsentPolicy as aD, type Translation as aE, type ChangeContext as aF, type ChangeContextPayloadOneOf as aG, type PropertiesChange as aH, type V4SiteCreated as aI, type SiteCloned as aJ, type DomainEvent as aK, type DomainEventBodyOneOf as aL, type EntityCreatedEvent as aM, type RestoreInfo as aN, type EntityUpdatedEvent as aO, type EntityDeletedEvent as aP, type ActionEvent as aQ, type MessageEnvelope as aR, type IdentificationData as aS, type IdentificationDataIdOneOf as aT, type BaseEventMetadata as aU, type EventMetadata as aV, type SchedulesQueryResult as aW, type SiteMarkedAsTemplate as aa, type SiteMarkedAsWixSite as ab, type ServiceProvisioned as ac, type ServiceRemoved as ad, type SiteRenamed as ae, type SiteHardDeleted as af, type NamespaceChanged as ag, type StudioAssigned as ah, type StudioUnassigned as ai, type SiteUrlChanged as aj, type SitePurgedExternally as ak, type OdeditorAssigned as al, type OdeditorUnassigned as am, type PicassoAssigned as an, type PicassoUnassigned as ao, type Empty as ap, type SitePropertiesNotification as aq, type SitePropertiesEvent as ar, type Properties as as, type Categories as at, type Locale as au, type Address as av, type AddressHint as aw, type GeoCoordinates as ax, type BusinessSchedule as ay, type TimePeriod as az, type UpdateScheduleOptions as b, type CancelScheduleOptions as c, type CancelScheduleResponse as d, type ScheduleCancelledEnvelope as e, type ScheduleClonedEnvelope as f, type ScheduleCreatedEnvelope as g, type ScheduleUpdatedEnvelope as h, Status as i, RequestedFields as j, Trigger as k, State as l, SiteCreatedContext as m, DayOfWeek as n, ResolutionMethod as o, type Location as p, type ConferencingDetails as q, type Permission as r, type CommonIdentificationData as s, type CommonIdentificationDataIdOneOf as t, type GetScheduleRequest as u, type GetScheduleResponse as v, type QuerySchedulesRequest as w, type CursorQuery as x, type CursorQueryPagingMethodOneOf as y, type CursorPaging as z };
+export { type ActionEvent, type Address, type AddressHint, type Asset, type BaseEventMetadata, type BusinessSchedule, type CancelScheduleApplicationErrors, type CancelScheduleOptions, type CancelScheduleRequest, type CancelScheduleResponse, type Categories, type ChangeContext, type ChangeContextPayloadOneOf, type CloneScheduleRequest, type CloneScheduleResponse, type CommonIdentificationData, type CommonIdentificationDataIdOneOf, type ConferencingDetails, type ConsentPolicy, type CreateScheduleOptions, type CreateScheduleRequest, type CreateScheduleResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, DayOfWeek, type DayOfWeekWithLiterals, type DeleteContext, DeleteStatus, type DeleteStatusWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type GeoCoordinates, type GetScheduleOptions, type GetScheduleRequest, type GetScheduleResponse, type IdentificationData, type IdentificationDataIdOneOf, IdentityType, type IdentityTypeWithLiterals, type Locale, type Location, LocationType, type LocationTypeWithLiterals, type MessageEnvelope, type MetaSiteSpecialEvent, type MetaSiteSpecialEventPayloadOneOf, type Multilingual, Namespace, type NamespaceChanged, type NamespaceWithLiterals, type OdeditorAssigned, type OdeditorUnassigned, type ParticipantNotification, type Permission, type PicassoAssigned, type PicassoUnassigned, PlacementType, type PlacementTypeWithLiterals, type Properties, type PropertiesChange, type QuerySchedulesOptions, type QuerySchedulesRequest, type QuerySchedulesResponse, RequestedFields, type RequestedFieldsWithLiterals, ResolutionMethod, type ResolutionMethodWithLiterals, type RestoreInfo, Role, type RoleWithLiterals, type Schedule, type ScheduleCancelled, type ScheduleCancelledEnvelope, type ScheduleCloned, type ScheduleClonedEnvelope, type ScheduleCreatedEnvelope, type ScheduleUpdatedEnvelope, type ScheduleUpdatedWithMetadata, type SchedulesQueryBuilder, type SchedulesQueryResult, type ServiceProvisioned, type ServiceRemoved, type SiteCloned, type SiteCreated, SiteCreatedContext, type SiteCreatedContextWithLiterals, type SiteDeleted, type SiteHardDeleted, type SiteMarkedAsTemplate, type SiteMarkedAsWixSite, type SitePropertiesEvent, type SitePropertiesNotification, type SitePublished, type SitePurgedExternally, type SiteRenamed, type SiteTransferred, type SiteUndeleted, type SiteUnpublished, type SiteUrlChanged, type SpecialHourPeriod, State, type StateWithLiterals, Status, type StatusWithLiterals, type StudioAssigned, type StudioUnassigned, type SupportedLanguage, type TimePeriod, type Translation, Trigger, type TriggerWithLiterals, Type, type TypeWithLiterals, type UpdateSchedule, type UpdateScheduleApplicationErrors, type UpdateScheduleOptions, type UpdateScheduleRequest, type UpdateScheduleResponse, type V4SiteCreated, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, cancelSchedule, createSchedule, getSchedule, onScheduleCancelled, onScheduleCloned, onScheduleCreated, onScheduleUpdated, querySchedules, updateSchedule };