@medusajs/core-flows/dist/file/workflows/upload-files.d.ts

Set of workflow definitions for Medusa

import { FileDTO } from "@medusajs/framework/types";
/**
 * The data to upload files.
 */
export type UploadFilesWorkflowInput = {
    /**
     * The files to upload.
     */
    files: {
        /**
         * The name of the file.
         */
        filename: string;
        /**
         * The MIME type of the file.
         *
         * @example
         * img/jpg
         */
        mimeType: string;
        /**
         * The content of the file. For images, for example,
         * use binary string. For CSV files, use the CSV content.
         */
        content: string;
        /**
         * The access level of the file. Use `public` for the file that
         * can be accessed by anyone. For example, for images that are displayed
         * on the storefront. Use `private` for files that are only accessible
         * by authenticated users. For example, for CSV files used to
         * import data.
         */
        access: "public" | "private";
    }[];
};
export declare const uploadFilesWorkflowId = "upload-files";
/**
 * This workflow uploads one or more files using the installed
 * [File Module Provider](https://docs.medusajs.com/resources/infrastructure-modules/file). The workflow is used by the
 * [Upload Files Admin API Route](https://docs.medusajs.com/api/admin#uploads_postuploads).
 *
 * You can use this workflow within your customizations or your own custom workflows, allowing you to
 * upload files within your custom flows.
 *
 * @example
 * const { result } = await uploadFilesWorkflow(container)
 * .run({
 *   input: {
 *     files: [
 *       {
 *         filename: "test.jpg",
 *         mimeType: "img/jpg",
 *         content: "binary-string",
 *         access: "public"
 *       }
 *     ]
 *   }
 * })
 *
 * @summary
 *
 * Upload files using the installed File Module Provider.
 */
export declare const uploadFilesWorkflow: import("@medusajs/framework/workflows-sdk").ReturnWorkflow<UploadFilesWorkflowInput, FileDTO[], []>;
//# sourceMappingURL=upload-files.d.ts.map