@wix/auto_sdk_table-reservations_experiences 1.0.0

package/build/cjs/index.d.ts

@@ -0,0 +1,85 @@
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { Experience, UpdateExperience, ExperiencesQueryBuilder, BulkUpdateExperienceTagsOptions, BulkUpdateExperienceTagsResponse, BulkUpdateExperienceTagsApplicationErrors, BulkUpdateExperienceTagsByFilterOptions, BulkUpdateExperienceTagsByFilterResponse, BulkUpdateExperienceTagsByFilterApplicationErrors, ExperienceCreatedEnvelope, ExperienceTagsModifiedEnvelope, ExperienceUpdatedEnvelope } from './index.typings.js';
+export { ActionEvent, Address, AddressHint, Alignment, AlignmentWithLiterals, AnchorData, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AppTypeWithLiterals, ApplicationError, Approval, AspectRatio, AspectRatioWithLiterals, AudioData, Background, BackgroundBackgroundOneOf, BackgroundType, BackgroundTypeWithLiterals, BaseEventMetadata, BlockquoteData, BookingData, Border, BorderColors, BulkActionMetadata, BulkUpdateExperienceTagsByFilterRequest, BulkUpdateExperienceTagsRequest, BulkUpdateExperienceTagsResult, BulletedListData, BusinessSchedule, ButtonData, ButtonDataType, ButtonDataTypeWithLiterals, ButtonStyles, CaptionData, CardStyles, Categories, CellStyle, ChangeContext, ChangeContextPayloadOneOf, CodeBlockData, CollapsibleListData, ColorData, Colors, Configuration, ConsentPolicy, CreateExperienceRequest, CreateExperienceResponse, Crop, CropWithLiterals, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, CustomFieldDefinition, DayOfWeek, DayOfWeekWithLiterals, Decoration, DecorationDataOneOf, DecorationType, DecorationTypeWithLiterals, Design, Dimensions, Direction, DirectionWithLiterals, DisplayInfo, DividerData, DividerDataAlignment, DividerDataAlignmentWithLiterals, DocumentStyle, DomainEvent, DomainEventBodyOneOf, EmailMarketingCheckbox, EmbedData, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, Entry, EntryRecurrenceOptionsOneOf, EventData, EventMetadata, ExperiencesQueryResult, ExtendedFields, FileData, FileSource, FileSourceDataOneOf, FontSizeData, FontType, FontTypeWithLiterals, GIF, GIFData, GIFType, GIFTypeWithLiterals, GalleryData, GalleryOptions, GalleryOptionsLayout, GeoCoordinates, GetExperienceRequest, GetExperienceResponse, Gradient, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataStyles, ImageStyles, InitialExpandedItems, InitialExpandedItemsWithLiterals, Item, ItemDataOneOf, ItemMetadata, ItemStyle, Layout, LayoutCellData, LayoutType, LayoutTypeWithLiterals, LayoutWithLiterals, LineStyle, LineStyleWithLiterals, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListValue, Locale, MapData, MapSettings, MapType, MapTypeWithLiterals, MaxGuests, Media, MentionData, MessageEnvelope, Metadata, Mode, ModeWithLiterals, Multilingual, Node, NodeDataOneOf, NodeStyle, NodeType, NodeTypeWithLiterals, NoticePeriod, NullValue, NullValueWithLiterals, Oembed, OnOptions, OnOptionsOptionsOneOf, OneTimeOptions, OnlineReservations, OnlineReservationsBusinessSchedule, Option, OptionDesign, OptionLayout, OrderedListData, Orientation, OrientationWithLiterals, PDFSettings, ParagraphData, PartySize, PaymentPolicy, PaymentPolicyOptionsOneOf, PaymentPolicyType, PaymentPolicyTypeWithLiterals, PerGuestOptions, Permissions, Placement, PlacementType, PlacementTypeWithLiterals, PlacementWithLiterals, PlaybackOptions, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataAlignmentWithLiterals, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Poll, PollData, PollDataLayout, PollDesign, PollLayout, PollLayoutDirection, PollLayoutDirectionWithLiterals, PollLayoutType, PollLayoutTypeWithLiterals, Position, PositionWithLiterals, PricingData, PrivacyPolicy, PrivacyPolicyValueOneOf, Properties, PropertiesChange, QueryExperiencesRequest, QueryExperiencesResponse, Recurrence, RecurrenceWithLiterals, Rel, ReservationForm, Resizing, ResizingWithLiterals, ResolutionMethod, ResolutionMethodWithLiterals, RestoreInfo, RibbonStyles, RichContent, Settings, SiteCloned, SiteCreated, SitePropertiesEvent, SitePropertiesNotification, SortOrder, SortOrderWithLiterals, Sorting, Source, SourceWithLiterals, SpecialHourPeriod, SpecificTablesOptions, Spoiler, SpoilerData, StartDaysAndTimes, StartDaysAndTimesDayOfWeek, StartDaysAndTimesDayOfWeekWithLiterals, Styles, StylesBorder, StylesPosition, StylesPositionWithLiterals, SupportedLanguage, Table, TableAssignmentType, TableAssignmentTypeWithLiterals, TableAvailabilityType, TableAvailabilityTypeWithLiterals, TableCellData, TableCombination, TableData, TableManagement, TableManagementMode, TableManagementModeWithLiterals, TableManagementOptionsOneOf, TagList, Tags, TagsModified, Target, TargetWithLiterals, TermsAndConditions, TermsAndConditionsValueOneOf, TextAlignment, TextAlignmentWithLiterals, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, ThumbnailsAlignmentWithLiterals, TimePeriod, Translation, Type, TypeWithLiterals, Unit, UnitWithLiterals, UpdateExperienceRequest, UpdateExperienceResponse, VerticalAlignment, VerticalAlignmentWithLiterals, Video, VideoData, ViewMode, ViewModeWithLiterals, ViewRole, ViewRoleWithLiterals, VoteRole, VoteRoleWithLiterals, WebhookIdentityType, WebhookIdentityTypeWithLiterals, WeeklyOptions, Width, WidthType, WidthTypeWithLiterals, WidthWithLiterals } from './index.typings.js';
+
+declare function createExperience$1(httpClient: HttpClient): CreateExperienceSignature;
+interface CreateExperienceSignature {
+    /**
+     * Creates an Experience.
+     * @param - Experience to be created.
+     * @returns The created Experience.
+     */
+    (experience: NonNullablePaths<Experience, `configuration` | `configuration.displayInfo` | `configuration.displayInfo.name` | `configuration.onlineReservations` | `configuration.onlineReservations.approval` | `configuration.onlineReservations.approval.mode` | `configuration.onlineReservations.maxGuests.number` | `configuration.onlineReservations.maximumReservationNotice.number` | `configuration.onlineReservations.maximumReservationNotice.unit` | `configuration.onlineReservations.minimumReservationNotice.number` | `configuration.onlineReservations.minimumReservationNotice.unit` | `configuration.onlineReservations.partySize` | `configuration.onlineReservations.partySize.max` | `configuration.onlineReservations.partySize.min` | `configuration.paymentPolicy` | `configuration.paymentPolicy.paymentPolicyType` | `reservationLocationId`, 5>): Promise<NonNullablePaths<Experience, `configuration.paymentPolicy.paymentPolicyType` | `configuration.onlineReservations.minimumReservationNotice.unit` | `configuration.onlineReservations.approval.mode` | `configuration.onlineReservations.businessSchedule.entries` | `configuration.onlineReservations.businessSchedule.entries.${number}.recurrence` | `configuration.reservationForm.customFieldDefinitions` | `configuration.tableManagement.onOptions.specificTablesOptions.tables` | `configuration.tableManagement.onOptions.specificTablesOptions.tableCombinations` | `configuration.tableManagement.onOptions.tableAvailabilityType` | `configuration.tableManagement.onOptions.tableAssignmentType` | `configuration.tableManagement.mode` | `tags.privateTags.tagIds`, 7>>;
+}
+declare function getExperience$1(httpClient: HttpClient): GetExperienceSignature;
+interface GetExperienceSignature {
+    /**
+     * Retrieves an Experience.
+     * @param - ID of the Experience to retrieve.
+     * @returns The requested Experience.
+     */
+    (experienceId: string): Promise<NonNullablePaths<Experience, `configuration.paymentPolicy.paymentPolicyType` | `configuration.onlineReservations.minimumReservationNotice.unit` | `configuration.onlineReservations.approval.mode` | `configuration.onlineReservations.businessSchedule.entries` | `configuration.onlineReservations.businessSchedule.entries.${number}.recurrence` | `configuration.reservationForm.customFieldDefinitions` | `configuration.tableManagement.onOptions.specificTablesOptions.tables` | `configuration.tableManagement.onOptions.specificTablesOptions.tableCombinations` | `configuration.tableManagement.onOptions.tableAvailabilityType` | `configuration.tableManagement.onOptions.tableAssignmentType` | `configuration.tableManagement.mode` | `tags.privateTags.tagIds`, 7>>;
+}
+declare function updateExperience$1(httpClient: HttpClient): UpdateExperienceSignature;
+interface UpdateExperienceSignature {
+    /**
+     * Updates an Experience.
+     *
+     * Each time the Experience is updated,
+     * `revision` increments by 1.
+     * The current `revision` must be passed when updating the Experience.
+     * This ensures you're working with the latest Experience
+     * and prevents unintended overwrites.
+     * @param - Experience ID.
+     * @returns Updated Experience.
+     */
+    (_id: string, experience: NonNullablePaths<UpdateExperience, `revision`, 2>): Promise<NonNullablePaths<Experience, `configuration.paymentPolicy.paymentPolicyType` | `configuration.onlineReservations.minimumReservationNotice.unit` | `configuration.onlineReservations.approval.mode` | `configuration.onlineReservations.businessSchedule.entries` | `configuration.onlineReservations.businessSchedule.entries.${number}.recurrence` | `configuration.reservationForm.customFieldDefinitions` | `configuration.tableManagement.onOptions.specificTablesOptions.tables` | `configuration.tableManagement.onOptions.specificTablesOptions.tableCombinations` | `configuration.tableManagement.onOptions.tableAvailabilityType` | `configuration.tableManagement.onOptions.tableAssignmentType` | `configuration.tableManagement.mode` | `tags.privateTags.tagIds`, 7>>;
+}
+declare function queryExperiences$1(httpClient: HttpClient): QueryExperiencesSignature;
+interface QueryExperiencesSignature {
+    /**
+     * Queries Experiences.
+     */
+    (): ExperiencesQueryBuilder;
+}
+declare function bulkUpdateExperienceTags$1(httpClient: HttpClient): BulkUpdateExperienceTagsSignature;
+interface BulkUpdateExperienceTagsSignature {
+    /**
+     * Synchronously update tags on multiple Experiences, by list of Experiences ids
+     * A tag that appears both in the list of assign and unassign tags, will be assigned
+     * @param - List of NileProtoTagsEntities that their tags will update.
+     */
+    (experienceIds: string[], options?: BulkUpdateExperienceTagsOptions): Promise<NonNullablePaths<BulkUpdateExperienceTagsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6> & {
+        __applicationErrorsType?: BulkUpdateExperienceTagsApplicationErrors;
+    }>;
+}
+declare function bulkUpdateExperienceTagsByFilter$1(httpClient: HttpClient): BulkUpdateExperienceTagsByFilterSignature;
+interface BulkUpdateExperienceTagsByFilterSignature {
+    /**
+     * Asynchronously update tags on multiple Experiences, by provided filter
+     * An empty filter will update all Experiences
+     * A tag that appears both in the list of assign and unassign tags, will be assigned
+     * @param - Filter
+     */
+    (filter: Record<string, any>, options?: BulkUpdateExperienceTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateExperienceTagsByFilterResponse, `jobId`, 2> & {
+        __applicationErrorsType?: BulkUpdateExperienceTagsByFilterApplicationErrors;
+    }>;
+}
+declare const onExperienceCreated$1: EventDefinition<ExperienceCreatedEnvelope, "wix.table_reservations.v1.experience_created">;
+declare const onExperienceTagsModified$1: EventDefinition<ExperienceTagsModifiedEnvelope, "wix.table_reservations.v1.experience_tags_modified">;
+declare const onExperienceUpdated$1: EventDefinition<ExperienceUpdatedEnvelope, "wix.table_reservations.v1.experience_updated">;
+
+declare const createExperience: MaybeContext<BuildRESTFunction<typeof createExperience$1> & typeof createExperience$1>;
+declare const getExperience: MaybeContext<BuildRESTFunction<typeof getExperience$1> & typeof getExperience$1>;
+declare const updateExperience: MaybeContext<BuildRESTFunction<typeof updateExperience$1> & typeof updateExperience$1>;
+declare const queryExperiences: MaybeContext<BuildRESTFunction<typeof queryExperiences$1> & typeof queryExperiences$1>;
+declare const bulkUpdateExperienceTags: MaybeContext<BuildRESTFunction<typeof bulkUpdateExperienceTags$1> & typeof bulkUpdateExperienceTags$1>;
+declare const bulkUpdateExperienceTagsByFilter: MaybeContext<BuildRESTFunction<typeof bulkUpdateExperienceTagsByFilter$1> & typeof bulkUpdateExperienceTagsByFilter$1>;
+/** */
+declare const onExperienceCreated: BuildEventDefinition<typeof onExperienceCreated$1> & typeof onExperienceCreated$1;
+/** */
+declare const onExperienceTagsModified: BuildEventDefinition<typeof onExperienceTagsModified$1> & typeof onExperienceTagsModified$1;
+/** */
+declare const onExperienceUpdated: BuildEventDefinition<typeof onExperienceUpdated$1> & typeof onExperienceUpdated$1;
+
+export { BulkUpdateExperienceTagsApplicationErrors, BulkUpdateExperienceTagsByFilterApplicationErrors, BulkUpdateExperienceTagsByFilterOptions, BulkUpdateExperienceTagsByFilterResponse, BulkUpdateExperienceTagsOptions, BulkUpdateExperienceTagsResponse, Experience, ExperienceCreatedEnvelope, ExperienceTagsModifiedEnvelope, ExperienceUpdatedEnvelope, ExperiencesQueryBuilder, UpdateExperience, bulkUpdateExperienceTags, bulkUpdateExperienceTagsByFilter, createExperience, getExperience, onExperienceCreated, onExperienceTagsModified, onExperienceUpdated, queryExperiences, updateExperience };