@wix/media 1.0.132 → 1.0.134

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.
Files changed (4) hide show
  1. package/package.json +3 -3
  2. package/type-bundles/context.bundle.d.ts +152 -137
  3. package/type-bundles/index.bundle.d.ts +152 -137
  4. package/type-bundles/meta.bundle.d.ts +78 -100
package/type-bundles/meta.bundle.d.ts CHANGED
@@ -1434,7 +1434,7 @@ interface FileDescriptor$1 {
1434
1434
  */
1435
1435
  sizeInBytes?: string | null;
1436
1436
  /**
1437
- * Whether the file is public or private. Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files).
1437
+ * Whether the file is public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)).
1438
1438
  * @readonly
1439
1439
  */
1440
1440
  private?: boolean;
@@ -1466,7 +1466,7 @@ interface FileDescriptor$1 {
1466
1466
  * @readonly
1467
1467
  */
1468
1468
  thumbnailUrl?: string | null;
1469
- /** Labels assigned to media files that describe and categorize them. Provided by the user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
1469
+ /** Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
1470
1470
  labels?: string[];
1471
1471
  /**
1472
1472
  * Date and time the file was created.
@@ -1782,9 +1782,9 @@ declare enum IdentityType$1 {
1782
1782
  APP = "APP"
1783
1783
  }
1784
1784
  interface ExternalInfo$1 {
1785
- /** External information to pass in the [File Ready](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-ready) or [File Failed](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-failed) events. */
1785
+ /** External information to specify in the File Ready or File Failed events. */
1786
1786
  origin?: string;
1787
- /** External IDs to pass in the [File Ready](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-ready) or [File Failed](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-failed) events. */
1787
+ /** External IDs to specify in the File Ready or File Failed events. */
1788
1788
  externalIds?: string[];
1789
1789
  }
1790
1790
  interface ApplicationError$1 {
@@ -1799,8 +1799,8 @@ interface GenerateFilesDownloadUrlRequest$1 {
1799
1799
  /**
1800
1800
  * IDs of the files to download.
1801
1801
  *
1802
- * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
1803
- * Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter).
1802
+ * You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
1803
+ * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
1804
1804
  */
1805
1805
  fileIds: string[];
1806
1806
  }
@@ -1812,14 +1812,14 @@ interface GenerateFileDownloadUrlRequest$1 {
1812
1812
  /**
1813
1813
  * File ID.
1814
1814
  *
1815
- * You can also pass the file's Wix media URL. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032`.
1816
- * Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter).
1815
+ * You can also specify the file's Wix media URL. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032`.
1816
+ * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
1817
1817
  */
1818
1818
  fileId: string;
1819
1819
  /**
1820
1820
  * Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type. <br />
1821
1821
  *
1822
- * **Note:** The name that appears in the Media Manager is taken from the `filename` query parameter in the upload request.
1822
+ * **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
1823
1823
  */
1824
1824
  downloadFileName?: string | null;
1825
1825
  /**
@@ -1871,10 +1871,10 @@ interface GetFileDescriptorRequest$1 {
1871
1871
  /**
1872
1872
  * File ID.
1873
1873
  *
1874
- * You can also pass the file's Wix media URL. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032`.
1875
- * Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter).
1874
+ * You can also specify the file's Wix media URL. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032`.
1875
+ * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
1876
1876
  *
1877
- * Note that you must encode the Wix media URL to pass it as a query param because it contains special characters. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032` becomes `wix%3Aimage%3A%2F%2Fv1%2F0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg%2Fleon.jpg%23originWidth%3D3024%26originHeight%3D4032`.
1877
+ * If you are working in REST, note that you must encode the Wix media URL to specify it as a query param because it contains special characters. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032` becomes `wix%3Aimage%3A%2F%2Fv1%2F0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg%2Fleon.jpg%23originWidth%3D3024%26originHeight%3D4032`.
1878
1878
  */
1879
1879
  fileId: string;
1880
1880
  }
@@ -1886,8 +1886,8 @@ interface GetFileDescriptorsRequest$1 {
1886
1886
  /**
1887
1887
  * File IDs.
1888
1888
  *
1889
- * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
1890
- * Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter).
1889
+ * You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
1890
+ * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
1891
1891
  */
1892
1892
  fileIds: string[];
1893
1893
  }
@@ -1908,7 +1908,7 @@ interface GenerateFileUploadUrlRequest$1 {
1908
1908
  mimeType: string | null;
1909
1909
  /**
1910
1910
  * Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
1911
- * <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` query parameter in the upload request.
1911
+ * <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
1912
1912
  */
1913
1913
  fileName?: string | null;
1914
1914
  /**
@@ -1922,9 +1922,9 @@ interface GenerateFileUploadUrlRequest$1 {
1922
1922
  * Default: `media-root`.
1923
1923
  */
1924
1924
  parentFolderId?: string | null;
1925
- /** Whether the file will be public or private. Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files). */
1925
+ /** Whether the file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
1926
1926
  private?: boolean | null;
1927
- /** Labels assigned to media files that describe and categorize them. Provided by the user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
1927
+ /** Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
1928
1928
  labels?: string[] | null;
1929
1929
  /** A place to map an external entity to an uploaded file in the Wix Media Manager. */
1930
1930
  externalInfo?: ExternalInfo$1;
@@ -1945,7 +1945,7 @@ interface GenerateFileResumableUploadUrlRequest$1 {
1945
1945
  mimeType: string | null;
1946
1946
  /**
1947
1947
  * Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
1948
- * <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` query parameter in the upload request.
1948
+ * <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
1949
1949
  */
1950
1950
  fileName?: string | null;
1951
1951
  /**
@@ -1959,9 +1959,9 @@ interface GenerateFileResumableUploadUrlRequest$1 {
1959
1959
  * Default: `media-root`.
1960
1960
  */
1961
1961
  parentFolderId?: string | null;
1962
- /** Whether the file will be public or private. Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files). */
1962
+ /** Whether the file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
1963
1963
  private?: boolean | null;
1964
- /** Labels assigned to media files that describe and categorize them. Provided by the user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
1964
+ /** Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
1965
1965
  labels?: string[] | null;
1966
1966
  /** The upload protocol to use for implementing the resumable upload. */
1967
1967
  uploadProtocol?: UploadProtocol$1;
@@ -2001,13 +2001,13 @@ interface ImportFileRequest$1 {
2001
2001
  * Default: `media-root`.
2002
2002
  */
2003
2003
  parentFolderId?: string | null;
2004
- /** Whether the file will be public or private. Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files). */
2004
+ /** Whether the file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
2005
2005
  private?: boolean | null;
2006
- /** Labels assigned to media files that describe and categorize them. Provided by the user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
2006
+ /** Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
2007
2007
  labels?: string[] | null;
2008
2008
  /** File mime type. */
2009
2009
  mimeType?: string;
2010
- /** Information sent to the [File Ready](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-ready) and [File Failed](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-failed) webhooks. See [Importing Files](/files/importing-files#using-externalinfo) to learn more. */
2010
+ /** Information sent to the File Ready and File Failed events. See Importing Files ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_using-externalinfo) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#using-externalinfo)) to learn more. */
2011
2011
  externalInfo?: ExternalInfo$1;
2012
2012
  /** Optional parameters that should be sent with the external URL. */
2013
2013
  urlParams?: Record<string, any> | null;
@@ -2036,11 +2036,7 @@ interface BulkImportFilesResponse$1 {
2036
2036
  interface BulkImportFileRequest$1 {
2037
2037
  /** Information about the files to import. */
2038
2038
  importFileRequests: ImportFileRequest$1[];
2039
- /**
2040
- * Whether to include the imported File Descriptor in the response. Set to `false` to exclude the File Descriptor from the returned object.
2041
- *
2042
- * Default: `true`
2043
- */
2039
+ /** Default: `true` */
2044
2040
  returnEntity?: boolean | null;
2045
2041
  }
2046
2042
  interface BulkImportFileResponse$1 {
@@ -2052,7 +2048,7 @@ interface BulkImportFileResponse$1 {
2052
2048
  interface BulkImportFileResult$1 {
2053
2049
  /** Item metadata. */
2054
2050
  itemMetadata?: ItemMetadata$1;
2055
- /** Imported file. This field is returned if the operation was successful and `returnEntity` is not set to `false`. */
2051
+ /** Imported file. This field is included in the response if the operation was successful and `returnEntity` is not set to `false`. */
2056
2052
  item?: FileDescriptor$1;
2057
2053
  }
2058
2054
  interface ItemMetadata$1 {
@@ -2079,12 +2075,9 @@ interface ListFilesRequest$1 {
2079
2075
  * Default:`media-root`.
2080
2076
  */
2081
2077
  parentFolderId?: string | null;
2082
- /**
2083
- * File media type.
2084
- * excluding: OTHER media type
2085
- */
2078
+ /** File media type. */
2086
2079
  mediaTypes?: MediaType$1[];
2087
- /** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files). */
2080
+ /** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
2088
2081
  private?: boolean | null;
2089
2082
  /**
2090
2083
  * Field name and order to sort by. One of: <br />
@@ -2146,12 +2139,9 @@ interface SearchFilesRequest$1 {
2146
2139
  * Default: `MEDIA_ROOT`.
2147
2140
  */
2148
2141
  rootFolder?: RootFolder$3;
2149
- /**
2150
- * File media type.
2151
- * excluding: OTHER media type
2152
- */
2142
+ /** File media type. */
2153
2143
  mediaTypes?: MediaType$1[];
2154
- /** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files). */
2144
+ /** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
2155
2145
  private?: boolean | null;
2156
2146
  /**
2157
2147
  * Field name and order to sort by. One of: <br />
@@ -2182,8 +2172,8 @@ interface GenerateVideoStreamingUrlRequest$1 {
2182
2172
  /**
2183
2173
  * File ID.
2184
2174
  *
2185
- * You can also pass the file's Wix media URL. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032`.
2186
- * Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter).
2175
+ * You can also specify the file's Wix media URL. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032`.
2176
+ * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
2187
2177
  */
2188
2178
  fileId: string;
2189
2179
  /** Video stream format. */
@@ -2202,8 +2192,8 @@ interface BulkDeleteFilesRequest$1 {
2202
2192
  /**
2203
2193
  * IDs of the files to move to the Media Manager's trash bin.
2204
2194
  *
2205
- * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
2206
- * Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter).
2195
+ * You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
2196
+ * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
2207
2197
  */
2208
2198
  fileIds: string[];
2209
2199
  /**
@@ -2218,8 +2208,8 @@ interface BulkRestoreFilesFromTrashBinRequest$1 {
2218
2208
  /**
2219
2209
  * IDs of the files to restore from the Media Manager's trash bin.
2220
2210
  *
2221
- * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
2222
- * Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter).
2211
+ * You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
2212
+ * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
2223
2213
  */
2224
2214
  fileIds: string[];
2225
2215
  }
@@ -2231,12 +2221,9 @@ interface ListDeletedFilesRequest$1 {
2231
2221
  * Default: `media-root`.
2232
2222
  */
2233
2223
  parentFolderId?: string | null;
2234
- /**
2235
- * File media type.
2236
- * excluding: OTHER media type
2237
- */
2224
+ /** File media type. */
2238
2225
  mediaTypes?: MediaType$1[];
2239
- /** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files). */
2226
+ /** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
2240
2227
  private?: boolean | null;
2241
2228
  /**
2242
2229
  * Field name and order to sort by. One of: <br />
@@ -2330,6 +2317,8 @@ interface FileMediaNonNullableFields$1 {
2330
2317
  archive?: ArchiveNonNullableFields$1;
2331
2318
  model3d?: Model3DNonNullableFields$1;
2332
2319
  other?: OtherMediaNonNullableFields$1;
2320
+ icon?: ImageMediaNonNullableFields$1;
2321
+ flash?: OtherMediaNonNullableFields$1;
2333
2322
  }
2334
2323
  interface IdentityInfoNonNullableFields$1 {
2335
2324
  identityType: IdentityType$1;
@@ -2434,7 +2423,7 @@ interface FileDescriptor {
2434
2423
  */
2435
2424
  sizeInBytes?: string | null;
2436
2425
  /**
2437
- * Whether the file is public or private. Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files).
2426
+ * Whether the file is public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)).
2438
2427
  * @readonly
2439
2428
  */
2440
2429
  private?: boolean;
@@ -2466,7 +2455,7 @@ interface FileDescriptor {
2466
2455
  * @readonly
2467
2456
  */
2468
2457
  thumbnailUrl?: string | null;
2469
- /** Labels assigned to media files that describe and categorize them. Provided by the user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
2458
+ /** Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
2470
2459
  labels?: string[];
2471
2460
  /**
2472
2461
  * Date and time the file was created.
@@ -2712,9 +2701,9 @@ declare enum IdentityType {
2712
2701
  APP = "APP"
2713
2702
  }
2714
2703
  interface ExternalInfo {
2715
- /** External information to pass in the [File Ready](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-ready) or [File Failed](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-failed) events. */
2704
+ /** External information to specify in the File Ready or File Failed events. */
2716
2705
  origin?: string;
2717
- /** External IDs to pass in the [File Ready](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-ready) or [File Failed](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-failed) events. */
2706
+ /** External IDs to specify in the File Ready or File Failed events. */
2718
2707
  externalIds?: string[];
2719
2708
  }
2720
2709
  interface ApplicationError {
@@ -2729,8 +2718,8 @@ interface GenerateFilesDownloadUrlRequest {
2729
2718
  /**
2730
2719
  * IDs of the files to download.
2731
2720
  *
2732
- * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
2733
- * Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter).
2721
+ * You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
2722
+ * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
2734
2723
  */
2735
2724
  fileIds: string[];
2736
2725
  }
@@ -2742,14 +2731,14 @@ interface GenerateFileDownloadUrlRequest {
2742
2731
  /**
2743
2732
  * File ID.
2744
2733
  *
2745
- * You can also pass the file's Wix media URL. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032`.
2746
- * Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter).
2734
+ * You can also specify the file's Wix media URL. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032`.
2735
+ * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
2747
2736
  */
2748
2737
  fileId: string;
2749
2738
  /**
2750
2739
  * Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type. <br />
2751
2740
  *
2752
- * **Note:** The name that appears in the Media Manager is taken from the `filename` query parameter in the upload request.
2741
+ * **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
2753
2742
  */
2754
2743
  downloadFileName?: string | null;
2755
2744
  /**
@@ -2801,10 +2790,10 @@ interface GetFileDescriptorRequest {
2801
2790
  /**
2802
2791
  * File ID.
2803
2792
  *
2804
- * You can also pass the file's Wix media URL. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032`.
2805
- * Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter).
2793
+ * You can also specify the file's Wix media URL. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032`.
2794
+ * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
2806
2795
  *
2807
- * Note that you must encode the Wix media URL to pass it as a query param because it contains special characters. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032` becomes `wix%3Aimage%3A%2F%2Fv1%2F0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg%2Fleon.jpg%23originWidth%3D3024%26originHeight%3D4032`.
2796
+ * If you are working in REST, note that you must encode the Wix media URL to specify it as a query param because it contains special characters. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032` becomes `wix%3Aimage%3A%2F%2Fv1%2F0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg%2Fleon.jpg%23originWidth%3D3024%26originHeight%3D4032`.
2808
2797
  */
2809
2798
  fileId: string;
2810
2799
  }
@@ -2816,8 +2805,8 @@ interface GetFileDescriptorsRequest {
2816
2805
  /**
2817
2806
  * File IDs.
2818
2807
  *
2819
- * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
2820
- * Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter).
2808
+ * You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
2809
+ * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
2821
2810
  */
2822
2811
  fileIds: string[];
2823
2812
  }
@@ -2838,7 +2827,7 @@ interface GenerateFileUploadUrlRequest {
2838
2827
  mimeType: string | null;
2839
2828
  /**
2840
2829
  * Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
2841
- * <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` query parameter in the upload request.
2830
+ * <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
2842
2831
  */
2843
2832
  fileName?: string | null;
2844
2833
  /**
@@ -2852,9 +2841,9 @@ interface GenerateFileUploadUrlRequest {
2852
2841
  * Default: `media-root`.
2853
2842
  */
2854
2843
  parentFolderId?: string | null;
2855
- /** Whether the file will be public or private. Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files). */
2844
+ /** Whether the file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
2856
2845
  private?: boolean | null;
2857
- /** Labels assigned to media files that describe and categorize them. Provided by the user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
2846
+ /** Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
2858
2847
  labels?: string[] | null;
2859
2848
  /** A place to map an external entity to an uploaded file in the Wix Media Manager. */
2860
2849
  externalInfo?: ExternalInfo;
@@ -2875,7 +2864,7 @@ interface GenerateFileResumableUploadUrlRequest {
2875
2864
  mimeType: string | null;
2876
2865
  /**
2877
2866
  * Temporary file name used to identify the file type. For example, a file named "myFile.jpeg" identifies as an "image/jpeg" file type.
2878
- * <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` query parameter in the upload request.
2867
+ * <br /> **Note:** The name that appears in the Media Manager is taken from the `filename` parameter in the Generate File Upload Url call.
2879
2868
  */
2880
2869
  fileName?: string | null;
2881
2870
  /**
@@ -2889,9 +2878,9 @@ interface GenerateFileResumableUploadUrlRequest {
2889
2878
  * Default: `media-root`.
2890
2879
  */
2891
2880
  parentFolderId?: string | null;
2892
- /** Whether the file will be public or private. Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files). */
2881
+ /** Whether the file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
2893
2882
  private?: boolean | null;
2894
- /** Labels assigned to media files that describe and categorize them. Provided by the user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
2883
+ /** Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
2895
2884
  labels?: string[] | null;
2896
2885
  /** The upload protocol to use for implementing the resumable upload. */
2897
2886
  uploadProtocol?: UploadProtocol;
@@ -2931,13 +2920,13 @@ interface ImportFileRequest {
2931
2920
  * Default: `media-root`.
2932
2921
  */
2933
2922
  parentFolderId?: string | null;
2934
- /** Whether the file will be public or private. Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files). */
2923
+ /** Whether the file will be public or private. Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
2935
2924
  private?: boolean | null;
2936
- /** Labels assigned to media files that describe and categorize them. Provided by the user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
2925
+ /** Labels assigned to media files that describe and categorize them. Provided by the Wix user, or generated by [Google Vision API](https://cloud.google.com/vision/docs/drag-and-drop) for images. */
2937
2926
  labels?: string[] | null;
2938
2927
  /** File mime type. */
2939
2928
  mimeType?: string;
2940
- /** Information sent to the [File Ready](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-ready) and [File Failed](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-failed) webhooks. See [Importing Files](/files/importing-files#using-externalinfo) to learn more. */
2929
+ /** Information sent to the File Ready and File Failed events. See Importing Files ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_using-externalinfo) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#using-externalinfo)) to learn more. */
2941
2930
  externalInfo?: ExternalInfo;
2942
2931
  /** Optional parameters that should be sent with the external URL. */
2943
2932
  urlParams?: Record<string, any> | null;
@@ -2966,11 +2955,7 @@ interface BulkImportFilesResponse {
2966
2955
  interface BulkImportFileRequest {
2967
2956
  /** Information about the files to import. */
2968
2957
  importFileRequests: ImportFileRequest[];
2969
- /**
2970
- * Whether to include the imported File Descriptor in the response. Set to `false` to exclude the File Descriptor from the returned object.
2971
- *
2972
- * Default: `true`
2973
- */
2958
+ /** Default: `true` */
2974
2959
  returnEntity?: boolean | null;
2975
2960
  }
2976
2961
  interface BulkImportFileResponse {
@@ -2982,7 +2967,7 @@ interface BulkImportFileResponse {
2982
2967
  interface BulkImportFileResult {
2983
2968
  /** Item metadata. */
2984
2969
  itemMetadata?: ItemMetadata;
2985
- /** Imported file. This field is returned if the operation was successful and `returnEntity` is not set to `false`. */
2970
+ /** Imported file. This field is included in the response if the operation was successful and `returnEntity` is not set to `false`. */
2986
2971
  item?: FileDescriptor;
2987
2972
  }
2988
2973
  interface ItemMetadata {
@@ -3009,12 +2994,9 @@ interface ListFilesRequest {
3009
2994
  * Default:`media-root`.
3010
2995
  */
3011
2996
  parentFolderId?: string | null;
3012
- /**
3013
- * File media type.
3014
- * excluding: OTHER media type
3015
- */
2997
+ /** File media type. */
3016
2998
  mediaTypes?: MediaType[];
3017
- /** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files). */
2999
+ /** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
3018
3000
  private?: boolean | null;
3019
3001
  /**
3020
3002
  * Field name and order to sort by. One of: <br />
@@ -3076,12 +3058,9 @@ interface SearchFilesRequest {
3076
3058
  * Default: `MEDIA_ROOT`.
3077
3059
  */
3078
3060
  rootFolder?: RootFolder$2;
3079
- /**
3080
- * File media type.
3081
- * excluding: OTHER media type
3082
- */
3061
+ /** File media type. */
3083
3062
  mediaTypes?: MediaType[];
3084
- /** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files). */
3063
+ /** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
3085
3064
  private?: boolean | null;
3086
3065
  /**
3087
3066
  * Field name and order to sort by. One of: <br />
@@ -3112,8 +3091,8 @@ interface GenerateVideoStreamingUrlRequest {
3112
3091
  /**
3113
3092
  * File ID.
3114
3093
  *
3115
- * You can also pass the file's Wix media URL. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032`.
3116
- * Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter).
3094
+ * You can also specify the file's Wix media URL. For example, `wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032`.
3095
+ * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
3117
3096
  */
3118
3097
  fileId: string;
3119
3098
  /** Video stream format. */
@@ -3132,8 +3111,8 @@ interface BulkDeleteFilesRequest {
3132
3111
  /**
3133
3112
  * IDs of the files to move to the Media Manager's trash bin.
3134
3113
  *
3135
- * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
3136
- * Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter).
3114
+ * You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
3115
+ * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
3137
3116
  */
3138
3117
  fileIds: string[];
3139
3118
  /**
@@ -3148,8 +3127,8 @@ interface BulkRestoreFilesFromTrashBinRequest {
3148
3127
  /**
3149
3128
  * IDs of the files to restore from the Media Manager's trash bin.
3150
3129
  *
3151
- * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
3152
- * Learn more about the [file ID parameter](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter).
3130
+ * You can also specify the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
3131
+ * Learn more about the file ID parameter ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/file-and-folder-ids#file-id-as-a-parameter) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/file-id#file-id-as-a-parameter)).
3153
3132
  */
3154
3133
  fileIds: string[];
3155
3134
  }
@@ -3161,12 +3140,9 @@ interface ListDeletedFilesRequest {
3161
3140
  * Default: `media-root`.
3162
3141
  */
3163
3142
  parentFolderId?: string | null;
3164
- /**
3165
- * File media type.
3166
- * excluding: OTHER media type
3167
- */
3143
+ /** File media type. */
3168
3144
  mediaTypes?: MediaType[];
3169
- /** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about [private files](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files). */
3145
+ /** \n`true`: Returns only private files. \n`false`: Returns only public files. \n`undefined`: Returns public and private files. \n Learn more about private files ([SDK](https://dev.wix.com/docs/rest/assets/media/media-manager/files/private-files) | [REST](https://dev.wix.com/docs/sdk/backend-modules/media/files/private-files)). */
3170
3146
  private?: boolean | null;
3171
3147
  /**
3172
3148
  * Field name and order to sort by. One of: <br />
@@ -3233,6 +3209,8 @@ interface FileMediaNonNullableFields {
3233
3209
  archive?: ArchiveNonNullableFields;
3234
3210
  model3d?: Model3DNonNullableFields;
3235
3211
  other?: OtherMediaNonNullableFields;
3212
+ icon?: ImageMediaNonNullableFields;
3213
+ flash?: OtherMediaNonNullableFields;
3236
3214
  }
3237
3215
  interface IdentityInfoNonNullableFields {
3238
3216
  identityType: IdentityType;