import { RequestOptionsFactory } from '@wix/sdk-types'; /** * Retrieves a list of galleries. * * 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. */ export declare function listGalleries(payload: object): RequestOptionsFactory; /** Retrieves a gallery by ID. */ export declare function getGallery(payload: object): RequestOptionsFactory; /** * Retrieves a list of media items in a specified gallery. * * This function retrieves a list of up to 100 gallery items. The gallery items are listed by `sortOrder` in descending order. */ export declare function listGalleryItems(payload: object): RequestOptionsFactory; /** Retrieves a gallery item by ID. */ export declare function getGalleryItem(payload: object): RequestOptionsFactory; /** * Creates a new gallery. * * 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. * * 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). * *
* * __Important:__ * 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. * *
*/ export declare function createGallery(payload: object): RequestOptionsFactory; /** * Updates a gallery. * * Only the fields in the `gallery` object parameter can be updated. Specify which fields to update. Unspecified fields remain the same. * *
* * __Important:__ * 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. * *
*/ export declare function updateGallery(payload: object): RequestOptionsFactory; /** * Deletes a gallery. * * When a gallery is deleted, the deleted gallery is no longer returned when calling the [`listGalleries()`](/pro-gallery/list-galleries) function. */ export declare function deleteGallery(payload: object): RequestOptionsFactory; /** * Deletes multiple media items from a gallery. * @deprecated It has been replaced with com.wixpress.exposure.progallery.BulkDeleteGalleryItems(), and will be removed on 2024-08-15. */ export declare function deleteGalleryItems(payload: object): RequestOptionsFactory; /** Deletes multiple media items from a gallery. */ export declare function bulkDeleteGalleryItems(payload: object): RequestOptionsFactory; /** * Creates a media item in a specified gallery. * * The `createGalleryItem()` function returns a Promise that resolves to a newly-created gallery item after it has successfully been created. * *
* * __Important:__ * 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. * *
*/ export declare function createGalleryItem(payload: object): RequestOptionsFactory; /** * Updates a media item in a specified gallery. * * Only the fields in the `item` object parameter can be updated. Specify which fields to update. Unspecified fields remain the same. * *
* * __Important:__ * 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. * *
*/ export declare function updateGalleryItem(payload: object): RequestOptionsFactory; /** * Deletes a media item from a gallery. * * When a gallery item is deleted, the deleted gallery item is no longer returned when calling the [`listGalleryItems()`](/pro-gallery/list-gallery-items) function. */ export declare function deleteGalleryItem(payload: object): RequestOptionsFactory;