@wix/auto_sdk_media_folders 1.0.0

package/build/cjs/src/media-site-media-v1-folder-folders.types.d.ts

@@ -0,0 +1,360 @@
+export interface Folder {
+    /** Folder ID. Generated when a folder is created in the Media Manager. */
+    id?: string;
+    /** Folder name as it appears in the Media Manager. */
+    displayName?: string;
+    /** ID of the folder's parent folder. <br /> Default: `media-root` folder. */
+    parentFolderId?: string;
+    /**
+     * Date the folder was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date the folder was updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /**
+     * State of the folder.
+     * @readonly
+     */
+    state?: State;
+}
+export declare enum State {
+    OK = "OK",
+    DELETED = "DELETED"
+}
+export declare enum Namespace {
+    NO_NAMESPACE = "NO_NAMESPACE",
+    OTHERS = "OTHERS",
+    /** ANY = 2; */
+    WIX_VIDEO = "WIX_VIDEO",
+    /** _nsWixMusic */
+    WIX_MUSIC = "WIX_MUSIC",
+    /** _nsArtStore */
+    ALBUMS_AND_ART_STORE = "ALBUMS_AND_ART_STORE",
+    /** _nsDigitalProduct */
+    WIX_ECOM = "WIX_ECOM",
+    /** _nsPhotoShareApp */
+    PHOTO_SHARE_APP = "PHOTO_SHARE_APP",
+    /** _nsSharingApp, */
+    SHARING_APP = "SHARING_APP",
+    /** engage */
+    CHAT = "CHAT",
+    /** logobuilder */
+    LOGO_BUILDER = "LOGO_BUILDER",
+    /** WixExposure */
+    ALBUMS_OLD = "ALBUMS_OLD",
+    /** chat-mobile-uploads */
+    CHAT_MOBILE = "CHAT_MOBILE",
+    /** _nsWixForms */
+    WIX_FORMS = "WIX_FORMS",
+    /** _nsWixLegends */
+    WIX_LEGENDS = "WIX_LEGENDS"
+}
+export interface CreateFolderRequest {
+    /** Folder name that appears in the Media Manager. */
+    displayName: string;
+    /** ID of the folder's parent folder. */
+    parentFolderId?: string | null;
+}
+export interface CreateFolderResponse {
+    /** Information about the newly created folder. */
+    folder?: Folder;
+}
+export interface GetFolderRequest {
+    /** Folder ID. */
+    folderId: string;
+}
+export interface GetFolderResponse {
+    /** Information about the folder. */
+    folder?: Folder;
+}
+export interface ListFoldersRequest {
+    /**
+     * ID of the folder's parent folder.
+     * <br /> Default: `media-root` folder.
+     */
+    parentFolderId?: string | null;
+    /**
+     * Field name and order to sort by. One of: <br />
+     * * `displayName`
+     * * `updatedDate`
+     * Default: `updatedDate` in `desc` order.
+     */
+    sort?: Sorting;
+    /** Cursor and paging information. */
+    paging?: CursorPaging;
+}
+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 CursorPaging {
+    /** Maximum number of items to return in the results. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+export interface ListFoldersResponse {
+    /** Information about the folders in the requested folder. */
+    folders?: Folder[];
+    /** The next cursor if it exists. */
+    nextCursor?: PagingMetadataV2;
+}
+export interface PagingMetadataV2 {
+    /** 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 string pointing to the next page in the list of results. */
+    next?: string | null;
+}
+export interface SearchFoldersRequest {
+    /**
+     * A root folder in the Media Manager to search in. <br />
+     * Default: `MEDIA_ROOT`.
+     */
+    rootFolder?: RootFolder;
+    /**
+     * Field name and order to sort by. One of:
+     * * `displayName`
+     * * `updatedDate`
+     * Default: `updatedDate` in `desc` order.
+     */
+    sort?: Sorting;
+    /** Cursor and paging information. */
+    paging?: CursorPaging;
+    /**
+     * Term to search for, such as the value of a folder's `displayName`. <br />
+     * For example, if a folder's `displayName` is 'my-videos-folder', the search term is 'my-videos-folder'.
+     */
+    search?: string | null;
+}
+export declare enum RootFolder {
+    /** Root of all site media */
+    MEDIA_ROOT = "MEDIA_ROOT",
+    /** Root of the trash system folder */
+    TRASH_ROOT = "TRASH_ROOT",
+    /** Root of all visitor uploads */
+    VISITOR_UPLOADS_ROOT = "VISITOR_UPLOADS_ROOT"
+}
+export interface SearchFoldersResponse {
+    /** Information about the folders in the requested folder. */
+    folders?: Folder[];
+    /** The next cursor if it exists. */
+    nextCursor?: PagingMetadataV2;
+}
+export interface UpdateFolderRequest {
+    /** Folder to update. */
+    folder: Folder;
+}
+export interface UpdateFolderResponse {
+    /** Information about the updated folder. */
+    folder?: Folder;
+}
+export interface UnsupportedRequestValueError {
+    /** Optional A list of allowed values */
+    allowedValues?: string[];
+    /** The unsupported value send in the request */
+    requestValue?: string;
+}
+export interface GenerateFolderDownloadUrlRequest {
+    /** Folder ID. */
+    folderId: string;
+}
+export interface GenerateFolderDownloadUrlResponse {
+    /** URL for downloading a specific folder in the Media Manager. */
+    downloadUrl?: string;
+}
+export interface BulkDeleteFoldersRequest {
+    /** IDs of the folders to move to the Media Manager's trash bin. */
+    folderIds: string[];
+    /**
+     * Whether the specified folders are permanently deleted. <br />
+     * Default: `false`
+     */
+    permanent?: boolean;
+}
+export interface BulkDeleteFoldersResponse {
+}
+export interface BulkRestoreFoldersFromTrashBinRequest {
+    /** IDs of the folders to restore from the Media Manager's trash bin. */
+    folderIds: string[];
+}
+export interface BulkRestoreFoldersFromTrashBinResponse {
+}
+export interface ListDeletedFoldersRequest {
+    /** ID of the folder's parent folder. */
+    parentFolderId?: string | null;
+    /**
+     * Field name and order to sort by. One of:
+     * * `displayName`
+     * * `updatedDate`
+     * Default: `updatedDate` in `desc` order.
+     */
+    sort?: Sorting;
+    /** Cursor and paging information. */
+    paging?: CursorPaging;
+}
+export interface ListDeletedFoldersResponse {
+    /** List of folders in the Media Manager's trash bin. */
+    folders?: Folder[];
+    /** The next cursor if it exists. */
+    nextCursor?: PagingMetadataV2;
+}
+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 {
+    entityAsJson?: string;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
+}
+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.
+     */
+    currentEntityAsJson?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntityAsJson?: string | null;
+}
+export interface ActionEvent {
+    bodyAsJson?: 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"
+}
+interface FolderNonNullableFields {
+    id: string;
+    displayName: string;
+    parentFolderId: string;
+    state: State;
+    namespace: Namespace;
+}
+export interface CreateFolderResponseNonNullableFields {
+    folder?: FolderNonNullableFields;
+}
+export interface GetFolderResponseNonNullableFields {
+    folder?: FolderNonNullableFields;
+}
+export interface ListFoldersResponseNonNullableFields {
+    folders: FolderNonNullableFields[];
+}
+export interface SearchFoldersResponseNonNullableFields {
+    folders: FolderNonNullableFields[];
+}
+export interface UpdateFolderResponseNonNullableFields {
+    folder?: FolderNonNullableFields;
+}
+export interface GenerateFolderDownloadUrlResponseNonNullableFields {
+    downloadUrl: string;
+}
+export interface ListDeletedFoldersResponseNonNullableFields {
+    folders: FolderNonNullableFields[];
+}
+export {};

package/build/cjs/src/media-site-media-v1-folder-folders.types.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookIdentityType = exports.RootFolder = exports.SortOrder = exports.Namespace = exports.State = void 0;
+var State;
+(function (State) {
+    State["OK"] = "OK";
+    State["DELETED"] = "DELETED";
+})(State || (exports.State = State = {}));
+var Namespace;
+(function (Namespace) {
+    Namespace["NO_NAMESPACE"] = "NO_NAMESPACE";
+    Namespace["OTHERS"] = "OTHERS";
+    /** ANY = 2; */
+    Namespace["WIX_VIDEO"] = "WIX_VIDEO";
+    /** _nsWixMusic */
+    Namespace["WIX_MUSIC"] = "WIX_MUSIC";
+    /** _nsArtStore */
+    Namespace["ALBUMS_AND_ART_STORE"] = "ALBUMS_AND_ART_STORE";
+    /** _nsDigitalProduct */
+    Namespace["WIX_ECOM"] = "WIX_ECOM";
+    /** _nsPhotoShareApp */
+    Namespace["PHOTO_SHARE_APP"] = "PHOTO_SHARE_APP";
+    /** _nsSharingApp, */
+    Namespace["SHARING_APP"] = "SHARING_APP";
+    /** engage */
+    Namespace["CHAT"] = "CHAT";
+    /** logobuilder */
+    Namespace["LOGO_BUILDER"] = "LOGO_BUILDER";
+    /** WixExposure */
+    Namespace["ALBUMS_OLD"] = "ALBUMS_OLD";
+    /** chat-mobile-uploads */
+    Namespace["CHAT_MOBILE"] = "CHAT_MOBILE";
+    /** _nsWixForms */
+    Namespace["WIX_FORMS"] = "WIX_FORMS";
+    /** _nsWixLegends */
+    Namespace["WIX_LEGENDS"] = "WIX_LEGENDS";
+})(Namespace || (exports.Namespace = Namespace = {}));
+var SortOrder;
+(function (SortOrder) {
+    SortOrder["ASC"] = "ASC";
+    SortOrder["DESC"] = "DESC";
+})(SortOrder || (exports.SortOrder = SortOrder = {}));
+var RootFolder;
+(function (RootFolder) {
+    /** Root of all site media */
+    RootFolder["MEDIA_ROOT"] = "MEDIA_ROOT";
+    /** Root of the trash system folder */
+    RootFolder["TRASH_ROOT"] = "TRASH_ROOT";
+    /** Root of all visitor uploads */
+    RootFolder["VISITOR_UPLOADS_ROOT"] = "VISITOR_UPLOADS_ROOT";
+})(RootFolder || (exports.RootFolder = RootFolder = {}));
+var WebhookIdentityType;
+(function (WebhookIdentityType) {
+    WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
+    WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+    WebhookIdentityType["MEMBER"] = "MEMBER";
+    WebhookIdentityType["WIX_USER"] = "WIX_USER";
+    WebhookIdentityType["APP"] = "APP";
+})(WebhookIdentityType || (exports.WebhookIdentityType = WebhookIdentityType = {}));
+//# sourceMappingURL=media-site-media-v1-folder-folders.types.js.map

package/build/cjs/src/media-site-media-v1-folder-folders.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"media-site-media-v1-folder-folders.types.js","sourceRoot":"","sources":["../../../src/media-site-media-v1-folder-folders.types.ts"],"names":[],"mappings":";;;AAwBA,IAAY,KAGX;AAHD,WAAY,KAAK;IACf,kBAAS,CAAA;IACT,4BAAmB,CAAA;AACrB,CAAC,EAHW,KAAK,qBAAL,KAAK,QAGhB;AAED,IAAY,SA2BX;AA3BD,WAAY,SAAS;IACnB,0CAA6B,CAAA;IAC7B,8BAAiB,CAAA;IACjB,eAAe;IACf,oCAAuB,CAAA;IACvB,kBAAkB;IAClB,oCAAuB,CAAA;IACvB,kBAAkB;IAClB,0DAA6C,CAAA;IAC7C,wBAAwB;IACxB,kCAAqB,CAAA;IACrB,uBAAuB;IACvB,gDAAmC,CAAA;IACnC,qBAAqB;IACrB,wCAA2B,CAAA;IAC3B,aAAa;IACb,0BAAa,CAAA;IACb,kBAAkB;IAClB,0CAA6B,CAAA;IAC7B,kBAAkB;IAClB,sCAAyB,CAAA;IACzB,0BAA0B;IAC1B,wCAA2B,CAAA;IAC3B,kBAAkB;IAClB,oCAAuB,CAAA;IACvB,oBAAoB;IACpB,wCAA2B,CAAA;AAC7B,CAAC,EA3BW,SAAS,yBAAT,SAAS,QA2BpB;AAgDD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAuDD,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,6BAA6B;IAC7B,uCAAyB,CAAA;IACzB,sCAAsC;IACtC,uCAAyB,CAAA;IACzB,kCAAkC;IAClC,2DAA6C,CAAA;AAC/C,CAAC,EAPW,UAAU,0BAAV,UAAU,QAOrB;AA+LD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}