@wix/media 1.0.59 → 1.0.61

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

@@ -0,0 +1,221 @@
+export interface EnterpriseCategory {
+    /**
+     * Id of the category
+     * @readonly
+     */
+    id?: string;
+    /** The display name that will be shown for the item */
+    displayName?: string | null;
+    /** Id of the parent category, will default to the account master category */
+    parentCategoryId?: string | null;
+    /** Sort order number of the category, will determine the order of the category with other categories under the same parent category */
+    sortOrder?: number | null;
+    /** Publish status of the category */
+    publishStatus?: PublishStatus;
+    /**
+     * Date and time the category was created.
+     * @readonly
+     */
+    createdDate?: Date;
+    /**
+     * Date and time the category was updated.
+     * @readonly
+     */
+    updatedDate?: Date;
+}
+export declare enum PublishStatus {
+    UNDEFINED = "UNDEFINED",
+    UNPUBLISHED = "UNPUBLISHED",
+    PUBLISHED = "PUBLISHED",
+    WIX_ONLY = "WIX_ONLY"
+}
+export declare enum MediaType {
+    MIXED = "MIXED",
+    IMAGE = "IMAGE",
+    VIDEO = "VIDEO",
+    AUDIO = "AUDIO",
+    DOCUMENT = "DOCUMENT",
+    VECTOR = "VECTOR",
+    ARCHIVE = "ARCHIVE",
+    MODEL3D = "MODEL3D"
+}
+export interface CreateCategoryRequest {
+    /** The category object that will be created */
+    category: EnterpriseCategory;
+}
+export interface CreateCategoryResponse {
+    /** A list of items matching the request */
+    category?: EnterpriseCategory;
+}
+export interface DeleteCategoryRequest {
+    /** Category id */
+    categoryId: string;
+}
+export interface DeleteCategoryResponse {
+}
+export interface UpdateCategoryRequest {
+    /** The category object that will be created */
+    category: EnterpriseCategory;
+}
+export interface UpdateCategoryResponse {
+    /** The updated category */
+    category?: EnterpriseCategory;
+}
+export interface GetCategoryRequest {
+    /** Category id */
+    categoryId: string;
+    /** number of sub category levels */
+    levels?: number | null;
+    /** filter categories by publish statuses. When empty will return PUBLISHED and UNPUBLISHED */
+    publishStatus?: PublishStatus;
+}
+export interface GetCategoryResponse {
+    /** The category details */
+    category?: EnterpriseCategoryTree;
+}
+export interface EnterpriseCategoryTree {
+    /** Category information */
+    category?: EnterpriseCategory;
+    /** Information about the sub categories */
+    subCategories?: EnterpriseCategoryTree[];
+}
+export interface EnterpriseOnboardingRequest {
+    /** The account id of the organization - will be used as the organization category id */
+    accountId: string;
+    /** The account name of the organization - will be used as the organization category name */
+    accountName?: string;
+}
+export interface EnterpriseOnboardingResponse {
+    /** The enterprise category */
+    category?: EnterpriseCategory;
+}
+export interface LinkItemsToCategoryRequest {
+    /** The category to link to */
+    categoryId?: string;
+    /** The item ids that will be added to the category */
+    itemIds?: string[];
+}
+export interface LinkItemsToCategoryResponse {
+}
+export interface UnlinkItemsFromCategoryRequest {
+    /** The category to link to */
+    categoryId?: string;
+    /** The item ids that will be added to the category */
+    itemIds?: string[];
+}
+export interface UnlinkItemsFromCategoryResponse {
+}
+export interface GetMediaManagerCategoriesRequest {
+}
+export interface GetMediaManagerCategoriesResponse {
+    /** The category details */
+    category?: EnterpriseCategoryTree;
+}
+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 CreateCategoryResponseNonNullableFields {
+    category?: {
+        id: string;
+        publishStatus: PublishStatus;
+        mediaType: MediaType;
+    };
+}
+export interface UpdateCategoryResponseNonNullableFields {
+    category?: {
+        id: string;
+        publishStatus: PublishStatus;
+        mediaType: MediaType;
+    };
+}
+export interface GetCategoryResponseNonNullableFields {
+    category?: {
+        category?: {
+            id: string;
+            publishStatus: PublishStatus;
+            mediaType: MediaType;
+        };
+        subCategories: NonNullable<GetCategoryResponseNonNullableFields>['category'][];
+    };
+}
+export interface EnterpriseOnboardingResponseNonNullableFields {
+    category?: {
+        id: string;
+        publishStatus: PublishStatus;
+        mediaType: MediaType;
+    };
+}
+export interface GetMediaManagerCategoriesResponseNonNullableFields {
+    category?: {
+        category?: {
+            id: string;
+            publishStatus: PublishStatus;
+            mediaType: MediaType;
+        };
+        subCategories: NonNullable<GetMediaManagerCategoriesResponseNonNullableFields>['category'][];
+    };
+}

package/build/es/src/media-enterprise-public-media-v1-enterprise-category.types.js

@@ -0,0 +1,19 @@
+export var PublishStatus;
+(function (PublishStatus) {
+    PublishStatus["UNDEFINED"] = "UNDEFINED";
+    PublishStatus["UNPUBLISHED"] = "UNPUBLISHED";
+    PublishStatus["PUBLISHED"] = "PUBLISHED";
+    PublishStatus["WIX_ONLY"] = "WIX_ONLY";
+})(PublishStatus || (PublishStatus = {}));
+export var MediaType;
+(function (MediaType) {
+    MediaType["MIXED"] = "MIXED";
+    MediaType["IMAGE"] = "IMAGE";
+    MediaType["VIDEO"] = "VIDEO";
+    MediaType["AUDIO"] = "AUDIO";
+    MediaType["DOCUMENT"] = "DOCUMENT";
+    MediaType["VECTOR"] = "VECTOR";
+    MediaType["ARCHIVE"] = "ARCHIVE";
+    MediaType["MODEL3D"] = "MODEL3D";
+})(MediaType || (MediaType = {}));
+//# sourceMappingURL=media-enterprise-public-media-v1-enterprise-category.types.js.map

package/build/es/src/media-enterprise-public-media-v1-enterprise-category.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"media-enterprise-public-media-v1-enterprise-category.types.js","sourceRoot":"","sources":["../../../src/media-enterprise-public-media-v1-enterprise-category.types.ts"],"names":[],"mappings":"AA0BA,MAAM,CAAN,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,wCAAuB,CAAA;IACvB,4CAA2B,CAAA;IAC3B,wCAAuB,CAAA;IACvB,sCAAqB,CAAA;AACvB,CAAC,EALW,aAAa,KAAb,aAAa,QAKxB;AAED,MAAM,CAAN,IAAY,SASX;AATD,WAAY,SAAS;IACnB,4BAAe,CAAA;IACf,4BAAe,CAAA;IACf,4BAAe,CAAA;IACf,4BAAe,CAAA;IACf,kCAAqB,CAAA;IACrB,8BAAiB,CAAA;IACjB,gCAAmB,CAAA;IACnB,gCAAmB,CAAA;AACrB,CAAC,EATW,SAAS,KAAT,SAAS,QASpB"}

package/build/es/src/media-enterprise-public-media-v1-enterprise-category.universal.d.ts

@@ -0,0 +1,315 @@
+import { EventDefinition } from '@wix/sdk-types';
+export interface EnterpriseCategory {
+    /**
+     * Id of the category
+     * @readonly
+     */
+    _id?: string;
+    /** The display name that will be shown for the item */
+    displayName?: string | null;
+    /** Id of the parent category, will default to the account master category */
+    parentCategoryId?: string | null;
+    /** Sort order number of the category, will determine the order of the category with other categories under the same parent category */
+    sortOrder?: number | null;
+    /** Publish status of the category */
+    publishStatus?: PublishStatus;
+    /**
+     * Date and time the category was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Date and time the category was updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+}
+export declare enum PublishStatus {
+    UNDEFINED = "UNDEFINED",
+    UNPUBLISHED = "UNPUBLISHED",
+    PUBLISHED = "PUBLISHED",
+    WIX_ONLY = "WIX_ONLY"
+}
+export declare enum MediaType {
+    MIXED = "MIXED",
+    IMAGE = "IMAGE",
+    VIDEO = "VIDEO",
+    AUDIO = "AUDIO",
+    DOCUMENT = "DOCUMENT",
+    VECTOR = "VECTOR",
+    ARCHIVE = "ARCHIVE",
+    MODEL3D = "MODEL3D"
+}
+export interface CreateCategoryRequest {
+    /** The category object that will be created */
+    category: EnterpriseCategory;
+}
+export interface CreateCategoryResponse {
+    /** A list of items matching the request */
+    category?: EnterpriseCategory;
+}
+export interface DeleteCategoryRequest {
+    /** Category id */
+    categoryId: string;
+}
+export interface DeleteCategoryResponse {
+}
+export interface UpdateCategoryRequest {
+    /** The category object that will be created */
+    category: EnterpriseCategory;
+}
+export interface UpdateCategoryResponse {
+    /** The updated category */
+    category?: EnterpriseCategory;
+}
+export interface GetCategoryRequest {
+    /** Category id */
+    categoryId: string;
+    /** number of sub category levels */
+    levels?: number | null;
+    /** filter categories by publish statuses. When empty will return PUBLISHED and UNPUBLISHED */
+    publishStatus?: PublishStatus;
+}
+export interface GetCategoryResponse {
+    /** The category details */
+    category?: EnterpriseCategoryTree;
+}
+export interface EnterpriseCategoryTree {
+    /** Category information */
+    category?: EnterpriseCategory;
+    /** Information about the sub categories */
+    subCategories?: EnterpriseCategoryTree[];
+}
+export interface EnterpriseOnboardingRequest {
+    /** The account id of the organization - will be used as the organization category id */
+    accountId: string;
+    /** The account name of the organization - will be used as the organization category name */
+    accountName?: string;
+}
+export interface EnterpriseOnboardingResponse {
+    /** The enterprise category */
+    category?: EnterpriseCategory;
+}
+export interface LinkItemsToCategoryRequest {
+    /** The category to link to */
+    categoryId?: string;
+    /** The item ids that will be added to the category */
+    itemIds?: string[];
+}
+export interface LinkItemsToCategoryResponse {
+}
+export interface UnlinkItemsFromCategoryRequest {
+    /** The category to link to */
+    categoryId?: string;
+    /** The item ids that will be added to the category */
+    itemIds?: string[];
+}
+export interface UnlinkItemsFromCategoryResponse {
+}
+export interface GetMediaManagerCategoriesRequest {
+}
+export interface GetMediaManagerCategoriesResponse {
+    /** The category details */
+    category?: EnterpriseCategoryTree;
+}
+export interface DomainEvent<T = string> extends DomainEventBodyOneOf<T> {
+    createdEvent?: EntityCreatedEvent<T>;
+    updatedEvent?: EntityUpdatedEvent<T>;
+    deletedEvent?: EntityDeletedEvent<T>;
+    actionEvent?: ActionEvent<T>;
+    /**
+     * 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;
+}
+export interface DomainCreatedEvent<T> extends Omit<DomainEvent<T>, 'deletedEvent' | 'updatedEvent' | 'actionEvent'> {
+}
+export interface DomainDeletedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'updatedEvent' | 'actionEvent'> {
+}
+export interface DomainUpdatedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'actionEvent'> {
+}
+export interface DomainActionEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'updatedEvent'> {
+}
+/** @oneof */
+export interface DomainEventBodyOneOf<T> {
+    createdEvent?: EntityCreatedEvent<T>;
+    updatedEvent?: EntityUpdatedEvent<T>;
+    deletedEvent?: EntityDeletedEvent<T>;
+    actionEvent?: ActionEvent<T>;
+}
+export interface EntityCreatedEvent<T> {
+    entity?: T;
+}
+export interface EntityUpdatedEvent<T> {
+    /**
+     * 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?: T;
+}
+export interface EntityDeletedEvent<T> {
+    /** Entity that was deleted */
+    deletedEntity?: T | null;
+}
+export interface ActionEvent<T> {
+    body?: T;
+}
+export interface CreateCategoryResponseNonNullableFields {
+    category?: {
+        _id: string;
+        publishStatus: PublishStatus;
+    };
+}
+export interface UpdateCategoryResponseNonNullableFields {
+    category?: {
+        _id: string;
+        publishStatus: PublishStatus;
+    };
+}
+export interface GetCategoryResponseNonNullableFields {
+    category?: {
+        category?: {
+            _id: string;
+            publishStatus: PublishStatus;
+        };
+        subCategories: NonNullable<GetCategoryResponseNonNullableFields>['category'][];
+    };
+}
+export interface EnterpriseOnboardingResponseNonNullableFields {
+    category?: {
+        _id: string;
+        publishStatus: PublishStatus;
+    };
+}
+export interface GetMediaManagerCategoriesResponseNonNullableFields {
+    category?: {
+        category?: {
+            _id: string;
+            publishStatus: PublishStatus;
+        };
+        subCategories: NonNullable<GetMediaManagerCategoriesResponseNonNullableFields>['category'][];
+    };
+}
+export declare const onEnterpriseCategoryCreated: EventDefinition<DomainCreatedEvent<EnterpriseCategory>, "wix.media.enterprise_public_media.v1.enterprise_category_created">;
+export declare const onEnterpriseCategoryDeleted: EventDefinition<DomainDeletedEvent<EnterpriseCategory>, "wix.media.enterprise_public_media.v1.enterprise_category_deleted">;
+export declare const onEnterpriseCategoryUpdated: EventDefinition<DomainUpdatedEvent<EnterpriseCategory>, "wix.media.enterprise_public_media.v1.enterprise_category_updated">;
+/**
+ * Fetch a list of random media from different providers, using site information to customize results when available
+ * @param category - The category object that will be created
+ * @public
+ * @documentationMaturity preview
+ * @requiredField category
+ * @requiredField category.displayName
+ * @returns A list of items matching the request
+ */
+export declare function createCategory(category: EnterpriseCategory): Promise<EnterpriseCategory & NonNullable<CreateCategoryResponseNonNullableFields>['category']>;
+/**
+ * Delete a category including all its subcategories - but not the items
+ * @param categoryId - Category id
+ * @public
+ * @documentationMaturity preview
+ * @requiredField categoryId
+ */
+export declare function deleteCategory(categoryId: string): Promise<void>;
+/**
+ * Update category details
+ * @param _id - Id of the category
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField category
+ * @returns The updated category
+ */
+export declare function updateCategory(_id: string, category: UpdateCategory): Promise<EnterpriseCategory & NonNullable<UpdateCategoryResponseNonNullableFields>['category']>;
+export interface UpdateCategory {
+    /**
+     * Id of the category
+     * @readonly
+     */
+    _id?: string;
+    /** The display name that will be shown for the item */
+    displayName?: string | null;
+    /** Id of the parent category, will default to the account master category */
+    parentCategoryId?: string | null;
+    /** Sort order number of the category, will determine the order of the category with other categories under the same parent category */
+    sortOrder?: number | null;
+    /** Publish status of the category */
+    publishStatus?: PublishStatus;
+    /**
+     * Date and time the category was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Date and time the category was updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+}
+/**
+ * Get information about a specific category
+ * @param categoryId - Category id
+ * @public
+ * @documentationMaturity preview
+ * @requiredField categoryId
+ * @returns The category details
+ */
+export declare function getCategory(categoryId: string, options?: GetCategoryOptions): Promise<EnterpriseCategoryTree & NonNullable<GetCategoryResponseNonNullableFields>['category']>;
+export interface GetCategoryOptions {
+    /** number of sub category levels */
+    levels?: number | null;
+    /** filter categories by publish statuses. When empty will return PUBLISHED and UNPUBLISHED */
+    publishStatus?: PublishStatus;
+}
+/**
+ * Create the enterprise category under "enterprise-media" main category
+ * the caller identity must be have the same accountId of the request
+ * @param accountId - The account id of the organization - will be used as the organization category id
+ * @public
+ * @documentationMaturity preview
+ * @requiredField accountId
+ */
+export declare function enterpriseOnboarding(accountId: string, options?: EnterpriseOnboardingOptions): Promise<EnterpriseOnboardingResponse & EnterpriseOnboardingResponseNonNullableFields>;
+export interface EnterpriseOnboardingOptions {
+    /** The account name of the organization - will be used as the organization category name */
+    accountName?: string;
+}
+/**
+ * Get the account category tree details
+ * @public
+ * @documentationMaturity preview
+ */
+export declare function getMediaManagerCategories(): Promise<GetMediaManagerCategoriesResponse & GetMediaManagerCategoriesResponseNonNullableFields>;