@wix/auto_sdk_calendar_schedules 1.0.0

package/build/cjs/src/calendar-v3-schedule-schedules.public.d.ts

@@ -0,0 +1,86 @@
+import { EventDefinition, HttpClient } from '@wix/sdk-types';
+import { CancelScheduleOptions, CancelScheduleResponse, CancelScheduleResponseNonNullableFields, CreateScheduleOptions, GetScheduleOptions, QuerySchedulesOptions, Schedule, ScheduleCancelledEnvelope, ScheduleClonedEnvelope, ScheduleCreatedEnvelope, ScheduleNonNullableFields, ScheduleUpdatedEnvelope, SchedulesQueryBuilder, UpdateSchedule, UpdateScheduleOptions } from './calendar-v3-schedule-schedules.universal.js';
+export declare const __metadata: {
+    PACKAGE_NAME: string;
+};
+export declare function getSchedule(httpClient: HttpClient): GetScheduleSignature;
+interface GetScheduleSignature {
+    /**
+     * Retrieves a schedule.
+     * @param - ID of the schedule to retrieve.
+     * @returns Retrieved schedule.
+     */
+    (scheduleId: string | null, options?: GetScheduleOptions | undefined): Promise<Schedule & ScheduleNonNullableFields>;
+}
+export declare function querySchedules(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;
+}
+export declare function createSchedule(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 & ScheduleNonNullableFields>;
+}
+export declare function updateSchedule(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 | null, schedule: UpdateSchedule, options?: UpdateScheduleOptions | undefined): Promise<Schedule & ScheduleNonNullableFields>;
+}
+export declare function cancelSchedule(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 | null, options?: CancelScheduleOptions | undefined): Promise<CancelScheduleResponse & CancelScheduleResponseNonNullableFields>;
+}
+export declare const onScheduleCancelled: EventDefinition<ScheduleCancelledEnvelope, "wix.calendar.v3.schedule_cancelled">;
+export declare const onScheduleCloned: EventDefinition<ScheduleClonedEnvelope, "wix.calendar.v3.schedule_cloned">;
+export declare const onScheduleCreated: EventDefinition<ScheduleCreatedEnvelope, "wix.calendar.v3.schedule_created">;
+export declare const onScheduleUpdated: EventDefinition<ScheduleUpdatedEnvelope, "wix.calendar.v3.schedule_updated">;
+export { ActionEvent, Address, AddressHint, Asset, BaseEventMetadata, BusinessSchedule, CancelScheduleOptions, CancelScheduleRequest, CancelScheduleResponse, CancelScheduleResponseNonNullableFields, Categories, ChangeContext, ChangeContextPayloadOneOf, CloneScheduleRequest, CloneScheduleResponse, CommonIdentificationData, CommonIdentificationDataIdOneOf, ConferencingDetails, ConsentPolicy, CreateScheduleOptions, CreateScheduleRequest, CreateScheduleResponse, CreateScheduleResponseNonNullableFields, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DayOfWeek, DeleteContext, DeleteStatus, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendedFields, GeoCoordinates, GetScheduleOptions, GetScheduleRequest, GetScheduleResponse, GetScheduleResponseNonNullableFields, IdentificationData, IdentificationDataIdOneOf, IdentityType, Locale, Location, LocationType, MessageEnvelope, MetaSiteSpecialEvent, MetaSiteSpecialEventPayloadOneOf, Multilingual, Namespace, NamespaceChanged, ParticipantNotification, Permission, PlacementType, Properties, PropertiesChange, QuerySchedulesOptions, QuerySchedulesRequest, QuerySchedulesResponse, QuerySchedulesResponseNonNullableFields, RequestedFields, ResolutionMethod, RestoreInfo, Role, Schedule, ScheduleCancelled, ScheduleCancelledEnvelope, ScheduleCloned, ScheduleClonedEnvelope, ScheduleCreatedEnvelope, ScheduleNonNullableFields, ScheduleUpdatedEnvelope, ScheduleUpdatedWithMetadata, SchedulesQueryBuilder, SchedulesQueryResult, ServiceProvisioned, ServiceRemoved, SiteCloned, SiteCreated, SiteCreatedContext, SiteDeleted, SiteHardDeleted, SiteMarkedAsTemplate, SiteMarkedAsWixSite, SitePropertiesEvent, SitePropertiesNotification, SitePublished, SiteRenamed, SiteTransferred, SiteUndeleted, SiteUnpublished, SpecialHourPeriod, State, Status, StudioAssigned, StudioUnassigned, SupportedLanguage, TimePeriod, Translation, Trigger, Type, UpdateSchedule, UpdateScheduleOptions, UpdateScheduleRequest, UpdateScheduleResponse, UpdateScheduleResponseNonNullableFields, V4SiteCreated, WebhookIdentityType, } from './calendar-v3-schedule-schedules.universal.js';

package/build/cjs/src/calendar-v3-schedule-schedules.public.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookIdentityType = exports.Type = exports.Trigger = exports.Status = exports.State = exports.SiteCreatedContext = exports.Role = exports.ResolutionMethod = exports.RequestedFields = exports.PlacementType = exports.Namespace = exports.LocationType = exports.IdentityType = exports.DeleteStatus = exports.DayOfWeek = exports.onScheduleUpdated = exports.onScheduleCreated = exports.onScheduleCloned = exports.onScheduleCancelled = exports.cancelSchedule = exports.updateSchedule = exports.createSchedule = exports.querySchedules = exports.getSchedule = exports.__metadata = void 0;
+const rename_all_nested_keys_1 = require("@wix/sdk-runtime/rename-all-nested-keys");
+const timestamp_1 = require("@wix/sdk-runtime/transformations/timestamp");
+const transform_paths_1 = require("@wix/sdk-runtime/transformations/transform-paths");
+const sdk_types_1 = require("@wix/sdk-types");
+const calendar_v3_schedule_schedules_universal_js_1 = require("./calendar-v3-schedule-schedules.universal.js");
+exports.__metadata = { PACKAGE_NAME: '@wix/calendar' };
+function getSchedule(httpClient) {
+    return (scheduleId, options) => (0, calendar_v3_schedule_schedules_universal_js_1.getSchedule)(scheduleId, options, 
+    // @ts-ignore
+    { httpClient });
+}
+exports.getSchedule = getSchedule;
+function querySchedules(httpClient) {
+    return (options) => (0, calendar_v3_schedule_schedules_universal_js_1.querySchedules)(options, 
+    // @ts-ignore
+    { httpClient });
+}
+exports.querySchedules = querySchedules;
+function createSchedule(httpClient) {
+    return (schedule, options) => (0, calendar_v3_schedule_schedules_universal_js_1.createSchedule)(schedule, options, 
+    // @ts-ignore
+    { httpClient });
+}
+exports.createSchedule = createSchedule;
+function updateSchedule(httpClient) {
+    return (_id, schedule, options) => (0, calendar_v3_schedule_schedules_universal_js_1.updateSchedule)(_id, schedule, options, 
+    // @ts-ignore
+    { httpClient });
+}
+exports.updateSchedule = updateSchedule;
+function cancelSchedule(httpClient) {
+    return (scheduleId, options) => (0, calendar_v3_schedule_schedules_universal_js_1.cancelSchedule)(scheduleId, options, 
+    // @ts-ignore
+    { httpClient });
+}
+exports.cancelSchedule = cancelSchedule;
+exports.onScheduleCancelled = (0, sdk_types_1.EventDefinition)('wix.calendar.v3.schedule_cancelled', true, (event) => (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)((0, transform_paths_1.transformPaths)(event, [
+    {
+        transformFn: timestamp_1.transformRESTTimestampToSDKTimestamp,
+        paths: [
+            { path: 'data.schedule.createdDate' },
+            { path: 'data.schedule.updatedDate' },
+            { path: 'metadata.eventTime' },
+        ],
+    },
+])))();
+exports.onScheduleCloned = (0, sdk_types_1.EventDefinition)('wix.calendar.v3.schedule_cloned', true, (event) => (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)((0, transform_paths_1.transformPaths)(event, [
+    {
+        transformFn: timestamp_1.transformRESTTimestampToSDKTimestamp,
+        paths: [
+            { path: 'data.schedule.createdDate' },
+            { path: 'data.schedule.updatedDate' },
+            { path: 'metadata.eventTime' },
+        ],
+    },
+])))();
+exports.onScheduleCreated = (0, sdk_types_1.EventDefinition)('wix.calendar.v3.schedule_created', true, (event) => (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)((0, transform_paths_1.transformPaths)(event, [
+    {
+        transformFn: timestamp_1.transformRESTTimestampToSDKTimestamp,
+        paths: [
+            { path: 'entity.createdDate' },
+            { path: 'entity.updatedDate' },
+            { path: 'metadata.eventTime' },
+        ],
+    },
+])))();
+exports.onScheduleUpdated = (0, sdk_types_1.EventDefinition)('wix.calendar.v3.schedule_updated', true, (event) => (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)((0, transform_paths_1.transformPaths)(event, [
+    {
+        transformFn: timestamp_1.transformRESTTimestampToSDKTimestamp,
+        paths: [
+            { path: 'entity.createdDate' },
+            { path: 'entity.updatedDate' },
+            { path: 'metadata.eventTime' },
+        ],
+    },
+])))();
+var calendar_v3_schedule_schedules_universal_js_2 = require("./calendar-v3-schedule-schedules.universal.js");
+Object.defineProperty(exports, "DayOfWeek", { enumerable: true, get: function () { return calendar_v3_schedule_schedules_universal_js_2.DayOfWeek; } });
+Object.defineProperty(exports, "DeleteStatus", { enumerable: true, get: function () { return calendar_v3_schedule_schedules_universal_js_2.DeleteStatus; } });
+Object.defineProperty(exports, "IdentityType", { enumerable: true, get: function () { return calendar_v3_schedule_schedules_universal_js_2.IdentityType; } });
+Object.defineProperty(exports, "LocationType", { enumerable: true, get: function () { return calendar_v3_schedule_schedules_universal_js_2.LocationType; } });
+Object.defineProperty(exports, "Namespace", { enumerable: true, get: function () { return calendar_v3_schedule_schedules_universal_js_2.Namespace; } });
+Object.defineProperty(exports, "PlacementType", { enumerable: true, get: function () { return calendar_v3_schedule_schedules_universal_js_2.PlacementType; } });
+Object.defineProperty(exports, "RequestedFields", { enumerable: true, get: function () { return calendar_v3_schedule_schedules_universal_js_2.RequestedFields; } });
+Object.defineProperty(exports, "ResolutionMethod", { enumerable: true, get: function () { return calendar_v3_schedule_schedules_universal_js_2.ResolutionMethod; } });
+Object.defineProperty(exports, "Role", { enumerable: true, get: function () { return calendar_v3_schedule_schedules_universal_js_2.Role; } });
+Object.defineProperty(exports, "SiteCreatedContext", { enumerable: true, get: function () { return calendar_v3_schedule_schedules_universal_js_2.SiteCreatedContext; } });
+Object.defineProperty(exports, "State", { enumerable: true, get: function () { return calendar_v3_schedule_schedules_universal_js_2.State; } });
+Object.defineProperty(exports, "Status", { enumerable: true, get: function () { return calendar_v3_schedule_schedules_universal_js_2.Status; } });
+Object.defineProperty(exports, "Trigger", { enumerable: true, get: function () { return calendar_v3_schedule_schedules_universal_js_2.Trigger; } });
+Object.defineProperty(exports, "Type", { enumerable: true, get: function () { return calendar_v3_schedule_schedules_universal_js_2.Type; } });
+Object.defineProperty(exports, "WebhookIdentityType", { enumerable: true, get: function () { return calendar_v3_schedule_schedules_universal_js_2.WebhookIdentityType; } });
+//# sourceMappingURL=calendar-v3-schedule-schedules.public.js.map

package/build/cjs/src/calendar-v3-schedule-schedules.public.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"calendar-v3-schedule-schedules.public.js","sourceRoot":"","sources":["../../../src/calendar-v3-schedule-schedules.public.ts"],"names":[],"mappings":";;;AAAA,oFAAkG;AAClG,0EAAkG;AAClG,sFAAkF;AAClF,8CAA6D;AAC7D,+GAqBuD;AAE1C,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC;AAE5D,SAAgB,WAAW,CAAC,UAAsB;IAChD,OAAO,CAAC,UAAyB,EAAE,OAA4B,EAAE,EAAE,CACjE,IAAA,yDAAoB,EAClB,UAAU,EACV,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,kCAQC;AAcD,SAAgB,cAAc,CAC5B,UAAsB;IAEtB,OAAO,CAAC,OAA+B,EAAE,EAAE,CACzC,IAAA,4DAAuB,EACrB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,wCASC;AAwBD,SAAgB,cAAc,CAC5B,UAAsB;IAEtB,OAAO,CAAC,QAAkB,EAAE,OAA+B,EAAE,EAAE,CAC7D,IAAA,4DAAuB,EACrB,QAAQ,EACR,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAVD,wCAUC;AAmBD,SAAgB,cAAc,CAC5B,UAAsB;IAEtB,OAAO,CACL,GAAkB,EAClB,QAAwB,EACxB,OAA+B,EAC/B,EAAE,CACF,IAAA,4DAAuB,EACrB,GAAG,EACH,QAAQ,EACR,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAfD,wCAeC;AAsBD,SAAgB,cAAc,CAC5B,UAAsB;IAEtB,OAAO,CAAC,UAAyB,EAAE,OAA+B,EAAE,EAAE,CACpE,IAAA,4DAAuB,EACrB,UAAU,EACV,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAVD,wCAUC;AAmBY,QAAA,mBAAmB,GAAG,IAAA,2BAAe,EAChD,oCAAoC,EACpC,IAAI,EACJ,CAAC,KAAgC,EAAE,EAAE,CACnC,IAAA,gEAAuC,EACrC,IAAA,gCAAc,EAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,gDAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,2BAA2B,EAAE;YACrC,EAAE,IAAI,EAAE,2BAA2B,EAAE;YACrC,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;CACF,CAAC,CACH,CACJ,EAA6B,CAAC;AAClB,QAAA,gBAAgB,GAAG,IAAA,2BAAe,EAC7C,iCAAiC,EACjC,IAAI,EACJ,CAAC,KAA6B,EAAE,EAAE,CAChC,IAAA,gEAAuC,EACrC,IAAA,gCAAc,EAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,gDAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,2BAA2B,EAAE;YACrC,EAAE,IAAI,EAAE,2BAA2B,EAAE;YACrC,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;CACF,CAAC,CACH,CACJ,EAA0B,CAAC;AACf,QAAA,iBAAiB,GAAG,IAAA,2BAAe,EAC9C,kCAAkC,EAClC,IAAI,EACJ,CAAC,KAA8B,EAAE,EAAE,CACjC,IAAA,gEAAuC,EACrC,IAAA,gCAAc,EAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,gDAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;CACF,CAAC,CACH,CACJ,EAA2B,CAAC;AAChB,QAAA,iBAAiB,GAAG,IAAA,2BAAe,EAC9C,kCAAkC,EAClC,IAAI,EACJ,CAAC,KAA8B,EAAE,EAAE,CACjC,IAAA,gEAAuC,EACrC,IAAA,gCAAc,EAAC,KAAK,EAAE;IACpB;QACE,WAAW,EAAE,gDAAoC;QACjD,KAAK,EAAE;YACL,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;YAC9B,EAAE,IAAI,EAAE,oBAAoB,EAAE;SAC/B;KACF;CACF,CAAC,CACH,CACJ,EAA2B,CAAC;AAE7B,6GAkHuD;AArFrD,wIAAA,SAAS,OAAA;AAET,2IAAA,YAAY,OAAA;AAgBZ,2IAAA,YAAY,OAAA;AAGZ,2IAAA,YAAY,OAAA;AAKZ,wIAAA,SAAS,OAAA;AAIT,4IAAA,aAAa,OAAA;AAOb,8IAAA,eAAe,OAAA;AACf,+IAAA,gBAAgB,OAAA;AAEhB,mIAAA,IAAI,OAAA;AAgBJ,iJAAA,kBAAkB,OAAA;AAalB,oIAAA,KAAK,OAAA;AACL,qIAAA,MAAM,OAAA;AAMN,sIAAA,OAAO,OAAA;AACP,mIAAA,IAAI,OAAA;AAOJ,kJAAA,mBAAmB,OAAA"}