@wix/media 1.0.59 → 1.0.61

package/build/es/src/media-enterprise-public-media-v1-enterprise-item.types.d.ts

@@ -0,0 +1,949 @@
+/**
+ * Duration for video fits better if there will be type specific media item.. however, is it ok to implement
+ * an additional one of field called details?
+ */
+export interface EnterpriseMediaItem {
+    /**
+     * Id of the item in public media
+     * @readonly
+     */
+    id?: string;
+    /**
+     * Media type of the item
+     * @readonly
+     */
+    mediaType?: MediaType;
+    /**
+     * Size of the uploaded file in bytes.
+     * @readonly
+     */
+    sizeInBytes?: string | null;
+    /** The item title, part of searchable fields */
+    title?: string | null;
+    /**
+     * The aspect ratio of the item
+     * An object containing urls for different views of the item
+     * @readonly
+     */
+    assets?: ItemAssets;
+    /** Tags describing the image, part of searchable fields */
+    displayTags?: string[] | null;
+    /** Tags for internal client use, part of searchable fields */
+    internalTags?: string[] | null;
+    /**
+     * Tags for filtering items in the search
+     * @readonly
+     */
+    systemTags?: string[] | null;
+    /**
+     * Category ids this item belongs to
+     * @readonly
+     */
+    parentCategoryIds?: string[] | null;
+    /** Status of the item */
+    publishStatus?: PublishStatus;
+    /**
+     * Date and time the item was created.
+     * @readonly
+     */
+    createdDate?: Date;
+    /**
+     * Date and time the item was updated.
+     * @readonly
+     */
+    updatedDate?: Date;
+    /**
+     * An internal id used with different wix media systems
+     * @readonly
+     */
+    internalId?: string | null;
+}
+export declare enum MediaType {
+    MIXED = "MIXED",
+    IMAGE = "IMAGE",
+    VIDEO = "VIDEO",
+    AUDIO = "AUDIO",
+    DOCUMENT = "DOCUMENT",
+    VECTOR = "VECTOR",
+    ARCHIVE = "ARCHIVE",
+    MODEL3D = "MODEL3D"
+}
+export interface ItemAssets extends ItemAssetsAssetsOneOf {
+    /** Assets for image media type */
+    image?: Image;
+    /** Assets for video media type */
+    video?: VideoV2;
+    /** Assets for vector media type */
+    vector?: Image;
+    /** Assets for audio media type */
+    audio?: Audio;
+    /** Assets for document media type */
+    document?: Document;
+    /** Information about the archive. */
+    archive?: Archive;
+    /** Information about the 3D Model. */
+    model3d?: Model3D;
+}
+/** @oneof */
+export interface ItemAssetsAssetsOneOf {
+    /** Assets for image media type */
+    image?: Image;
+    /** Assets for video media type */
+    video?: VideoV2;
+    /** Assets for vector media type */
+    vector?: Image;
+    /** Assets for audio media type */
+    audio?: Audio;
+    /** Assets for document media type */
+    document?: Document;
+    /** Information about the archive. */
+    archive?: Archive;
+    /** Information about the 3D Model. */
+    model3d?: Model3D;
+}
+export interface Image {
+    /** WixMedia image ID. */
+    id?: string;
+    /** Image URL. */
+    url?: string;
+    /**
+     * Original image height.
+     * @readonly
+     */
+    height?: number;
+    /**
+     * Original image width.
+     * @readonly
+     */
+    width?: number;
+    /** Image alt text. */
+    altText?: string | null;
+    /**
+     * Image filename.
+     * @readonly
+     */
+    filename?: string | null;
+}
+export interface VideoV2 {
+    /** WixMedia ID. */
+    id?: string;
+    /**
+     * Available resolutions for the video, starting with the optimal resolution.
+     * @readonly
+     */
+    resolutions?: VideoResolution[];
+    /**
+     * Video filename.
+     * @readonly
+     */
+    filename?: string | null;
+}
+export interface VideoResolution {
+    /** Video URL. */
+    url?: string;
+    /** Video height. */
+    height?: number;
+    /** Video width. */
+    width?: number;
+    /**
+     * Video format
+     * Possible values: ['144p.mp4' '144p.webm' '240p.mp4' '240p.webm' '360p.mp4' '360p.webm' '480p.mp4' '480p.webm'
+     * '720p.mp4' '720p.webm' '1080p.mp4' '1080p.webm' ]
+     */
+    format?: string;
+}
+export interface Audio {
+    /** WixMedia ID. */
+    id?: string;
+    /** Audio URL. */
+    url?: string;
+    /**
+     * Audio filename.
+     * @readonly
+     */
+    filename?: string | null;
+}
+export interface Document {
+    /** WixMedia ID. */
+    id?: string;
+    /** Document URL. */
+    url?: string;
+    /** Document filename. */
+    filename?: string | null;
+}
+export interface Archive {
+    /** WixMedia ID. */
+    id?: string;
+    /** Archive URL. */
+    url?: string;
+    /**
+     * Archive URL expiration date (when relevant).
+     * @readonly
+     */
+    urlExpirationDate?: Date;
+    /** Archive size in bytes. */
+    sizeInBytes?: string | null;
+    /** Archive filename. */
+    filename?: string | null;
+}
+export interface Model3D {
+    /** WixMedia 3D ID. */
+    id?: string;
+    /** 3D URL. */
+    url?: string;
+    /** 3D thumbnail Image */
+    thumbnail?: Image;
+    /** 3D alt text. */
+    altText?: string | null;
+    /**
+     * 3D URL expiration date (when relevant).
+     * @readonly
+     */
+    urlExpirationDate?: Date;
+    /**
+     * 3D filename.
+     * @readonly
+     */
+    filename?: string | null;
+    /**
+     * 3D size in bytes.
+     * @readonly
+     */
+    sizeInBytes?: string | null;
+}
+export declare enum PublishStatus {
+    UNDEFINED = "UNDEFINED",
+    UNPUBLISHED = "UNPUBLISHED",
+    PUBLISHED = "PUBLISHED",
+    WIX_ONLY = "WIX_ONLY"
+}
+export interface ItemCategoriesChanged {
+    /** A list of the current item categories */
+    itemCategoryIds?: string[] | null;
+    /** A list of the categories that where unlinked from the item */
+    unlinkedCategoryIds?: string[] | null;
+    /** A list of the categories that where linked to the item */
+    linkedCategoryIds?: string[] | null;
+}
+export interface ItemUploadCallbackRequest {
+    /** The item id of the created item */
+    itemId?: string;
+    /** The callback passed to the upload endpoint */
+    callbackToken?: string;
+}
+export interface ItemUploadCallbackResponse {
+}
+export interface GenerateFileUploadUrlRequest {
+    /** The uploaded original file name including the extension */
+    fileName?: string;
+    /** The file mime-type - will be used to identify the type of media */
+    contentType?: string;
+    /** The file size in bytes */
+    sizeInBytes?: number;
+    /**
+     * An optional list of categories to link the created item to
+     * The item will be linked to the account category automatically
+     */
+    categoryIds?: string[] | null;
+}
+export interface GenerateFileUploadUrlResponse {
+    /** The upload url to upload the file to */
+    uploadUrl?: string;
+}
+export interface ImportFileRequest {
+    /** The url to the file to be imported */
+    url: string;
+    /** The uploaded original file name including the extension - will be used as the initial display name */
+    fileName?: string | null;
+    /** The file mime-type - will be used to identify the type of media */
+    contentType?: string | null;
+    /** The file size in bytes */
+    sizeInBytes?: number | null;
+    /**
+     * An optional list of categories to link the created item to
+     * The item will be linked to the account category automatically
+     */
+    categoryIds?: string[] | null;
+    /** The media type of the uploaded file */
+    mediaType?: MediaType;
+    /**
+     * A unique identifier of the client that imported the file
+     * This information will exist in the system_tags field prefixed by '_external_uploader:{uploader_system_tag}'
+     */
+    uploaderSystemTag?: string | null;
+    /**
+     * An additional container for external information
+     * mostly used to pass identifying information of related entities in external services
+     * This information will exist in the system_tags field prefixed by '_external_uploader_info:{uploader_info_system_tag}'
+     */
+    uploaderInfoSystemTag?: string | null;
+}
+export interface ImportFileResponse {
+    /**
+     * Partial item - without the assets
+     * At this stage of implementation only the 'internal_id' will be filled
+     * all other required values will be fake values
+     */
+    item?: EnterpriseMediaItem;
+}
+export interface SearchItemsRequest {
+    /** Items search query */
+    query?: Search;
+}
+export interface Search extends SearchPagingMethodOneOf {
+    /** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
+    paging?: Paging;
+    /** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
+    filter?: Record<string, any> | null;
+    /** free text to match in searchable fields */
+    search?: SearchDetails;
+}
+/** @oneof */
+export interface SearchPagingMethodOneOf {
+    /** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
+    paging?: Paging;
+}
+export interface SearchDetails {
+    /** search term or expression */
+    expression?: string | null;
+}
+export interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+export interface SearchItemsResponse {
+    /** A list of items matching the request */
+    items?: EnterpriseMediaItem[];
+    /** Information about the search results. */
+    pagingMetadata?: PagingMetadataV2;
+}
+export interface PagingMetadataV2 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
+    total?: number | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+}
+export interface Cursors {
+    /** Cursor pointing to next page in the list of results. */
+    next?: string | null;
+}
+export interface QueryItemsRequest {
+    /** Items query */
+    query?: QueryV2;
+}
+export interface QueryV2 extends QueryV2PagingMethodOneOf {
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging;
+    /**
+     * Filter object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+export interface QueryV2PagingMethodOneOf {
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging;
+}
+export interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface QueryItemsResponse {
+    /** A list of items matching the request */
+    items?: EnterpriseMediaItem[];
+    /** Information for the next request. */
+    pagingMetadata?: PagingMetadataV2;
+}
+export interface UpdateItemRequest {
+    /** The category object that will be created */
+    item: EnterpriseMediaItem;
+}
+export interface UpdateItemResponse {
+    /** Updated item info */
+    item?: EnterpriseMediaItem;
+}
+export interface PublishStatusChanged {
+    /** The new item status */
+    publishStatus?: PublishStatus;
+}
+export interface BulkUpdateItemRequest {
+    /** Requests to update individual item */
+    updateItemRequests: UpdateItemRequest[];
+    /** Should the response return the updated item */
+    returnEntity?: boolean;
+}
+export interface BulkUpdateItemResponse {
+    /** Requests to update individual item */
+    results?: BulkItemUpdateResult[];
+    /** Metadata of the operation */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkItemUpdateResult {
+    /** updated item metadata */
+    itemMetadata?: ItemMetadata;
+    /** only returned if operation was successful and if returnEntity flag was on */
+    item?: EnterpriseMediaItem;
+}
+export interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+export interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+export interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+export interface GetItemRequest {
+    /** Item id */
+    itemId: string;
+}
+export interface GetItemResponse {
+    /** item info */
+    item?: EnterpriseMediaItem;
+}
+export interface LinkItemToCategoriesRequest {
+    /** The item id */
+    itemId: string;
+    /** The category ids that the item will be linked to */
+    categoryIds?: string[];
+}
+export interface LinkItemToCategoriesResponse {
+    /** The linked category ids */
+    linkedCategoryIds?: string[] | null;
+}
+export interface UnlinkItemFromCategoriesRequest {
+    /** The item id */
+    itemId: string;
+    /** The category ids that the item will be unlinked from */
+    categoryIds?: string[];
+}
+export interface UnlinkItemFromCategoriesResponse {
+    /** The unlinked category ids */
+    unlinkedCategoryIds?: string[] | null;
+}
+export interface OverwriteItemCategoriesRequest {
+    /** The item id */
+    itemId: string;
+    /** The category ids the item will be linked to after this operation */
+    categoryIds?: string[];
+}
+export interface OverwriteItemCategoriesResponse {
+    /** The linked category ids */
+    linkedCategoryIds?: string[] | null;
+    /** The unlinked category ids */
+    unlinkedCategoryIds?: string[] | null;
+}
+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. */
+    eventTime?: Date;
+    /**
+     * 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 {
+    entityAsJson?: string;
+}
+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.
+     */
+    currentEntityAsJson?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntityAsJson?: string | null;
+}
+export interface ActionEvent {
+    bodyAsJson?: string;
+}
+export interface GenerateFileUploadUrlResponseNonNullableFields {
+    uploadUrl: string;
+}
+export interface ImportFileResponseNonNullableFields {
+    item?: {
+        id: string;
+        mediaType: MediaType;
+        assets?: {
+            image?: {
+                id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+            video?: {
+                id: string;
+                url: string;
+                resolutions: {
+                    url: string;
+                    height: number;
+                    width: number;
+                    poster?: {
+                        id: string;
+                        url: string;
+                        height: number;
+                        width: number;
+                    };
+                    format: string;
+                }[];
+                posters: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                }[];
+            };
+            vector?: {
+                id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+            audio?: {
+                id: string;
+                url: string;
+            };
+            document?: {
+                id: string;
+                url: string;
+            };
+            archive?: {
+                id: string;
+                url: string;
+            };
+            model3d?: {
+                id: string;
+                url: string;
+                thumbnail?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+            };
+        };
+        publishStatus: PublishStatus;
+    };
+}
+export interface SearchItemsResponseNonNullableFields {
+    items: {
+        id: string;
+        mediaType: MediaType;
+        assets?: {
+            image?: {
+                id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+            video?: {
+                id: string;
+                url: string;
+                resolutions: {
+                    url: string;
+                    height: number;
+                    width: number;
+                    poster?: {
+                        id: string;
+                        url: string;
+                        height: number;
+                        width: number;
+                    };
+                    format: string;
+                }[];
+                posters: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                }[];
+            };
+            vector?: {
+                id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+            audio?: {
+                id: string;
+                url: string;
+            };
+            document?: {
+                id: string;
+                url: string;
+            };
+            archive?: {
+                id: string;
+                url: string;
+            };
+            model3d?: {
+                id: string;
+                url: string;
+                thumbnail?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+            };
+        };
+        publishStatus: PublishStatus;
+    }[];
+}
+export interface QueryItemsResponseNonNullableFields {
+    items: {
+        id: string;
+        mediaType: MediaType;
+        assets?: {
+            image?: {
+                id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+            video?: {
+                id: string;
+                url: string;
+                resolutions: {
+                    url: string;
+                    height: number;
+                    width: number;
+                    poster?: {
+                        id: string;
+                        url: string;
+                        height: number;
+                        width: number;
+                    };
+                    format: string;
+                }[];
+                posters: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                }[];
+            };
+            vector?: {
+                id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+            audio?: {
+                id: string;
+                url: string;
+            };
+            document?: {
+                id: string;
+                url: string;
+            };
+            archive?: {
+                id: string;
+                url: string;
+            };
+            model3d?: {
+                id: string;
+                url: string;
+                thumbnail?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+            };
+        };
+        publishStatus: PublishStatus;
+    }[];
+}
+export interface UpdateItemResponseNonNullableFields {
+    item?: {
+        id: string;
+        mediaType: MediaType;
+        assets?: {
+            image?: {
+                id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+            video?: {
+                id: string;
+                url: string;
+                resolutions: {
+                    url: string;
+                    height: number;
+                    width: number;
+                    poster?: {
+                        id: string;
+                        url: string;
+                        height: number;
+                        width: number;
+                    };
+                    format: string;
+                }[];
+                posters: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                }[];
+            };
+            vector?: {
+                id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+            audio?: {
+                id: string;
+                url: string;
+            };
+            document?: {
+                id: string;
+                url: string;
+            };
+            archive?: {
+                id: string;
+                url: string;
+            };
+            model3d?: {
+                id: string;
+                url: string;
+                thumbnail?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+            };
+        };
+        publishStatus: PublishStatus;
+    };
+}
+export interface BulkUpdateItemResponseNonNullableFields {
+    results: {
+        itemMetadata?: {
+            originalIndex: number;
+            success: boolean;
+            error?: {
+                code: string;
+                description: string;
+            };
+        };
+        item?: {
+            id: string;
+            mediaType: MediaType;
+            assets?: {
+                image?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+                video?: {
+                    id: string;
+                    url: string;
+                    resolutions: {
+                        url: string;
+                        height: number;
+                        width: number;
+                        poster?: {
+                            id: string;
+                            url: string;
+                            height: number;
+                            width: number;
+                        };
+                        format: string;
+                    }[];
+                    posters: {
+                        id: string;
+                        url: string;
+                        height: number;
+                        width: number;
+                    }[];
+                };
+                vector?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+                audio?: {
+                    id: string;
+                    url: string;
+                };
+                document?: {
+                    id: string;
+                    url: string;
+                };
+                archive?: {
+                    id: string;
+                    url: string;
+                };
+                model3d?: {
+                    id: string;
+                    url: string;
+                    thumbnail?: {
+                        id: string;
+                        url: string;
+                        height: number;
+                        width: number;
+                    };
+                };
+            };
+            publishStatus: PublishStatus;
+        };
+    }[];
+    bulkActionMetadata?: {
+        totalSuccesses: number;
+        totalFailures: number;
+        undetailedFailures: number;
+    };
+}
+export interface GetItemResponseNonNullableFields {
+    item?: {
+        id: string;
+        mediaType: MediaType;
+        assets?: {
+            image?: {
+                id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+            video?: {
+                id: string;
+                url: string;
+                resolutions: {
+                    url: string;
+                    height: number;
+                    width: number;
+                    poster?: {
+                        id: string;
+                        url: string;
+                        height: number;
+                        width: number;
+                    };
+                    format: string;
+                }[];
+                posters: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                }[];
+            };
+            vector?: {
+                id: string;
+                url: string;
+                height: number;
+                width: number;
+            };
+            audio?: {
+                id: string;
+                url: string;
+            };
+            document?: {
+                id: string;
+                url: string;
+            };
+            archive?: {
+                id: string;
+                url: string;
+            };
+            model3d?: {
+                id: string;
+                url: string;
+                thumbnail?: {
+                    id: string;
+                    url: string;
+                    height: number;
+                    width: number;
+                };
+            };
+        };
+        publishStatus: PublishStatus;
+    };
+}