@wix/auto_sdk_pro-gallery_pro-gallery 1.0.21 → 1.0.22

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/build/{index.d.ts → cjs/index.d.ts} +20 -15
  2. package/build/{internal → cjs}/index.js +1 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/{pro-gallery-v2-gallery-pro-gallery.universal-CExTgtbV.d.mts → cjs/index.typings.d.ts} +327 -3
  5. package/build/cjs/index.typings.js +1467 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/{internal → cjs}/meta.d.ts +2 -1
  8. package/build/{index.d.mts → es/index.d.mts} +20 -15
  9. package/build/{index.mjs → es/index.mjs} +1 -0
  10. package/build/es/index.mjs.map +1 -0
  11. package/build/{internal/pro-gallery-v2-gallery-pro-gallery.universal-CExTgtbV.d.ts → es/index.typings.d.mts} +327 -3
  12. package/build/es/index.typings.mjs +1422 -0
  13. package/build/es/index.typings.mjs.map +1 -0
  14. package/build/{internal → es}/meta.d.mts +2 -1
  15. package/build/es/package.json +3 -0
  16. package/build/internal/{index.d.ts → cjs/index.d.ts} +20 -15
  17. package/build/{index.js → internal/cjs/index.js} +1 -0
  18. package/build/internal/cjs/index.js.map +1 -0
  19. package/build/{pro-gallery-v2-gallery-pro-gallery.universal-CExTgtbV.d.ts → internal/cjs/index.typings.d.ts} +327 -3
  20. package/build/internal/cjs/index.typings.js +1467 -0
  21. package/build/internal/cjs/index.typings.js.map +1 -0
  22. package/build/{meta.d.ts → internal/cjs/meta.d.ts} +2 -1
  23. package/build/internal/cjs/meta.js.map +1 -0
  24. package/build/internal/{index.d.mts → es/index.d.mts} +20 -15
  25. package/build/internal/{index.mjs → es/index.mjs} +1 -0
  26. package/build/internal/es/index.mjs.map +1 -0
  27. package/build/internal/{pro-gallery-v2-gallery-pro-gallery.universal-CExTgtbV.d.mts → es/index.typings.d.mts} +327 -3
  28. package/build/internal/es/index.typings.mjs +1422 -0
  29. package/build/internal/{index.js.map → es/index.typings.mjs.map} +1 -1
  30. package/build/{meta.d.mts → internal/es/meta.d.mts} +2 -1
  31. package/build/internal/es/meta.mjs.map +1 -0
  32. package/package.json +12 -11
  33. package/build/index.js.map +0 -1
  34. package/build/index.mjs.map +0 -1
  35. package/build/internal/index.mjs.map +0 -1
  36. package/build/meta.js.map +0 -1
  37. package/build/meta.mjs.map +0 -1
  38. /package/build/{internal → cjs}/meta.js +0 -0
  39. /package/build/{internal → cjs}/meta.js.map +0 -0
  40. /package/build/{internal → es}/meta.mjs +0 -0
  41. /package/build/{internal → es}/meta.mjs.map +0 -0
  42. /package/build/{meta.js → internal/cjs/meta.js} +0 -0
  43. /package/build/{meta.mjs → internal/es/meta.mjs} +0 -0
@@ -1,3 +1,5 @@
1
+ import { NonNullablePaths } from '@wix/sdk-types';
2
+
1
3
  interface Gallery {
2
4
  /**
3
5
  * Gallery ID.
@@ -93,6 +95,8 @@ declare enum LinkType {
93
95
  /** For internal usage using wixLinkData. */
94
96
  INTERNAL = "INTERNAL"
95
97
  }
98
+ /** @enumType */
99
+ type LinkTypeWithLiterals = LinkType | 'UNDEFINED' | 'EXTERNAL' | 'INTERNAL';
96
100
  /** The link object generated by panels in the editor and used by applications in Wix */
97
101
  interface WixLink extends WixLinkLinkOneOf {
98
102
  /** External link type */
@@ -292,6 +296,8 @@ declare enum ImageType {
292
296
  WIX_MEDIA = "WIX_MEDIA",
293
297
  EXTERNAL = "EXTERNAL"
294
298
  }
299
+ /** @enumType */
300
+ type ImageTypeWithLiterals = ImageType | 'UNDEFINED' | 'WIX_MEDIA' | 'EXTERNAL';
295
301
  interface Point {
296
302
  /** X-coordinate of the focal point. */
297
303
  x?: number;
@@ -654,10 +660,11 @@ declare enum RCLabel {
654
660
  MOBILE_APP_BUILDER = "MOBILE_APP_BUILDER",
655
661
  SEO = "SEO",
656
662
  FEEDBACK = "FEEDBACK",
657
- ACCESSIBILITY = "ACCESSIBILITY"
663
+ ACCESSIBILITY = "ACCESSIBILITY",
664
+ ENTERPRISE_APPROVALS = "ENTERPRISE_APPROVALS"
658
665
  }
659
666
  /** @enumType */
660
- type RCLabelWithLiterals = RCLabel | 'UNKNOWN' | 'RELEASE_MANAGER' | 'BLOCKS' | 'WIX_CLI' | 'MOBILE_APP_BUILDER' | 'SEO' | 'FEEDBACK' | 'ACCESSIBILITY';
667
+ type RCLabelWithLiterals = RCLabel | 'UNKNOWN' | 'RELEASE_MANAGER' | 'BLOCKS' | 'WIX_CLI' | 'MOBILE_APP_BUILDER' | 'SEO' | 'FEEDBACK' | 'ACCESSIBILITY' | 'ENTERPRISE_APPROVALS';
661
668
  interface DomainEvent extends DomainEventBodyOneOf {
662
669
  /** Information about a newly-created gallery. */
663
670
  createdEvent?: EntityCreatedEvent;
@@ -881,6 +888,8 @@ declare enum State {
881
888
  /** The gallery in the LiveSite. */
882
889
  PUBLISHED = "PUBLISHED"
883
890
  }
891
+ /** @enumType */
892
+ type StateWithLiterals = State | 'UNDEFINED' | 'SAVED' | 'PUBLISHED';
884
893
  interface ListGalleriesResponse {
885
894
  /** Total number of galleries in the site. */
886
895
  totalGalleries?: number | null;
@@ -1281,25 +1290,134 @@ interface GalleryCreatedEnvelope {
1281
1290
  entity: Gallery;
1282
1291
  metadata: EventMetadata;
1283
1292
  }
1293
+ /**
1294
+ * Triggered when a gallery is created.
1295
+ *
1296
+ * > __Note:__ The event data doesn't include gallery items or their IDs.
1297
+ * > To receive information about the created items you need to listen to the [Gallery Item Created webhook](https://dev.wix.com/api/rest/site-content/pro-gallery/gallery-item-created-webhook).
1298
+ * @permissionScope Manage Galleries
1299
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
1300
+ * @permissionScope Read Galleries
1301
+ * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES
1302
+ * @permissionId PRO_GALLERY.READ
1303
+ * @webhook
1304
+ * @eventType wix.pro_gallery.gallery_v2_created
1305
+ * @serviceIdentifier com.wixpress.exposure.progallery.ProGallery
1306
+ * @slug created
1307
+ * @documentationMaturity preview
1308
+ */
1309
+ declare function onGalleryCreated(handler: (event: GalleryCreatedEnvelope) => void | Promise<void>): void;
1284
1310
  interface GalleryDeletedEnvelope {
1285
1311
  metadata: EventMetadata;
1286
1312
  }
1313
+ /**
1314
+ * Triggered when a gallery is deleted.
1315
+ * @permissionScope Manage Galleries
1316
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
1317
+ * @permissionScope Read Galleries
1318
+ * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES
1319
+ * @permissionId PRO_GALLERY.READ
1320
+ * @webhook
1321
+ * @eventType wix.pro_gallery.gallery_v2_deleted
1322
+ * @serviceIdentifier com.wixpress.exposure.progallery.ProGallery
1323
+ * @slug deleted
1324
+ * @documentationMaturity preview
1325
+ */
1326
+ declare function onGalleryDeleted(handler: (event: GalleryDeletedEnvelope) => void | Promise<void>): void;
1287
1327
  interface GalleryItemCreatedEnvelope {
1288
1328
  data: GalleryItemCreated;
1289
1329
  metadata: EventMetadata;
1290
1330
  }
1331
+ /**
1332
+ * Triggered when a media item in a specified gallery is created.
1333
+ * @permissionScope Manage Galleries
1334
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
1335
+ * @permissionScope Read Galleries
1336
+ * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES
1337
+ * @permissionId PRO_GALLERY.READ
1338
+ * @webhook
1339
+ * @eventType wix.pro_gallery.gallery_v2_gallery_item_created
1340
+ * @serviceIdentifier com.wixpress.exposure.progallery.ProGallery
1341
+ * @slug gallery_item_created
1342
+ * @documentationMaturity preview
1343
+ */
1344
+ declare function onGalleryItemCreated(handler: (event: GalleryItemCreatedEnvelope) => void | Promise<void>): void;
1291
1345
  interface GalleryItemDeletedEnvelope {
1292
1346
  data: GalleryItemDeleted;
1293
1347
  metadata: EventMetadata;
1294
1348
  }
1349
+ /**
1350
+ * Triggered when a media item in a specified gallery is deleted.
1351
+ *
1352
+ * > __Note:__ The event is triggered when a gallery item is deleted individually and when a gallery item is deleted because its gallery is deleted.
1353
+ * > The property `originatedFrom` has the value `Gallery Deleted` if the entire gallery is deleted. If the gallery item is deleted individually, this field is empty.
1354
+ * @permissionScope Manage Galleries
1355
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
1356
+ * @permissionScope Read Galleries
1357
+ * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES
1358
+ * @permissionId PRO_GALLERY.READ
1359
+ * @webhook
1360
+ * @eventType wix.pro_gallery.gallery_v2_gallery_item_deleted
1361
+ * @serviceIdentifier com.wixpress.exposure.progallery.ProGallery
1362
+ * @slug gallery_item_deleted
1363
+ * @documentationMaturity preview
1364
+ */
1365
+ declare function onGalleryItemDeleted(handler: (event: GalleryItemDeletedEnvelope) => void | Promise<void>): void;
1295
1366
  interface GalleryItemUpdatedEnvelope {
1296
1367
  data: GalleryItemUpdated;
1297
1368
  metadata: EventMetadata;
1298
1369
  }
1370
+ /**
1371
+ * Triggered when a media item in a specified gallery is updated.
1372
+ * @permissionScope Manage Galleries
1373
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
1374
+ * @permissionScope Read Galleries
1375
+ * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES
1376
+ * @permissionId PRO_GALLERY.READ
1377
+ * @webhook
1378
+ * @eventType wix.pro_gallery.gallery_v2_gallery_item_updated
1379
+ * @serviceIdentifier com.wixpress.exposure.progallery.ProGallery
1380
+ * @slug gallery_item_updated
1381
+ * @documentationMaturity preview
1382
+ */
1383
+ declare function onGalleryItemUpdated(handler: (event: GalleryItemUpdatedEnvelope) => void | Promise<void>): void;
1299
1384
  interface GalleryUpdatedEnvelope {
1300
1385
  entity: Gallery;
1301
1386
  metadata: EventMetadata;
1302
1387
  }
1388
+ /**
1389
+ * Triggered when a gallery is updated.
1390
+ *
1391
+ * > __Note:__ The event data doesn't include gallery items or their IDs.
1392
+ * > To receive information about the updated items you need to listen to the [Gallery Item Updated webhook](https://dev.wix.com/api/rest/site-content/pro-gallery/gallery-item-updated-webhook).
1393
+ * @permissionScope Manage Galleries
1394
+ * @permissionScopeId SCOPE.DC-PROGALLERY.MANAGE-GALLERIES
1395
+ * @permissionScope Read Galleries
1396
+ * @permissionScopeId SCOPE.DC-PROGALLERY.READ-GALLERIES
1397
+ * @permissionId PRO_GALLERY.READ
1398
+ * @webhook
1399
+ * @eventType wix.pro_gallery.gallery_v2_updated
1400
+ * @serviceIdentifier com.wixpress.exposure.progallery.ProGallery
1401
+ * @slug updated
1402
+ * @documentationMaturity preview
1403
+ */
1404
+ declare function onGalleryUpdated(handler: (event: GalleryUpdatedEnvelope) => void | Promise<void>): void;
1405
+ type GalleryNonNullablePaths = `items` | `items.${number}.image.focalPoint.x` | `items.${number}.image.focalPoint.y` | `items.${number}.video.type` | `items.${number}.type`;
1406
+ /**
1407
+ * Retrieves a list of galleries.
1408
+ *
1409
+ * This function retrieves a list of up to 10 galleries at a given time. To list the next 10 galleries in your site's backend, use the `offset` parameter.
1410
+ * @public
1411
+ * @documentationMaturity preview
1412
+ * @param options - Options to use when getting the list of galleries.
1413
+ * @permissionId PRO_GALLERY.READ
1414
+ * @applicableIdentity APP
1415
+ * @applicableIdentity VISITOR
1416
+ * @fqn com.wixpress.exposure.progallery.ProGallery.ListGalleries
1417
+ */
1418
+ declare function listGalleries(options?: ListGalleriesOptions): Promise<NonNullablePaths<ListGalleriesResponse, {
1419
+ [P in GalleryNonNullablePaths]: `galleries.${number}.${P}`;
1420
+ }[GalleryNonNullablePaths]>>;
1303
1421
  interface ListGalleriesOptions {
1304
1422
  /**
1305
1423
  * Number of galleries to list. Defaults to `10`.
@@ -1316,6 +1434,20 @@ interface ListGalleriesOptions {
1316
1434
  */
1317
1435
  limit?: number | null;
1318
1436
  }
1437
+ /**
1438
+ * Retrieves a gallery by ID.
1439
+ * @param galleryId - Gallery ID.
1440
+ * @public
1441
+ * @documentationMaturity preview
1442
+ * @requiredField galleryId
1443
+ * @param options - Options to use when getting the gallery.
1444
+ * @permissionId PRO_GALLERY.READ
1445
+ * @applicableIdentity APP
1446
+ * @applicableIdentity VISITOR
1447
+ * @returns Returned gallery.
1448
+ * @fqn com.wixpress.exposure.progallery.ProGallery.GetGallery
1449
+ */
1450
+ declare function getGallery(galleryId: string, options?: GetGalleryOptions): Promise<NonNullablePaths<Gallery, GalleryNonNullablePaths>>;
1319
1451
  interface GetGalleryOptions extends GetGalleryOptionsVersionOneOf {
1320
1452
  /** Number of media items to skip in the returns. Defaults to `0`. */
1321
1453
  itemOffset?: number | null;
@@ -1333,6 +1465,21 @@ interface GetGalleryOptions extends GetGalleryOptionsVersionOneOf {
1333
1465
  /** @oneof */
1334
1466
  interface GetGalleryOptionsVersionOneOf {
1335
1467
  }
1468
+ /**
1469
+ * Retrieves a list of media items in a specified gallery.
1470
+ *
1471
+ * This function retrieves a list of up to 100 gallery items. The gallery items are listed by `sortOrder` in descending order.
1472
+ * @param galleryId - Gallery ID.
1473
+ * @public
1474
+ * @documentationMaturity preview
1475
+ * @requiredField galleryId
1476
+ * @param options - Options to use when getting the list of gallery items.
1477
+ * @permissionId PRO_GALLERY.READ
1478
+ * @applicableIdentity APP
1479
+ * @applicableIdentity VISITOR
1480
+ * @fqn com.wixpress.exposure.progallery.ProGallery.ListGalleryItems
1481
+ */
1482
+ declare function listGalleryItems(galleryId: string, options?: ListGalleryItemsOptions): Promise<NonNullablePaths<ListGalleryItemsResponse, `items` | `items.${number}.image.focalPoint.x` | `items.${number}.image.focalPoint.y` | `items.${number}.video.type` | `items.${number}.type`>>;
1336
1483
  interface ListGalleryItemsOptions {
1337
1484
  /** Number of media items to skip in the returns. Defaults to `0`. */
1338
1485
  itemOffset?: number | null;
@@ -1347,6 +1494,21 @@ interface ListGalleryItemsOptions {
1347
1494
  */
1348
1495
  itemLimit?: number | null;
1349
1496
  }
1497
+ /**
1498
+ * Retrieves a gallery item by ID.
1499
+ * @public
1500
+ * @documentationMaturity preview
1501
+ * @requiredField identifiers
1502
+ * @requiredField identifiers.galleryId
1503
+ * @requiredField identifiers.itemId
1504
+ * @param identifiers - Gallery ID and Item ID.
1505
+ * @permissionId PRO_GALLERY.READ
1506
+ * @applicableIdentity APP
1507
+ * @applicableIdentity VISITOR
1508
+ * @returns Returned media item.
1509
+ * @fqn com.wixpress.exposure.progallery.ProGallery.GetGalleryItem
1510
+ */
1511
+ declare function getGalleryItem(identifiers: NonNullablePaths<GetGalleryItemIdentifiers, `galleryId` | `itemId`>): Promise<NonNullablePaths<Item, `image.focalPoint.x` | `image.focalPoint.y` | `video.type` | `type` | `tags.values`>>;
1350
1512
  interface GetGalleryItemIdentifiers {
1351
1513
  /**
1352
1514
  * Gallery ID.
@@ -1359,6 +1521,31 @@ interface GetGalleryItemIdentifiers {
1359
1521
  */
1360
1522
  itemId: string;
1361
1523
  }
1524
+ /**
1525
+ * Creates a new gallery.
1526
+ *
1527
+ * You can create your own gallery by providing the gallery information, or clone an existing gallery using the ID of that existing gallery. When a gallery is cloned, the newly-created gallery includes the same properties as the existing gallery except for the gallery and item IDs, sort order, and created and updated dates.
1528
+ *
1529
+ * The newly-created gallery is only available on your backend, and doesn't appear on your live site. To display your backend gallery on your live site, you need to connect it to a gallery component on your live site. To do this, import the `createGallery()` function to your page code, and write code to convert the backend gallery object to the frontend gallery component object. Once converted, the newly created backend gallery is visible on your live site. For reference, check out the code example, "Create a gallery and display it on your live site". To learn more, see [Displaying a Pro Gallery on Your Site Using the Pro Gallery Backend API](https://support.wix.com/en/article/velo-tutorial-displaying-a-pro-gallery-on-your-site-using-the-pro-gallery-backend-api).
1530
+ *
1531
+ * <blockquote class="important">
1532
+ *
1533
+ * __Important:__
1534
+ * When creating `image` items in your gallery, the images must be uploaded to the [Wix Media Manager](https://support.wix.com/en/article/wix-media-uploading-media-to-the-media-manager) first as the `imageInfo` parameter currently only supports the Wix media URL.
1535
+ *
1536
+ * </blockquote>
1537
+ * @public
1538
+ * @documentationMaturity preview
1539
+ * @requiredField options.gallery.items.metadata.image.imageInfo
1540
+ * @requiredField options.gallery.items.metadata.text.html
1541
+ * @requiredField options.gallery.items.metadata.video.videoInfo
1542
+ * @param options - Options to use when creating the gallery.
1543
+ * @permissionId PRO_GALLERY.MANAGE
1544
+ * @applicableIdentity APP
1545
+ * @returns Created gallery.
1546
+ * @fqn com.wixpress.exposure.progallery.ProGallery.CreateGallery
1547
+ */
1548
+ declare function createGallery(options?: NonNullablePaths<CreateGalleryOptions, `gallery.items.${number}.image.imageInfo` | `gallery.items.${number}.text.html` | `gallery.items.${number}.video.videoInfo`>): Promise<NonNullablePaths<Gallery, GalleryNonNullablePaths>>;
1362
1549
  interface CreateGalleryOptions {
1363
1550
  /** Gallery to create. */
1364
1551
  gallery?: Gallery;
@@ -1368,6 +1555,32 @@ interface CreateGalleryOptions {
1368
1555
  */
1369
1556
  cloneFromGalleryId?: string | null;
1370
1557
  }
1558
+ /**
1559
+ * Updates a gallery.
1560
+ *
1561
+ * Only the fields in the `gallery` object parameter can be updated. Specify which fields to update. Unspecified fields remain the same.
1562
+ *
1563
+ * <blockquote class="important">
1564
+ *
1565
+ * __Important:__
1566
+ * When updating `image` items in your gallery, the images must be uploaded to the [Wix Media Manager](https://support.wix.com/en/article/wix-media-uploading-media-to-the-media-manager) first as the `imageInfo` parameter currently only supports the Wix media URL.
1567
+ *
1568
+ * </blockquote>
1569
+ * @public
1570
+ * @documentationMaturity preview
1571
+ * @requiredField _id
1572
+ * @requiredField gallery
1573
+ * @requiredField gallery.items.metadata.image.imageInfo
1574
+ * @requiredField gallery.items.metadata.text.html
1575
+ * @requiredField gallery.items.metadata.video.videoInfo
1576
+ * @param _id - ID of the gallery to update.
1577
+ * @param gallery - The information for the gallery being updated.
1578
+ * @permissionId PRO_GALLERY.MANAGE
1579
+ * @applicableIdentity APP
1580
+ * @returns Updated gallery.
1581
+ * @fqn com.wixpress.exposure.progallery.ProGallery.UpdateGallery
1582
+ */
1583
+ declare function updateGallery(_id: string, gallery: NonNullablePaths<UpdateGallery, `items.${number}.image.imageInfo` | `items.${number}.text.html` | `items.${number}.video.videoInfo`>): Promise<NonNullablePaths<Gallery, GalleryNonNullablePaths>>;
1371
1584
  interface UpdateGallery {
1372
1585
  /**
1373
1586
  * Gallery ID.
@@ -1396,6 +1609,35 @@ interface UpdateGallery {
1396
1609
  */
1397
1610
  _createdDate?: Date | null;
1398
1611
  }
1612
+ /**
1613
+ * Deletes a gallery.
1614
+ *
1615
+ * When a gallery is deleted, the deleted gallery is no longer returned when calling the [`listGalleries()`](/pro-gallery/list-galleries) function.
1616
+ * @param galleryId - ID of the gallery to delete.
1617
+ * @public
1618
+ * @documentationMaturity preview
1619
+ * @requiredField galleryId
1620
+ * @permissionId PRO_GALLERY.MANAGE
1621
+ * @applicableIdentity APP
1622
+ * @fqn com.wixpress.exposure.progallery.ProGallery.DeleteGallery
1623
+ */
1624
+ declare function deleteGallery(galleryId: string): Promise<NonNullablePaths<DeleteGalleryResponse, `galleryId`>>;
1625
+ /**
1626
+ * Deletes multiple media items from a gallery.
1627
+ * @param galleryId - Gallery ID.
1628
+ * @public
1629
+ * @documentationMaturity preview
1630
+ * @requiredField galleryId
1631
+ * @permissionId PRO_GALLERY.MANAGE
1632
+ * @applicableIdentity APP
1633
+ * @fqn com.wixpress.exposure.progallery.ProGallery.DeleteGalleryItems
1634
+ * @deprecated
1635
+ * @replacedBy wix.pro_gallery.v2.gallery.BulkDeleteGalleryItems
1636
+ * @targetRemovalDate 2024-08-15
1637
+ */
1638
+ declare function deleteGalleryItems(galleryId: string, options?: DeleteGalleryItemsOptions): Promise<NonNullablePaths<DeleteGalleryItemsResponse, {
1639
+ [P in GalleryNonNullablePaths]: `gallery.${P}`;
1640
+ }[GalleryNonNullablePaths]>>;
1399
1641
  interface DeleteGalleryItemsOptions {
1400
1642
  /**
1401
1643
  * ID of the media item to delete.
@@ -1403,6 +1645,73 @@ interface DeleteGalleryItemsOptions {
1403
1645
  */
1404
1646
  itemsIds?: string[];
1405
1647
  }
1648
+ /**
1649
+ * Deletes multiple media items from a gallery.
1650
+ * @param galleryId - Gallery ID.
1651
+ * @param itemIds - IDs of the media items to delete.
1652
+ * @public
1653
+ * @documentationMaturity preview
1654
+ * @requiredField galleryId
1655
+ * @requiredField itemIds
1656
+ * @permissionId PRO_GALLERY.MANAGE
1657
+ * @applicableIdentity APP
1658
+ * @fqn com.wixpress.exposure.progallery.ProGallery.BulkDeleteGalleryItems
1659
+ */
1660
+ declare function bulkDeleteGalleryItems(galleryId: string, itemIds: string[]): Promise<NonNullablePaths<BulkDeleteGalleryItemsResponse, `itemIds`>>;
1661
+ /**
1662
+ * Creates a media item in a specified gallery.
1663
+ *
1664
+ * The `createGalleryItem()` function returns a Promise that resolves to a newly-created gallery item after it has successfully been created.
1665
+ *
1666
+ * <blockquote class="important">
1667
+ *
1668
+ * __Important:__
1669
+ * When creating `image` items in your gallery, the images must be uploaded to the [Wix Media Manager](https://support.wix.com/en/article/wix-media-uploading-media-to-the-media-manager) first as the `imageInfo` parameter currently only supports the Wix media URL.
1670
+ *
1671
+ * </blockquote>
1672
+ * @param galleryId - Gallery ID.
1673
+ * @param item - Media item to create.
1674
+ * @public
1675
+ * @documentationMaturity preview
1676
+ * @requiredField galleryId
1677
+ * @requiredField item
1678
+ * @requiredField item.metadata.image.imageInfo
1679
+ * @requiredField item.metadata.text.html
1680
+ * @requiredField item.metadata.video.videoInfo
1681
+ * @permissionId PRO_GALLERY.MANAGE
1682
+ * @applicableIdentity APP
1683
+ * @returns Created media item.
1684
+ * @fqn com.wixpress.exposure.progallery.ProGallery.CreateGalleryItem
1685
+ */
1686
+ declare function createGalleryItem(galleryId: string, item: NonNullablePaths<Item, `image.imageInfo` | `text.html` | `video.videoInfo`>): Promise<NonNullablePaths<Item, `image.focalPoint.x` | `image.focalPoint.y` | `video.type` | `type` | `tags.values`>>;
1687
+ /**
1688
+ * Updates a media item in a specified gallery.
1689
+ *
1690
+ * Only the fields in the `item` object parameter can be updated. Specify which fields to update. Unspecified fields remain the same.
1691
+ *
1692
+ * <blockquote class="important">
1693
+ *
1694
+ * __Important:__
1695
+ * When updating `image` items in your gallery, the images must be uploaded to the [Wix Media Manager](https://support.wix.com/en/article/wix-media-uploading-media-to-the-media-manager) first as the `imageInfo` parameter currently only supports the Wix media URL.
1696
+ *
1697
+ * </blockquote>
1698
+ * @public
1699
+ * @documentationMaturity preview
1700
+ * @requiredField identifiers
1701
+ * @requiredField identifiers.galleryId
1702
+ * @requiredField identifiers.itemId
1703
+ * @requiredField item
1704
+ * @requiredField item.metadata.image.imageInfo
1705
+ * @requiredField item.metadata.text.html
1706
+ * @requiredField item.metadata.video.videoInfo
1707
+ * @param item - The information for the gallery item being updated.
1708
+ * @param identifiers - Gallery ID and Item ID.
1709
+ * @permissionId PRO_GALLERY.MANAGE
1710
+ * @applicableIdentity APP
1711
+ * @returns Updated media item.
1712
+ * @fqn com.wixpress.exposure.progallery.ProGallery.UpdateGalleryItem
1713
+ */
1714
+ declare function updateGalleryItem(identifiers: NonNullablePaths<UpdateGalleryItemIdentifiers, `galleryId` | `itemId`>, item: NonNullablePaths<UpdateGalleryItem, `image.imageInfo` | `text.html` | `video.videoInfo`>): Promise<NonNullablePaths<Item, `image.focalPoint.x` | `image.focalPoint.y` | `video.type` | `type` | `tags.values`>>;
1406
1715
  interface UpdateGalleryItemIdentifiers {
1407
1716
  /**
1408
1717
  * ID of the gallery containing the item to update.
@@ -1461,6 +1770,21 @@ interface UpdateGalleryItem {
1461
1770
  /** Item tags. */
1462
1771
  tags?: Tags;
1463
1772
  }
1773
+ /**
1774
+ * Deletes a media item from a gallery.
1775
+ *
1776
+ * When a gallery item is deleted, the deleted gallery item is no longer returned when calling the [`listGalleryItems()`](/pro-gallery/list-gallery-items) function.
1777
+ * @public
1778
+ * @documentationMaturity preview
1779
+ * @requiredField identifiers
1780
+ * @requiredField identifiers.galleryId
1781
+ * @requiredField identifiers.itemId
1782
+ * @param identifiers - Gallery ID and Item ID.
1783
+ * @permissionId PRO_GALLERY.MANAGE
1784
+ * @applicableIdentity APP
1785
+ * @fqn com.wixpress.exposure.progallery.ProGallery.DeleteGalleryItem
1786
+ */
1787
+ declare function deleteGalleryItem(identifiers: NonNullablePaths<DeleteGalleryItemIdentifiers, `galleryId` | `itemId`>): Promise<NonNullablePaths<DeleteGalleryItemResponse, `itemId`>>;
1464
1788
  interface DeleteGalleryItemIdentifiers {
1465
1789
  /**
1466
1790
  * Gallery ID.
@@ -1474,4 +1798,4 @@ interface DeleteGalleryItemIdentifiers {
1474
1798
  itemId: string;
1475
1799
  }
1476
1800
 
1477
- export { type Text as $, type AnchorLink as A, type BulkDeleteGalleryItemsResponse as B, type CreateGalleryOptions as C, type DeleteGalleryResponse as D, Enum as E, type DynamicPageLink as F, type GetGalleryOptions as G, type DocumentLink as H, type Item as I, type EmailLink as J, type PhoneLink as K, type ListGalleriesOptions as L, type AddressLink as M, type WhatsAppLink as N, type TpaPageLink as O, type PageLink as P, type Image as Q, RCLabel as R, State as S, Type as T, type UpdateGallery as U, VideoType as V, WebhookIdentityType as W, type Point as X, type UnsharpMasking as Y, type Video as Z, type VideoResolution as _, type ListGalleriesResponse as a, type CreateGalleryItemsResponse as a$, type Tags as a0, type SecondaryMedia as a1, type SecondaryMediaMetadataOneOf as a2, type InvalidateCache as a3, type InvalidateCacheGetByOneOf as a4, type App as a5, type Page as a6, type URI as a7, type File as a8, type CustomTag as a9, type RestoreAllGalleriesEvent as aA, type ListGalleriesItemsRequest as aB, type ItemId as aC, type ListGalleriesItemsResponse as aD, type ItemsInGallery as aE, type TriggerRestoreAllGalleriesAsyncRequest as aF, type TriggerRestoreAllGalleriesAsyncResponse as aG, type GalleryItemCreated as aH, type GalleryItemUpdated as aI, type GalleryItemDeleted as aJ, type ListGalleriesRequest as aK, type GetGalleryRequest as aL, type GetGalleryRequestVersionOneOf as aM, type GetGalleryResponse as aN, type ListGalleryItemsRequest as aO, type GetGalleryItemRequest as aP, type GetGalleryItemResponse as aQ, type CreateGalleryRequest as aR, type CreateGalleryResponse as aS, type UpdateGalleryRequest as aT, type UpdateGalleryResponse as aU, type DeleteGalleryRequest as aV, type DeleteGalleryItemsRequest as aW, type BulkDeleteGalleryItemsRequest as aX, type CreateGalleryItemRequest as aY, type CreateGalleryItemResponse as aZ, type CreateGalleryItemsRequest as a_, type GalleryPublished as aa, type CleanDeletedGalleriesEvent as ab, type ProgallerypublisherPublishGalleryRequest as ac, type ProgallerypublisherPublishGalleryResponse as ad, type GetActiveGalleryRevisionRequest as ae, type GetActiveGalleryRevisionResponse as af, type GetGalleryRevisionRequest as ag, type GetGalleryRevisionResponse as ah, type PublishGalleryItemRequest as ai, type PublishGalleryItemResponse as aj, type PublishGalleryItemsRequest as ak, type PublishGalleryItemsResponse as al, type Empty as am, type HtmlSitePublished as an, type EventsPage as ao, type HtmlSiteRCPublished as ap, type DomainEvent as aq, type DomainEventBodyOneOf as ar, type EntityCreatedEvent as as, type RestoreInfo as at, type EntityUpdatedEvent as au, type EntityDeletedEvent as av, type ActionEvent as aw, type MessageEnvelope as ax, type IdentificationData as ay, type IdentificationDataIdOneOf as az, type Gallery as b, type UpdateGalleryItemRequest as b0, type UpdateGalleryItemResponse as b1, type DeleteGalleryItemRequest as b2, type PublishGalleryRequest as b3, type PublishGalleryResponse as b4, type UpdateDocumentsEvent as b5, type UpdateDocumentsEventOperationOneOf as b6, type DocumentUpdateOperation as b7, type IndexDocument as b8, type DocumentPayload as b9, type DocumentImage as ba, type DeleteByIdsOperation as bb, type DeleteByFilterOperation as bc, type UpdateByFilterOperation as bd, type UpdateExistingOperation as be, type SearchIndexingNotification as bf, type BaseEventMetadata as bg, type EventMetadata as bh, type GetGalleryOptionsVersionOneOf as bi, type ListGalleryItemsOptions as c, type ListGalleryItemsResponse as d, type GetGalleryItemIdentifiers as e, type DeleteGalleryItemsOptions as f, type DeleteGalleryItemsResponse as g, type UpdateGalleryItemIdentifiers as h, type UpdateGalleryItem as i, type DeleteGalleryItemIdentifiers as j, type DeleteGalleryItemResponse as k, type GalleryCreatedEnvelope as l, type GalleryDeletedEnvelope as m, type GalleryItemCreatedEnvelope as n, type GalleryItemDeletedEnvelope as o, type GalleryItemUpdatedEnvelope as p, type GalleryUpdatedEnvelope as q, LinkType as r, LinkRel as s, ImageType as t, SearchIndexingNotificationState as u, type ItemMetadataOneOf as v, type Link as w, type WixLink as x, type WixLinkLinkOneOf as y, type ExternalLink as z };
1801
+ export { type ActionEvent, type AddressLink, type AnchorLink, type App, type BaseEventMetadata, type BulkDeleteGalleryItemsRequest, type BulkDeleteGalleryItemsResponse, type CleanDeletedGalleriesEvent, type CreateGalleryItemRequest, type CreateGalleryItemResponse, type CreateGalleryItemsRequest, type CreateGalleryItemsResponse, type CreateGalleryOptions, type CreateGalleryRequest, type CreateGalleryResponse, type CustomTag, type DeleteByFilterOperation, type DeleteByIdsOperation, type DeleteGalleryItemIdentifiers, type DeleteGalleryItemRequest, type DeleteGalleryItemResponse, type DeleteGalleryItemsOptions, type DeleteGalleryItemsRequest, type DeleteGalleryItemsResponse, type DeleteGalleryRequest, type DeleteGalleryResponse, type DocumentImage, type DocumentLink, type DocumentPayload, type DocumentUpdateOperation, type DomainEvent, type DomainEventBodyOneOf, type DynamicPageLink, type EmailLink, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, Enum, type EnumWithLiterals, type EventMetadata, type EventsPage, type ExternalLink, type File, type Gallery, type GalleryCreatedEnvelope, type GalleryDeletedEnvelope, type GalleryItemCreated, type GalleryItemCreatedEnvelope, type GalleryItemDeleted, type GalleryItemDeletedEnvelope, type GalleryItemUpdated, type GalleryItemUpdatedEnvelope, type GalleryPublished, type GalleryUpdatedEnvelope, type GetActiveGalleryRevisionRequest, type GetActiveGalleryRevisionResponse, type GetGalleryItemIdentifiers, type GetGalleryItemRequest, type GetGalleryItemResponse, type GetGalleryOptions, type GetGalleryOptionsVersionOneOf, type GetGalleryRequest, type GetGalleryRequestVersionOneOf, type GetGalleryResponse, type GetGalleryRevisionRequest, type GetGalleryRevisionResponse, type HtmlSitePublished, type HtmlSiteRCPublished, type IdentificationData, type IdentificationDataIdOneOf, type Image, ImageType, type ImageTypeWithLiterals, type IndexDocument, type InvalidateCache, type InvalidateCacheGetByOneOf, type Item, type ItemId, type ItemMetadataOneOf, type ItemsInGallery, type Link, LinkRel, type LinkRelWithLiterals, LinkType, type LinkTypeWithLiterals, type ListGalleriesItemsRequest, type ListGalleriesItemsResponse, type ListGalleriesOptions, type ListGalleriesRequest, type ListGalleriesResponse, type ListGalleryItemsOptions, type ListGalleryItemsRequest, type ListGalleryItemsResponse, type MessageEnvelope, type Page, type PageLink, type PhoneLink, type Point, type ProgallerypublisherPublishGalleryRequest, type ProgallerypublisherPublishGalleryResponse, type PublishGalleryItemRequest, type PublishGalleryItemResponse, type PublishGalleryItemsRequest, type PublishGalleryItemsResponse, type PublishGalleryRequest, type PublishGalleryResponse, RCLabel, type RCLabelWithLiterals, type RestoreAllGalleriesEvent, type RestoreInfo, type SearchIndexingNotification, SearchIndexingNotificationState, type SearchIndexingNotificationStateWithLiterals, type SecondaryMedia, type SecondaryMediaMetadataOneOf, State, type StateWithLiterals, type Tags, type Text, type TpaPageLink, type TriggerRestoreAllGalleriesAsyncRequest, type TriggerRestoreAllGalleriesAsyncResponse, Type, type TypeWithLiterals, type URI, type UnsharpMasking, type UpdateByFilterOperation, type UpdateDocumentsEvent, type UpdateDocumentsEventOperationOneOf, type UpdateExistingOperation, type UpdateGallery, type UpdateGalleryItem, type UpdateGalleryItemIdentifiers, type UpdateGalleryItemRequest, type UpdateGalleryItemResponse, type UpdateGalleryRequest, type UpdateGalleryResponse, type Video, type VideoResolution, VideoType, type VideoTypeWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WhatsAppLink, type WixLink, type WixLinkLinkOneOf, bulkDeleteGalleryItems, createGallery, createGalleryItem, deleteGallery, deleteGalleryItem, deleteGalleryItems, getGallery, getGalleryItem, listGalleries, listGalleryItems, onGalleryCreated, onGalleryDeleted, onGalleryItemCreated, onGalleryItemDeleted, onGalleryItemUpdated, onGalleryUpdated, updateGallery, updateGalleryItem };