@wix/auto_sdk_media-collections_media-collections 1.0.0 → 1.0.2

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

@@ -2,10 +2,15 @@ export interface MediaCollection {
     /**
      * Collection id
      * @readonly
+     * @format GUID
      */
     _id?: string;
-    /** Collection name */
+    /**
+     * Collection name
+     * @maxLength 100
+     */
     name?: string;
+    /** @maxLength 500 */
     description?: string | null;
     /**
      * total count of MediaCollection members
@@ -38,13 +43,23 @@ export interface CollectionMember {
     /**
      * Member id
      * @readonly
+     * @format GUID
      */
     memberId?: string;
-    /** Member nickname */
+    /**
+     * Member nickname
+     * @maxLength 100
+     */
     nickname?: string | null;
-    /** Member slug */
+    /**
+     * Member slug
+     * @maxLength 100
+     */
     slug?: string | null;
-    /** Member photo url */
+    /**
+     * Member photo url
+     * @maxLength 200
+     */
     photoUrl?: string | null;
 }
 export interface MediaCollectionItem extends MediaCollectionItemMetadataOneOf {
@@ -57,6 +72,7 @@ export interface MediaCollectionItem extends MediaCollectionItemMetadataOneOf {
     /**
      * item id
      * @readonly
+     * @format GUID
      */
     _id?: string | null;
     /** item url for photos or video */
@@ -167,7 +183,10 @@ export interface WixLinkLinkOneOf {
     tpaPage?: TpaPageLink;
 }
 export interface ExternalLink {
-    /** The url of the page */
+    /**
+     * 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;
@@ -194,7 +213,10 @@ export interface PageLink {
     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 of link
+     * @maxSize 20
+     */
     rel?: LinkRel[];
 }
 export interface AnchorLink {
@@ -204,7 +226,10 @@ export interface AnchorLink {
     anchorDataId?: string;
     /** The page id we want from the site */
     pageId?: string;
-    /** rel of link */
+    /**
+     * rel of link
+     * @maxSize 20
+     */
     rel?: LinkRel[];
 }
 export interface DynamicPageLink {
@@ -214,7 +239,10 @@ export interface DynamicPageLink {
     innerRoute?: string;
     /** The data id (from the JSON page) of the anchor that should be used */
     anchorDataId?: string | null;
-    /** rel of link */
+    /**
+     * rel of link
+     * @maxSize 20
+     */
     rel?: LinkRel[];
 }
 export interface DocumentLink {
@@ -226,7 +254,10 @@ export interface DocumentLink {
     indexable?: boolean;
 }
 export interface EmailLink {
-    /** The email we will be sending a message to */
+    /**
+     * The email we will be sending a message to
+     * @format EMAIL
+     */
     recipient?: string;
     /** The subject of the email */
     subject?: string | null;
@@ -234,7 +265,11 @@ export interface EmailLink {
     body?: string | null;
 }
 export interface PhoneLink {
-    /** The phone number we want to link to */
+    /**
+     * The phone number we want to link to
+     * @format PHONE
+     * @maxLength 100
+     */
     phoneNumber?: string;
 }
 export interface AddressLink {
@@ -242,7 +277,10 @@ export interface AddressLink {
     address?: string;
 }
 export interface WhatsAppLink {
-    /** The whatsApp phone number we want to connect with */
+    /**
+     * The whatsApp phone number we want to connect with
+     * @format PHONE
+     */
     phoneNumber?: string;
 }
 /** Link to a TPA page */
@@ -257,7 +295,10 @@ export interface TpaPageLink {
     appDefinitionId?: string;
     /** The relativepath of linked page */
     path?: string;
-    /** rel of link */
+    /**
+     * rel of link
+     * @maxSize 20
+     */
     rel?: LinkRel[];
 }
 export declare enum DataType {
@@ -275,7 +316,11 @@ export interface PhotoMetadata {
     focalPoint?: Point;
     /** aka Exchangeable image file format */
     exif?: Record<string, any> | null;
-    /** the image quality */
+    /**
+     * the image quality
+     * @min 30
+     * @max 100
+     */
     quality?: number | null;
     /** photo sharpening */
     unsharpMasking?: UnsharpMasking;
@@ -289,11 +334,17 @@ export interface Point {
     y?: number;
 }
 export interface UnsharpMasking {
-    /** number controls the amount of contrast that is added at the edges. */
+    /**
+     * 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 */
+    /**
+     * The minimal level of brightness change that will be sharpened
+     * @max 1
+     */
     threshold?: number | null;
 }
 export interface VideoMetadata {
@@ -373,6 +424,7 @@ export declare enum PrivacySettings {
     Secret = "Secret"
 }
 export interface PermanentSiteDeletedResponse {
+    /** @format GUID */
     requestId?: string;
     uniqueServiceIdentifier?: string;
     status?: Status;
@@ -457,9 +509,15 @@ export interface ActionEvent {
     body?: string;
 }
 export interface MessageEnvelope {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -467,26 +525,50 @@ export interface MessageEnvelope {
     data?: string;
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * 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. */
+    /**
+     * 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.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * 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. */
+    /**
+     * 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.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }
 export declare enum WebhookIdentityType {
@@ -522,19 +604,37 @@ export interface CollectionEventEventTypeOneOf {
     memberLeftCollection?: MemberLeftCollection;
 }
 export interface CollectionItemId {
-    /** Id of the gallery in ProGallery */
+    /**
+     * Id of the gallery in ProGallery
+     * @format GUID
+     */
     galleryId?: string;
-    /** Id of the item in ProGallery */
+    /**
+     * Id of the item in ProGallery
+     * @format GUID
+     */
     itemId?: string;
 }
 export interface CollectionCreated {
-    /** Collection id */
+    /**
+     * Collection id
+     * @format GUID
+     */
     _id?: string;
-    /** Collection name */
+    /**
+     * Collection name
+     * @maxLength 100
+     */
     name?: string;
-    /** Collection description */
+    /**
+     * Collection description
+     * @maxLength 500
+     */
     description?: string | null;
-    /** Id of the member who created the collection */
+    /**
+     * Id of the member who created the collection
+     * @format GUID
+     */
     creatorMemberId?: string;
     /** When the collection was created */
     _createdDate?: Date | null;
@@ -542,9 +642,15 @@ export interface CollectionCreated {
     privacySettings?: PrivacySettings;
 }
 export interface ItemsAddedToCollection {
-    /** Id of the collection */
+    /**
+     * Id of the collection
+     * @format GUID
+     */
     collectionId?: string;
-    /** Id of the member who added items */
+    /**
+     * Id of the member who added items
+     * @format GUID
+     */
     addedByMember?: string;
     /** Ids of the items that were added */
     collectionItemIds?: CollectionItemId[];
@@ -552,37 +658,65 @@ export interface ItemsAddedToCollection {
     addedDate?: Date | null;
 }
 export interface ItemsRemovedFromCollection {
-    /** Id of the collection */
+    /**
+     * Id of the collection
+     * @format GUID
+     */
     collectionId?: string;
-    /** Id of the member who removed items */
+    /**
+     * Id of the member who removed items
+     * @format GUID
+     */
     removedByMember?: string;
-    /** Ids of the items that were removed */
+    /**
+     * 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 */
+    /**
+     * Id of the collection
+     * @format GUID
+     */
     collectionId?: string;
-    /** Id of the member who joined */
+    /**
+     * 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 */
+    /**
+     * Id of the collection
+     * @format GUID
+     */
     collectionId?: string;
-    /** Id of the member who left */
+    /**
+     * Id of the member who left
+     * @format GUID
+     */
     memberId?: string;
     /** When the member left */
     leftDate?: Date | null;
 }
 export interface GetMediaCollectionRequest {
-    /** Collection id */
+    /**
+     * 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 */
+    /**
+     * The amount of items per response, default is 50
+     * @min 1
+     * @max 200
+     */
     limit?: number | null;
 }
 export interface GetMediaCollectionResponse {
@@ -602,9 +736,15 @@ export declare enum MemberStatus {
     ADMIN = "ADMIN"
 }
 export interface ListCollectionsForItemRequest {
-    /** Gallery id */
+    /**
+     * Gallery id
+     * @format GUID
+     */
     galleryId?: string;
-    /** Item id */
+    /**
+     * Item id
+     * @format GUID
+     */
     itemId: string;
 }
 export interface ListCollectionsForItemResponse {
@@ -612,9 +752,16 @@ export interface ListCollectionsForItemResponse {
     itemInCollections?: ItemInCollection[];
 }
 export interface ItemInCollection {
-    /** Collection id */
+    /**
+     * Collection id
+     * @format GUID
+     */
     mediaCollectionId?: string;
-    /** Collection name */
+    /**
+     * Collection name
+     * @minLength 1
+     * @maxLength 100
+     */
     name?: string;
     /** Is the item in the collection */
     isItemInCollection?: boolean;
@@ -626,13 +773,22 @@ export interface ItemInCollection {
     totalItemsCount?: number | null;
     /** The first item in the collection */
     firstItem?: MediaCollectionItem;
-    /** The creator's nickname */
+    /**
+     * The creator's nickname
+     * @maxLength 100
+     */
     creatorNickname?: string | null;
 }
 export interface GetCollectionItemRequest {
-    /** Collection id */
+    /**
+     * Collection id
+     * @format GUID
+     */
     mediaCollectionId: string;
-    /** Item id */
+    /**
+     * Item id
+     * @format GUID
+     */
     itemId: string;
 }
 export interface GetCollectionItemResponse {
@@ -640,7 +796,11 @@ export interface GetCollectionItemResponse {
     item?: MediaCollectionItem;
 }
 export interface ListMediaCollectionsRequest {
-    /** the amount of collections per response, default is 1000 */
+    /**
+     * 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;
@@ -669,9 +829,16 @@ export interface CollectionAndStatus {
     memberStatus?: MemberStatus;
 }
 export interface CreateMediaCollectionRequest {
-    /** Name of the collection */
+    /**
+     * Name of the collection
+     * @minLength 1
+     * @maxLength 100
+     */
     name: string;
-    /** Description of the collection */
+    /**
+     * Description of the collection
+     * @maxLength 500
+     */
     description?: string | null;
     /** Privacy settings of the collection */
     privacySettings?: PrivacySettings;
@@ -679,15 +846,24 @@ export interface CreateMediaCollectionRequest {
     items?: AddItem[];
 }
 export interface AddItem {
-    /** Gallery id */
+    /**
+     * Gallery id
+     * @format GUID
+     */
     galleryId?: string;
-    /** Item id */
+    /**
+     * Item id
+     * @format GUID
+     */
     itemId?: string;
     /** Order index of the item */
     orderIndex?: number | null;
 }
 export interface CreateMediaCollectionResponse {
-    /** id of the collection that was created */
+    /**
+     * id of the collection that was created
+     * @format GUID
+     */
     mediaCollectionId?: string;
 }
 export interface PartiallyUpdateMediaCollectionRequest {
@@ -702,7 +878,10 @@ export interface PartiallyUpdateMediaCollectionRequest {
 export interface PartiallyUpdateMediaCollectionResponse {
 }
 export interface UpdateCollectionLockRequest {
-    /** Collection to lock */
+    /**
+     * Collection to lock
+     * @format GUID
+     */
     mediaCollectionId?: string;
     /** Lock status */
     locked?: boolean;
@@ -710,13 +889,19 @@ export interface UpdateCollectionLockRequest {
 export interface UpdateCollectionLockResponse {
 }
 export interface DeleteMediaCollectionRequest {
-    /** the collection to delete */
+    /**
+     * the collection to delete
+     * @format GUID
+     */
     mediaCollectionId: string;
 }
 export interface DeleteMediaCollectionResponse {
 }
 export interface ListCollectionMembersRequest {
-    /** the collection to get its members */
+    /**
+     * the collection to get its members
+     * @format GUID
+     */
     mediaCollectionId: string;
     /** Filter the members by their role in the collection */
     filterBy?: FilterBy;
@@ -736,7 +921,10 @@ export interface MemberAndStatus {
     memberStatus?: MemberStatus;
 }
 export interface AddItemsRequest {
-    /** Collection to add items */
+    /**
+     * Collection to add items
+     * @format GUID
+     */
     mediaCollectionId: string;
     /** Items to add */
     items?: AddItem[];
@@ -744,20 +932,32 @@ export interface AddItemsRequest {
 export interface AddItemsResponse {
 }
 export interface RemoveItemsRequest {
-    /** Collection to remove items from */
+    /**
+     * Collection to remove items from
+     * @format GUID
+     */
     mediaCollectionId: string;
-    /** Items to remove */
+    /**
+     * Items to remove
+     * @format GUID
+     */
     itemsIds?: string[];
 }
 export interface RemoveItemsResponse {
 }
 export interface UpdateItemsRequest {
-    /** Collection to update items */
+    /**
+     * Collection to update items
+     * @format GUID
+     */
     mediaCollectionId?: string;
     items?: UpdateItem[];
 }
 export interface UpdateItem {
-    /** Item to update */
+    /**
+     * Item to update
+     * @format GUID
+     */
     itemId?: string;
     /** New order index of the item */
     orderIndex?: number;
@@ -765,27 +965,42 @@ export interface UpdateItem {
 export interface UpdateItemsResponse {
 }
 export interface JoinToCollectionRequest {
-    /** Collection to join */
+    /**
+     * Collection to join
+     * @format GUID
+     */
     mediaCollectionId: string;
 }
 export interface JoinToCollectionResponse {
 }
 export interface RemoveMemberFromCollectionRequest {
-    /** Collection the member will be removed from being a member */
+    /**
+     * Collection the member will be removed from being a member
+     * @format GUID
+     */
     mediaCollectionId?: string;
-    /** Member id to remove from the collection */
+    /**
+     * Member id to remove from the collection
+     * @format GUID
+     */
     memberId?: string;
 }
 export interface RemoveMemberFromCollectionResponse {
 }
 export interface LeaveCollectionRequest {
-    /** Collection the member will be leaving */
+    /**
+     * Collection the member will be leaving
+     * @format GUID
+     */
     mediaCollectionId: string;
 }
 export interface LeaveCollectionResponse {
 }
 export interface ListCollectionItemsRequest {
-    /** Collection to get its items */
+    /**
+     * Collection to get its items
+     * @format GUID
+     */
     mediaCollectionId: string;
 }
 export interface ListCollectionItemsResponse {
@@ -793,9 +1008,15 @@ export interface ListCollectionItemsResponse {
     collectionItems?: CollectionItem[];
 }
 export interface CollectionItem {
-    /** Gallery id */
+    /**
+     * Gallery id
+     * @format GUID
+     */
     galleryId?: string;
-    /** Item id */
+    /**
+     * Item id
+     * @format GUID
+     */
     itemId?: string;
     /** Order index of the item */
     orderIndex?: number | null;
@@ -805,7 +1026,10 @@ export interface CollectionItem {
 export interface ListAllItemsBelongToCollectionRequest {
 }
 export interface ListAllItemsBelongToCollectionResponse {
-    /** List of the item ids that belong to one or more collection */
+    /**
+     * List of the item ids that belong to one or more collection
+     * @format GUID
+     */
     itemIds?: string[];
 }
 interface CollectionMemberNonNullableFields {
@@ -947,9 +1171,15 @@ export interface ListCollectionItemsResponseNonNullableFields {
     collectionItems: CollectionItemNonNullableFields[];
 }
 export interface BaseEventMetadata {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -998,6 +1228,8 @@ export interface CollectionCreatedEnvelope {
 }
 /** @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;
@@ -1014,7 +1246,11 @@ export declare function get(mediaCollectionId: string, options?: GetOptions): Pr
 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 */
+    /**
+     * The amount of items per response, default is 50
+     * @min 1
+     * @max 200
+     */
     limit?: number | null;
 }
 /**
@@ -1027,7 +1263,10 @@ export interface GetOptions {
  */
 export declare function listCollectionsForItem(itemId: string, options?: ListCollectionsForItemOptions): Promise<ListCollectionsForItemResponse & ListCollectionsForItemResponseNonNullableFields>;
 export interface ListCollectionsForItemOptions {
-    /** Gallery id */
+    /**
+     * Gallery id
+     * @format GUID
+     */
     galleryId?: string;
 }
 /**
@@ -1041,9 +1280,15 @@ export interface ListCollectionsForItemOptions {
  */
 export declare function getCollectionItem(identifiers: GetCollectionItemIdentifiers): Promise<GetCollectionItemResponse & GetCollectionItemResponseNonNullableFields>;
 export interface GetCollectionItemIdentifiers {
-    /** Collection id */
+    /**
+     * Collection id
+     * @format GUID
+     */
     mediaCollectionId: string;
-    /** Item id */
+    /**
+     * Item id
+     * @format GUID
+     */
     itemId: string;
 }
 /**
@@ -1054,7 +1299,11 @@ export interface GetCollectionItemIdentifiers {
  */
 export declare function list(options?: ListOptions): Promise<ListMediaCollectionsResponse & ListMediaCollectionsResponseNonNullableFields>;
 export interface ListOptions {
-    /** the amount of collections per response, default is 1000 */
+    /**
+     * 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;
@@ -1074,7 +1323,10 @@ export interface ListOptions {
  */
 export declare function create(name: string, options?: CreateOptions): Promise<CreateMediaCollectionResponse & CreateMediaCollectionResponseNonNullableFields>;
 export interface CreateOptions {
-    /** Description of the collection */
+    /**
+     * Description of the collection
+     * @maxLength 500
+     */
     description?: string | null;
     /** Privacy settings of the collection */
     privacySettings?: PrivacySettings;
@@ -1097,10 +1349,15 @@ export interface PartiallyUpdateMediaCollection {
     /**
      * Collection id
      * @readonly
+     * @format GUID
      */
     _id?: string;
-    /** Collection name */
+    /**
+     * Collection name
+     * @maxLength 100
+     */
     name?: string;
+    /** @maxLength 500 */
     description?: string | null;
     /**
      * total count of MediaCollection members
@@ -1181,7 +1438,10 @@ export interface AddItemsOptions {
  */
 export declare function removeItems(mediaCollectionId: string, options?: RemoveItemsOptions): Promise<void>;
 export interface RemoveItemsOptions {
-    /** Items to remove */
+    /**
+     * Items to remove
+     * @format GUID
+     */
     itemsIds?: string[];
 }
 /**