@wix/auto_sdk_media_files 1.0.21 → 1.0.23
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 +36 -33
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +136 -67
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +45 -20
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +36 -33
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +136 -67
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +45 -20
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +36 -33
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +136 -67
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +45 -20
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +36 -33
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +136 -67
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +45 -20
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +3 -3
|
@@ -1013,8 +1013,9 @@ interface BulkImportFileResult {
|
|
|
1013
1013
|
}
|
|
1014
1014
|
interface ListFilesRequest {
|
|
1015
1015
|
/**
|
|
1016
|
-
* ID of the file's parent folder.
|
|
1017
|
-
*
|
|
1016
|
+
* ID of the file's parent folder.
|
|
1017
|
+
*
|
|
1018
|
+
* Default: `media-root`.
|
|
1018
1019
|
* @maxLength 100
|
|
1019
1020
|
*/
|
|
1020
1021
|
parentFolderId?: string | null;
|
|
@@ -1023,13 +1024,22 @@ interface ListFilesRequest {
|
|
|
1023
1024
|
* @maxSize 30
|
|
1024
1025
|
*/
|
|
1025
1026
|
mediaTypes?: MediaTypeWithLiterals[];
|
|
1026
|
-
/**
|
|
1027
|
+
/**
|
|
1028
|
+
* Whether to return only private or only public files.
|
|
1029
|
+
* + `true`: Returns only private files.
|
|
1030
|
+
* + `false`: Returns only public files.
|
|
1031
|
+
* + `undefined`: Returns public and private files.
|
|
1032
|
+
*
|
|
1033
|
+
* 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)).
|
|
1034
|
+
*/
|
|
1027
1035
|
private?: boolean | null;
|
|
1028
1036
|
/**
|
|
1029
|
-
* Field name and order to sort by. One of:
|
|
1030
|
-
*
|
|
1031
|
-
*
|
|
1032
|
-
*
|
|
1037
|
+
* Field name and order to sort by. One of:
|
|
1038
|
+
*
|
|
1039
|
+
* `displayName`
|
|
1040
|
+
* `updatedDate`
|
|
1041
|
+
* `sizeInBytes`
|
|
1042
|
+
*
|
|
1033
1043
|
* Default: `updatedDate` in `desc` order.
|
|
1034
1044
|
*/
|
|
1035
1045
|
sort?: Sorting;
|
|
@@ -1090,14 +1100,17 @@ interface Cursors {
|
|
|
1090
1100
|
}
|
|
1091
1101
|
interface SearchFilesRequest {
|
|
1092
1102
|
/**
|
|
1093
|
-
*
|
|
1094
|
-
*
|
|
1095
|
-
* For example,
|
|
1103
|
+
* Free text to match in searchable fields.
|
|
1104
|
+
*
|
|
1105
|
+
* For example, search for specific values in a file's
|
|
1106
|
+
* `displayName`, `mimeType`, or `label`.
|
|
1096
1107
|
* @maxLength 200
|
|
1097
1108
|
*/
|
|
1098
1109
|
search?: string | null;
|
|
1099
1110
|
/**
|
|
1100
|
-
*
|
|
1111
|
+
* The root folder in the media manager to search in.
|
|
1112
|
+
* For more information, see Root Folders in Terminology ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/introduction#terminology) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/introduction#terminology)).
|
|
1113
|
+
*
|
|
1101
1114
|
* Default: `MEDIA_ROOT`.
|
|
1102
1115
|
*/
|
|
1103
1116
|
rootFolder?: RootFolderWithLiterals;
|
|
@@ -1106,13 +1119,23 @@ interface SearchFilesRequest {
|
|
|
1106
1119
|
* @maxSize 30
|
|
1107
1120
|
*/
|
|
1108
1121
|
mediaTypes?: MediaTypeWithLiterals[];
|
|
1109
|
-
/**
|
|
1122
|
+
/**
|
|
1123
|
+
* Whether to return only private or only public files.
|
|
1124
|
+
* + `true`: Returns only private files.
|
|
1125
|
+
* + `false`: Returns only public files.
|
|
1126
|
+
* + `undefined`: Returns public and private files.
|
|
1127
|
+
*
|
|
1128
|
+
* 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)).
|
|
1129
|
+
*/
|
|
1110
1130
|
private?: boolean | null;
|
|
1111
1131
|
/**
|
|
1112
|
-
* Field name and order to sort by.
|
|
1113
|
-
*
|
|
1114
|
-
*
|
|
1115
|
-
*
|
|
1132
|
+
* Field name and order to sort by.
|
|
1133
|
+
*
|
|
1134
|
+
* One of:
|
|
1135
|
+
* `displayName`
|
|
1136
|
+
* `updatedDate`
|
|
1137
|
+
* `sizeInBytes`
|
|
1138
|
+
*
|
|
1116
1139
|
* Default: `updatedDate` in `desc` order.
|
|
1117
1140
|
*/
|
|
1118
1141
|
sort?: Sorting;
|
|
@@ -1120,18 +1143,20 @@ interface SearchFilesRequest {
|
|
|
1120
1143
|
paging?: CursorPaging;
|
|
1121
1144
|
}
|
|
1122
1145
|
declare enum RootFolder {
|
|
1123
|
-
/**
|
|
1146
|
+
/** Contains all files and folders in the Media Manager's **Site Files** tab in the UI. */
|
|
1124
1147
|
MEDIA_ROOT = "MEDIA_ROOT",
|
|
1125
|
-
/**
|
|
1148
|
+
/** Contains all files and folders in the Media Manager's **Trash** tab in the UI. */
|
|
1126
1149
|
TRASH_ROOT = "TRASH_ROOT",
|
|
1127
|
-
/**
|
|
1150
|
+
/** Contains all files and folders created by site visitors or members. */
|
|
1128
1151
|
VISITOR_UPLOADS_ROOT = "VISITOR_UPLOADS_ROOT"
|
|
1129
1152
|
}
|
|
1130
1153
|
/** @enumType */
|
|
1131
1154
|
type RootFolderWithLiterals = RootFolder | 'MEDIA_ROOT' | 'TRASH_ROOT' | 'VISITOR_UPLOADS_ROOT';
|
|
1132
1155
|
interface SearchFilesResponse {
|
|
1133
1156
|
/**
|
|
1134
|
-
*
|
|
1157
|
+
* Retrieved files that match the search criteria specified in the request.
|
|
1158
|
+
*
|
|
1159
|
+
* Each file includes all standard file information.
|
|
1135
1160
|
* @maxSize 200
|
|
1136
1161
|
*/
|
|
1137
1162
|
files?: FileDescriptor[];
|
|
@@ -1448,18 +1473,23 @@ declare enum WebhookIdentityType {
|
|
|
1448
1473
|
}
|
|
1449
1474
|
/** @enumType */
|
|
1450
1475
|
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1476
|
+
/** @docsIgnore */
|
|
1451
1477
|
type GenerateFileDownloadUrlValidationErrors = {
|
|
1452
1478
|
ruleName?: 'INVALID_ASSET_KEY';
|
|
1453
1479
|
};
|
|
1480
|
+
/** @docsIgnore */
|
|
1454
1481
|
type GetFileDescriptorValidationErrors = {
|
|
1455
1482
|
ruleName?: 'RESOURCE_NOT_FOUND';
|
|
1456
1483
|
};
|
|
1484
|
+
/** @docsIgnore */
|
|
1457
1485
|
type GetFileDescriptorsValidationErrors = {
|
|
1458
1486
|
ruleName?: 'RESOURCE_NOT_FOUND';
|
|
1459
1487
|
};
|
|
1488
|
+
/** @docsIgnore */
|
|
1460
1489
|
type UpdateFileDescriptorValidationErrors = {
|
|
1461
1490
|
ruleName?: 'FIELD_MASK_IS_EMPTY_OR_MISSING';
|
|
1462
1491
|
};
|
|
1492
|
+
/** @docsIgnore */
|
|
1463
1493
|
type GenerateFileUploadUrlValidationErrors = {
|
|
1464
1494
|
ruleName?: 'MISMATCH_MIME_TYPE';
|
|
1465
1495
|
} | {
|
|
@@ -1471,6 +1501,7 @@ type GenerateFileUploadUrlValidationErrors = {
|
|
|
1471
1501
|
} | {
|
|
1472
1502
|
ruleName?: 'SITE_QUOTA_EXCEEDED';
|
|
1473
1503
|
};
|
|
1504
|
+
/** @docsIgnore */
|
|
1474
1505
|
type GenerateFileResumableUploadUrlValidationErrors = {
|
|
1475
1506
|
ruleName?: 'MISMATCH_MIME_TYPE';
|
|
1476
1507
|
} | {
|
|
@@ -1480,19 +1511,23 @@ type GenerateFileResumableUploadUrlValidationErrors = {
|
|
|
1480
1511
|
} | {
|
|
1481
1512
|
ruleName?: 'FILE_SIZE_OVER_LIMIT';
|
|
1482
1513
|
};
|
|
1514
|
+
/** @docsIgnore */
|
|
1483
1515
|
type ImportFileValidationErrors = {
|
|
1484
1516
|
ruleName?: 'SITE_QUOTA_EXCEEDED';
|
|
1485
1517
|
};
|
|
1518
|
+
/** @docsIgnore */
|
|
1486
1519
|
type ListFilesValidationErrors = {
|
|
1487
1520
|
ruleName?: 'UNSUPPORTED_MEDIA_TYPE';
|
|
1488
1521
|
} | {
|
|
1489
1522
|
ruleName?: 'UNSUPPORTED_SORT_VALUE';
|
|
1490
1523
|
};
|
|
1524
|
+
/** @docsIgnore */
|
|
1491
1525
|
type SearchFilesValidationErrors = {
|
|
1492
1526
|
ruleName?: 'UNSUPPORTED_MEDIA_TYPE';
|
|
1493
1527
|
} | {
|
|
1494
1528
|
ruleName?: 'UNSUPPORTED_SORT_VALUE';
|
|
1495
1529
|
};
|
|
1530
|
+
/** @docsIgnore */
|
|
1496
1531
|
type ListDeletedFilesValidationErrors = {
|
|
1497
1532
|
ruleName?: 'UNSUPPORTED_MEDIA_TYPE';
|
|
1498
1533
|
} | {
|
|
@@ -1563,6 +1598,8 @@ interface FileDescriptorDeletedEnvelope {
|
|
|
1563
1598
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
1564
1599
|
* @permissionScope Manage Portfolio
|
|
1565
1600
|
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
1601
|
+
* @permissionScope View SEO Settings
|
|
1602
|
+
* @permissionScopeId SCOPE.PROMOTE.VIEW-SEO
|
|
1566
1603
|
* @permissionScope Manage Blog
|
|
1567
1604
|
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
1568
1605
|
* @permissionScope Access Verticals by Automations
|
|
@@ -1598,6 +1635,8 @@ interface FileDescriptorFileFailedEnvelope {
|
|
|
1598
1635
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
1599
1636
|
* @permissionScope Manage Portfolio
|
|
1600
1637
|
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
1638
|
+
* @permissionScope View SEO Settings
|
|
1639
|
+
* @permissionScopeId SCOPE.PROMOTE.VIEW-SEO
|
|
1601
1640
|
* @permissionScope Manage Blog
|
|
1602
1641
|
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
1603
1642
|
* @permissionScope Access Verticals by Automations
|
|
@@ -1635,6 +1674,8 @@ interface FileDescriptorFileReadyEnvelope {
|
|
|
1635
1674
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
1636
1675
|
* @permissionScope Manage Portfolio
|
|
1637
1676
|
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
1677
|
+
* @permissionScope View SEO Settings
|
|
1678
|
+
* @permissionScopeId SCOPE.PROMOTE.VIEW-SEO
|
|
1638
1679
|
* @permissionScope Manage Blog
|
|
1639
1680
|
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
1640
1681
|
* @permissionScope Access Verticals by Automations
|
|
@@ -1670,6 +1711,8 @@ interface FileDescriptorUpdatedEnvelope {
|
|
|
1670
1711
|
* @permissionScopeId SCOPE.DC-MEDIA.MANAGE-MEDIAMANAGER
|
|
1671
1712
|
* @permissionScope Manage Portfolio
|
|
1672
1713
|
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
1714
|
+
* @permissionScope View SEO Settings
|
|
1715
|
+
* @permissionScopeId SCOPE.PROMOTE.VIEW-SEO
|
|
1673
1716
|
* @permissionScope Manage Blog
|
|
1674
1717
|
* @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
|
|
1675
1718
|
* @permissionScope Access Verticals by Automations
|
|
@@ -1685,7 +1728,6 @@ interface FileDescriptorUpdatedEnvelope {
|
|
|
1685
1728
|
* @slug updated
|
|
1686
1729
|
*/
|
|
1687
1730
|
declare function onFileDescriptorUpdated(handler: (event: FileDescriptorUpdatedEnvelope) => void | Promise<void>): void;
|
|
1688
|
-
type FileDescriptorNonNullablePaths = `_id` | `displayName` | `url` | `hash` | `private` | `mediaType` | `media.image.colors.palette` | `media.image.faces` | `media.image.faces.${number}.confidence` | `media.image.faces.${number}.x` | `media.image.faces.${number}.y` | `media.image.faces.${number}.height` | `media.image.faces.${number}.width` | `media.audio._id` | `media.audio.assets` | `media.archive._id` | `media.archive.url` | `media.model3d._id` | `media.model3d.url` | `operationStatus` | `labels` | `siteId` | `state`;
|
|
1689
1731
|
/**
|
|
1690
1732
|
* Generates a URL for downloading a compressed file containing specific files in the Media Manager.
|
|
1691
1733
|
*
|
|
@@ -1704,7 +1746,7 @@ type FileDescriptorNonNullablePaths = `_id` | `displayName` | `url` | `hash` | `
|
|
|
1704
1746
|
* @applicableIdentity APP
|
|
1705
1747
|
* @fqn com.wix.media.site_media.v1.FilesService.GenerateFilesDownloadUrl
|
|
1706
1748
|
*/
|
|
1707
|
-
declare function generateFilesDownloadUrl(fileIds: string[]): Promise<NonNullablePaths<GenerateFilesDownloadUrlResponse, `downloadUrl
|
|
1749
|
+
declare function generateFilesDownloadUrl(fileIds: string[]): Promise<NonNullablePaths<GenerateFilesDownloadUrlResponse, `downloadUrl`, 2>>;
|
|
1708
1750
|
/**
|
|
1709
1751
|
* Generates one or more temporary URLs for downloading a specific file in the Media Manager.
|
|
1710
1752
|
*
|
|
@@ -1727,7 +1769,7 @@ declare function generateFilesDownloadUrl(fileIds: string[]): Promise<NonNullabl
|
|
|
1727
1769
|
* @applicableIdentity APP
|
|
1728
1770
|
* @fqn com.wix.media.site_media.v1.FilesService.GenerateFileDownloadUrl
|
|
1729
1771
|
*/
|
|
1730
|
-
declare function generateFileDownloadUrl(fileId: string, options?: GenerateFileDownloadUrlOptions): Promise<NonNullablePaths<GenerateFileDownloadUrlResponse, `downloadUrls` | `downloadUrls.${number}.url` | `downloadUrls.${number}.assetKey
|
|
1772
|
+
declare function generateFileDownloadUrl(fileId: string, options?: GenerateFileDownloadUrlOptions): Promise<NonNullablePaths<GenerateFileDownloadUrlResponse, `downloadUrls` | `downloadUrls.${number}.url` | `downloadUrls.${number}.assetKey`, 4> & {
|
|
1731
1773
|
__validationErrorsType?: GenerateFileDownloadUrlValidationErrors;
|
|
1732
1774
|
}>;
|
|
1733
1775
|
interface GenerateFileDownloadUrlOptions {
|
|
@@ -1781,7 +1823,7 @@ interface GenerateFileDownloadUrlOptions {
|
|
|
1781
1823
|
* @returns Information about the file.
|
|
1782
1824
|
* @fqn com.wix.media.site_media.v1.FilesService.GetFileDescriptor
|
|
1783
1825
|
*/
|
|
1784
|
-
declare function getFileDescriptor(fileId: string): Promise<NonNullablePaths<FileDescriptor,
|
|
1826
|
+
declare function getFileDescriptor(fileId: string): Promise<NonNullablePaths<FileDescriptor, `_id` | `displayName` | `url` | `hash` | `private` | `mediaType` | `media.image.colors.palette` | `media.image.faces` | `media.image.faces.${number}.confidence` | `media.image.faces.${number}.x` | `media.image.faces.${number}.y` | `media.image.faces.${number}.height` | `media.image.faces.${number}.width` | `media.audio._id` | `media.audio.assets` | `media.archive._id` | `media.archive.url` | `media.model3d._id` | `media.model3d.url` | `operationStatus` | `labels` | `siteId` | `state`, 6> & {
|
|
1785
1827
|
__validationErrorsType?: GetFileDescriptorValidationErrors;
|
|
1786
1828
|
}>;
|
|
1787
1829
|
/**
|
|
@@ -1796,9 +1838,7 @@ declare function getFileDescriptor(fileId: string): Promise<NonNullablePaths<Fil
|
|
|
1796
1838
|
* @applicableIdentity APP
|
|
1797
1839
|
* @fqn com.wix.media.site_media.v1.FilesService.GetFileDescriptors
|
|
1798
1840
|
*/
|
|
1799
|
-
declare function getFileDescriptors(fileIds: string[]): Promise<NonNullablePaths<GetFileDescriptorsResponse, {
|
|
1800
|
-
[P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
|
|
1801
|
-
}[FileDescriptorNonNullablePaths]> & {
|
|
1841
|
+
declare function getFileDescriptors(fileIds: string[]): Promise<NonNullablePaths<GetFileDescriptorsResponse, `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> & {
|
|
1802
1842
|
__validationErrorsType?: GetFileDescriptorsValidationErrors;
|
|
1803
1843
|
}>;
|
|
1804
1844
|
/**
|
|
@@ -1814,7 +1854,7 @@ declare function getFileDescriptors(fileIds: string[]): Promise<NonNullablePaths
|
|
|
1814
1854
|
* @returns Information about the updated file.
|
|
1815
1855
|
* @fqn com.wix.media.site_media.v1.FilesService.UpdateFileDescriptor
|
|
1816
1856
|
*/
|
|
1817
|
-
declare function updateFileDescriptor(file: NonNullablePaths<FileDescriptor, `_id
|
|
1857
|
+
declare function updateFileDescriptor(file: NonNullablePaths<FileDescriptor, `_id`, 2>): Promise<NonNullablePaths<FileDescriptor, `_id` | `displayName` | `url` | `hash` | `private` | `mediaType` | `media.image.colors.palette` | `media.image.faces` | `media.image.faces.${number}.confidence` | `media.image.faces.${number}.x` | `media.image.faces.${number}.y` | `media.image.faces.${number}.height` | `media.image.faces.${number}.width` | `media.audio._id` | `media.audio.assets` | `media.archive._id` | `media.archive.url` | `media.model3d._id` | `media.model3d.url` | `operationStatus` | `labels` | `siteId` | `state`, 6> & {
|
|
1818
1858
|
__validationErrorsType?: UpdateFileDescriptorValidationErrors;
|
|
1819
1859
|
}>;
|
|
1820
1860
|
/**
|
|
@@ -1832,7 +1872,7 @@ declare function updateFileDescriptor(file: NonNullablePaths<FileDescriptor, `_i
|
|
|
1832
1872
|
* @applicableIdentity APP
|
|
1833
1873
|
* @fqn com.wix.media.site_media.v1.FilesService.GenerateFileUploadUrl
|
|
1834
1874
|
*/
|
|
1835
|
-
declare function generateFileUploadUrl(mimeType: string, options?: GenerateFileUploadUrlOptions): Promise<NonNullablePaths<GenerateFileUploadUrlResponse, `uploadUrl
|
|
1875
|
+
declare function generateFileUploadUrl(mimeType: string, options?: GenerateFileUploadUrlOptions): Promise<NonNullablePaths<GenerateFileUploadUrlResponse, `uploadUrl`, 2> & {
|
|
1836
1876
|
__validationErrorsType?: GenerateFileUploadUrlValidationErrors;
|
|
1837
1877
|
}>;
|
|
1838
1878
|
interface GenerateFileUploadUrlOptions {
|
|
@@ -1890,7 +1930,7 @@ interface GenerateFileUploadUrlOptions {
|
|
|
1890
1930
|
* @applicableIdentity APP
|
|
1891
1931
|
* @fqn com.wix.media.site_media.v1.FilesService.GenerateFileResumableUploadUrl
|
|
1892
1932
|
*/
|
|
1893
|
-
declare function generateFileResumableUploadUrl(mimeType: string, options?: GenerateFileResumableUploadUrlOptions): Promise<NonNullablePaths<GenerateFileResumableUploadUrlResponse, `uploadProtocol` | `uploadUrl` | `uploadToken
|
|
1933
|
+
declare function generateFileResumableUploadUrl(mimeType: string, options?: GenerateFileResumableUploadUrlOptions): Promise<NonNullablePaths<GenerateFileResumableUploadUrlResponse, `uploadProtocol` | `uploadUrl` | `uploadToken`, 2> & {
|
|
1894
1934
|
__validationErrorsType?: GenerateFileResumableUploadUrlValidationErrors;
|
|
1895
1935
|
}>;
|
|
1896
1936
|
interface GenerateFileResumableUploadUrlOptions {
|
|
@@ -1957,9 +1997,7 @@ interface GenerateFileResumableUploadUrlOptions {
|
|
|
1957
1997
|
* @applicableIdentity APP
|
|
1958
1998
|
* @fqn com.wix.media.site_media.v1.FilesService.ImportFile
|
|
1959
1999
|
*/
|
|
1960
|
-
declare function importFile(url: string, options?: ImportFileOptions): Promise<NonNullablePaths<ImportFileResponse, {
|
|
1961
|
-
[P in FileDescriptorNonNullablePaths]: `file.${P}`;
|
|
1962
|
-
}[FileDescriptorNonNullablePaths]> & {
|
|
2000
|
+
declare function importFile(url: string, options?: ImportFileOptions): Promise<NonNullablePaths<ImportFileResponse, `file._id` | `file.displayName` | `file.url` | `file.hash` | `file.private` | `file.mediaType` | `file.media.image.colors.palette` | `file.media.image.faces` | `file.media.image.faces.${number}.confidence` | `file.media.image.faces.${number}.x` | `file.media.image.faces.${number}.y` | `file.media.image.faces.${number}.height` | `file.media.image.faces.${number}.width` | `file.media.audio._id` | `file.media.audio.assets` | `file.media.archive._id` | `file.media.archive.url` | `file.media.model3d._id` | `file.media.model3d.url` | `file.operationStatus` | `file.labels` | `file.siteId` | `file.state`, 7> & {
|
|
1963
2001
|
__validationErrorsType?: ImportFileValidationErrors;
|
|
1964
2002
|
}>;
|
|
1965
2003
|
interface ImportFileOptions {
|
|
@@ -2037,9 +2075,7 @@ interface ImportFileOptions {
|
|
|
2037
2075
|
* @replacedBy com.wix.media.site_media.v1.FilesService.BulkImportFile
|
|
2038
2076
|
* @targetRemovalDate 2024-03-31
|
|
2039
2077
|
*/
|
|
2040
|
-
declare function bulkImportFiles(importFileRequests: NonNullablePaths<ImportFileRequest, `url
|
|
2041
|
-
[P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
|
|
2042
|
-
}[FileDescriptorNonNullablePaths]>>;
|
|
2078
|
+
declare function bulkImportFiles(importFileRequests: NonNullablePaths<ImportFileRequest, `url`, 2>[]): Promise<NonNullablePaths<BulkImportFilesResponse, `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>>;
|
|
2043
2079
|
/**
|
|
2044
2080
|
* Imports a bulk of files to the Media Manager using external urls. <br/>
|
|
2045
2081
|
*
|
|
@@ -2066,9 +2102,7 @@ declare function bulkImportFiles(importFileRequests: NonNullablePaths<ImportFile
|
|
|
2066
2102
|
* @applicableIdentity APP
|
|
2067
2103
|
* @fqn com.wix.media.site_media.v1.FilesService.BulkImportFile
|
|
2068
2104
|
*/
|
|
2069
|
-
declare function bulkImportFile(importFileRequests: NonNullablePaths<ImportFileRequest, `url
|
|
2070
|
-
[P in FileDescriptorNonNullablePaths]: `results.${number}.item.${P}`;
|
|
2071
|
-
}[FileDescriptorNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
2105
|
+
declare function bulkImportFile(importFileRequests: NonNullablePaths<ImportFileRequest, `url`, 2>[], options?: BulkImportFileOptions): Promise<NonNullablePaths<BulkImportFileResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item._id` | `results.${number}.item.displayName` | `results.${number}.item.url` | `results.${number}.item.hash` | `results.${number}.item.private` | `results.${number}.item.mediaType` | `results.${number}.item.operationStatus` | `results.${number}.item.siteId` | `results.${number}.item.state` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
|
|
2072
2106
|
interface BulkImportFileOptions {
|
|
2073
2107
|
/** Default: `true` */
|
|
2074
2108
|
returnEntity?: boolean | null;
|
|
@@ -2083,15 +2117,14 @@ interface BulkImportFileOptions {
|
|
|
2083
2117
|
* @applicableIdentity APP
|
|
2084
2118
|
* @fqn com.wix.media.site_media.v1.FilesService.ListFiles
|
|
2085
2119
|
*/
|
|
2086
|
-
declare function listFiles(options?: ListFilesOptions): Promise<NonNullablePaths<ListFilesResponse, {
|
|
2087
|
-
[P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
|
|
2088
|
-
}[FileDescriptorNonNullablePaths]> & {
|
|
2120
|
+
declare function listFiles(options?: ListFilesOptions): Promise<NonNullablePaths<ListFilesResponse, `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> & {
|
|
2089
2121
|
__validationErrorsType?: ListFilesValidationErrors;
|
|
2090
2122
|
}>;
|
|
2091
2123
|
interface ListFilesOptions {
|
|
2092
2124
|
/**
|
|
2093
|
-
* ID of the file's parent folder.
|
|
2094
|
-
*
|
|
2125
|
+
* ID of the file's parent folder.
|
|
2126
|
+
*
|
|
2127
|
+
* Default: `media-root`.
|
|
2095
2128
|
* @maxLength 100
|
|
2096
2129
|
*/
|
|
2097
2130
|
parentFolderId?: string | null;
|
|
@@ -2100,13 +2133,22 @@ interface ListFilesOptions {
|
|
|
2100
2133
|
* @maxSize 30
|
|
2101
2134
|
*/
|
|
2102
2135
|
mediaTypes?: MediaTypeWithLiterals[];
|
|
2103
|
-
/**
|
|
2136
|
+
/**
|
|
2137
|
+
* Whether to return only private or only public files.
|
|
2138
|
+
* + `true`: Returns only private files.
|
|
2139
|
+
* + `false`: Returns only public files.
|
|
2140
|
+
* + `undefined`: Returns public and private files.
|
|
2141
|
+
*
|
|
2142
|
+
* 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)).
|
|
2143
|
+
*/
|
|
2104
2144
|
private?: boolean | null;
|
|
2105
2145
|
/**
|
|
2106
|
-
* Field name and order to sort by. One of:
|
|
2107
|
-
*
|
|
2108
|
-
*
|
|
2109
|
-
*
|
|
2146
|
+
* Field name and order to sort by. One of:
|
|
2147
|
+
*
|
|
2148
|
+
* `displayName`
|
|
2149
|
+
* `updatedDate`
|
|
2150
|
+
* `sizeInBytes`
|
|
2151
|
+
*
|
|
2110
2152
|
* Default: `updatedDate` in `desc` order.
|
|
2111
2153
|
*/
|
|
2112
2154
|
sort?: Sorting;
|
|
@@ -2114,30 +2156,49 @@ interface ListFilesOptions {
|
|
|
2114
2156
|
paging?: CursorPaging;
|
|
2115
2157
|
}
|
|
2116
2158
|
/**
|
|
2117
|
-
*
|
|
2159
|
+
* Retrieves a list of up to 200 files with the specified filtering, sorting, and cursor paging.
|
|
2160
|
+
*
|
|
2161
|
+
* If no parameters are specified, the method returns all files in the `MEDIA_ROOT` folder.
|
|
2162
|
+
*
|
|
2163
|
+
* ## Defaults
|
|
2164
|
+
*
|
|
2165
|
+
* Search Files has the following default setting, which you can override:
|
|
2166
|
+
* + Sorted by `updatedDate` in descending order.
|
|
2167
|
+
*
|
|
2168
|
+
* ## Filters
|
|
2118
2169
|
*
|
|
2119
|
-
*
|
|
2170
|
+
* When using filters for dates, you must use
|
|
2171
|
+
* [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).
|
|
2172
|
+
*
|
|
2173
|
+
* ## See also
|
|
2174
|
+
*
|
|
2175
|
+
* To learn about working with *Search* methods, see
|
|
2176
|
+
* _API Query Language_
|
|
2177
|
+
* ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/docs/rest/articles/get-started/api-query-language))
|
|
2178
|
+
* and *Sorting and Paging*
|
|
2179
|
+
* ([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)).
|
|
2120
2180
|
* @public
|
|
2121
2181
|
* @param options - Options to specify which folders to search.
|
|
2122
2182
|
* @permissionId MEDIA.SITE_MEDIA_FILES_LIST
|
|
2123
2183
|
* @applicableIdentity APP
|
|
2124
2184
|
* @fqn com.wix.media.site_media.v1.FilesService.SearchFiles
|
|
2125
2185
|
*/
|
|
2126
|
-
declare function searchFiles(options?: SearchFilesOptions): Promise<NonNullablePaths<SearchFilesResponse, {
|
|
2127
|
-
[P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
|
|
2128
|
-
}[FileDescriptorNonNullablePaths]> & {
|
|
2186
|
+
declare function searchFiles(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> & {
|
|
2129
2187
|
__validationErrorsType?: SearchFilesValidationErrors;
|
|
2130
2188
|
}>;
|
|
2131
2189
|
interface SearchFilesOptions {
|
|
2132
2190
|
/**
|
|
2133
|
-
*
|
|
2134
|
-
*
|
|
2135
|
-
* For example,
|
|
2191
|
+
* Free text to match in searchable fields.
|
|
2192
|
+
*
|
|
2193
|
+
* For example, search for specific values in a file's
|
|
2194
|
+
* `displayName`, `mimeType`, or `label`.
|
|
2136
2195
|
* @maxLength 200
|
|
2137
2196
|
*/
|
|
2138
2197
|
search?: string | null;
|
|
2139
2198
|
/**
|
|
2140
|
-
*
|
|
2199
|
+
* The root folder in the media manager to search in.
|
|
2200
|
+
* For more information, see Root Folders in Terminology ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/introduction#terminology) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/introduction#terminology)).
|
|
2201
|
+
*
|
|
2141
2202
|
* Default: `MEDIA_ROOT`.
|
|
2142
2203
|
*/
|
|
2143
2204
|
rootFolder?: RootFolderWithLiterals;
|
|
@@ -2146,13 +2207,23 @@ interface SearchFilesOptions {
|
|
|
2146
2207
|
* @maxSize 30
|
|
2147
2208
|
*/
|
|
2148
2209
|
mediaTypes?: MediaTypeWithLiterals[];
|
|
2149
|
-
/**
|
|
2210
|
+
/**
|
|
2211
|
+
* Whether to return only private or only public files.
|
|
2212
|
+
* + `true`: Returns only private files.
|
|
2213
|
+
* + `false`: Returns only public files.
|
|
2214
|
+
* + `undefined`: Returns public and private files.
|
|
2215
|
+
*
|
|
2216
|
+
* 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)).
|
|
2217
|
+
*/
|
|
2150
2218
|
private?: boolean | null;
|
|
2151
2219
|
/**
|
|
2152
|
-
* Field name and order to sort by.
|
|
2153
|
-
*
|
|
2154
|
-
*
|
|
2155
|
-
*
|
|
2220
|
+
* Field name and order to sort by.
|
|
2221
|
+
*
|
|
2222
|
+
* One of:
|
|
2223
|
+
* `displayName`
|
|
2224
|
+
* `updatedDate`
|
|
2225
|
+
* `sizeInBytes`
|
|
2226
|
+
*
|
|
2156
2227
|
* Default: `updatedDate` in `desc` order.
|
|
2157
2228
|
*/
|
|
2158
2229
|
sort?: Sorting;
|
|
@@ -2174,7 +2245,7 @@ interface SearchFilesOptions {
|
|
|
2174
2245
|
* @applicableIdentity APP
|
|
2175
2246
|
* @fqn com.wix.media.site_media.v1.FilesService.GenerateVideoStreamingUrl
|
|
2176
2247
|
*/
|
|
2177
|
-
declare function generateVideoStreamingUrl(fileId: string, options?: GenerateVideoStreamingUrlOptions): Promise<NonNullablePaths<GenerateVideoStreamingUrlResponse, `downloadUrl.url` | `downloadUrl.assetKey
|
|
2248
|
+
declare function generateVideoStreamingUrl(fileId: string, options?: GenerateVideoStreamingUrlOptions): Promise<NonNullablePaths<GenerateVideoStreamingUrlResponse, `downloadUrl.url` | `downloadUrl.assetKey`, 3>>;
|
|
2178
2249
|
interface GenerateVideoStreamingUrlOptions {
|
|
2179
2250
|
/** Video stream format. */
|
|
2180
2251
|
format?: StreamFormatWithLiterals;
|
|
@@ -2232,9 +2303,7 @@ declare function bulkRestoreFilesFromTrashBin(fileIds: string[]): Promise<void>;
|
|
|
2232
2303
|
* @applicableIdentity APP
|
|
2233
2304
|
* @fqn com.wix.media.site_media.v1.FilesService.ListDeletedFiles
|
|
2234
2305
|
*/
|
|
2235
|
-
declare function listDeletedFiles(options?: ListDeletedFilesOptions): Promise<NonNullablePaths<ListDeletedFilesResponse, {
|
|
2236
|
-
[P in FileDescriptorNonNullablePaths]: `files.${number}.${P}`;
|
|
2237
|
-
}[FileDescriptorNonNullablePaths]> & {
|
|
2306
|
+
declare function listDeletedFiles(options?: ListDeletedFilesOptions): Promise<NonNullablePaths<ListDeletedFilesResponse, `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> & {
|
|
2238
2307
|
__validationErrorsType?: ListDeletedFilesValidationErrors;
|
|
2239
2308
|
}>;
|
|
2240
2309
|
interface ListDeletedFilesOptions {
|