@wix/auto_sdk_pro-gallery_pro-gallery 1.0.22 → 1.0.24

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.
@@ -1402,7 +1402,6 @@ interface GalleryUpdatedEnvelope {
1402
1402
  * @documentationMaturity preview
1403
1403
  */
1404
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
1405
  /**
1407
1406
  * Retrieves a list of galleries.
1408
1407
  *
@@ -1412,12 +1411,9 @@ type GalleryNonNullablePaths = `items` | `items.${number}.image.focalPoint.x` |
1412
1411
  * @param options - Options to use when getting the list of galleries.
1413
1412
  * @permissionId PRO_GALLERY.READ
1414
1413
  * @applicableIdentity APP
1415
- * @applicableIdentity VISITOR
1416
1414
  * @fqn com.wixpress.exposure.progallery.ProGallery.ListGalleries
1417
1415
  */
1418
- declare function listGalleries(options?: ListGalleriesOptions): Promise<NonNullablePaths<ListGalleriesResponse, {
1419
- [P in GalleryNonNullablePaths]: `galleries.${number}.${P}`;
1420
- }[GalleryNonNullablePaths]>>;
1416
+ declare function listGalleries(options?: ListGalleriesOptions): Promise<NonNullablePaths<ListGalleriesResponse, `galleries`, 2>>;
1421
1417
  interface ListGalleriesOptions {
1422
1418
  /**
1423
1419
  * Number of galleries to list. Defaults to `10`.
@@ -1443,11 +1439,10 @@ interface ListGalleriesOptions {
1443
1439
  * @param options - Options to use when getting the gallery.
1444
1440
  * @permissionId PRO_GALLERY.READ
1445
1441
  * @applicableIdentity APP
1446
- * @applicableIdentity VISITOR
1447
1442
  * @returns Returned gallery.
1448
1443
  * @fqn com.wixpress.exposure.progallery.ProGallery.GetGallery
1449
1444
  */
1450
- declare function getGallery(galleryId: string, options?: GetGalleryOptions): Promise<NonNullablePaths<Gallery, GalleryNonNullablePaths>>;
1445
+ declare function getGallery(galleryId: string, options?: GetGalleryOptions): Promise<NonNullablePaths<Gallery, `items` | `items.${number}.image.focalPoint.x` | `items.${number}.image.focalPoint.y` | `items.${number}.video.type` | `items.${number}.type`, 6>>;
1451
1446
  interface GetGalleryOptions extends GetGalleryOptionsVersionOneOf {
1452
1447
  /** Number of media items to skip in the returns. Defaults to `0`. */
1453
1448
  itemOffset?: number | null;
@@ -1476,10 +1471,9 @@ interface GetGalleryOptionsVersionOneOf {
1476
1471
  * @param options - Options to use when getting the list of gallery items.
1477
1472
  * @permissionId PRO_GALLERY.READ
1478
1473
  * @applicableIdentity APP
1479
- * @applicableIdentity VISITOR
1480
1474
  * @fqn com.wixpress.exposure.progallery.ProGallery.ListGalleryItems
1481
1475
  */
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`>>;
1476
+ 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`, 6>>;
1483
1477
  interface ListGalleryItemsOptions {
1484
1478
  /** Number of media items to skip in the returns. Defaults to `0`. */
1485
1479
  itemOffset?: number | null;
@@ -1504,11 +1498,10 @@ interface ListGalleryItemsOptions {
1504
1498
  * @param identifiers - Gallery ID and Item ID.
1505
1499
  * @permissionId PRO_GALLERY.READ
1506
1500
  * @applicableIdentity APP
1507
- * @applicableIdentity VISITOR
1508
1501
  * @returns Returned media item.
1509
1502
  * @fqn com.wixpress.exposure.progallery.ProGallery.GetGalleryItem
1510
1503
  */
1511
- declare function getGalleryItem(identifiers: NonNullablePaths<GetGalleryItemIdentifiers, `galleryId` | `itemId`>): Promise<NonNullablePaths<Item, `image.focalPoint.x` | `image.focalPoint.y` | `video.type` | `type` | `tags.values`>>;
1504
+ declare function getGalleryItem(identifiers: NonNullablePaths<GetGalleryItemIdentifiers, `galleryId` | `itemId`, 2>): Promise<NonNullablePaths<Item, `image.focalPoint.x` | `image.focalPoint.y` | `video.type` | `type` | `tags.values`, 4>>;
1512
1505
  interface GetGalleryItemIdentifiers {
1513
1506
  /**
1514
1507
  * Gallery ID.
@@ -1545,7 +1538,7 @@ interface GetGalleryItemIdentifiers {
1545
1538
  * @returns Created gallery.
1546
1539
  * @fqn com.wixpress.exposure.progallery.ProGallery.CreateGallery
1547
1540
  */
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>>;
1541
+ declare function createGallery(options?: NonNullablePaths<CreateGalleryOptions, `gallery.items.${number}.image.imageInfo` | `gallery.items.${number}.text.html` | `gallery.items.${number}.video.videoInfo`, 6>): Promise<NonNullablePaths<Gallery, `items` | `items.${number}.image.focalPoint.x` | `items.${number}.image.focalPoint.y` | `items.${number}.video.type` | `items.${number}.type`, 6>>;
1549
1542
  interface CreateGalleryOptions {
1550
1543
  /** Gallery to create. */
1551
1544
  gallery?: Gallery;
@@ -1580,7 +1573,7 @@ interface CreateGalleryOptions {
1580
1573
  * @returns Updated gallery.
1581
1574
  * @fqn com.wixpress.exposure.progallery.ProGallery.UpdateGallery
1582
1575
  */
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>>;
1576
+ declare function updateGallery(_id: string, gallery: NonNullablePaths<UpdateGallery, `items.${number}.image.imageInfo` | `items.${number}.text.html` | `items.${number}.video.videoInfo`, 5>): Promise<NonNullablePaths<Gallery, `items` | `items.${number}.image.focalPoint.x` | `items.${number}.image.focalPoint.y` | `items.${number}.video.type` | `items.${number}.type`, 6>>;
1584
1577
  interface UpdateGallery {
1585
1578
  /**
1586
1579
  * Gallery ID.
@@ -1621,7 +1614,7 @@ interface UpdateGallery {
1621
1614
  * @applicableIdentity APP
1622
1615
  * @fqn com.wixpress.exposure.progallery.ProGallery.DeleteGallery
1623
1616
  */
1624
- declare function deleteGallery(galleryId: string): Promise<NonNullablePaths<DeleteGalleryResponse, `galleryId`>>;
1617
+ declare function deleteGallery(galleryId: string): Promise<NonNullablePaths<DeleteGalleryResponse, `galleryId`, 2>>;
1625
1618
  /**
1626
1619
  * Deletes multiple media items from a gallery.
1627
1620
  * @param galleryId - Gallery ID.
@@ -1635,9 +1628,7 @@ declare function deleteGallery(galleryId: string): Promise<NonNullablePaths<Dele
1635
1628
  * @replacedBy wix.pro_gallery.v2.gallery.BulkDeleteGalleryItems
1636
1629
  * @targetRemovalDate 2024-08-15
1637
1630
  */
1638
- declare function deleteGalleryItems(galleryId: string, options?: DeleteGalleryItemsOptions): Promise<NonNullablePaths<DeleteGalleryItemsResponse, {
1639
- [P in GalleryNonNullablePaths]: `gallery.${P}`;
1640
- }[GalleryNonNullablePaths]>>;
1631
+ declare function deleteGalleryItems(galleryId: string, options?: DeleteGalleryItemsOptions): Promise<NonNullablePaths<DeleteGalleryItemsResponse, `gallery.items` | `gallery.items.${number}.image.focalPoint.x` | `gallery.items.${number}.image.focalPoint.y` | `gallery.items.${number}.video.type` | `gallery.items.${number}.type`, 7>>;
1641
1632
  interface DeleteGalleryItemsOptions {
1642
1633
  /**
1643
1634
  * ID of the media item to delete.
@@ -1657,7 +1648,7 @@ interface DeleteGalleryItemsOptions {
1657
1648
  * @applicableIdentity APP
1658
1649
  * @fqn com.wixpress.exposure.progallery.ProGallery.BulkDeleteGalleryItems
1659
1650
  */
1660
- declare function bulkDeleteGalleryItems(galleryId: string, itemIds: string[]): Promise<NonNullablePaths<BulkDeleteGalleryItemsResponse, `itemIds`>>;
1651
+ declare function bulkDeleteGalleryItems(galleryId: string, itemIds: string[]): Promise<NonNullablePaths<BulkDeleteGalleryItemsResponse, `itemIds`, 2>>;
1661
1652
  /**
1662
1653
  * Creates a media item in a specified gallery.
1663
1654
  *
@@ -1683,7 +1674,7 @@ declare function bulkDeleteGalleryItems(galleryId: string, itemIds: string[]): P
1683
1674
  * @returns Created media item.
1684
1675
  * @fqn com.wixpress.exposure.progallery.ProGallery.CreateGalleryItem
1685
1676
  */
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`>>;
1677
+ declare function createGalleryItem(galleryId: string, item: NonNullablePaths<Item, `image.imageInfo` | `text.html` | `video.videoInfo`, 3>): Promise<NonNullablePaths<Item, `image.focalPoint.x` | `image.focalPoint.y` | `video.type` | `type` | `tags.values`, 4>>;
1687
1678
  /**
1688
1679
  * Updates a media item in a specified gallery.
1689
1680
  *
@@ -1711,7 +1702,7 @@ declare function createGalleryItem(galleryId: string, item: NonNullablePaths<Ite
1711
1702
  * @returns Updated media item.
1712
1703
  * @fqn com.wixpress.exposure.progallery.ProGallery.UpdateGalleryItem
1713
1704
  */
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`>>;
1705
+ declare function updateGalleryItem(identifiers: NonNullablePaths<UpdateGalleryItemIdentifiers, `galleryId` | `itemId`, 2>, item: NonNullablePaths<UpdateGalleryItem, `image.imageInfo` | `text.html` | `video.videoInfo`, 3>): Promise<NonNullablePaths<Item, `image.focalPoint.x` | `image.focalPoint.y` | `video.type` | `type` | `tags.values`, 4>>;
1715
1706
  interface UpdateGalleryItemIdentifiers {
1716
1707
  /**
1717
1708
  * ID of the gallery containing the item to update.
@@ -1784,7 +1775,7 @@ interface UpdateGalleryItem {
1784
1775
  * @applicableIdentity APP
1785
1776
  * @fqn com.wixpress.exposure.progallery.ProGallery.DeleteGalleryItem
1786
1777
  */
1787
- declare function deleteGalleryItem(identifiers: NonNullablePaths<DeleteGalleryItemIdentifiers, `galleryId` | `itemId`>): Promise<NonNullablePaths<DeleteGalleryItemResponse, `itemId`>>;
1778
+ declare function deleteGalleryItem(identifiers: NonNullablePaths<DeleteGalleryItemIdentifiers, `galleryId` | `itemId`, 2>): Promise<NonNullablePaths<DeleteGalleryItemResponse, `itemId`, 2>>;
1788
1779
  interface DeleteGalleryItemIdentifiers {
1789
1780
  /**
1790
1781
  * Gallery ID.