@wix/auto_sdk_media-collections_media-collections 1.0.21 → 1.0.23

package/build/{collections-v1-collection-media-collections.universal-CUKnIZcW.d.mts → cjs/index.typings.d.ts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 interface MediaCollection {
     /**
      * Collection id
@@ -1090,6 +1092,23 @@ interface CollectionCreatedEnvelope {
     entity: MediaCollection;
     metadata: EventMetadata;
 }
+/** @webhook
+ * @eventType wix.collections.collection_created
+ * @serviceIdentifier com.wixpress.exposure.mediacollections.MediaCollectionsService
+ * @slug created
+ * @documentationMaturity preview
+ */
+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
+ */
+declare function get(mediaCollectionId: string, options?: GetOptions): Promise<NonNullablePaths<MediaCollection, `_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}.dataType` | `items.${number}.mediaOwner` | `items.${number}.galleryId` | `itemsCount` | `privacySettings` | `locked`, 6>>;
 interface GetOptions {
     /** number of items to skip in the current sort order, default is 0 */
     offset?: number | null;
@@ -1100,6 +1119,15 @@ interface GetOptions {
      */
     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
+ */
+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.videoMetadata.source` | `itemInCollections.${number}.firstItem.link.type` | `itemInCollections.${number}.firstItem.dataType` | `itemInCollections.${number}.firstItem.mediaOwner` | `itemInCollections.${number}.firstItem.galleryId`, 6>>;
 interface ListCollectionsForItemOptions {
     /**
      * Gallery id
@@ -1107,6 +1135,16 @@ interface ListCollectionsForItemOptions {
      */
     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
+ */
+declare function getCollectionItem(identifiers: NonNullablePaths<GetCollectionItemIdentifiers, `itemId` | `mediaCollectionId`, 2>): 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`, 6>>;
 interface GetCollectionItemIdentifiers {
     /**
      * Collection id
@@ -1119,6 +1157,13 @@ interface GetCollectionItemIdentifiers {
      */
     itemId: string;
 }
+/**
+ * List all collections that the item belongs to
+ * @public
+ * @documentationMaturity preview
+ * @fqn com.wixpress.exposure.mediacollections.MediaCollectionsService.List
+ */
+declare function list(options?: ListOptions): Promise<NonNullablePaths<ListMediaCollectionsResponse, `collectionsStatus` | `collectionsStatus.${number}.mediaCollection._id` | `collectionsStatus.${number}.mediaCollection.name` | `collectionsStatus.${number}.mediaCollection.membersCount` | `collectionsStatus.${number}.mediaCollection.creator.memberId` | `collectionsStatus.${number}.mediaCollection.itemsCount` | `collectionsStatus.${number}.mediaCollection.privacySettings` | `collectionsStatus.${number}.mediaCollection.locked` | `collectionsStatus.${number}.memberStatus`, 6>>;
 interface ListOptions {
     /**
      * the amount of collections per response, default is 1000
@@ -1134,6 +1179,15 @@ interface ListOptions {
      */
     filterByRoles?: FilterByRoles;
 }
+/**
+ * Create a new collection
+ * @param name - Name of the collection
+ * @public
+ * @documentationMaturity preview
+ * @requiredField name
+ * @fqn com.wixpress.exposure.mediacollections.MediaCollectionsService.Create
+ */
+declare function create(name: string, options?: CreateOptions): Promise<NonNullablePaths<CreateMediaCollectionResponse, `mediaCollectionId`, 2>>;
 interface CreateOptions {
     /**
      * Description of the collection
@@ -1145,6 +1199,18 @@ interface CreateOptions {
     /** 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
+ */
+declare function partiallyUpdate(_id: string, mediaCollection: PartiallyUpdateMediaCollection, options: NonNullablePaths<PartiallyUpdateOptions, `fieldMask`, 2>): Promise<void>;
 interface PartiallyUpdateMediaCollection {
     /**
      * Collection id
@@ -1193,14 +1259,50 @@ interface PartiallyUpdateOptions {
      */
     fieldMask: string[];
 }
+/**
+ * Delete a collection
+ * @param mediaCollectionId - the collection to delete
+ * @public
+ * @documentationMaturity preview
+ * @requiredField mediaCollectionId
+ * @fqn com.wixpress.exposure.mediacollections.MediaCollectionsService._delete
+ */
+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
+ */
+declare function listCollectionMembers(mediaCollectionId: string, options?: ListCollectionMembersOptions): Promise<NonNullablePaths<ListCollectionMembersResponse, `membersRoles` | `membersRoles.${number}.member.memberId` | `membersRoles.${number}.memberStatus`, 5>>;
 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
+ */
+declare function addItems(mediaCollectionId: string, options?: AddItemsOptions): Promise<void>;
 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
+ */
+declare function removeItems(mediaCollectionId: string, options?: RemoveItemsOptions): Promise<void>;
 interface RemoveItemsOptions {
     /**
      * Items to remove
@@ -1208,5 +1310,28 @@ interface RemoveItemsOptions {
      */
     itemsIds?: string[];
 }
+/**
+ * Join to a collection
+ * @param mediaCollectionId - Collection to join
+ * @public
+ * @documentationMaturity preview
+ * @requiredField mediaCollectionId
+ * @fqn com.wixpress.exposure.mediacollections.MediaCollectionsService.JoinToCollection
+ */
+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
+ */
+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
+ */
+declare function listCollectionItems(mediaCollectionId: string): Promise<NonNullablePaths<ListCollectionItemsResponse, `collectionItems` | `collectionItems.${number}.galleryId` | `collectionItems.${number}.itemId`, 4>>;
 
-export { type DomainEventBodyOneOf as $, type AddItemsOptions as A, type EmailLink as B, type CreateOptions as C, DataType as D, type ExternalLink as E, type PhoneLink as F, type GetOptions as G, type AddressLink as H, type WhatsAppLink as I, type TpaPageLink as J, type PhotoMetadata as K, type ListCollectionsForItemOptions as L, type MediaCollection as M, type Point as N, type Thumbnail as O, type PartiallyUpdateMediaCollection as P, type Resolution as Q, type RemoveItemsOptions as R, Source as S, Type as T, type UnsharpMasking as U, type VideoMetadata as V, WebhookIdentityType as W, type TextMetadata as X, type PermanentSiteDeletedResponse as Y, type Empty as Z, type DomainEvent as _, type ListCollectionsForItemResponse as a, type EntityCreatedEvent as a0, type RestoreInfo as a1, type EntityUpdatedEvent as a2, type EntityDeletedEvent as a3, type ActionEvent as a4, type MessageEnvelope as a5, type IdentificationData as a6, type IdentificationDataIdOneOf as a7, type CollectionEvent as a8, type CollectionEventEventTypeOneOf as a9, type AddItemsResponse as aA, type RemoveItemsRequest as aB, type RemoveItemsResponse as aC, type UpdateItemsRequest as aD, type UpdateItem as aE, type UpdateItemsResponse as aF, type JoinToCollectionRequest as aG, type JoinToCollectionResponse as aH, type RemoveMemberFromCollectionRequest as aI, type RemoveMemberFromCollectionResponse as aJ, type LeaveCollectionRequest as aK, type LeaveCollectionResponse as aL, type ListCollectionItemsRequest as aM, type CollectionItem as aN, type ListAllItemsBelongToCollectionRequest as aO, type ListAllItemsBelongToCollectionResponse as aP, type BaseEventMetadata as aQ, type EventMetadata as aR, type CollectionItemId as aa, type CollectionCreated as ab, type ItemsAddedToCollection as ac, type ItemsRemovedFromCollection as ad, type MemberJoinedToCollection as ae, type MemberLeftCollection as af, type GetMediaCollectionRequest as ag, type GetMediaCollectionResponse as ah, type ListCollectionsForItemRequest as ai, type ItemInCollection as aj, type GetCollectionItemRequest as ak, type ListMediaCollectionsRequest as al, type FilterByRoles as am, type CollectionAndStatus as an, type CreateMediaCollectionRequest as ao, type AddItem as ap, type PartiallyUpdateMediaCollectionRequest as aq, type PartiallyUpdateMediaCollectionResponse as ar, type UpdateCollectionLockRequest as as, type UpdateCollectionLockResponse as at, type DeleteMediaCollectionRequest as au, type DeleteMediaCollectionResponse as av, type ListCollectionMembersRequest as aw, type FilterBy as ax, type MemberAndStatus as ay, type AddItemsRequest as az, type GetCollectionItemIdentifiers as b, type GetCollectionItemResponse as c, type ListOptions as d, type ListMediaCollectionsResponse as e, type CreateMediaCollectionResponse as f, type PartiallyUpdateOptions as g, type ListCollectionMembersOptions as h, type ListCollectionMembersResponse as i, type ListCollectionItemsResponse as j, type CollectionCreatedEnvelope as k, LinkRel as l, MediaOwner as m, PrivacySettings as n, Status as o, MemberStatus as p, type CollectionMember as q, type MediaCollectionItem as r, type MediaCollectionItemMetadataOneOf as s, type Link as t, type WixLink as u, type WixLinkLinkOneOf as v, type PageLink as w, type AnchorLink as x, type DynamicPageLink as y, type DocumentLink as z };
+export { type ActionEvent, type AddItem, type AddItemsOptions, type AddItemsRequest, type AddItemsResponse, type AddressLink, type AnchorLink, type BaseEventMetadata, type CollectionAndStatus, type CollectionCreated, type CollectionCreatedEnvelope, type CollectionEvent, type CollectionEventEventTypeOneOf, type CollectionItem, type CollectionItemId, type CollectionMember, type CreateMediaCollectionRequest, type CreateMediaCollectionResponse, type CreateOptions, DataType, type DataTypeWithLiterals, type DeleteMediaCollectionRequest, type DeleteMediaCollectionResponse, type DocumentLink, type DomainEvent, type DomainEventBodyOneOf, type DynamicPageLink, type EmailLink, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExternalLink, type FilterBy, type FilterByRoles, type GetCollectionItemIdentifiers, type GetCollectionItemRequest, type GetCollectionItemResponse, type GetMediaCollectionRequest, type GetMediaCollectionResponse, type GetOptions, type IdentificationData, type IdentificationDataIdOneOf, type ItemInCollection, type ItemsAddedToCollection, type ItemsRemovedFromCollection, type JoinToCollectionRequest, type JoinToCollectionResponse, type LeaveCollectionRequest, type LeaveCollectionResponse, type Link, LinkRel, type LinkRelWithLiterals, type ListAllItemsBelongToCollectionRequest, type ListAllItemsBelongToCollectionResponse, type ListCollectionItemsRequest, type ListCollectionItemsResponse, type ListCollectionMembersOptions, type ListCollectionMembersRequest, type ListCollectionMembersResponse, type ListCollectionsForItemOptions, type ListCollectionsForItemRequest, type ListCollectionsForItemResponse, type ListMediaCollectionsRequest, type ListMediaCollectionsResponse, type ListOptions, type MediaCollection, type MediaCollectionItem, type MediaCollectionItemMetadataOneOf, MediaOwner, type MediaOwnerWithLiterals, type MemberAndStatus, type MemberJoinedToCollection, type MemberLeftCollection, MemberStatus, type MemberStatusWithLiterals, type MessageEnvelope, type PageLink, type PartiallyUpdateMediaCollection, type PartiallyUpdateMediaCollectionRequest, type PartiallyUpdateMediaCollectionResponse, type PartiallyUpdateOptions, type PermanentSiteDeletedResponse, type PhoneLink, type PhotoMetadata, type Point, PrivacySettings, type PrivacySettingsWithLiterals, type RemoveItemsOptions, type RemoveItemsRequest, type RemoveItemsResponse, type RemoveMemberFromCollectionRequest, type RemoveMemberFromCollectionResponse, type Resolution, type RestoreInfo, Source, type SourceWithLiterals, Status, type StatusWithLiterals, type TextMetadata, type Thumbnail, type TpaPageLink, Type, type TypeWithLiterals, type UnsharpMasking, type UpdateCollectionLockRequest, type UpdateCollectionLockResponse, type UpdateItem, type UpdateItemsRequest, type UpdateItemsResponse, type VideoMetadata, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WhatsAppLink, type WixLink, type WixLinkLinkOneOf, _delete, addItems, create, get, getCollectionItem, joinToCollection, leaveCollection, list, listCollectionItems, listCollectionMembers, listCollectionsForItem, onCollectionCreated, partiallyUpdate, removeItems };