@wix/auto_sdk_media-collections_media-collections 1.0.4 → 1.0.5

package/build/internal/cjs/src/collections-v1-collection-media-collections.universal.d.ts

@@ -1,1338 +0,0 @@
-import { NonNullablePaths } from '@wix/sdk-types';
-export interface MediaCollection {
-    /**
-     * Collection id
-     * @readonly
-     * @format GUID
-     */
-    _id?: string;
-    /**
-     * Collection name
-     * @maxLength 100
-     */
-    name?: string;
-    /** @maxLength 500 */
-    description?: string | null;
-    /**
-     * total count of MediaCollection members
-     * @readonly
-     */
-    membersCount?: number;
-    /**
-     * the member who created the MediaCollection
-     * @readonly
-     */
-    creator?: CollectionMember;
-    /**
-     * when MediaCollection was created
-     * @readonly
-     */
-    _createdDate?: Date | null;
-    /** Items in the collection */
-    items?: MediaCollectionItem[];
-    /**
-     * total count of items
-     * @readonly
-     */
-    itemsCount?: number;
-    /** Privacy settings */
-    privacySettings?: PrivacySettingsWithLiterals;
-    /** If true, the collection is locked and should not be updated */
-    locked?: boolean;
-}
-export interface CollectionMember {
-    /**
-     * Member id
-     * @readonly
-     * @format GUID
-     */
-    memberId?: string;
-    /**
-     * Member nickname
-     * @maxLength 100
-     */
-    nickname?: string | null;
-    /**
-     * Member slug
-     * @maxLength 100
-     */
-    slug?: string | null;
-    /**
-     * Member photo url
-     * @maxLength 200
-     */
-    photoUrl?: string | null;
-}
-export interface MediaCollectionItem extends MediaCollectionItemMetadataOneOf {
-    /** Photo metadata */
-    photoMetadata?: PhotoMetadata;
-    /** Video metadata */
-    videoMetadata?: VideoMetadata;
-    /** Text metadata */
-    textMetadata?: TextMetadata;
-    /**
-     * item id
-     * @readonly
-     * @format GUID
-     */
-    _id?: string | null;
-    /** item url for photos or video */
-    mediaUrl?: string | null;
-    /** if not present in an update it mean the item will be added as currentTimestamp */
-    sortOrder?: number | null;
-    /** item's original filename */
-    name?: string | null;
-    /** item's title */
-    title?: string | null;
-    /** item's description */
-    description?: string | null;
-    /** a link from the item to something else */
-    link?: Link;
-    /** item type: text, photo or video */
-    dataType?: DataTypeWithLiterals;
-    /**
-     * When the item was added to the collection
-     * @readonly
-     */
-    addedDate?: Date | null;
-    /**
-     * When the item was last updated
-     * @readonly
-     */
-    _updatedDate?: Date | null;
-    /** The owner of the media */
-    mediaOwner?: MediaOwnerWithLiterals;
-    /** Tags for media */
-    tags?: string[];
-    /** Token for media */
-    token?: string | null;
-    /** Gallery id */
-    galleryId?: string;
-}
-/** @oneof */
-export interface MediaCollectionItemMetadataOneOf {
-    /** Photo metadata */
-    photoMetadata?: PhotoMetadata;
-    /** Video metadata */
-    videoMetadata?: VideoMetadata;
-    /** Text metadata */
-    textMetadata?: TextMetadata;
-}
-export interface Link {
-    type?: TypeWithLiterals;
-    /** Link text */
-    text?: string | null;
-    /** Link url */
-    url?: string | null;
-    /** Link target */
-    target?: string | null;
-    /** Data on how to construct the link from wix editor inputs */
-    wixLinkData?: WixLink;
-}
-export declare enum Type {
-    /** Undefined */
-    Undefined = "Undefined",
-    /** external link */
-    External = "External",
-    /** link to wix pages */
-    Internal = "Internal"
-}
-/** @enumType */
-export type TypeWithLiterals = Type | 'Undefined' | 'External' | 'Internal';
-/** The link object generated by panels in the editor and used by applications in Wix */
-export interface WixLink extends WixLinkLinkOneOf {
-    /** External link type */
-    external?: ExternalLink;
-    /** Page link type */
-    page?: PageLink;
-    /** Anchor link type */
-    anchor?: AnchorLink;
-    /** Dynamic page link type */
-    dynamicPage?: DynamicPageLink;
-    /** Document link type */
-    document?: DocumentLink;
-    /** Email link type */
-    email?: EmailLink;
-    /** Phone link type */
-    phone?: PhoneLink;
-    /** Address link type */
-    address?: AddressLink;
-    /** WhatsApp link type */
-    whatsApp?: WhatsAppLink;
-    /** TPA link type */
-    tpaPage?: TpaPageLink;
-}
-/** @oneof */
-export interface WixLinkLinkOneOf {
-    /** External link type */
-    external?: ExternalLink;
-    /** Page link type */
-    page?: PageLink;
-    /** Anchor link type */
-    anchor?: AnchorLink;
-    /** Dynamic page link type */
-    dynamicPage?: DynamicPageLink;
-    /** Document link type */
-    document?: DocumentLink;
-    /** Email link type */
-    email?: EmailLink;
-    /** Phone link type */
-    phone?: PhoneLink;
-    /** Address link type */
-    address?: AddressLink;
-    /** WhatsApp link type */
-    whatsApp?: WhatsAppLink;
-    /** TPA link type */
-    tpaPage?: TpaPageLink;
-}
-export interface ExternalLink {
-    /**
-     * The url of the page
-     * @format WEB_URL
-     */
-    url?: string;
-    /** Where this link should open, supports _self and _blank or any name the user chooses. _self means same page, _blank means new page. */
-    target?: string | null;
-}
-/**
- * The 'rel' attribute of the link. The rel attribute defines the relationship between a linked resource and the current document.
- * Further reading (also about different possible rel types): https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel
- * Following are the accepted 'rel' types by Wix applications.
- */
-export declare enum LinkRel {
-    /** default (not implemented) */
-    unknown_link_rel = "unknown_link_rel",
-    /** Indicates that the current document's original author or publisher does not endorse the referenced document. */
-    nofollow = "nofollow",
-    /** Instructs the browser to navigate to the target resource without granting the new browsing context access to the document that opened it. */
-    noopener = "noopener",
-    /** No Referer header will be included. Additionally, has the same effect as noopener. */
-    noreferrer = "noreferrer",
-    /** Indicates a link that resulted from advertisements or paid placements. */
-    sponsored = "sponsored"
-}
-/** @enumType */
-export type LinkRelWithLiterals = LinkRel | 'unknown_link_rel' | 'nofollow' | 'noopener' | 'noreferrer' | 'sponsored';
-export interface PageLink {
-    /** The page id we want from the site */
-    pageId?: string;
-    /** Where this link should open, supports _self and _blank or any name the user chooses. _self means same page, _blank means new page. */
-    target?: string | null;
-    /**
-     * rel of link
-     * @maxSize 20
-     */
-    rel?: LinkRelWithLiterals[];
-}
-export interface AnchorLink {
-    /** The name of the anchor */
-    anchorName?: string;
-    /** The data id (from the JSON page) of the anchor that should be used */
-    anchorDataId?: string;
-    /** The page id we want from the site */
-    pageId?: string;
-    /**
-     * rel of link
-     * @maxSize 20
-     */
-    rel?: LinkRelWithLiterals[];
-}
-export interface DynamicPageLink {
-    /** The router that handles this link */
-    routerId?: string;
-    /** The path data we'd like */
-    innerRoute?: string;
-    /** The data id (from the JSON page) of the anchor that should be used */
-    anchorDataId?: string | null;
-    /**
-     * rel of link
-     * @maxSize 20
-     */
-    rel?: LinkRelWithLiterals[];
-}
-export interface DocumentLink {
-    /** The id of the document */
-    docId?: string;
-    /** The name of the document for download purposes */
-    name?: string | null;
-    /** If this document can be indexed by scrapers, default is false */
-    indexable?: boolean;
-}
-export interface EmailLink {
-    /**
-     * The email we will be sending a message to
-     * @format EMAIL
-     */
-    recipient?: string;
-    /** The subject of the email */
-    subject?: string | null;
-    /** The body of the email */
-    body?: string | null;
-}
-export interface PhoneLink {
-    /**
-     * The phone number we want to link to
-     * @format PHONE
-     * @maxLength 100
-     */
-    phoneNumber?: string;
-}
-export interface AddressLink {
-    /** An address that we can link to */
-    address?: string;
-}
-export interface WhatsAppLink {
-    /**
-     * The whatsApp phone number we want to connect with
-     * @format PHONE
-     */
-    phoneNumber?: string;
-}
-/** Link to a TPA page */
-export interface TpaPageLink {
-    /** Type of item (e.g. 'wix.stores.sub_pages.product') */
-    itemTypeIdentifier?: string;
-    /** Id of linked item */
-    itemId?: string;
-    /** Id of linked page */
-    pageId?: string;
-    /** Id of app being linked to (AppDefId) */
-    appDefinitionId?: string;
-    /** The relativepath of linked page */
-    path?: string;
-    /**
-     * rel of link
-     * @maxSize 20
-     */
-    rel?: LinkRelWithLiterals[];
-}
-export declare enum DataType {
-    Undefined = "Undefined",
-    Photo = "Photo",
-    Video = "Video",
-    Text = "Text"
-}
-/** @enumType */
-export type DataTypeWithLiterals = DataType | 'Undefined' | 'Photo' | 'Video' | 'Text';
-export interface PhotoMetadata {
-    /** Photo width */
-    width?: number | null;
-    /** Photo height */
-    height?: number | null;
-    /** The focal point of the image */
-    focalPoint?: Point;
-    /** aka Exchangeable image file format */
-    exif?: Record<string, any> | null;
-    /**
-     * the image quality
-     * @min 30
-     * @max 100
-     */
-    quality?: number | null;
-    /** photo sharpening */
-    unsharpMasking?: UnsharpMasking;
-    /** id in WixMedia */
-    mediaId?: string | null;
-}
-export interface Point {
-    /** x coordinate */
-    x?: number;
-    /** y coordinate */
-    y?: number;
-}
-export interface UnsharpMasking {
-    /**
-     * number controls the amount of contrast that is added at the edges.
-     * @max 5
-     */
-    amount?: number | null;
-    /** number in pixels. The size of the edges to be enhanced */
-    radius?: number | null;
-    /**
-     * The minimal level of brightness change that will be sharpened
-     * @max 1
-     */
-    threshold?: number | null;
-}
-export interface VideoMetadata {
-    /** Video width */
-    width?: number | null;
-    /** Video height */
-    height?: number | null;
-    /** Video duration in milliseconds */
-    duration?: string | null;
-    /** Video source */
-    source?: SourceWithLiterals;
-    /** Video posters */
-    posters?: Thumbnail[];
-    /** Video resolutions */
-    resolutions?: Resolution[];
-    /** External source's representation for this video's id */
-    externalId?: string | null;
-}
-export declare enum Source {
-    /** Undefined */
-    Undefined = "Undefined",
-    /** Youtube */
-    Youtube = "Youtube",
-    /** Vimeo */
-    Vimeo = "Vimeo",
-    /** Custom */
-    Custom = "Custom"
-}
-/** @enumType */
-export type SourceWithLiterals = Source | 'Undefined' | 'Youtube' | 'Vimeo' | 'Custom';
-export interface Thumbnail {
-    /** Thumbnail url */
-    url?: string | null;
-    /** Thumbnail width */
-    width?: number | null;
-    /** Thumbnail height */
-    height?: number | null;
-    /** Is this the default thumbnail */
-    default?: boolean | null;
-    /** The focal point of the image */
-    focalPoint?: Point;
-}
-export interface Resolution {
-    /** eg 720p, 1024p etc */
-    videoMode?: string | null;
-    /** Video width */
-    width?: number | null;
-    /** Video height */
-    height?: number | null;
-    /** Map representing the file format (eg mp4)  to the url. In case of an external source the format can be youtube, vimeo, etc. */
-    urls?: Record<string, string>;
-}
-export interface TextMetadata {
-    /** text data */
-    html?: string | null;
-    /** css style info for container */
-    style?: Record<string, any> | null;
-    /** populated via progallery app only (ck editor format) */
-    editorHtml?: string | null;
-    /** the wix editor's font Id used to display the text data */
-    editorFontId?: string | null;
-}
-export declare enum MediaOwner {
-    /** Undefined */
-    Undefined = "Undefined",
-    /** Wix */
-    Wix = "Wix",
-    /** DeviantArt */
-    DeviantArt = "DeviantArt",
-    /** Custom */
-    Custom = "Custom"
-}
-/** @enumType */
-export type MediaOwnerWithLiterals = MediaOwner | 'Undefined' | 'Wix' | 'DeviantArt' | 'Custom';
-export declare enum PrivacySettings {
-    /** Undefined */
-    Undefined = "Undefined",
-    /** Public */
-    Public = "Public",
-    /** Secret */
-    Secret = "Secret"
-}
-/** @enumType */
-export type PrivacySettingsWithLiterals = PrivacySettings | 'Undefined' | 'Public' | 'Secret';
-export interface PermanentSiteDeletedResponse {
-    /** @format GUID */
-    requestId?: string;
-    uniqueServiceIdentifier?: string;
-    status?: StatusWithLiterals;
-    /** @readonly */
-    _createdDate?: Date | null;
-}
-export declare enum Status {
-    UNKNOWN = "UNKNOWN",
-    HANDLED = "HANDLED",
-    NOTHING_TO_HANDLE = "NOTHING_TO_HANDLE"
-}
-/** @enumType */
-export type StatusWithLiterals = Status | 'UNKNOWN' | 'HANDLED' | 'NOTHING_TO_HANDLE';
-export interface Empty {
-}
-export interface DomainEvent extends DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
-    _id?: string;
-    /**
-     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
-     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
-     */
-    entityFqdn?: string;
-    /**
-     * Event action name, placed at the top level to make it easier for users to dispatch messages.
-     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
-     */
-    slug?: string;
-    /** ID of the entity associated with the event. */
-    entityId?: string;
-    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
-    eventTime?: Date | null;
-    /**
-     * Whether the event was triggered as a result of a privacy regulation application
-     * (for example, GDPR).
-     */
-    triggeredByAnonymizeRequest?: boolean | null;
-    /** If present, indicates the action that triggered the event. */
-    originatedFrom?: string | null;
-    /**
-     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
-     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
-     */
-    entityEventSequence?: string | null;
-}
-/** @oneof */
-export interface DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-}
-export interface EntityCreatedEvent {
-    entity?: string;
-}
-export interface RestoreInfo {
-    deletedDate?: Date | null;
-}
-export interface EntityUpdatedEvent {
-    /**
-     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
-     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
-     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
-     */
-    currentEntity?: string;
-}
-export interface EntityDeletedEvent {
-    /** Entity that was deleted. */
-    deletedEntity?: string | null;
-}
-export interface ActionEvent {
-    body?: string;
-}
-export interface MessageEnvelope {
-    /**
-     * App instance ID.
-     * @format GUID
-     */
-    instanceId?: string | null;
-    /**
-     * Event type.
-     * @maxLength 150
-     */
-    eventType?: string;
-    /** The identification type and identity data. */
-    identity?: IdentificationData;
-    /** Stringify payload. */
-    data?: string;
-}
-export interface IdentificationData extends IdentificationDataIdOneOf {
-    /**
-     * ID of a site visitor that has not logged in to the site.
-     * @format GUID
-     */
-    anonymousVisitorId?: string;
-    /**
-     * ID of a site visitor that has logged in to the site.
-     * @format GUID
-     */
-    memberId?: string;
-    /**
-     * ID of a Wix user (site owner, contributor, etc.).
-     * @format GUID
-     */
-    wixUserId?: string;
-    /**
-     * ID of an app.
-     * @format GUID
-     */
-    appId?: string;
-    /** @readonly */
-    identityType?: WebhookIdentityTypeWithLiterals;
-}
-/** @oneof */
-export interface IdentificationDataIdOneOf {
-    /**
-     * ID of a site visitor that has not logged in to the site.
-     * @format GUID
-     */
-    anonymousVisitorId?: string;
-    /**
-     * ID of a site visitor that has logged in to the site.
-     * @format GUID
-     */
-    memberId?: string;
-    /**
-     * ID of a Wix user (site owner, contributor, etc.).
-     * @format GUID
-     */
-    wixUserId?: string;
-    /**
-     * ID of an app.
-     * @format GUID
-     */
-    appId?: string;
-}
-export declare enum WebhookIdentityType {
-    UNKNOWN = "UNKNOWN",
-    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
-    MEMBER = "MEMBER",
-    WIX_USER = "WIX_USER",
-    APP = "APP"
-}
-/** @enumType */
-export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
-export interface CollectionEvent extends CollectionEventEventTypeOneOf {
-    /** Collection created */
-    collectionCreated?: CollectionCreated;
-    /** Items added to collection */
-    itemsAddedToCollection?: ItemsAddedToCollection;
-    /** Items removed from collection */
-    itemsRemovedFromCollection?: ItemsRemovedFromCollection;
-    /** Member joined to collection */
-    memberJoinedToCollection?: MemberJoinedToCollection;
-    /** Member left collection */
-    memberLeftCollection?: MemberLeftCollection;
-}
-/** @oneof */
-export interface CollectionEventEventTypeOneOf {
-    /** Collection created */
-    collectionCreated?: CollectionCreated;
-    /** Items added to collection */
-    itemsAddedToCollection?: ItemsAddedToCollection;
-    /** Items removed from collection */
-    itemsRemovedFromCollection?: ItemsRemovedFromCollection;
-    /** Member joined to collection */
-    memberJoinedToCollection?: MemberJoinedToCollection;
-    /** Member left collection */
-    memberLeftCollection?: MemberLeftCollection;
-}
-export interface CollectionItemId {
-    /**
-     * Id of the gallery in ProGallery
-     * @format GUID
-     */
-    galleryId?: string;
-    /**
-     * Id of the item in ProGallery
-     * @format GUID
-     */
-    itemId?: string;
-}
-export interface CollectionCreated {
-    /**
-     * Collection id
-     * @format GUID
-     */
-    _id?: string;
-    /**
-     * Collection name
-     * @maxLength 100
-     */
-    name?: string;
-    /**
-     * Collection description
-     * @maxLength 500
-     */
-    description?: string | null;
-    /**
-     * Id of the member who created the collection
-     * @format GUID
-     */
-    creatorMemberId?: string;
-    /** When the collection was created */
-    _createdDate?: Date | null;
-    /** Privacy settings */
-    privacySettings?: PrivacySettingsWithLiterals;
-}
-export interface ItemsAddedToCollection {
-    /**
-     * Id of the collection
-     * @format GUID
-     */
-    collectionId?: string;
-    /**
-     * Id of the member who added items
-     * @format GUID
-     */
-    addedByMember?: string;
-    /** Ids of the items that were added */
-    collectionItemIds?: CollectionItemId[];
-    /** When the items were added */
-    addedDate?: Date | null;
-}
-export interface ItemsRemovedFromCollection {
-    /**
-     * Id of the collection
-     * @format GUID
-     */
-    collectionId?: string;
-    /**
-     * Id of the member who removed items
-     * @format GUID
-     */
-    removedByMember?: string;
-    /**
-     * Ids of the items that were removed
-     * @format GUID
-     */
-    itemIds?: string[];
-    /** When the items were removed */
-    removedDate?: Date | null;
-}
-export interface MemberJoinedToCollection {
-    /**
-     * Id of the collection
-     * @format GUID
-     */
-    collectionId?: string;
-    /**
-     * Id of the member who joined
-     * @format GUID
-     */
-    memberId?: string;
-    /** When the member was joined */
-    joinedDate?: Date | null;
-}
-export interface MemberLeftCollection {
-    /**
-     * Id of the collection
-     * @format GUID
-     */
-    collectionId?: string;
-    /**
-     * Id of the member who left
-     * @format GUID
-     */
-    memberId?: string;
-    /** When the member left */
-    leftDate?: Date | null;
-}
-export interface GetMediaCollectionRequest {
-    /**
-     * Collection id
-     * @format GUID
-     */
-    mediaCollectionId: string;
-    /** number of items to skip in the current sort order, default is 0 */
-    offset?: number | null;
-    /**
-     * The amount of items per response, default is 50
-     * @min 1
-     * @max 200
-     */
-    limit?: number | null;
-}
-export interface GetMediaCollectionResponse {
-    /** The collection */
-    mediaCollection?: MediaCollection;
-    /** The member's status in the collection */
-    memberStatus?: MemberStatusWithLiterals;
-}
-export declare enum MemberStatus {
-    /** Undefined */
-    UNDEFINED = "UNDEFINED",
-    /** Not a member */
-    NOT_MEMBER = "NOT_MEMBER",
-    /** Member */
-    MEMBER = "MEMBER",
-    /** Admin */
-    ADMIN = "ADMIN"
-}
-/** @enumType */
-export type MemberStatusWithLiterals = MemberStatus | 'UNDEFINED' | 'NOT_MEMBER' | 'MEMBER' | 'ADMIN';
-export interface ListCollectionsForItemRequest {
-    /**
-     * Gallery id
-     * @format GUID
-     */
-    galleryId?: string;
-    /**
-     * Item id
-     * @format GUID
-     */
-    itemId: string;
-}
-export interface ListCollectionsForItemResponse {
-    /** The collections that the item belongs to */
-    itemInCollections?: ItemInCollection[];
-}
-export interface ItemInCollection {
-    /**
-     * Collection id
-     * @format GUID
-     */
-    mediaCollectionId?: string;
-    /**
-     * Collection name
-     * @minLength 1
-     * @maxLength 100
-     */
-    name?: string;
-    /** Is the item in the collection */
-    isItemInCollection?: boolean;
-    /** Is the collection locked */
-    isLocked?: boolean;
-    /** Member's role in the collection */
-    role?: MemberStatusWithLiterals;
-    /** Total count of items in the collection */
-    totalItemsCount?: number | null;
-    /** The first item in the collection */
-    firstItem?: MediaCollectionItem;
-    /**
-     * The creator's nickname
-     * @maxLength 100
-     */
-    creatorNickname?: string | null;
-}
-export interface GetCollectionItemRequest {
-    /**
-     * Collection id
-     * @format GUID
-     */
-    mediaCollectionId: string;
-    /**
-     * Item id
-     * @format GUID
-     */
-    itemId: string;
-}
-export interface GetCollectionItemResponse {
-    /** The item */
-    item?: MediaCollectionItem;
-}
-export interface ListMediaCollectionsRequest {
-    /**
-     * the amount of collections per response, default is 1000
-     * @min 1
-     * @max 2000
-     */
-    limit?: number | null;
-    /** number of collections to skip in the current sort order, default is 0 */
-    offset?: number | null;
-    /**
-     * If empty, no filter will be applied
-     * Else, will return only collections that the member has those roles on them. Currently supporting: MEMBER, ADMIN.
-     */
-    filterByRoles?: FilterByRoles;
-}
-export interface FilterByRoles {
-    roles?: MemberStatusWithLiterals[];
-}
-export interface ListMediaCollectionsResponse {
-    /** The collections and the member's role in them */
-    collectionsStatus?: CollectionAndStatus[];
-    /**
-     * total count of MediaCollection members
-     * @readonly
-     */
-    totalCollectionsCount?: number | null;
-}
-export interface CollectionAndStatus {
-    /** The Media Collection */
-    mediaCollection?: MediaCollection;
-    /** The member's status in the collection */
-    memberStatus?: MemberStatusWithLiterals;
-}
-export interface CreateMediaCollectionRequest {
-    /**
-     * Name of the collection
-     * @minLength 1
-     * @maxLength 100
-     */
-    name: string;
-    /**
-     * Description of the collection
-     * @maxLength 500
-     */
-    description?: string | null;
-    /** Privacy settings of the collection */
-    privacySettings?: PrivacySettingsWithLiterals;
-    /** Items to add to the collection */
-    items?: AddItem[];
-}
-export interface AddItem {
-    /**
-     * Gallery id
-     * @format GUID
-     */
-    galleryId?: string;
-    /**
-     * Item id
-     * @format GUID
-     */
-    itemId?: string;
-    /** Order index of the item */
-    orderIndex?: number | null;
-}
-export interface CreateMediaCollectionResponse {
-    /**
-     * id of the collection that was created
-     * @format GUID
-     */
-    mediaCollectionId?: string;
-}
-export interface PartiallyUpdateMediaCollectionRequest {
-    /** Collection to update */
-    mediaCollection: MediaCollection;
-    /**
-     * fields to update
-     * supported fields: name, description, privacy_settings
-     */
-    fieldMask: string[];
-}
-export interface PartiallyUpdateMediaCollectionResponse {
-}
-export interface UpdateCollectionLockRequest {
-    /**
-     * Collection to lock
-     * @format GUID
-     */
-    mediaCollectionId?: string;
-    /** Lock status */
-    locked?: boolean;
-}
-export interface UpdateCollectionLockResponse {
-}
-export interface DeleteMediaCollectionRequest {
-    /**
-     * the collection to delete
-     * @format GUID
-     */
-    mediaCollectionId: string;
-}
-export interface DeleteMediaCollectionResponse {
-}
-export interface ListCollectionMembersRequest {
-    /**
-     * the collection to get its members
-     * @format GUID
-     */
-    mediaCollectionId: string;
-    /** Filter the members by their role in the collection */
-    filterBy?: FilterBy;
-}
-export interface FilterBy {
-    /** Member's status in the collection */
-    memberStatus?: MemberStatusWithLiterals;
-}
-export interface ListCollectionMembersResponse {
-    /** The collection's members and their roles */
-    membersRoles?: MemberAndStatus[];
-}
-export interface MemberAndStatus {
-    /** The member */
-    member?: CollectionMember;
-    /** The member's role in the collection */
-    memberStatus?: MemberStatusWithLiterals;
-}
-export interface AddItemsRequest {
-    /**
-     * Collection to add items
-     * @format GUID
-     */
-    mediaCollectionId: string;
-    /** Items to add */
-    items?: AddItem[];
-}
-export interface AddItemsResponse {
-}
-export interface RemoveItemsRequest {
-    /**
-     * Collection to remove items from
-     * @format GUID
-     */
-    mediaCollectionId: string;
-    /**
-     * Items to remove
-     * @format GUID
-     */
-    itemsIds?: string[];
-}
-export interface RemoveItemsResponse {
-}
-export interface UpdateItemsRequest {
-    /**
-     * Collection to update items
-     * @format GUID
-     */
-    mediaCollectionId?: string;
-    items?: UpdateItem[];
-}
-export interface UpdateItem {
-    /**
-     * Item to update
-     * @format GUID
-     */
-    itemId?: string;
-    /** New order index of the item */
-    orderIndex?: number;
-}
-export interface UpdateItemsResponse {
-}
-export interface JoinToCollectionRequest {
-    /**
-     * Collection to join
-     * @format GUID
-     */
-    mediaCollectionId: string;
-}
-export interface JoinToCollectionResponse {
-}
-export interface RemoveMemberFromCollectionRequest {
-    /**
-     * Collection the member will be removed from being a member
-     * @format GUID
-     */
-    mediaCollectionId?: string;
-    /**
-     * Member id to remove from the collection
-     * @format GUID
-     */
-    memberId?: string;
-}
-export interface RemoveMemberFromCollectionResponse {
-}
-export interface LeaveCollectionRequest {
-    /**
-     * Collection the member will be leaving
-     * @format GUID
-     */
-    mediaCollectionId: string;
-}
-export interface LeaveCollectionResponse {
-}
-export interface ListCollectionItemsRequest {
-    /**
-     * Collection to get its items
-     * @format GUID
-     */
-    mediaCollectionId: string;
-}
-export interface ListCollectionItemsResponse {
-    /** The collection's items */
-    collectionItems?: CollectionItem[];
-}
-export interface CollectionItem {
-    /**
-     * Gallery id
-     * @format GUID
-     */
-    galleryId?: string;
-    /**
-     * Item id
-     * @format GUID
-     */
-    itemId?: string;
-    /** Order index of the item */
-    orderIndex?: number | null;
-    /** Date the item was added to the collection */
-    addedDate?: Date | null;
-}
-export interface ListAllItemsBelongToCollectionRequest {
-}
-export interface ListAllItemsBelongToCollectionResponse {
-    /**
-     * List of the item ids that belong to one or more collection
-     * @format GUID
-     */
-    itemIds?: string[];
-}
-export interface BaseEventMetadata {
-    /**
-     * App instance ID.
-     * @format GUID
-     */
-    instanceId?: string | null;
-    /**
-     * Event type.
-     * @maxLength 150
-     */
-    eventType?: string;
-    /** The identification type and identity data. */
-    identity?: IdentificationData;
-}
-export interface EventMetadata extends BaseEventMetadata {
-    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
-    _id?: string;
-    /**
-     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
-     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
-     */
-    entityFqdn?: string;
-    /**
-     * Event action name, placed at the top level to make it easier for users to dispatch messages.
-     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
-     */
-    slug?: string;
-    /** ID of the entity associated with the event. */
-    entityId?: string;
-    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
-    eventTime?: Date | null;
-    /**
-     * Whether the event was triggered as a result of a privacy regulation application
-     * (for example, GDPR).
-     */
-    triggeredByAnonymizeRequest?: boolean | null;
-    /** If present, indicates the action that triggered the event. */
-    originatedFrom?: string | null;
-    /**
-     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
-     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
-     */
-    entityEventSequence?: string | null;
-}
-export interface CollectionCreatedEnvelope {
-    entity: MediaCollection;
-    metadata: EventMetadata;
-}
-/** @webhook
- * @eventType wix.collections.collection_created
- * @serviceIdentifier com.wixpress.exposure.mediacollections.MediaCollectionsService
- * @slug created
- * @documentationMaturity preview
- */
-export declare function onCollectionCreated(handler: (event: CollectionCreatedEnvelope) => void | Promise<void>): void;
-type CollectionNonNullablePaths = `_id` | `name` | `membersCount` | `creator.memberId` | `items` | `items.${number}.photoMetadata.focalPoint.x` | `items.${number}.photoMetadata.focalPoint.y` | `items.${number}.videoMetadata.source` | `items.${number}.link.type` | `items.${number}.link.wixLinkData.external.url` | `items.${number}.link.wixLinkData.page.pageId` | `items.${number}.link.wixLinkData.anchor.anchorName` | `items.${number}.link.wixLinkData.anchor.anchorDataId` | `items.${number}.link.wixLinkData.anchor.pageId` | `items.${number}.link.wixLinkData.dynamicPage.routerId` | `items.${number}.link.wixLinkData.dynamicPage.innerRoute` | `items.${number}.link.wixLinkData.document.docId` | `items.${number}.link.wixLinkData.document.indexable` | `items.${number}.link.wixLinkData.email.recipient` | `items.${number}.link.wixLinkData.phone.phoneNumber` | `items.${number}.link.wixLinkData.address.address` | `items.${number}.link.wixLinkData.whatsApp.phoneNumber` | `items.${number}.link.wixLinkData.tpaPage.itemTypeIdentifier` | `items.${number}.link.wixLinkData.tpaPage.itemId` | `items.${number}.link.wixLinkData.tpaPage.pageId` | `items.${number}.link.wixLinkData.tpaPage.appDefinitionId` | `items.${number}.link.wixLinkData.tpaPage.path` | `items.${number}.dataType` | `items.${number}.mediaOwner` | `items.${number}.galleryId` | `itemsCount` | `privacySettings` | `locked`;
-/**
- * Get a specific collection by its id
- * @param mediaCollectionId - Collection id
- * @public
- * @documentationMaturity preview
- * @requiredField mediaCollectionId
- * @returns The collection
- * @fqn com.wixpress.exposure.mediacollections.MediaCollectionsService.Get
- */
-export declare function get(mediaCollectionId: string, options?: GetOptions): Promise<NonNullablePaths<MediaCollection, CollectionNonNullablePaths>>;
-export interface GetOptions {
-    /** number of items to skip in the current sort order, default is 0 */
-    offset?: number | null;
-    /**
-     * The amount of items per response, default is 50
-     * @min 1
-     * @max 200
-     */
-    limit?: number | null;
-}
-/**
- * List all collections that the member has a role in them
- * @param itemId - Item id
- * @public
- * @documentationMaturity preview
- * @requiredField itemId
- * @fqn com.wixpress.exposure.mediacollections.MediaCollectionsService.ListCollectionsForItem
- */
-export declare function listCollectionsForItem(itemId: string, options?: ListCollectionsForItemOptions): Promise<NonNullablePaths<ListCollectionsForItemResponse, `itemInCollections` | `itemInCollections.${number}.mediaCollectionId` | `itemInCollections.${number}.name` | `itemInCollections.${number}.isItemInCollection` | `itemInCollections.${number}.isLocked` | `itemInCollections.${number}.role` | `itemInCollections.${number}.firstItem.photoMetadata.focalPoint.x` | `itemInCollections.${number}.firstItem.photoMetadata.focalPoint.y` | `itemInCollections.${number}.firstItem.videoMetadata.source` | `itemInCollections.${number}.firstItem.link.type` | `itemInCollections.${number}.firstItem.link.wixLinkData.external.url` | `itemInCollections.${number}.firstItem.link.wixLinkData.page.pageId` | `itemInCollections.${number}.firstItem.link.wixLinkData.anchor.anchorName` | `itemInCollections.${number}.firstItem.link.wixLinkData.anchor.anchorDataId` | `itemInCollections.${number}.firstItem.link.wixLinkData.anchor.pageId` | `itemInCollections.${number}.firstItem.link.wixLinkData.dynamicPage.routerId` | `itemInCollections.${number}.firstItem.link.wixLinkData.dynamicPage.innerRoute` | `itemInCollections.${number}.firstItem.link.wixLinkData.document.docId` | `itemInCollections.${number}.firstItem.link.wixLinkData.document.indexable` | `itemInCollections.${number}.firstItem.link.wixLinkData.email.recipient` | `itemInCollections.${number}.firstItem.link.wixLinkData.phone.phoneNumber` | `itemInCollections.${number}.firstItem.link.wixLinkData.address.address` | `itemInCollections.${number}.firstItem.link.wixLinkData.whatsApp.phoneNumber` | `itemInCollections.${number}.firstItem.link.wixLinkData.tpaPage.itemTypeIdentifier` | `itemInCollections.${number}.firstItem.link.wixLinkData.tpaPage.itemId` | `itemInCollections.${number}.firstItem.link.wixLinkData.tpaPage.pageId` | `itemInCollections.${number}.firstItem.link.wixLinkData.tpaPage.appDefinitionId` | `itemInCollections.${number}.firstItem.link.wixLinkData.tpaPage.path` | `itemInCollections.${number}.firstItem.dataType` | `itemInCollections.${number}.firstItem.mediaOwner` | `itemInCollections.${number}.firstItem.galleryId`>>;
-export interface ListCollectionsForItemOptions {
-    /**
-     * Gallery id
-     * @format GUID
-     */
-    galleryId?: string;
-}
-/**
- * Get a specific item from a collection
- * @public
- * @documentationMaturity preview
- * @requiredField identifiers
- * @requiredField identifiers.itemId
- * @requiredField identifiers.mediaCollectionId
- * @fqn com.wixpress.exposure.mediacollections.MediaCollectionsService.GetCollectionItem
- */
-export declare function getCollectionItem(identifiers: NonNullablePaths<GetCollectionItemIdentifiers, `itemId` | `mediaCollectionId`>): Promise<NonNullablePaths<GetCollectionItemResponse, `item.photoMetadata.focalPoint.x` | `item.photoMetadata.focalPoint.y` | `item.videoMetadata.source` | `item.videoMetadata.posters` | `item.videoMetadata.resolutions` | `item.link.type` | `item.link.wixLinkData.external.url` | `item.link.wixLinkData.page.pageId` | `item.link.wixLinkData.page.rel` | `item.link.wixLinkData.anchor.anchorName` | `item.link.wixLinkData.anchor.anchorDataId` | `item.link.wixLinkData.anchor.pageId` | `item.link.wixLinkData.anchor.rel` | `item.link.wixLinkData.dynamicPage.routerId` | `item.link.wixLinkData.dynamicPage.innerRoute` | `item.link.wixLinkData.dynamicPage.rel` | `item.link.wixLinkData.document.docId` | `item.link.wixLinkData.document.indexable` | `item.link.wixLinkData.email.recipient` | `item.link.wixLinkData.phone.phoneNumber` | `item.link.wixLinkData.address.address` | `item.link.wixLinkData.whatsApp.phoneNumber` | `item.link.wixLinkData.tpaPage.itemTypeIdentifier` | `item.link.wixLinkData.tpaPage.itemId` | `item.link.wixLinkData.tpaPage.pageId` | `item.link.wixLinkData.tpaPage.appDefinitionId` | `item.link.wixLinkData.tpaPage.path` | `item.link.wixLinkData.tpaPage.rel` | `item.dataType` | `item.mediaOwner` | `item.tags` | `item.galleryId`>>;
-export interface GetCollectionItemIdentifiers {
-    /**
-     * Collection id
-     * @format GUID
-     */
-    mediaCollectionId: string;
-    /**
-     * Item id
-     * @format GUID
-     */
-    itemId: string;
-}
-/**
- * List all collections that the item belongs to
- * @public
- * @documentationMaturity preview
- * @fqn com.wixpress.exposure.mediacollections.MediaCollectionsService.List
- */
-export declare function list(options?: ListOptions): Promise<NonNullablePaths<ListMediaCollectionsResponse, `collectionsStatus` | {
-    [P in CollectionNonNullablePaths]: `collectionsStatus.${number}.mediaCollection.${P}`;
-}[CollectionNonNullablePaths] | `collectionsStatus.${number}.memberStatus`>>;
-export interface ListOptions {
-    /**
-     * the amount of collections per response, default is 1000
-     * @min 1
-     * @max 2000
-     */
-    limit?: number | null;
-    /** number of collections to skip in the current sort order, default is 0 */
-    offset?: number | null;
-    /**
-     * If empty, no filter will be applied
-     * Else, will return only collections that the member has those roles on them. Currently supporting: MEMBER, ADMIN.
-     */
-    filterByRoles?: FilterByRoles;
-}
-/**
- * Create a new collection
- * @param name - Name of the collection
- * @public
- * @documentationMaturity preview
- * @requiredField name
- * @fqn com.wixpress.exposure.mediacollections.MediaCollectionsService.Create
- */
-export declare function create(name: string, options?: CreateOptions): Promise<NonNullablePaths<CreateMediaCollectionResponse, `mediaCollectionId`>>;
-export interface CreateOptions {
-    /**
-     * Description of the collection
-     * @maxLength 500
-     */
-    description?: string | null;
-    /** Privacy settings of the collection */
-    privacySettings?: PrivacySettingsWithLiterals;
-    /** Items to add to the collection */
-    items?: AddItem[];
-}
-/**
- * Update a collection
- * @param _id - Collection id
- * @public
- * @documentationMaturity preview
- * @requiredField _id
- * @requiredField mediaCollection
- * @requiredField options
- * @requiredField options.fieldMask
- * @fqn com.wixpress.exposure.mediacollections.MediaCollectionsService.PartiallyUpdate
- */
-export declare function partiallyUpdate(_id: string, mediaCollection: PartiallyUpdateMediaCollection, options: NonNullablePaths<PartiallyUpdateOptions, `fieldMask`>): Promise<void>;
-export interface PartiallyUpdateMediaCollection {
-    /**
-     * Collection id
-     * @readonly
-     * @format GUID
-     */
-    _id?: string;
-    /**
-     * Collection name
-     * @maxLength 100
-     */
-    name?: string;
-    /** @maxLength 500 */
-    description?: string | null;
-    /**
-     * total count of MediaCollection members
-     * @readonly
-     */
-    membersCount?: number;
-    /**
-     * the member who created the MediaCollection
-     * @readonly
-     */
-    creator?: CollectionMember;
-    /**
-     * when MediaCollection was created
-     * @readonly
-     */
-    _createdDate?: Date | null;
-    /** Items in the collection */
-    items?: MediaCollectionItem[];
-    /**
-     * total count of items
-     * @readonly
-     */
-    itemsCount?: number;
-    /** Privacy settings */
-    privacySettings?: PrivacySettingsWithLiterals;
-    /** If true, the collection is locked and should not be updated */
-    locked?: boolean;
-}
-export interface PartiallyUpdateOptions {
-    /**
-     * fields to update
-     * supported fields: name, description, privacy_settings
-     */
-    fieldMask: string[];
-}
-/**
- * Delete a collection
- * @param mediaCollectionId - the collection to delete
- * @public
- * @documentationMaturity preview
- * @requiredField mediaCollectionId
- * @fqn com.wixpress.exposure.mediacollections.MediaCollectionsService._delete
- */
-export declare function _delete(mediaCollectionId: string): Promise<void>;
-/**
- * List all members of a collection
- * @param mediaCollectionId - the collection to get its members
- * @public
- * @documentationMaturity preview
- * @requiredField mediaCollectionId
- * @fqn com.wixpress.exposure.mediacollections.MediaCollectionsService.ListCollectionMembers
- */
-export declare function listCollectionMembers(mediaCollectionId: string, options?: ListCollectionMembersOptions): Promise<NonNullablePaths<ListCollectionMembersResponse, `membersRoles` | `membersRoles.${number}.member.memberId` | `membersRoles.${number}.memberStatus`>>;
-export interface ListCollectionMembersOptions {
-    /** Filter the members by their role in the collection */
-    filterBy?: FilterBy;
-}
-/**
- * Add items to a collection
- * @param mediaCollectionId - Collection to add items
- * @public
- * @documentationMaturity preview
- * @requiredField mediaCollectionId
- * @fqn com.wixpress.exposure.mediacollections.MediaCollectionsService.AddItems
- */
-export declare function addItems(mediaCollectionId: string, options?: AddItemsOptions): Promise<void>;
-export interface AddItemsOptions {
-    /** Items to add */
-    items?: AddItem[];
-}
-/**
- * Remove items from a collection
- * @param mediaCollectionId - Collection to remove items from
- * @public
- * @documentationMaturity preview
- * @requiredField mediaCollectionId
- * @fqn com.wixpress.exposure.mediacollections.MediaCollectionsService.RemoveItems
- */
-export declare function removeItems(mediaCollectionId: string, options?: RemoveItemsOptions): Promise<void>;
-export interface RemoveItemsOptions {
-    /**
-     * Items to remove
-     * @format GUID
-     */
-    itemsIds?: string[];
-}
-/**
- * Join to a collection
- * @param mediaCollectionId - Collection to join
- * @public
- * @documentationMaturity preview
- * @requiredField mediaCollectionId
- * @fqn com.wixpress.exposure.mediacollections.MediaCollectionsService.JoinToCollection
- */
-export declare function joinToCollection(mediaCollectionId: string): Promise<void>;
-/** @param mediaCollectionId - Collection the member will be leaving
- * @public
- * @documentationMaturity preview
- * @requiredField mediaCollectionId
- * @fqn com.wixpress.exposure.mediacollections.MediaCollectionsService.LeaveCollection
- */
-export declare function leaveCollection(mediaCollectionId: string): Promise<void>;
-/** @param mediaCollectionId - Collection to get its items
- * @public
- * @documentationMaturity preview
- * @requiredField mediaCollectionId
- * @fqn com.wixpress.exposure.mediacollections.MediaCollectionsService.ListCollectionItems
- */
-export declare function listCollectionItems(mediaCollectionId: string): Promise<NonNullablePaths<ListCollectionItemsResponse, `collectionItems` | `collectionItems.${number}.galleryId` | `collectionItems.${number}.itemId`>>;
-export {};