@wix/auto_sdk_media-collections_media-collections 1.0.0

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

@@ -0,0 +1,1210 @@
+export interface MediaCollection {
+    /**
+     * Collection id
+     * @readonly
+     */
+    _id?: string;
+    /** Collection name */
+    name?: string;
+    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?: PrivacySettings;
+    /** If true, the collection is locked and should not be updated */
+    locked?: boolean;
+}
+export interface CollectionMember {
+    /**
+     * Member id
+     * @readonly
+     */
+    memberId?: string;
+    /** Member nickname */
+    nickname?: string | null;
+    /** Member slug */
+    slug?: string | null;
+    /** Member photo url */
+    photoUrl?: string | null;
+}
+export interface MediaCollectionItem extends MediaCollectionItemMetadataOneOf {
+    /** Photo metadata */
+    photoMetadata?: PhotoMetadata;
+    /** Video metadata */
+    videoMetadata?: VideoMetadata;
+    /** Text metadata */
+    textMetadata?: TextMetadata;
+    /**
+     * item id
+     * @readonly
+     */
+    _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?: DataType;
+    /**
+     * 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?: MediaOwner;
+    /** 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?: Type;
+    /** 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"
+}
+/** 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 */
+    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"
+}
+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 */
+    rel?: LinkRel[];
+}
+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 */
+    rel?: LinkRel[];
+}
+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 */
+    rel?: LinkRel[];
+}
+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 */
+    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 */
+    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 */
+    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 */
+    rel?: LinkRel[];
+}
+export declare enum DataType {
+    Undefined = "Undefined",
+    Photo = "Photo",
+    Video = "Video",
+    Text = "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 */
+    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. */
+    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 */
+    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?: Source;
+    /** 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"
+}
+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"
+}
+export declare enum PrivacySettings {
+    /** Undefined */
+    Undefined = "Undefined",
+    /** Public */
+    Public = "Public",
+    /** Secret */
+    Secret = "Secret"
+}
+export interface PermanentSiteDeletedResponse {
+    requestId?: string;
+    uniqueServiceIdentifier?: string;
+    status?: Status;
+    /** @readonly */
+    _createdDate?: Date | null;
+}
+export declare enum Status {
+    UNKNOWN = "UNKNOWN",
+    HANDLED = "HANDLED",
+    NOTHING_TO_HANDLE = "NOTHING_TO_HANDLE"
+}
+export interface Empty {
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * 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 defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    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. */
+    instanceId?: string | null;
+    /** Event type. */
+    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. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "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 */
+    galleryId?: string;
+    /** Id of the item in ProGallery */
+    itemId?: string;
+}
+export interface CollectionCreated {
+    /** Collection id */
+    _id?: string;
+    /** Collection name */
+    name?: string;
+    /** Collection description */
+    description?: string | null;
+    /** Id of the member who created the collection */
+    creatorMemberId?: string;
+    /** When the collection was created */
+    _createdDate?: Date | null;
+    /** Privacy settings */
+    privacySettings?: PrivacySettings;
+}
+export interface ItemsAddedToCollection {
+    /** Id of the collection */
+    collectionId?: string;
+    /** Id of the member who added items */
+    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 */
+    collectionId?: string;
+    /** Id of the member who removed items */
+    removedByMember?: string;
+    /** Ids of the items that were removed */
+    itemIds?: string[];
+    /** When the items were removed */
+    removedDate?: Date | null;
+}
+export interface MemberJoinedToCollection {
+    /** Id of the collection */
+    collectionId?: string;
+    /** Id of the member who joined */
+    memberId?: string;
+    /** When the member was joined */
+    joinedDate?: Date | null;
+}
+export interface MemberLeftCollection {
+    /** Id of the collection */
+    collectionId?: string;
+    /** Id of the member who left */
+    memberId?: string;
+    /** When the member left */
+    leftDate?: Date | null;
+}
+export interface GetMediaCollectionRequest {
+    /** Collection id */
+    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 */
+    limit?: number | null;
+}
+export interface GetMediaCollectionResponse {
+    /** The collection */
+    mediaCollection?: MediaCollection;
+    /** The member's status in the collection */
+    memberStatus?: MemberStatus;
+}
+export declare enum MemberStatus {
+    /** Undefined */
+    UNDEFINED = "UNDEFINED",
+    /** Not a member */
+    NOT_MEMBER = "NOT_MEMBER",
+    /** Member */
+    MEMBER = "MEMBER",
+    /** Admin */
+    ADMIN = "ADMIN"
+}
+export interface ListCollectionsForItemRequest {
+    /** Gallery id */
+    galleryId?: string;
+    /** Item id */
+    itemId: string;
+}
+export interface ListCollectionsForItemResponse {
+    /** The collections that the item belongs to */
+    itemInCollections?: ItemInCollection[];
+}
+export interface ItemInCollection {
+    /** Collection id */
+    mediaCollectionId?: string;
+    /** Collection name */
+    name?: string;
+    /** Is the item in the collection */
+    isItemInCollection?: boolean;
+    /** Is the collection locked */
+    isLocked?: boolean;
+    /** Member's role in the collection */
+    role?: MemberStatus;
+    /** Total count of items in the collection */
+    totalItemsCount?: number | null;
+    /** The first item in the collection */
+    firstItem?: MediaCollectionItem;
+    /** The creator's nickname */
+    creatorNickname?: string | null;
+}
+export interface GetCollectionItemRequest {
+    /** Collection id */
+    mediaCollectionId: string;
+    /** Item id */
+    itemId: string;
+}
+export interface GetCollectionItemResponse {
+    /** The item */
+    item?: MediaCollectionItem;
+}
+export interface ListMediaCollectionsRequest {
+    /** the amount of collections per response, default is 1000 */
+    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?: MemberStatus[];
+}
+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?: MemberStatus;
+}
+export interface CreateMediaCollectionRequest {
+    /** Name of the collection */
+    name: string;
+    /** Description of the collection */
+    description?: string | null;
+    /** Privacy settings of the collection */
+    privacySettings?: PrivacySettings;
+    /** Items to add to the collection */
+    items?: AddItem[];
+}
+export interface AddItem {
+    /** Gallery id */
+    galleryId?: string;
+    /** Item id */
+    itemId?: string;
+    /** Order index of the item */
+    orderIndex?: number | null;
+}
+export interface CreateMediaCollectionResponse {
+    /** id of the collection that was created */
+    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 */
+    mediaCollectionId?: string;
+    /** Lock status */
+    locked?: boolean;
+}
+export interface UpdateCollectionLockResponse {
+}
+export interface DeleteMediaCollectionRequest {
+    /** the collection to delete */
+    mediaCollectionId: string;
+}
+export interface DeleteMediaCollectionResponse {
+}
+export interface ListCollectionMembersRequest {
+    /** the collection to get its members */
+    mediaCollectionId: string;
+    /** Filter the members by their role in the collection */
+    filterBy?: FilterBy;
+}
+export interface FilterBy {
+    /** Member's status in the collection */
+    memberStatus?: MemberStatus;
+}
+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?: MemberStatus;
+}
+export interface AddItemsRequest {
+    /** Collection to add items */
+    mediaCollectionId: string;
+    /** Items to add */
+    items?: AddItem[];
+}
+export interface AddItemsResponse {
+}
+export interface RemoveItemsRequest {
+    /** Collection to remove items from */
+    mediaCollectionId: string;
+    /** Items to remove */
+    itemsIds?: string[];
+}
+export interface RemoveItemsResponse {
+}
+export interface UpdateItemsRequest {
+    /** Collection to update items */
+    mediaCollectionId?: string;
+    items?: UpdateItem[];
+}
+export interface UpdateItem {
+    /** Item to update */
+    itemId?: string;
+    /** New order index of the item */
+    orderIndex?: number;
+}
+export interface UpdateItemsResponse {
+}
+export interface JoinToCollectionRequest {
+    /** Collection to join */
+    mediaCollectionId: string;
+}
+export interface JoinToCollectionResponse {
+}
+export interface RemoveMemberFromCollectionRequest {
+    /** Collection the member will be removed from being a member */
+    mediaCollectionId?: string;
+    /** Member id to remove from the collection */
+    memberId?: string;
+}
+export interface RemoveMemberFromCollectionResponse {
+}
+export interface LeaveCollectionRequest {
+    /** Collection the member will be leaving */
+    mediaCollectionId: string;
+}
+export interface LeaveCollectionResponse {
+}
+export interface ListCollectionItemsRequest {
+    /** Collection to get its items */
+    mediaCollectionId: string;
+}
+export interface ListCollectionItemsResponse {
+    /** The collection's items */
+    collectionItems?: CollectionItem[];
+}
+export interface CollectionItem {
+    /** Gallery id */
+    galleryId?: string;
+    /** Item id */
+    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 */
+    itemIds?: string[];
+}
+interface CollectionMemberNonNullableFields {
+    memberId: string;
+}
+interface PointNonNullableFields {
+    x: number;
+    y: number;
+}
+interface PhotoMetadataNonNullableFields {
+    focalPoint?: PointNonNullableFields;
+}
+interface ThumbnailNonNullableFields {
+    focalPoint?: PointNonNullableFields;
+}
+interface VideoMetadataNonNullableFields {
+    source: Source;
+    posters: ThumbnailNonNullableFields[];
+}
+interface ExternalLinkNonNullableFields {
+    url: string;
+    rel: LinkRel[];
+}
+interface PageLinkNonNullableFields {
+    pageId: string;
+    rel: LinkRel[];
+}
+interface AnchorLinkNonNullableFields {
+    anchorName: string;
+    anchorDataId: string;
+    pageId: string;
+    rel: LinkRel[];
+}
+interface DynamicPageLinkNonNullableFields {
+    routerId: string;
+    innerRoute: string;
+    rel: LinkRel[];
+}
+interface DocumentLinkNonNullableFields {
+    docId: string;
+    indexable: boolean;
+}
+interface EmailLinkNonNullableFields {
+    recipient: string;
+}
+interface PhoneLinkNonNullableFields {
+    phoneNumber: string;
+}
+interface AddressLinkNonNullableFields {
+    address: string;
+}
+interface WhatsAppLinkNonNullableFields {
+    phoneNumber: string;
+}
+interface TpaPageLinkNonNullableFields {
+    itemTypeIdentifier: string;
+    itemId: string;
+    pageId: string;
+    appDefinitionId: string;
+    path: string;
+    rel: LinkRel[];
+}
+interface WixLinkNonNullableFields {
+    external?: ExternalLinkNonNullableFields;
+    page?: PageLinkNonNullableFields;
+    anchor?: AnchorLinkNonNullableFields;
+    dynamicPage?: DynamicPageLinkNonNullableFields;
+    document?: DocumentLinkNonNullableFields;
+    email?: EmailLinkNonNullableFields;
+    phone?: PhoneLinkNonNullableFields;
+    address?: AddressLinkNonNullableFields;
+    whatsApp?: WhatsAppLinkNonNullableFields;
+    tpaPage?: TpaPageLinkNonNullableFields;
+}
+interface LinkNonNullableFields {
+    type: Type;
+    wixLinkData?: WixLinkNonNullableFields;
+}
+interface MediaCollectionItemNonNullableFields {
+    photoMetadata?: PhotoMetadataNonNullableFields;
+    videoMetadata?: VideoMetadataNonNullableFields;
+    link?: LinkNonNullableFields;
+    dataType: DataType;
+    secure: boolean;
+    mediaOwner: MediaOwner;
+    tags: string[];
+    galleryId: string;
+}
+export interface MediaCollectionNonNullableFields {
+    _id: string;
+    name: string;
+    membersCount: number;
+    creator?: CollectionMemberNonNullableFields;
+    items: MediaCollectionItemNonNullableFields[];
+    itemsCount: number;
+    privacySettings: PrivacySettings;
+    locked: boolean;
+}
+export interface GetMediaCollectionResponseNonNullableFields {
+    mediaCollection?: MediaCollectionNonNullableFields;
+    memberStatus: MemberStatus;
+}
+interface ItemInCollectionNonNullableFields {
+    mediaCollectionId: string;
+    name: string;
+    isItemInCollection: boolean;
+    isLocked: boolean;
+    role: MemberStatus;
+    firstItem?: MediaCollectionItemNonNullableFields;
+}
+export interface ListCollectionsForItemResponseNonNullableFields {
+    itemInCollections: ItemInCollectionNonNullableFields[];
+}
+export interface GetCollectionItemResponseNonNullableFields {
+    item?: MediaCollectionItemNonNullableFields;
+}
+interface CollectionAndStatusNonNullableFields {
+    mediaCollection?: MediaCollectionNonNullableFields;
+    memberStatus: MemberStatus;
+}
+export interface ListMediaCollectionsResponseNonNullableFields {
+    collectionsStatus: CollectionAndStatusNonNullableFields[];
+}
+export interface CreateMediaCollectionResponseNonNullableFields {
+    mediaCollectionId: string;
+}
+interface MemberAndStatusNonNullableFields {
+    member?: CollectionMemberNonNullableFields;
+    memberStatus: MemberStatus;
+}
+export interface ListCollectionMembersResponseNonNullableFields {
+    membersRoles: MemberAndStatusNonNullableFields[];
+}
+interface CollectionItemNonNullableFields {
+    galleryId: string;
+    itemId: string;
+}
+export interface ListCollectionItemsResponseNonNullableFields {
+    collectionItems: CollectionItemNonNullableFields[];
+}
+export interface BaseEventMetadata {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+export interface EventMetadata extends BaseEventMetadata {
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * 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 defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+export interface CollectionCreatedEnvelope {
+    entity: MediaCollection;
+    metadata: EventMetadata;
+}
+/** @webhook
+ * @eventType wix.collections.collection_created
+ * @documentationMaturity preview
+ */
+export declare function onCollectionCreated(handler: (event: CollectionCreatedEnvelope) => void | Promise<void>): void;
+/**
+ * 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<MediaCollection & MediaCollectionNonNullableFields>;
+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 */
+    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<ListCollectionsForItemResponse & ListCollectionsForItemResponseNonNullableFields>;
+export interface ListCollectionsForItemOptions {
+    /** Gallery id */
+    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: GetCollectionItemIdentifiers): Promise<GetCollectionItemResponse & GetCollectionItemResponseNonNullableFields>;
+export interface GetCollectionItemIdentifiers {
+    /** Collection id */
+    mediaCollectionId: string;
+    /** Item id */
+    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<ListMediaCollectionsResponse & ListMediaCollectionsResponseNonNullableFields>;
+export interface ListOptions {
+    /** the amount of collections per response, default is 1000 */
+    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<CreateMediaCollectionResponse & CreateMediaCollectionResponseNonNullableFields>;
+export interface CreateOptions {
+    /** Description of the collection */
+    description?: string | null;
+    /** Privacy settings of the collection */
+    privacySettings?: PrivacySettings;
+    /** 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: PartiallyUpdateOptions): Promise<void>;
+export interface PartiallyUpdateMediaCollection {
+    /**
+     * Collection id
+     * @readonly
+     */
+    _id?: string;
+    /** Collection name */
+    name?: string;
+    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?: PrivacySettings;
+    /** 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<ListCollectionMembersResponse & ListCollectionMembersResponseNonNullableFields>;
+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 */
+    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<ListCollectionItemsResponse & ListCollectionItemsResponseNonNullableFields>;
+export {};