@wix/auto_sdk_pro-gallery_pro-gallery 1.0.8 → 1.0.9

package/build/internal/meta.d.ts

@@ -0,0 +1,498 @@
+import { ag as ListGalleriesRequest$1, a as ListGalleriesResponse$1, ah as GetGalleryRequest$1, aj as GetGalleryResponse$1, ak as ListGalleryItemsRequest$1, d as ListGalleryItemsResponse$1, al as GetGalleryItemRequest$1, am as GetGalleryItemResponse$1, an as CreateGalleryRequest$1, ao as CreateGalleryResponse$1, ap as UpdateGalleryRequest$1, aq as UpdateGalleryResponse$1, ar as DeleteGalleryRequest$1, D as DeleteGalleryResponse$1, as as DeleteGalleryItemsRequest$1, g as DeleteGalleryItemsResponse$1, at as BulkDeleteGalleryItemsRequest$1, B as BulkDeleteGalleryItemsResponse$1, au as CreateGalleryItemRequest$1, av as CreateGalleryItemResponse$1, ay as UpdateGalleryItemRequest$1, az as UpdateGalleryItemResponse$1, aA as DeleteGalleryItemRequest$1, k as DeleteGalleryItemResponse$1 } from './pro-gallery-v2-gallery-pro-gallery.universal-KXp1KG3k.js';
+
+interface Gallery {
+    /**
+     * Gallery ID.
+     * @readonly
+     * @format GUID
+     */
+    id?: string | null;
+    /** Gallery name. */
+    name?: string | null;
+    /**
+     * Total number of items in the gallery.
+     * @readonly
+     */
+    totalItems?: number | null;
+    /** Media items in the gallery. */
+    items?: Item[];
+    /**
+     * Index that determines which position a gallery is displayed on the site. <br />
+     *
+     * >**Note:** If you assign the same sort order index to more than one gallery, the function fails.
+     */
+    sortOrder?: number | null;
+    /**
+     * Date and time the gallery was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+}
+interface Item extends ItemMetadataOneOf {
+    /** Details about the image. */
+    image?: Image;
+    /** Details about the video. */
+    video?: Video;
+    /** Details about the text file. */
+    text?: Text;
+    /**
+     * Item ID.
+     * @readonly
+     * @format GUID
+     */
+    id?: string | null;
+    /**
+     * Index that determines which position a media item is displayed in the gallery. <br />
+     *
+     * Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
+     *
+     * >**Note:** If you assign the same sort order index to more than one media item in a gallery, the function fails.
+     */
+    sortOrder?: number | null;
+    /** Item title. */
+    title?: string | null;
+    /** Item description. */
+    description?: string | null;
+    /** Link from the item. You can link to Wix sites or external URLs. */
+    link?: Link;
+    /**
+     * Type of item.
+     * @readonly
+     */
+    type?: TypeWithLiterals;
+    /**
+     * Date and time the item was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the item was last updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /** Item tags. */
+    tags?: Tags;
+}
+/** @oneof */
+interface ItemMetadataOneOf {
+    /** Details about the image. */
+    image?: Image;
+    /** Details about the video. */
+    video?: Video;
+    /** Details about the text file. */
+    text?: Text;
+}
+interface Link {
+    /** Display text of the link. */
+    text?: string | null;
+    /** Target URL of the link. */
+    url?: string | null;
+}
+declare enum Type {
+    UNDEFINED = "UNDEFINED",
+    IMAGE = "IMAGE",
+    VIDEO = "VIDEO",
+    TEXT = "TEXT"
+}
+/** @enumType */
+type TypeWithLiterals = Type | 'UNDEFINED' | 'IMAGE' | 'VIDEO' | 'TEXT';
+interface Image {
+    /** Information about the Wix Media image. */
+    imageInfo?: CommonImage;
+    /** Focal point of the image. */
+    focalPoint?: Point;
+    /** Set of key-value pairs describing the media in [Exchangeable Image File format](https://en.wikipedia.org/wiki/Exif). */
+    exif?: Record<string, any> | null;
+    /**
+     * Image compression level. <br />
+     *
+     * Min: `30` <br />
+     * Max: `100`
+     * @min 30
+     * @max 100
+     */
+    quality?: number | null;
+    /** [Unsharp masking](https://en.wikipedia.org/wiki/Unsharp_masking) values of the image. */
+    unsharpMasking?: UnsharpMasking;
+}
+interface CommonImage {
+    /** *Required.** WixMedia image ID. */
+    id?: string;
+    /**
+     * Image URL.
+     * @readonly
+     */
+    url?: string;
+    /** *Required.** Original image height. */
+    height?: number;
+    /** *Required.** Original image width. */
+    width?: number;
+    /** Image alt text. */
+    altText?: string | null;
+    /** Image filename. */
+    filename?: string | null;
+}
+interface Point {
+    /** X-coordinate of the focal point. */
+    x?: number;
+    /** Y-coordinate of the focal point. */
+    y?: number;
+}
+interface UnsharpMasking {
+    /**
+     * Unsharp masking amount. Controls the sharpening strength. <br />
+     *
+     * Min: `0` <br />
+     * Max: `5`
+     * @max 5
+     */
+    amount?: number | null;
+    /** Unsharp masking radius in pixels. Controls the sharpening width. */
+    radius?: number | null;
+    /**
+     * Unsharp masking threshold. Controls how different neighboring pixels must be for sharpening to apply. <br />
+     *
+     * Min: `0` <br />
+     * Max: `1`
+     * @max 1
+     */
+    threshold?: number | null;
+}
+interface Video {
+    /** Type of video. */
+    type?: VideoTypeWithLiterals;
+    /** Information about the video. */
+    videoInfo?: VideoV2;
+    /** Manually defined video duration in milliseconds. */
+    durationInMillis?: number | null;
+}
+declare enum VideoType {
+    UNDEFINED = "UNDEFINED",
+    WIX_MEDIA = "WIX_MEDIA",
+    YOUTUBE = "YOUTUBE",
+    VIMEO = "VIMEO"
+}
+/** @enumType */
+type VideoTypeWithLiterals = VideoType | 'UNDEFINED' | 'WIX_MEDIA' | 'YOUTUBE' | 'VIMEO';
+interface VideoV2 {
+    /** WixMedia ID. Required when associating an existing Wix Media video. */
+    id?: string;
+    /** Video URL. Required when associating a video from an external source. Supported sources: YouTube, Vimeo. */
+    url?: string;
+    /**
+     * Available resolutions for the video, starting with the optimal resolution.
+     * @maxSize 100
+     */
+    resolutions?: VideoResolution[];
+    /** Video filename. */
+    filename?: string | null;
+    /** Video posters. */
+    posters?: CommonImage[];
+}
+interface VideoResolution {
+    /** *Required.** Video URL. */
+    url?: string;
+    /** *Required.** Video height. */
+    height?: number;
+    /** *Required.** Video width. */
+    width?: number;
+    /** *Required.** Video format. For example, `mp4` or `hls`. */
+    format?: string;
+    /** Video quality. For example, `480p` or `720p`. */
+    quality?: string | null;
+    /** Video filename. */
+    filename?: string | null;
+}
+interface Text {
+    /** Text in HTML format. */
+    html?: string | null;
+    /**
+     * Set of key-value pairs describing the [CSS style](https://en.wikipedia.org/wiki/CSS) of the text.
+     *
+     * __Note:__ The object structure is customizable. See the [List Gallery Items](https://dev.wix.com/api/rest/site-content/pro-gallery/list-gallery-items) code example for supported values.
+     */
+    css?: Record<string, any> | null;
+    /** Reserved for internal use. */
+    editorHtml?: string | null;
+    /** Reserved for internal use. */
+    editorFontId?: string | null;
+}
+interface Tags {
+    /** List of tags assigned to the media item. */
+    values?: string[];
+}
+interface ListGalleriesRequest {
+    /**
+     * Maximum number of media items to return. <br />
+     *
+     * Min: `1` <br />
+     * Max: `100` <br />
+     * Default: `10`
+     * @min 1
+     * @max 100
+     */
+    itemLimit?: number | null;
+    /**
+     * Number of galleries to skip in the response. <br />
+     *
+     * Default: `0`
+     */
+    offset?: number | null;
+    /**
+     * Maximum number of galleries to return. <br />
+     *
+     * Min: `1` <br />
+     * Max: `10` <br />
+     * Default: `10`
+     * @min 1
+     * @max 10
+     */
+    limit?: number | null;
+}
+interface ListGalleriesResponse {
+    /** Total number of galleries in the site. */
+    totalGalleries?: number | null;
+    /** List of galleries. Sorted by `createdDate`. */
+    galleries?: Gallery[];
+}
+interface GetGalleryRequest extends GetGalleryRequestVersionOneOf {
+    /**
+     * Gallery ID.
+     * @format GUID
+     */
+    galleryId: string;
+    /**
+     * Number of media items to skip in the response. <br />
+     *
+     * Default: `0`
+     */
+    itemOffset?: number | null;
+    /**
+     * Maximum number of media items to return. <br />
+     *
+     * Min: `1` <br />
+     * Max: `100` <br />
+     * Default: `50`
+     * @min 1
+     * @max 200
+     */
+    itemLimit?: number | null;
+}
+/** @oneof */
+interface GetGalleryRequestVersionOneOf {
+}
+interface GetGalleryResponse {
+    /** Returned gallery. */
+    gallery?: Gallery;
+}
+interface ListGalleryItemsRequest {
+    /**
+     * Gallery ID.
+     * @format GUID
+     */
+    galleryId: string;
+    /**
+     * Number of media items to skip in the response. <br />
+     *
+     * Default: `0`
+     */
+    itemOffset?: number | null;
+    /**
+     * Maximum number of media items to return. <br />
+     *
+     * Min: `1` <br />
+     * Max: `100` <br />
+     * Default: `50`
+     * @min 1
+     * @max 200
+     */
+    itemLimit?: number | null;
+}
+interface ListGalleryItemsResponse {
+    /** List of media items in the gallery. */
+    items?: Item[];
+}
+interface GetGalleryItemRequest {
+    /**
+     * Gallery ID.
+     * @format GUID
+     */
+    galleryId: string;
+    /**
+     * Item ID.
+     * @format GUID
+     */
+    itemId: string;
+}
+interface GetGalleryItemResponse {
+    /** Returned media item. */
+    item?: Item;
+}
+interface CreateGalleryRequest {
+    /** Gallery to create. */
+    gallery?: Gallery;
+    /**
+     * Gallery ID to clone from.
+     * @format GUID
+     */
+    cloneFromGalleryId?: string | null;
+}
+interface CreateGalleryResponse {
+    /** Created gallery. */
+    gallery?: Gallery;
+}
+interface UpdateGalleryRequest {
+    /** Gallery to update. */
+    gallery: Gallery;
+}
+interface UpdateGalleryResponse {
+    /** Updated gallery. */
+    gallery?: Gallery;
+}
+interface DeleteGalleryRequest {
+    /**
+     * ID of the gallery to delete.
+     * @format GUID
+     */
+    galleryId: string;
+}
+interface DeleteGalleryResponse {
+    /**
+     * ID of the deleted gallery.
+     * @readonly
+     * @format GUID
+     */
+    galleryId?: string;
+}
+interface DeleteGalleryItemsRequest {
+    /**
+     * Gallery ID.
+     * @format GUID
+     */
+    galleryId: string;
+    /**
+     * ID of the media item to delete.
+     * @format GUID
+     */
+    itemsIds?: string[];
+}
+interface DeleteGalleryItemsResponse {
+    /** Gallery that previously included the deleted media item. */
+    gallery?: Gallery;
+}
+interface BulkDeleteGalleryItemsRequest {
+    /**
+     * Gallery ID.
+     * @format GUID
+     */
+    galleryId: string;
+    /**
+     * IDs of the media items to delete.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 1000
+     */
+    itemIds: string[];
+}
+interface BulkDeleteGalleryItemsResponse {
+    /**
+     * IDs of the deleted media items.
+     * @readonly
+     * @format GUID
+     */
+    itemIds?: string[];
+}
+interface CreateGalleryItemRequest {
+    /**
+     * Gallery ID.
+     * @format GUID
+     */
+    galleryId: string;
+    /** Media item to create. */
+    item: Item;
+}
+interface CreateGalleryItemResponse {
+    /** Created media item. */
+    item?: Item;
+}
+interface UpdateGalleryItemRequest {
+    /**
+     * Gallery ID.
+     * @format GUID
+     */
+    galleryId: string;
+    /** Media item to update. */
+    item: Item;
+}
+interface UpdateGalleryItemResponse {
+    /** Updated media item. */
+    item?: Item;
+}
+interface DeleteGalleryItemRequest {
+    /**
+     * Gallery ID.
+     * @format GUID
+     */
+    galleryId: string;
+    /**
+     * ID of the media item to delete.
+     * @format GUID
+     */
+    itemId: string;
+}
+interface DeleteGalleryItemResponse {
+    /**
+     * ID of the deleted media item.
+     * @readonly
+     * @format GUID
+     */
+    itemId?: string;
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function listGalleries(): __PublicMethodMetaInfo<'GET', {}, ListGalleriesRequest$1, ListGalleriesRequest, ListGalleriesResponse$1, ListGalleriesResponse>;
+declare function getGallery(): __PublicMethodMetaInfo<'GET', {
+    galleryId: string;
+}, GetGalleryRequest$1, GetGalleryRequest, GetGalleryResponse$1, GetGalleryResponse>;
+declare function listGalleryItems(): __PublicMethodMetaInfo<'GET', {
+    galleryId: string;
+}, ListGalleryItemsRequest$1, ListGalleryItemsRequest, ListGalleryItemsResponse$1, ListGalleryItemsResponse>;
+declare function getGalleryItem(): __PublicMethodMetaInfo<'GET', {
+    galleryId: string;
+    itemId: string;
+}, GetGalleryItemRequest$1, GetGalleryItemRequest, GetGalleryItemResponse$1, GetGalleryItemResponse>;
+declare function createGallery(): __PublicMethodMetaInfo<'POST', {}, CreateGalleryRequest$1, CreateGalleryRequest, CreateGalleryResponse$1, CreateGalleryResponse>;
+declare function updateGallery(): __PublicMethodMetaInfo<'PATCH', {
+    galleryId: string;
+}, UpdateGalleryRequest$1, UpdateGalleryRequest, UpdateGalleryResponse$1, UpdateGalleryResponse>;
+declare function deleteGallery(): __PublicMethodMetaInfo<'DELETE', {
+    galleryId: string;
+}, DeleteGalleryRequest$1, DeleteGalleryRequest, DeleteGalleryResponse$1, DeleteGalleryResponse>;
+declare function deleteGalleryItems(): __PublicMethodMetaInfo<'DELETE', {
+    galleryId: string;
+}, DeleteGalleryItemsRequest$1, DeleteGalleryItemsRequest, DeleteGalleryItemsResponse$1, DeleteGalleryItemsResponse>;
+declare function bulkDeleteGalleryItems(): __PublicMethodMetaInfo<'POST', {
+    galleryId: string;
+}, BulkDeleteGalleryItemsRequest$1, BulkDeleteGalleryItemsRequest, BulkDeleteGalleryItemsResponse$1, BulkDeleteGalleryItemsResponse>;
+declare function createGalleryItem(): __PublicMethodMetaInfo<'POST', {
+    galleryId: string;
+}, CreateGalleryItemRequest$1, CreateGalleryItemRequest, CreateGalleryItemResponse$1, CreateGalleryItemResponse>;
+declare function updateGalleryItem(): __PublicMethodMetaInfo<'PATCH', {
+    galleryId: string;
+    itemId: string;
+}, UpdateGalleryItemRequest$1, UpdateGalleryItemRequest, UpdateGalleryItemResponse$1, UpdateGalleryItemResponse>;
+declare function deleteGalleryItem(): __PublicMethodMetaInfo<'DELETE', {
+    galleryId: string;
+    itemId: string;
+}, DeleteGalleryItemRequest$1, DeleteGalleryItemRequest, DeleteGalleryItemResponse$1, DeleteGalleryItemResponse>;
+
+export { type __PublicMethodMetaInfo, bulkDeleteGalleryItems, createGallery, createGalleryItem, deleteGallery, deleteGalleryItem, deleteGalleryItems, getGallery, getGalleryItem, listGalleries, listGalleryItems, updateGallery, updateGalleryItem };