@wix/auto_sdk_rich-content_ricos-documents 1.0.55 → 1.0.56

package/build/cjs/index.d.ts

@@ -57,13 +57,25 @@ interface GenerateFileDownloadUrlSignature {
 declare function generateFileUploadUrl$1(httpClient: HttpClient): GenerateFileUploadUrlSignature;
 interface GenerateFileUploadUrlSignature {
     /**
-     * Generates a URL for uploading a file to the site's Media Manager, so the file can be added to a Ricos document.
+     * Generates a URL for uploading a file to the site's Media Manager, so you can add the file to a Ricos document.
      *
-     * Upload the file to the returned `uploadUrl` with a `PUT` request. The response of the upload request
-     * contains the uploaded file's descriptor, including its ID. Specify `private` as `true` to upload a file
-     * that can't be accessed from its file URL. Use [Generate File Download URL](https://dev.wix.com/docs/api-reference/assets/rich-content/ricos-documents/generate-file-download-url) to download private files.
+     * To upload the file, send a `PUT` request to `uploadUrl` with the file content as the request body and a
+     * `Content-Type` header that matches `mimeType`. If you didn't specify `fileName`, add the file name as the
+     * `filename` query parameter. For example, `PUT {uploadUrl}?filename=report.pdf`. The URL expires after 24 hours.
+     * Learn more about the [Upload API](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/upload-api).
      *
-     * Site visitors and members can call this method.
+     * The upload response contains the uploaded file's
+     * [file descriptor](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-descriptor-object).
+     * Specify its `file.id` as the file node's `fileData.src.id` in the Ricos document.
+     * A successful upload response doesn't mean the file is ready. To run code when it's ready, listen for the
+     * [File Ready](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-descriptor-file-ready) and
+     * [File Failed](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/file-descriptor-file-failed) events.
+     *
+     * Use this method to let site visitors and members add files to the content they create.
+     * To download a private file, call [Generate File Download URL](https://dev.wix.com/docs/api-reference/assets/rich-content/ricos-documents/generate-file-download-url).
+     *
+     * This method doesn't support resumable uploads. For the supported file types and sizes, see
+     * [Wix Media: Supported Media File Types and File Sizes](https://support.wix.com/en/article/wix-media-supported-media-file-types-and-file-sizes).
      * @param - MIME type of the file to upload. For example, `application/pdf`.
      */
     (mimeType: string, options?: GenerateFileUploadUrlOptions): Promise<GenerateFileUploadUrlResponse>;