@wix/auto_sdk_media_files 1.0.46 → 1.0.47
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +9 -11
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +35 -37
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +18 -18
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +9 -11
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +35 -37
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +18 -18
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +9 -11
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +35 -37
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +18 -18
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +9 -11
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +35 -37
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +18 -18
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
package/build/cjs/index.d.ts
CHANGED
|
@@ -87,9 +87,9 @@ interface GenerateFileUploadUrlSignature {
|
|
|
87
87
|
/**
|
|
88
88
|
* Generates an upload URL to allow external clients to upload a file to the Media Manager. <br/>
|
|
89
89
|
*
|
|
90
|
-
* To learn how external clients can use the generated upload URL in the response to upload a file to the Media Manager, see Upload API
|
|
90
|
+
* To learn how external clients can use the generated upload URL in the response to upload a file to the Media Manager, see the [Upload API](https://dev.wix.com/docs/rest/assets/media/media-manager/files/upload-api).
|
|
91
91
|
* > **Notes:**
|
|
92
|
-
* > - When you upload a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about knowing when a file is ready
|
|
92
|
+
* > - When you upload a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about [knowing when a file is ready](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready).
|
|
93
93
|
* > - Any interruption in the upload process stops the file upload. For files larger than 10MB, or when network connection is poor, call Generate File Resumable Upload URL instead. With the resumable upload URL, any interruption in the upload process pauses the file upload, and resumes the file upload process after the interruption.
|
|
94
94
|
* @param - File mime type.
|
|
95
95
|
* @param - Options to use when generating a file's upload URL.
|
|
@@ -104,9 +104,9 @@ interface GenerateFileResumableUploadUrlSignature {
|
|
|
104
104
|
* Generates a resumable upload URL to allow external clients to easily upload large files over 10MB to the Media Manager. <br/>
|
|
105
105
|
*
|
|
106
106
|
* With the resumable upload URL, any interruptions in the upload process pauses the file upload, and resumes the file upload process after the interruption. The resumable upload URL is also helpful when network connection is poor.
|
|
107
|
-
* To learn how external clients can use the generated upload URL in the response to upload large files to the Media Manager, see Resumable Upload API
|
|
107
|
+
* To learn how external clients can use the generated upload URL in the response to upload large files to the Media Manager, see [Resumable Upload API](https://dev.wix.com/docs/rest/assets/media/media-manager/files/resumable-upload-api).
|
|
108
108
|
*
|
|
109
|
-
* > **Note:** When you upload a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about knowing when a file is ready
|
|
109
|
+
* > **Note:** When you upload a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about [knowing when a file is ready](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready).
|
|
110
110
|
* @param - File mime type.
|
|
111
111
|
* @param - Options to use when generating a resumable upload URL.
|
|
112
112
|
*/
|
|
@@ -125,7 +125,7 @@ interface ImportFileSignature {
|
|
|
125
125
|
*
|
|
126
126
|
* >**Notes:**
|
|
127
127
|
* > - The `media` property isn't returned in the `files` response object.
|
|
128
|
-
* > - When you import a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about knowing when a file is ready
|
|
128
|
+
* > - When you import a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about [knowing when a file is ready](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready).
|
|
129
129
|
*
|
|
130
130
|
* To import a file, you need to do one of the following:
|
|
131
131
|
* - Specify its [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) in the `mimeType` field of the request. For example, `mimeType: 'image/jpeg'`.
|
|
@@ -151,7 +151,7 @@ interface BulkImportFilesSignature {
|
|
|
151
151
|
*
|
|
152
152
|
* >**Notes:**
|
|
153
153
|
* > - The `media` property isn't returned in the `files` response object.
|
|
154
|
-
* > - When you import a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about knowing when a file is ready
|
|
154
|
+
* > - When you import a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about [knowing when a file is ready](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready).
|
|
155
155
|
*
|
|
156
156
|
* To import files, you need to do one of the following for each file:
|
|
157
157
|
* - Specify its [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) in the `mimeType` field of the request. For example, `mimeType: 'image/jpeg'`.
|
|
@@ -176,7 +176,7 @@ interface BulkImportFileSignature {
|
|
|
176
176
|
*
|
|
177
177
|
* >**Notes:**
|
|
178
178
|
* > - The `media` property isn't returned in the `files` response object.
|
|
179
|
-
* > - When you import a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about knowing when a file is ready
|
|
179
|
+
* > - When you import a file, it's not immediately available, meaning you can't manage or use the file straight away. Learn more about [knowing when a file is ready](https://dev.wix.com/docs/api-reference/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready).
|
|
180
180
|
*
|
|
181
181
|
* To import files, you need to do one of the following for each file:
|
|
182
182
|
* - Specify its [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) in the `mimeType` field of the request. For example, `mimeType: 'image/jpeg'`.
|
|
@@ -220,10 +220,8 @@ interface SearchFilesSignature {
|
|
|
220
220
|
* ## See also
|
|
221
221
|
*
|
|
222
222
|
* To learn about working with *Search* methods, see
|
|
223
|
-
*
|
|
224
|
-
*
|
|
225
|
-
* and *Sorting and Paging*
|
|
226
|
-
* ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language#the-sort-array) | [REST](https://dev.wix.com/docs/rest/articles/get-started/sorting-and-paging)).
|
|
223
|
+
* [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language)
|
|
224
|
+
* and [*Sorting and Paging*](https://dev.wix.com/docs/rest/articles/get-started/sorting-and-paging).
|
|
227
225
|
* @param - Options to specify which folders to search.
|
|
228
226
|
*/
|
|
229
227
|
(options?: SearchFilesOptions): Promise<NonNullablePaths<SearchFilesResponse, `files` | `files.${number}._id` | `files.${number}.displayName` | `files.${number}.url` | `files.${number}.hash` | `files.${number}.private` | `files.${number}.mediaType` | `files.${number}.media.audio._id` | `files.${number}.media.archive._id` | `files.${number}.media.archive.url` | `files.${number}.media.model3d._id` | `files.${number}.media.model3d.url` | `files.${number}.operationStatus` | `files.${number}.siteId` | `files.${number}.state`, 6> & {
|