@wix/auto_sdk_calendar_schedules 1.0.45 → 1.0.46

package/build/index.d.mts

@@ -0,0 +1,108 @@
+import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { G as GetScheduleOptions, S as Schedule, Q as QuerySchedulesOptions, a as SchedulesQueryBuilder, C as CreateScheduleOptions, U as UpdateSchedule, b as UpdateScheduleOptions, c as CancelScheduleOptions, d as CancelScheduleResponse, e as ScheduleCancelledEnvelope, f as ScheduleClonedEnvelope, g as ScheduleCreatedEnvelope, h as ScheduleUpdatedEnvelope } from './calendar-v3-schedule-schedules.universal-Cy_4Hg5X.mjs';
+export { aQ as ActionEvent, av as Address, aw as AddressHint, a2 as Asset, aU as BaseEventMetadata, ay as BusinessSchedule, _ as CancelScheduleRequest, at as Categories, aF as ChangeContext, aG as ChangeContextPayloadOneOf, X as CloneScheduleRequest, Y as CloneScheduleResponse, s as CommonIdentificationData, t as CommonIdentificationDataIdOneOf, q as ConferencingDetails, aD as ConsentPolicy, H as CreateScheduleRequest, J as CreateScheduleResponse, z as CursorPaging, B as CursorPagingMetadata, x as CursorQuery, y as CursorQueryPagingMethodOneOf, F as Cursors, n as DayOfWeek, a6 as DeleteContext, D as DeleteStatus, aK as DomainEvent, aL as DomainEventBodyOneOf, ap as Empty, aM as EntityCreatedEvent, aP as EntityDeletedEvent, aO as EntityUpdatedEvent, aV as EventMetadata, E as ExtendedFields, ax as GeoCoordinates, u as GetScheduleRequest, v as GetScheduleResponse, aS as IdentificationData, aT as IdentificationDataIdOneOf, I as IdentityType, au as Locale, p as Location, L as LocationType, aR as MessageEnvelope, a0 as MetaSiteSpecialEvent, a1 as MetaSiteSpecialEventPayloadOneOf, aB as Multilingual, N as Namespace, ag as NamespaceChanged, al as OdeditorAssigned, am as OdeditorUnassigned, M as ParticipantNotification, r as Permission, an as PicassoAssigned, ao as PicassoUnassigned, P as PlacementType, as as Properties, aH as PropertiesChange, w as QuerySchedulesRequest, A as QuerySchedulesResponse, j as RequestedFields, o as ResolutionMethod, aN as RestoreInfo, R as Role, $ as ScheduleCancelled, Z as ScheduleCloned, V as ScheduleUpdatedWithMetadata, aW as SchedulesQueryResult, ac as ServiceProvisioned, ad as ServiceRemoved, aJ as SiteCloned, a3 as SiteCreated, m as SiteCreatedContext, a5 as SiteDeleted, af as SiteHardDeleted, aa as SiteMarkedAsTemplate, ab as SiteMarkedAsWixSite, ar as SitePropertiesEvent, aq as SitePropertiesNotification, a8 as SitePublished, ak as SitePurgedExternally, ae as SiteRenamed, a4 as SiteTransferred, a7 as SiteUndeleted, a9 as SiteUnpublished, aj as SiteUrlChanged, aA as SpecialHourPeriod, l as State, i as Status, ah as StudioAssigned, ai as StudioUnassigned, aC as SupportedLanguage, az as TimePeriod, aE as Translation, k as Trigger, T as Type, K as UpdateScheduleRequest, O as UpdateScheduleResponse, aI as V4SiteCreated, W as WebhookIdentityType } from './calendar-v3-schedule-schedules.universal-Cy_4Hg5X.mjs';
+
+declare function getSchedule$1(httpClient: HttpClient): GetScheduleSignature;
+interface GetScheduleSignature {
+    /**
+     * Retrieves a schedule.
+     * @param - ID of the schedule to retrieve.
+     * @returns Retrieved schedule.
+     */
+    (scheduleId: string, options?: GetScheduleOptions | undefined): Promise<Schedule>;
+}
+declare function querySchedules$1(httpClient: HttpClient): QuerySchedulesSignature;
+interface QuerySchedulesSignature {
+    /**
+     * 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`.
+     */
+    (options?: QuerySchedulesOptions | undefined): SchedulesQueryBuilder;
+}
+declare function createSchedule$1(httpClient: HttpClient): CreateScheduleSignature;
+interface CreateScheduleSignature {
+    /**
+     * 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 to create.
+     * @returns Created schedule.
+     */
+    (schedule: Schedule, options?: CreateScheduleOptions | undefined): Promise<Schedule>;
+}
+declare function updateSchedule$1(httpClient: HttpClient): UpdateScheduleSignature;
+interface UpdateScheduleSignature {
+    /**
+     * 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 - Schedule ID.
+     * @returns Updated schedule.
+     */
+    (_id: string, schedule: UpdateSchedule, options?: UpdateScheduleOptions | undefined): Promise<Schedule>;
+}
+declare function cancelSchedule$1(httpClient: HttpClient): CancelScheduleSignature;
+interface CancelScheduleSignature {
+    /**
+     * 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 - ID of the schedule to cancel.
+     */
+    (scheduleId: string, options?: CancelScheduleOptions | undefined): Promise<CancelScheduleResponse>;
+}
+declare const onScheduleCancelled$1: EventDefinition<ScheduleCancelledEnvelope, "wix.calendar.v3.schedule_cancelled">;
+declare const onScheduleCloned$1: EventDefinition<ScheduleClonedEnvelope, "wix.calendar.v3.schedule_cloned">;
+declare const onScheduleCreated$1: EventDefinition<ScheduleCreatedEnvelope, "wix.calendar.v3.schedule_created">;
+declare const onScheduleUpdated$1: EventDefinition<ScheduleUpdatedEnvelope, "wix.calendar.v3.schedule_updated">;
+
+declare const getSchedule: MaybeContext<BuildRESTFunction<typeof getSchedule$1> & typeof getSchedule$1>;
+declare const querySchedules: MaybeContext<BuildRESTFunction<typeof querySchedules$1> & typeof querySchedules$1>;
+declare const createSchedule: MaybeContext<BuildRESTFunction<typeof createSchedule$1> & typeof createSchedule$1>;
+declare const updateSchedule: MaybeContext<BuildRESTFunction<typeof updateSchedule$1> & typeof updateSchedule$1>;
+declare const cancelSchedule: MaybeContext<BuildRESTFunction<typeof cancelSchedule$1> & typeof cancelSchedule$1>;
+/**
+ * Triggered when a schedule is canceled.
+ */
+declare const onScheduleCancelled: BuildEventDefinition<typeof onScheduleCancelled$1>;
+/**
+ * Triggered when a schedule is cloned.
+ */
+declare const onScheduleCloned: BuildEventDefinition<typeof onScheduleCloned$1>;
+/**
+ * Triggered when a schedule is created.
+ */
+declare const onScheduleCreated: BuildEventDefinition<typeof onScheduleCreated$1>;
+/**
+ * Triggered when a schedule is updated.
+ */
+declare const onScheduleUpdated: BuildEventDefinition<typeof onScheduleUpdated$1>;
+
+export { CancelScheduleOptions, CancelScheduleResponse, CreateScheduleOptions, GetScheduleOptions, QuerySchedulesOptions, Schedule, ScheduleCancelledEnvelope, ScheduleClonedEnvelope, ScheduleCreatedEnvelope, ScheduleUpdatedEnvelope, SchedulesQueryBuilder, UpdateSchedule, UpdateScheduleOptions, cancelSchedule, createSchedule, getSchedule, onScheduleCancelled, onScheduleCloned, onScheduleCreated, onScheduleUpdated, querySchedules, updateSchedule };

package/build/index.d.ts

@@ -0,0 +1,108 @@
+import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { G as GetScheduleOptions, S as Schedule, Q as QuerySchedulesOptions, a as SchedulesQueryBuilder, C as CreateScheduleOptions, U as UpdateSchedule, b as UpdateScheduleOptions, c as CancelScheduleOptions, d as CancelScheduleResponse, e as ScheduleCancelledEnvelope, f as ScheduleClonedEnvelope, g as ScheduleCreatedEnvelope, h as ScheduleUpdatedEnvelope } from './calendar-v3-schedule-schedules.universal-Cy_4Hg5X.js';
+export { aQ as ActionEvent, av as Address, aw as AddressHint, a2 as Asset, aU as BaseEventMetadata, ay as BusinessSchedule, _ as CancelScheduleRequest, at as Categories, aF as ChangeContext, aG as ChangeContextPayloadOneOf, X as CloneScheduleRequest, Y as CloneScheduleResponse, s as CommonIdentificationData, t as CommonIdentificationDataIdOneOf, q as ConferencingDetails, aD as ConsentPolicy, H as CreateScheduleRequest, J as CreateScheduleResponse, z as CursorPaging, B as CursorPagingMetadata, x as CursorQuery, y as CursorQueryPagingMethodOneOf, F as Cursors, n as DayOfWeek, a6 as DeleteContext, D as DeleteStatus, aK as DomainEvent, aL as DomainEventBodyOneOf, ap as Empty, aM as EntityCreatedEvent, aP as EntityDeletedEvent, aO as EntityUpdatedEvent, aV as EventMetadata, E as ExtendedFields, ax as GeoCoordinates, u as GetScheduleRequest, v as GetScheduleResponse, aS as IdentificationData, aT as IdentificationDataIdOneOf, I as IdentityType, au as Locale, p as Location, L as LocationType, aR as MessageEnvelope, a0 as MetaSiteSpecialEvent, a1 as MetaSiteSpecialEventPayloadOneOf, aB as Multilingual, N as Namespace, ag as NamespaceChanged, al as OdeditorAssigned, am as OdeditorUnassigned, M as ParticipantNotification, r as Permission, an as PicassoAssigned, ao as PicassoUnassigned, P as PlacementType, as as Properties, aH as PropertiesChange, w as QuerySchedulesRequest, A as QuerySchedulesResponse, j as RequestedFields, o as ResolutionMethod, aN as RestoreInfo, R as Role, $ as ScheduleCancelled, Z as ScheduleCloned, V as ScheduleUpdatedWithMetadata, aW as SchedulesQueryResult, ac as ServiceProvisioned, ad as ServiceRemoved, aJ as SiteCloned, a3 as SiteCreated, m as SiteCreatedContext, a5 as SiteDeleted, af as SiteHardDeleted, aa as SiteMarkedAsTemplate, ab as SiteMarkedAsWixSite, ar as SitePropertiesEvent, aq as SitePropertiesNotification, a8 as SitePublished, ak as SitePurgedExternally, ae as SiteRenamed, a4 as SiteTransferred, a7 as SiteUndeleted, a9 as SiteUnpublished, aj as SiteUrlChanged, aA as SpecialHourPeriod, l as State, i as Status, ah as StudioAssigned, ai as StudioUnassigned, aC as SupportedLanguage, az as TimePeriod, aE as Translation, k as Trigger, T as Type, K as UpdateScheduleRequest, O as UpdateScheduleResponse, aI as V4SiteCreated, W as WebhookIdentityType } from './calendar-v3-schedule-schedules.universal-Cy_4Hg5X.js';
+
+declare function getSchedule$1(httpClient: HttpClient): GetScheduleSignature;
+interface GetScheduleSignature {
+    /**
+     * Retrieves a schedule.
+     * @param - ID of the schedule to retrieve.
+     * @returns Retrieved schedule.
+     */
+    (scheduleId: string, options?: GetScheduleOptions | undefined): Promise<Schedule>;
+}
+declare function querySchedules$1(httpClient: HttpClient): QuerySchedulesSignature;
+interface QuerySchedulesSignature {
+    /**
+     * 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`.
+     */
+    (options?: QuerySchedulesOptions | undefined): SchedulesQueryBuilder;
+}
+declare function createSchedule$1(httpClient: HttpClient): CreateScheduleSignature;
+interface CreateScheduleSignature {
+    /**
+     * 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 to create.
+     * @returns Created schedule.
+     */
+    (schedule: Schedule, options?: CreateScheduleOptions | undefined): Promise<Schedule>;
+}
+declare function updateSchedule$1(httpClient: HttpClient): UpdateScheduleSignature;
+interface UpdateScheduleSignature {
+    /**
+     * 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 - Schedule ID.
+     * @returns Updated schedule.
+     */
+    (_id: string, schedule: UpdateSchedule, options?: UpdateScheduleOptions | undefined): Promise<Schedule>;
+}
+declare function cancelSchedule$1(httpClient: HttpClient): CancelScheduleSignature;
+interface CancelScheduleSignature {
+    /**
+     * 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 - ID of the schedule to cancel.
+     */
+    (scheduleId: string, options?: CancelScheduleOptions | undefined): Promise<CancelScheduleResponse>;
+}
+declare const onScheduleCancelled$1: EventDefinition<ScheduleCancelledEnvelope, "wix.calendar.v3.schedule_cancelled">;
+declare const onScheduleCloned$1: EventDefinition<ScheduleClonedEnvelope, "wix.calendar.v3.schedule_cloned">;
+declare const onScheduleCreated$1: EventDefinition<ScheduleCreatedEnvelope, "wix.calendar.v3.schedule_created">;
+declare const onScheduleUpdated$1: EventDefinition<ScheduleUpdatedEnvelope, "wix.calendar.v3.schedule_updated">;
+
+declare const getSchedule: MaybeContext<BuildRESTFunction<typeof getSchedule$1> & typeof getSchedule$1>;
+declare const querySchedules: MaybeContext<BuildRESTFunction<typeof querySchedules$1> & typeof querySchedules$1>;
+declare const createSchedule: MaybeContext<BuildRESTFunction<typeof createSchedule$1> & typeof createSchedule$1>;
+declare const updateSchedule: MaybeContext<BuildRESTFunction<typeof updateSchedule$1> & typeof updateSchedule$1>;
+declare const cancelSchedule: MaybeContext<BuildRESTFunction<typeof cancelSchedule$1> & typeof cancelSchedule$1>;
+/**
+ * Triggered when a schedule is canceled.
+ */
+declare const onScheduleCancelled: BuildEventDefinition<typeof onScheduleCancelled$1>;
+/**
+ * Triggered when a schedule is cloned.
+ */
+declare const onScheduleCloned: BuildEventDefinition<typeof onScheduleCloned$1>;
+/**
+ * Triggered when a schedule is created.
+ */
+declare const onScheduleCreated: BuildEventDefinition<typeof onScheduleCreated$1>;
+/**
+ * Triggered when a schedule is updated.
+ */
+declare const onScheduleUpdated: BuildEventDefinition<typeof onScheduleUpdated$1>;
+
+export { CancelScheduleOptions, CancelScheduleResponse, CreateScheduleOptions, GetScheduleOptions, QuerySchedulesOptions, Schedule, ScheduleCancelledEnvelope, ScheduleClonedEnvelope, ScheduleCreatedEnvelope, ScheduleUpdatedEnvelope, SchedulesQueryBuilder, UpdateSchedule, UpdateScheduleOptions, cancelSchedule, createSchedule, getSchedule, onScheduleCancelled, onScheduleCloned, onScheduleCreated, onScheduleUpdated, querySchedules, updateSchedule };