@wix/auto_sdk_table-reservations_experiences 1.0.36 → 1.0.37

package/build/internal/es/{table-reservations-v1-experience-experiences.universal-BAFNaOzr.d.mts → table-reservations-v1-experience-experiences.universal-CHddGarE.d.mts}

@@ -3673,7 +3673,7 @@ interface BulkUpdateExperienceTagsByFilterResponse {
 }
 interface BulkArchiveExperiencesRequest {
     /**
-     * IDs of experiences to archive.
+     * IDs of the experiences to archive.
      * @minSize 1
      * @maxSize 100
      * @format GUID
@@ -3682,12 +3682,12 @@ interface BulkArchiveExperiencesRequest {
 }
 interface BulkArchiveExperiencesResponse {
     /**
-     * Result of bulk archive action
+     * Experiences updated by the bulk action.
      * @minSize 1
      * @maxSize 100
      */
     results?: BulkArchiveExperiencesResult[];
-    /** Metadata for the API call. */
+    /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
 interface BulkArchiveExperiencesResult {
@@ -3696,7 +3696,7 @@ interface BulkArchiveExperiencesResult {
 }
 interface BulkUnarchiveExperiencesRequest {
     /**
-     * Experience IDs to unarchive.
+     * IDs of the experiences to unarchive.
      * @minSize 1
      * @maxSize 100
      * @format GUID
@@ -3705,12 +3705,12 @@ interface BulkUnarchiveExperiencesRequest {
 }
 interface BulkUnarchiveExperiencesResponse {
     /**
-     * Result of bulk unarchive action
+     * Experiences updated by the bulk action.
      * @minSize 1
      * @maxSize 100
      */
     results?: BulkUnarchiveExperiencesResult[];
-    /** Metadata for the API call. */
+    /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
 interface BulkUnarchiveExperiencesResult {
@@ -4248,7 +4248,6 @@ interface ExperienceCreatedEnvelope {
  * @webhook
  * @eventType wix.table_reservations.v1.experience_created
  * @slug created
- * @documentationMaturity preview
  */
 declare function onExperienceCreated(handler: (event: ExperienceCreatedEnvelope) => void | Promise<void>): void;
 interface ExperienceTagsModifiedEnvelope {
@@ -4263,7 +4262,6 @@ interface ExperienceTagsModifiedEnvelope {
  * @webhook
  * @eventType wix.table_reservations.v1.experience_tags_modified
  * @slug tags_modified
- * @documentationMaturity preview
  */
 declare function onExperienceTagsModified(handler: (event: ExperienceTagsModifiedEnvelope) => void | Promise<void>): void;
 interface ExperienceUpdatedEnvelope {
@@ -4280,14 +4278,12 @@ interface ExperienceUpdatedEnvelope {
  * @webhook
  * @eventType wix.table_reservations.v1.experience_updated
  * @slug updated
- * @documentationMaturity preview
  */
 declare function onExperienceUpdated(handler: (event: ExperienceUpdatedEnvelope) => void | Promise<void>): void;
 /**
  * Creates an experience.
  * @param experience - Experience to create.
  * @public
- * @documentationMaturity preview
  * @requiredField experience
  * @requiredField experience.configuration
  * @requiredField experience.configuration.displayInfo
@@ -4316,7 +4312,6 @@ declare function createExperience(experience: NonNullablePaths<Experience, `conf
  * Retrieves an experience.
  * @param experienceId - ID of the experience to retrieve.
  * @public
- * @documentationMaturity preview
  * @requiredField experienceId
  * @permissionId TABLE_RESERVATIONS.EXPERIENCE_READ
  * @permissionId TABLE_RESERVATIONS.EXPERIENCE_READ_FULL
@@ -4331,7 +4326,6 @@ declare function getExperience(experienceId: string): Promise<NonNullablePaths<E
  * The slug is a URL-friendly identifier for the experience page, derived from the experience display name in kebab-case format. For example, "wine-tasting-event".
  * @param slug - Slug of the experience to retrieve.
  * @public
- * @documentationMaturity preview
  * @requiredField slug
  * @permissionId TABLE_RESERVATIONS.EXPERIENCE_READ
  * @permissionId TABLE_RESERVATIONS.EXPERIENCE_READ_FULL
@@ -4347,7 +4341,6 @@ declare function getExperienceBySlug(slug: string): Promise<NonNullablePaths<Get
  * This ensures you're working with the latest experience information and prevents unintended overwrites.
  * @param _id - Experience ID.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @requiredField experience
  * @requiredField experience.revision
@@ -4416,7 +4409,6 @@ interface UpdateExperience {
  * For a detailed list of supported operations, see the [Supported Filters and Sorting](https://dev.wix.com/docs/api-reference/business-solutions/restaurants/wix-restaurants-new/reservations/experiences/sorting-and-filtering) article.
  * To learn how to query reservation locations, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
  * @public
- * @documentationMaturity preview
  * @permissionId TABLE_RESERVATIONS.EXPERIENCE_READ
  * @permissionId TABLE_RESERVATIONS.EXPERIENCE_READ_FULL
  * @applicableIdentity APP
@@ -4439,70 +4431,50 @@ interface ExperiencesQueryResult extends QueryCursorResult {
 interface ExperiencesQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     eq: (propertyName: '_id' | 'reservationLocationId' | '_createdDate' | '_updatedDate' | 'configuration.displayInfo.name' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.startDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.endDate' | 'configuration.onlineReservations.businessSchedule.entries.oneTimeOptions.startDate' | 'configuration.visible' | 'configuration.tableManagement.onOptions.specificTablesOptions.reservedForExperience' | 'tags.privateTags.tagIds' | 'tags.publicTags.tagIds', value: any) => ExperiencesQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     ne: (propertyName: '_id' | 'reservationLocationId' | '_createdDate' | '_updatedDate' | 'configuration.displayInfo.name' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.startDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.endDate' | 'configuration.onlineReservations.businessSchedule.entries.oneTimeOptions.startDate' | 'configuration.visible' | 'configuration.tableManagement.onOptions.specificTablesOptions.reservedForExperience' | 'tags.privateTags.tagIds' | 'tags.publicTags.tagIds', value: any) => ExperiencesQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     ge: (propertyName: '_id' | 'reservationLocationId' | '_createdDate' | '_updatedDate' | 'configuration.displayInfo.name' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.startDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.endDate' | 'configuration.onlineReservations.businessSchedule.entries.oneTimeOptions.startDate', value: any) => ExperiencesQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     gt: (propertyName: '_id' | 'reservationLocationId' | '_createdDate' | '_updatedDate' | 'configuration.displayInfo.name' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.startDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.endDate' | 'configuration.onlineReservations.businessSchedule.entries.oneTimeOptions.startDate', value: any) => ExperiencesQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     le: (propertyName: '_id' | 'reservationLocationId' | '_createdDate' | '_updatedDate' | 'configuration.displayInfo.name' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.startDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.endDate' | 'configuration.onlineReservations.businessSchedule.entries.oneTimeOptions.startDate', value: any) => ExperiencesQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     lt: (propertyName: '_id' | 'reservationLocationId' | '_createdDate' | '_updatedDate' | 'configuration.displayInfo.name' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.startDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.endDate' | 'configuration.onlineReservations.businessSchedule.entries.oneTimeOptions.startDate', value: any) => ExperiencesQueryBuilder;
     /** @param propertyName - Property whose value is compared with `string`.
      * @param string - String to compare against. Case-insensitive.
-     * @documentationMaturity preview
      */
     startsWith: (propertyName: '_id' | 'reservationLocationId' | 'configuration.displayInfo.name' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.startDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.endDate' | 'configuration.onlineReservations.businessSchedule.entries.oneTimeOptions.startDate', value: string) => ExperiencesQueryBuilder;
     /** @param propertyName - Property whose value is compared with `values`.
      * @param values - List of values to compare against.
-     * @documentationMaturity preview
      */
     hasSome: (propertyName: '_id' | 'reservationLocationId' | '_createdDate' | '_updatedDate' | 'configuration.displayInfo.name' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.startDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.endDate' | 'configuration.onlineReservations.businessSchedule.entries.oneTimeOptions.startDate' | 'configuration.visible' | 'configuration.tableManagement.onOptions.specificTablesOptions.reservedForExperience' | 'tags.privateTags.tagIds' | 'tags.publicTags.tagIds', value: any[]) => ExperiencesQueryBuilder;
     /** @param propertyName - Property whose value is compared with `values`.
      * @param values - List of values to compare against.
-     * @documentationMaturity preview
      */
     hasAll: (propertyName: 'tags.privateTags.tagIds' | 'tags.publicTags.tagIds', value: any[]) => ExperiencesQueryBuilder;
-    /** @documentationMaturity preview */
     in: (propertyName: '_id' | 'reservationLocationId' | '_createdDate' | '_updatedDate' | 'configuration.displayInfo.name' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.startDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.endDate' | 'configuration.onlineReservations.businessSchedule.entries.oneTimeOptions.startDate' | 'configuration.visible' | 'configuration.tableManagement.onOptions.specificTablesOptions.reservedForExperience' | 'tags.privateTags.tagIds' | 'tags.publicTags.tagIds', value: any) => ExperiencesQueryBuilder;
-    /** @documentationMaturity preview */
     exists: (propertyName: '_id' | 'reservationLocationId' | '_createdDate' | '_updatedDate' | 'configuration.displayInfo.name' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.startDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.endDate' | 'configuration.onlineReservations.businessSchedule.entries.oneTimeOptions.startDate' | 'configuration.visible' | 'configuration.tableManagement.onOptions.specificTablesOptions.reservedForExperience' | 'tags.privateTags.tagIds' | 'tags.publicTags.tagIds', value: boolean) => ExperiencesQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
-     * @documentationMaturity preview
-     */
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
     ascending: (...propertyNames: Array<'_id' | 'reservationLocationId' | '_createdDate' | '_updatedDate' | 'configuration.displayInfo.name' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.startDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.endDate' | 'configuration.onlineReservations.businessSchedule.entries.oneTimeOptions.startDate' | 'configuration.visible' | 'configuration.tableManagement.onOptions.specificTablesOptions.reservedForExperience' | 'tags.privateTags.tagIds' | 'tags.publicTags.tagIds'>) => ExperiencesQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
-     * @documentationMaturity preview
-     */
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
     descending: (...propertyNames: Array<'_id' | 'reservationLocationId' | '_createdDate' | '_updatedDate' | 'configuration.displayInfo.name' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.startDate' | 'configuration.onlineReservations.businessSchedule.entries.weeklyOptions.endDate' | 'configuration.onlineReservations.businessSchedule.entries.oneTimeOptions.startDate' | 'configuration.visible' | 'configuration.tableManagement.onOptions.specificTablesOptions.reservedForExperience' | 'tags.privateTags.tagIds' | 'tags.publicTags.tagIds'>) => ExperiencesQueryBuilder;
-    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
-     * @documentationMaturity preview
-     */
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
     limit: (limit: number) => ExperiencesQueryBuilder;
-    /** @param cursor - A pointer to specific record
-     * @documentationMaturity preview
-     */
+    /** @param cursor - A pointer to specific record */
     skipTo: (cursor: string) => ExperiencesQueryBuilder;
-    /** @documentationMaturity preview */
     find: () => Promise<ExperiencesQueryResult>;
 }
 /**
@@ -4779,7 +4751,6 @@ type ExperienceSearch = {
  * Synchronously updates [tags](https://dev.wix.com/docs/api-reference/business-management/tags/introduction) on multiple experiences by experience IDs. A tag that appears in both assign and unassign lists is assigned.
  * @param experienceIds - List of experience IDs to update tags for.
  * @public
- * @documentationMaturity preview
  * @requiredField experienceIds
  * @permissionId TABLE_RESERVATIONS.EXPERIENCE_UPDATE_TAGS
  * @applicableIdentity APP
@@ -4798,7 +4769,6 @@ interface BulkUpdateExperienceTagsOptions {
  * Asynchronously updates [tags](https://dev.wix.com/docs/api-reference/business-management/tags/introduction) on multiple experiences using filter criteria. An empty filter updates all experiences. A tag that appears in both assign and unassign lists is assigned.
  * @param filter - Filter criteria to select experiences for tag updates.
  * @public
- * @documentationMaturity preview
  * @requiredField filter
  * @permissionId TABLE_RESERVATIONS.EXPERIENCE_UPDATE_TAGS
  * @applicableIdentity APP
@@ -4814,14 +4784,13 @@ interface BulkUpdateExperienceTagsByFilterOptions {
     unassignTags?: Tags;
 }
 /**
- * Archives multiple experiences at once.
+ * Archives multiple experiences.
+ *
+ * Archiving an experience sets `configuration.visible` to `false`, preventing it from appearing on the live site and from accepting new reservations.
  *
- * **Important:** Archiving an experience automatically sets `configuration.visible` to `false`,
- * hiding it from the live site. This ensures archived experiences cannot accept new reservations
- * and are not discoverable by customers.
- * @param experienceIds - IDs of experiences to archive.
+ * To unarchive experiences, call [Bulk Unarchive Experiences](https://dev.wix.com/docs/api-reference/business-solutions/restaurants/reservations/experiences/bulk-unarchive-experiences).
+ * @param experienceIds - IDs of the experiences to archive.
  * @public
- * @documentationMaturity preview
  * @requiredField experienceIds
  * @permissionId TABLE_RESERVATIONS.EXPERIENCE_ARCHIVE
  * @applicableIdentity APP
@@ -4829,21 +4798,14 @@ interface BulkUpdateExperienceTagsByFilterOptions {
  */
 declare function bulkArchiveExperiences(experienceIds: string[]): Promise<NonNullablePaths<BulkArchiveExperiencesResponse, `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>>;
 /**
- * Unarchives multiple experiences at once.
+ * Unarchives multiple experiences.
  *
- * **Important:** Unarchiving only sets `archived` to `false`. It does NOT restore the
- * `configuration.visible` setting to its pre-archived state. After unarchiving, you must
- * explicitly update `configuration.visible` to `true` if you want the experience to appear
- * on the live site again. This safety measure prevents accidentally publishing experiences
- * that may need review or updates before being made publicly available.
+ * Unarchiving an experience only sets the archived status to `false`. It doesn't restore `configuration.visible` to its previous state.
+ * To make the experience appear on the live site again, call [Update Experience](https://dev.wix.com/docs/api-reference/business-solutions/restaurants/reservations/experiences/update-experience) to set `configuration.visible` to `true`.
  *
- * **Example workflow:**
- * 1. Call `BulkUnarchiveExperiences` to restore dashboard access
- * 2. Review and update the experience as needed
- * 3. Call `UpdateExperience` to set `configuration.visible = true` when ready to publish
- * @param experienceIds - Experience IDs to unarchive.
+ * To archive experiences, call [Bulk Archive Experiences](https://dev.wix.com/docs/api-reference/business-solutions/restaurants/reservations/experiences/bulk-archive-experiences).
+ * @param experienceIds - IDs of the experiences to unarchive.
  * @public
- * @documentationMaturity preview
  * @requiredField experienceIds
  * @permissionId TABLE_RESERVATIONS.EXPERIENCE_UNARCHIVE
  * @applicableIdentity APP

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/auto_sdk_table-reservations_experiences",
-  "version": "1.0.36",
+  "version": "1.0.37",
   "license": "MIT",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
@@ -57,5 +57,5 @@
       "fqdn": "wix.table_reservations.v1.experience"
     }
   },
-  "falconPackageHash": "9362e37c1145b38e4b7387296ec7dd6a19fc81aa710fb832aa6054cd"
+  "falconPackageHash": "f5667c38792b1e5498106c973c1fd5743bd83d4e877652e279a7e74d"
 }