@wix/auto_sdk_media_files 1.0.18 → 1.0.20

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 (121) hide show
  1. package/build/cjs/index.d.ts +315 -1
  2. package/build/cjs/index.js +2264 -15
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +2266 -1
  5. package/build/cjs/index.typings.js +1935 -15
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +1053 -1
  8. package/build/cjs/meta.js +1326 -15
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/{internal/cjs/src/media-site-media-v1-file-descriptor-files.public.d.ts → es/index.d.mts} +93 -36
  11. package/build/es/index.mjs +2212 -0
  12. package/build/es/index.mjs.map +1 -0
  13. package/build/{internal/cjs/src/media-site-media-v1-file-descriptor-files.universal.d.ts → es/index.typings.d.mts} +227 -487
  14. package/build/es/index.typings.mjs +1887 -0
  15. package/build/es/index.typings.mjs.map +1 -0
  16. package/build/{internal/es/src/media-site-media-v1-file-descriptor-files.types.d.ts → es/meta.d.mts} +106 -585
  17. package/build/es/meta.mjs +1287 -0
  18. package/build/es/meta.mjs.map +1 -0
  19. package/build/internal/cjs/index.d.ts +315 -1
  20. package/build/internal/cjs/index.js +2264 -15
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +2266 -1
  23. package/build/internal/cjs/index.typings.js +1935 -15
  24. package/build/internal/cjs/index.typings.js.map +1 -1
  25. package/build/internal/cjs/meta.d.ts +1053 -1
  26. package/build/internal/cjs/meta.js +1326 -15
  27. package/build/internal/cjs/meta.js.map +1 -1
  28. package/build/{cjs/src/media-site-media-v1-file-descriptor-files.public.d.ts → internal/es/index.d.mts} +93 -36
  29. package/build/internal/es/index.mjs +2212 -0
  30. package/build/internal/es/index.mjs.map +1 -0
  31. package/build/internal/es/{src/media-site-media-v1-file-descriptor-files.universal.d.ts → index.typings.d.mts} +227 -487
  32. package/build/internal/es/index.typings.mjs +1887 -0
  33. package/build/internal/es/index.typings.mjs.map +1 -0
  34. package/build/{es/src/media-site-media-v1-file-descriptor-files.types.d.ts → internal/es/meta.d.mts} +106 -585
  35. package/build/internal/es/meta.mjs +1287 -0
  36. package/build/internal/es/meta.mjs.map +1 -0
  37. package/package.json +10 -9
  38. package/build/cjs/src/media-site-media-v1-file-descriptor-files.context.d.ts +0 -45
  39. package/build/cjs/src/media-site-media-v1-file-descriptor-files.context.js +0 -60
  40. package/build/cjs/src/media-site-media-v1-file-descriptor-files.context.js.map +0 -1
  41. package/build/cjs/src/media-site-media-v1-file-descriptor-files.http.d.ts +0 -148
  42. package/build/cjs/src/media-site-media-v1-file-descriptor-files.http.js +0 -1118
  43. package/build/cjs/src/media-site-media-v1-file-descriptor-files.http.js.map +0 -1
  44. package/build/cjs/src/media-site-media-v1-file-descriptor-files.meta.d.ts +0 -28
  45. package/build/cjs/src/media-site-media-v1-file-descriptor-files.meta.js +0 -332
  46. package/build/cjs/src/media-site-media-v1-file-descriptor-files.meta.js.map +0 -1
  47. package/build/cjs/src/media-site-media-v1-file-descriptor-files.public.js +0 -265
  48. package/build/cjs/src/media-site-media-v1-file-descriptor-files.public.js.map +0 -1
  49. package/build/cjs/src/media-site-media-v1-file-descriptor-files.types.d.ts +0 -1532
  50. package/build/cjs/src/media-site-media-v1-file-descriptor-files.types.js +0 -119
  51. package/build/cjs/src/media-site-media-v1-file-descriptor-files.types.js.map +0 -1
  52. package/build/cjs/src/media-site-media-v1-file-descriptor-files.universal.d.ts +0 -2526
  53. package/build/cjs/src/media-site-media-v1-file-descriptor-files.universal.js +0 -1483
  54. package/build/cjs/src/media-site-media-v1-file-descriptor-files.universal.js.map +0 -1
  55. package/build/es/index.d.ts +0 -1
  56. package/build/es/index.js +0 -2
  57. package/build/es/index.js.map +0 -1
  58. package/build/es/index.typings.d.ts +0 -1
  59. package/build/es/index.typings.js +0 -2
  60. package/build/es/index.typings.js.map +0 -1
  61. package/build/es/meta.d.ts +0 -1
  62. package/build/es/meta.js +0 -2
  63. package/build/es/meta.js.map +0 -1
  64. package/build/es/src/media-site-media-v1-file-descriptor-files.context.d.ts +0 -45
  65. package/build/es/src/media-site-media-v1-file-descriptor-files.context.js +0 -45
  66. package/build/es/src/media-site-media-v1-file-descriptor-files.context.js.map +0 -1
  67. package/build/es/src/media-site-media-v1-file-descriptor-files.http.d.ts +0 -148
  68. package/build/es/src/media-site-media-v1-file-descriptor-files.http.js +0 -1099
  69. package/build/es/src/media-site-media-v1-file-descriptor-files.http.js.map +0 -1
  70. package/build/es/src/media-site-media-v1-file-descriptor-files.meta.d.ts +0 -28
  71. package/build/es/src/media-site-media-v1-file-descriptor-files.meta.js +0 -290
  72. package/build/es/src/media-site-media-v1-file-descriptor-files.meta.js.map +0 -1
  73. package/build/es/src/media-site-media-v1-file-descriptor-files.public.d.ts +0 -258
  74. package/build/es/src/media-site-media-v1-file-descriptor-files.public.js +0 -234
  75. package/build/es/src/media-site-media-v1-file-descriptor-files.public.js.map +0 -1
  76. package/build/es/src/media-site-media-v1-file-descriptor-files.types.js +0 -116
  77. package/build/es/src/media-site-media-v1-file-descriptor-files.types.js.map +0 -1
  78. package/build/es/src/media-site-media-v1-file-descriptor-files.universal.d.ts +0 -2526
  79. package/build/es/src/media-site-media-v1-file-descriptor-files.universal.js +0 -1441
  80. package/build/es/src/media-site-media-v1-file-descriptor-files.universal.js.map +0 -1
  81. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.context.d.ts +0 -45
  82. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.context.js +0 -60
  83. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.context.js.map +0 -1
  84. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.http.d.ts +0 -148
  85. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.http.js +0 -1118
  86. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.http.js.map +0 -1
  87. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.meta.d.ts +0 -28
  88. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.meta.js +0 -332
  89. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.meta.js.map +0 -1
  90. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.public.js +0 -265
  91. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.public.js.map +0 -1
  92. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.types.d.ts +0 -1532
  93. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.types.js +0 -119
  94. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.types.js.map +0 -1
  95. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.universal.js +0 -1483
  96. package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.universal.js.map +0 -1
  97. package/build/internal/es/index.d.ts +0 -1
  98. package/build/internal/es/index.js +0 -2
  99. package/build/internal/es/index.js.map +0 -1
  100. package/build/internal/es/index.typings.d.ts +0 -1
  101. package/build/internal/es/index.typings.js +0 -2
  102. package/build/internal/es/index.typings.js.map +0 -1
  103. package/build/internal/es/meta.d.ts +0 -1
  104. package/build/internal/es/meta.js +0 -2
  105. package/build/internal/es/meta.js.map +0 -1
  106. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.context.d.ts +0 -45
  107. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.context.js +0 -45
  108. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.context.js.map +0 -1
  109. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.http.d.ts +0 -148
  110. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.http.js +0 -1099
  111. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.http.js.map +0 -1
  112. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.meta.d.ts +0 -28
  113. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.meta.js +0 -290
  114. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.meta.js.map +0 -1
  115. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.public.d.ts +0 -258
  116. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.public.js +0 -234
  117. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.public.js.map +0 -1
  118. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.types.js +0 -116
  119. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.types.js.map +0 -1
  120. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.universal.js +0 -1441
  121. package/build/internal/es/src/media-site-media-v1-file-descriptor-files.universal.js.map +0 -1
@@ -1 +1,315 @@
1
- export * from './src/media-site-media-v1-file-descriptor-files.context.js';
1
+ import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
2
+ import { GenerateFilesDownloadUrlResponse, GenerateFileDownloadUrlOptions, GenerateFileDownloadUrlResponse, GenerateFileDownloadUrlValidationErrors, FileDescriptor, GetFileDescriptorValidationErrors, GetFileDescriptorsResponse, GetFileDescriptorsValidationErrors, UpdateFileDescriptorValidationErrors, GenerateFileUploadUrlOptions, GenerateFileUploadUrlResponse, GenerateFileUploadUrlValidationErrors, GenerateFileResumableUploadUrlOptions, GenerateFileResumableUploadUrlResponse, GenerateFileResumableUploadUrlValidationErrors, ImportFileOptions, ImportFileResponse, ImportFileValidationErrors, ImportFileRequest, BulkImportFilesResponse, BulkImportFileOptions, BulkImportFileResponse, ListFilesOptions, ListFilesResponse, ListFilesValidationErrors, SearchFilesOptions, SearchFilesResponse, SearchFilesValidationErrors, GenerateVideoStreamingUrlOptions, GenerateVideoStreamingUrlResponse, BulkDeleteFilesOptions, ListDeletedFilesOptions, ListDeletedFilesResponse, ListDeletedFilesValidationErrors, FileDescriptorDeletedEnvelope, FileDescriptorFileFailedEnvelope, FileDescriptorFileReadyEnvelope, FileDescriptorUpdatedEnvelope } from './index.typings.js';
3
+ export { ActionEvent, ApplicationError, Archive, AudioV2, BaseEventMetadata, BulkActionMetadata, BulkAnnotateImageResult, BulkAnnotateImagesRequest, BulkAnnotateImagesResponse, BulkDeleteFilesRequest, BulkDeleteFilesResponse, BulkImportFileRequest, BulkImportFileResult, BulkImportFilesRequest, BulkPublishDraftFileResult, BulkPublishDraftFilesRequest, BulkPublishDraftFilesResponse, BulkRestoreFilesFromTrashBinRequest, BulkRestoreFilesFromTrashBinResponse, Color, ColorRGB, Colors, ContentDisposition, CursorPaging, Cursors, DomainEvent, DomainEventBodyOneOf, DownloadUrl, DraftFilePublished, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExternalInfo, FaceRecognition, FileFailed, FileMedia, FileMediaMediaOneOf, FileReady, FocalPoint, FontAsset, FontMedia, GenerateFileDownloadUrlRequest, GenerateFileResumableUploadUrlRequest, GenerateFileUploadUrlRequest, GenerateFilesDownloadUrlRequest, GenerateVideoStreamingUrlRequest, GenerateWebSocketTokenRequest, GenerateWebSocketTokenResponse, GetFileDescriptorRequest, GetFileDescriptorResponse, GetFileDescriptorsRequest, IdentificationData, IdentificationDataIdOneOf, IdentityInfo, IdentityType, ImageAnnotationConfigurations, ImageAnnotationType, ImageMedia, ItemMetadata, ListDeletedFilesRequest, ListFilesRequest, MediaType, MessageEnvelope, Model3D, Namespace, OperationStatus, OtherMedia, PagingMetadataV2, Plan, Plans, RestoreInfo, RootFolder, SearchFilesRequest, ServiceError, SiteQuotaExceededError, SortOrder, Sorting, State, StreamFormat, TotalQuota, UnsupportedRequestValueError, UpdateFileDescriptorRequest, UpdateFileDescriptorResponse, UpdateFileRequest, UpdateFileResponse, UploadProtocol, VideoResolution, WebhookIdentityType } from './index.typings.js';
4
+
5
+ declare function generateFilesDownloadUrl$1(httpClient: HttpClient): GenerateFilesDownloadUrlSignature;
6
+ interface GenerateFilesDownloadUrlSignature {
7
+ /**
8
+ * Generates a URL for downloading a compressed file containing specific files in the Media Manager.
9
+ *
10
+ * The compressed file can contain up to 1000 files.
11
+ *
12
+ * To generate a permanent URL for downloading a compressed file that contains multiple files in the Media Manager, call the Generate Files Download URL endpoint.
13
+ * Since this is a permanent URL, it is less secure.
14
+ * Therefore, to download private files, call the Generate File Download URL endpoint for each private file that you want to generate a download URL for.
15
+ * @param - IDs of the files to download.
16
+ *
17
+ * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
18
+ * Learn more in the File and Folder IDs article.
19
+ */
20
+ (fileIds: string[]): Promise<GenerateFilesDownloadUrlResponse>;
21
+ }
22
+ declare function generateFileDownloadUrl$1(httpClient: HttpClient): GenerateFileDownloadUrlSignature;
23
+ interface GenerateFileDownloadUrlSignature {
24
+ /**
25
+ * Generates one or more temporary URLs for downloading a specific file in the Media Manager.
26
+ *
27
+ * To download different assets of the file, specify the `assetKeys` parameter which generates a download URL for each asset.
28
+ * If no `assetKey` is specified, it defaults to `src`, which generates one download URL in the original file's format and quality.
29
+ *
30
+ * Call this endpoint to grant external clients access to a private media file. Specify the `expirationInMinutes` parameter to set the URL expiration time, and the `expirationRedirectUrl` parameter to add a redirect url when the URL expires.
31
+ *
32
+ * To generate a permanent URL for downloading a compressed file that contains multiple files in the Media Manager, call the Generate Files Download URL endpoint.
33
+ * Since this is a permanent URL, it is less secure.
34
+ * Therefore, to download private files, call the Generate File Download URL endpoint for each private file that you want to generate a download URL for.
35
+ * @param - Options to use when generating a file's download URL.
36
+ * @param - File ID.
37
+ *
38
+ * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
39
+ * Learn more in the File and Folder IDs article.
40
+ */
41
+ (fileId: string, options?: GenerateFileDownloadUrlOptions | undefined): Promise<GenerateFileDownloadUrlResponse & {
42
+ __validationErrorsType?: GenerateFileDownloadUrlValidationErrors | undefined;
43
+ }>;
44
+ }
45
+ declare function getFileDescriptor$1(httpClient: HttpClient): GetFileDescriptorSignature;
46
+ interface GetFileDescriptorSignature {
47
+ /**
48
+ * Gets information about a specific file in the Media Manager.
49
+ * @param - File ID.
50
+ *
51
+ * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
52
+ * Learn more in the File and Folder IDs article.
53
+ * @returns Information about the file.
54
+ */
55
+ (fileId: string): Promise<FileDescriptor & {
56
+ __validationErrorsType?: GetFileDescriptorValidationErrors | undefined;
57
+ }>;
58
+ }
59
+ declare function getFileDescriptors$1(httpClient: HttpClient): GetFileDescriptorsSignature;
60
+ interface GetFileDescriptorsSignature {
61
+ /**
62
+ * Gets information about specific files in the Media Manager.
63
+ * @param - File IDs.
64
+ *
65
+ * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
66
+ * Learn more in the File and Folder IDs article.
67
+ */
68
+ (fileIds: string[]): Promise<GetFileDescriptorsResponse & {
69
+ __validationErrorsType?: GetFileDescriptorsValidationErrors | undefined;
70
+ }>;
71
+ }
72
+ declare function updateFileDescriptor$1(httpClient: HttpClient): UpdateFileDescriptorSignature;
73
+ interface UpdateFileDescriptorSignature {
74
+ /**
75
+ * Updates a file. <br />
76
+ *
77
+ * Specify the `parentFolderId` parameter to move a file from its current folder to a different folder.
78
+ * @param - The file to update.
79
+ * @returns Information about the updated file.
80
+ */
81
+ (file: FileDescriptor): Promise<FileDescriptor & {
82
+ __validationErrorsType?: UpdateFileDescriptorValidationErrors | undefined;
83
+ }>;
84
+ }
85
+ declare function generateFileUploadUrl$1(httpClient: HttpClient): GenerateFileUploadUrlSignature;
86
+ interface GenerateFileUploadUrlSignature {
87
+ /**
88
+ * Generates an upload URL to allow external clients to upload a file to the Media Manager. <br/>
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 ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/upload-api) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/upload-api)).
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 ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_knowing-when-a-file-is-ready) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready)).
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
+ * @param - File mime type.
95
+ * @param - Options to use when generating a file's upload URL.
96
+ */
97
+ (mimeType: string, options?: GenerateFileUploadUrlOptions | undefined): Promise<GenerateFileUploadUrlResponse & {
98
+ __validationErrorsType?: GenerateFileUploadUrlValidationErrors | undefined;
99
+ }>;
100
+ }
101
+ declare function generateFileResumableUploadUrl$1(httpClient: HttpClient): GenerateFileResumableUploadUrlSignature;
102
+ interface GenerateFileResumableUploadUrlSignature {
103
+ /**
104
+ * Generates a resumable upload URL to allow external clients to easily upload large files over 10MB to the Media Manager. <br/>
105
+ *
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 ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/resumable-upload-api) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/resumable-upload-api)).
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 ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_knowing-when-a-file-is-ready) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready)).
110
+ * @param - File mime type.
111
+ * @param - Options to use when generating a resumable upload URL.
112
+ */
113
+ (mimeType: string, options?: GenerateFileResumableUploadUrlOptions | undefined): Promise<GenerateFileResumableUploadUrlResponse & {
114
+ __validationErrorsType?: GenerateFileResumableUploadUrlValidationErrors | undefined;
115
+ }>;
116
+ }
117
+ declare function importFile$1(httpClient: HttpClient): ImportFileSignature;
118
+ interface ImportFileSignature {
119
+ /**
120
+ * Imports a file to the Media Manager using an external url.
121
+ *
122
+ * Returns information about the imported file.
123
+ * Specify the `parentFolderId` and `filePath` parameters to specify which folder you want the file to be imported to.
124
+ * If no folder is specified, the file is imported to the `media-root` folder.
125
+ *
126
+ * >**Notes:**
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 ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_knowing-when-a-file-is-ready) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready)).
129
+ *
130
+ * To import a file, you need to do one of the following:
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'`.
132
+ * - Specify its extension in either the `displayName` or `url` field of the request. For example, `displayName: 'Example Image.jpeg` or `url: https://www.example.com/image.jpeg`.
133
+ * - Ensure the server hosting the file supports HEAD requests. In these cases the Wix servers can retrieve the MIME type from the hosting server.
134
+ * > **Note:** If you want to validate the media type, specify the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`.
135
+ * @param - Publicly accessible external file URL.
136
+ * @param - Options to use when importing a single file.
137
+ */
138
+ (url: string, options?: ImportFileOptions | undefined): Promise<ImportFileResponse & {
139
+ __validationErrorsType?: ImportFileValidationErrors | undefined;
140
+ }>;
141
+ }
142
+ declare function bulkImportFiles$1(httpClient: HttpClient): BulkImportFilesSignature;
143
+ interface BulkImportFilesSignature {
144
+ /**
145
+ * Imports a bulk of files to the Media Manager using external urls. <br/>
146
+ *
147
+ * Returns information about the imported files.
148
+ *
149
+ * Use the `parentFolderId` and `filePath` parameters to specify the folder you want each file to be imported to.
150
+ * If no folder is specified, the file is imported to the `media-root` folder.
151
+ *
152
+ * >**Notes:**
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 ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_knowing-when-a-file-is-ready) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready)).
155
+ *
156
+ * To import files, you need to do one of the following for each file:
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'`.
158
+ * - Include its extension in either the `displayName` or `url` field of the request. For example, `displayName: 'Example Image.jpeg` or `url: https://www.example.com/image.jpeg`.
159
+ * - Ensure the server hosting the file supports HEAD requests. In these cases the Wix servers can retrieve the MIME type from the hosting server.
160
+ * > **Note:** If you want to validate the media type, specify the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`.
161
+ * @param - Information about the files to import.
162
+ * @param - Options to use when uploading multiple files.
163
+ * @deprecated
164
+ */
165
+ (importFileRequests: ImportFileRequest[]): Promise<BulkImportFilesResponse>;
166
+ }
167
+ declare function bulkImportFile$1(httpClient: HttpClient): BulkImportFileSignature;
168
+ interface BulkImportFileSignature {
169
+ /**
170
+ * Imports a bulk of files to the Media Manager using external urls. <br/>
171
+ *
172
+ * Returns information about the imported files.
173
+ *
174
+ * Specify the `parentFolderId` and `filePath` parameters to specify the folder you want each file to be imported to.
175
+ * If no folder is specified, the file is imported to the `media-root` folder.
176
+ *
177
+ * >**Notes:**
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 ([SDK](https://dev.wix.com/docs/sdk/backend-modules/media/files/importing-files#backend-modules_media_files_knowing-when-a-file-is-ready) | [REST](https://dev.wix.com/docs/rest/assets/media/media-manager/files/importing-files#knowing-when-a-file-is-ready)).
180
+ *
181
+ * To import files, you need to do one of the following for each file:
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'`.
183
+ * - Include its extension in either the `displayName` or `url` field of the request. For example, `displayName: 'Example Image.jpeg` or `url: https://www.example.com/image.jpeg`.
184
+ * - Ensure the server hosting the file supports HEAD requests. In these cases the Wix servers can retrieve the MIME type from the hosting server.
185
+ * > **Note:** If you want to validate the media type, specify the file's expected media type in the optional `mediaType` field of the request. For example, `mediaType: 'IMAGE'`.
186
+ * @param - Information about the files to import.
187
+ * @param - Options to include the file descriptor in the response.
188
+ */
189
+ (importFileRequests: ImportFileRequest[], options?: BulkImportFileOptions | undefined): Promise<BulkImportFileResponse>;
190
+ }
191
+ declare function listFiles$1(httpClient: HttpClient): ListFilesSignature;
192
+ interface ListFilesSignature {
193
+ /**
194
+ * Retrieves a list of files in the Media Manager.
195
+ *
196
+ * To retrieve a list of files within a specific folder in the Media Manager, specify the folder's ID in the `parentFolderId` parameter. If no folder is specified, the method retrieves the list of files in the root folder of the Media Manager.
197
+ * @param - Options to use when listing media files.
198
+ */
199
+ (options?: ListFilesOptions | undefined): Promise<ListFilesResponse & {
200
+ __validationErrorsType?: ListFilesValidationErrors | undefined;
201
+ }>;
202
+ }
203
+ declare function searchFiles$1(httpClient: HttpClient): SearchFilesSignature;
204
+ interface SearchFilesSignature {
205
+ /**
206
+ * Searches all folders in the Media Manager and returns a list of files that match the terms specified in the parameters. <br/>
207
+ *
208
+ * If no parameters are specified, the endpoint returns all files in the `MEDIA_ROOT` folder.
209
+ * @param - Options to specify which folders to search.
210
+ */
211
+ (options?: SearchFilesOptions | undefined): Promise<SearchFilesResponse & {
212
+ __validationErrorsType?: SearchFilesValidationErrors | undefined;
213
+ }>;
214
+ }
215
+ declare function generateVideoStreamingUrl$1(httpClient: HttpClient): GenerateVideoStreamingUrlSignature;
216
+ interface GenerateVideoStreamingUrlSignature {
217
+ /**
218
+ * Generates a URL for streaming a specific video file in the Media Manager. <br/>
219
+ *
220
+ * To stream different assets of the file, specify the `assetKeys` parameter which generates a video streaming URL for each asset. If no assetKey is specified, it defaults to `src`, which generates one video streaming URL in the original file's format and quality.
221
+ * @param - Options to use when generating a video file's streaming URL.
222
+ * @param - File ID.
223
+ *
224
+ * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
225
+ * Learn more in the File and Folder IDs article.
226
+ */
227
+ (fileId: string, options?: GenerateVideoStreamingUrlOptions | undefined): Promise<GenerateVideoStreamingUrlResponse>;
228
+ }
229
+ declare function bulkDeleteFiles$1(httpClient: HttpClient): BulkDeleteFilesSignature;
230
+ interface BulkDeleteFilesSignature {
231
+ /**
232
+ * Deletes the specified files from the Media Manager. <br/>
233
+ *
234
+ * The deleted files are moved to the Media Manager's trash bin (`TRASH-ROOT` folder) unless permanently deleted. To permanently delete files, specify the `permanent` parameter with the value `true`. Permanently deleting files isn't reversible, so make sure that these files aren't being used in a site or in any other way as the files will no longer be accessible.
235
+ *
236
+ * Note the following:
237
+ * * The specified files can be from different folders.
238
+ * * Moving multiple files at once is an asynchronous action, and may take time for the changes to appear in the Media Manager.
239
+ * * Attempting to delete files that are already in the trash bin doesn't result in an error.
240
+ * * If a site contains deleted media files, the deleted media files still appear on the site as the files are still in the Media Manager (in the trash bin).
241
+ * * You can use Bulk Restore Files From Trash Bin to restore files from the Media Manager's trash bin.
242
+ * @param - Options to use when deleting files.
243
+ * @param - IDs of the files to move to the Media Manager's trash bin.
244
+ *
245
+ * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
246
+ * Learn more in the File and Folder IDs article.
247
+ */
248
+ (fileIds: string[], options?: BulkDeleteFilesOptions | undefined): Promise<void>;
249
+ }
250
+ declare function bulkRestoreFilesFromTrashBin$1(httpClient: HttpClient): BulkRestoreFilesFromTrashBinSignature;
251
+ interface BulkRestoreFilesFromTrashBinSignature {
252
+ /**
253
+ * Restores the specified files from the Media Manager's trash bin, and moves them to their original locations in the Media Manager.
254
+ * @param - IDs of the files to restore from the Media Manager's trash bin.
255
+ *
256
+ * You can also pass the files' Wix media URLs. For example, `["wix:image://v1/0abec0_b291a9349a0b4da59067f76287e386fb~mv2.jpg/leon.jpg#originWidth=3024&originHeight=4032"]`.
257
+ * Learn more in the File and Folder IDs article.
258
+ */
259
+ (fileIds: string[]): Promise<void>;
260
+ }
261
+ declare function listDeletedFiles$1(httpClient: HttpClient): ListDeletedFilesSignature;
262
+ interface ListDeletedFilesSignature {
263
+ /**
264
+ * Retrieves a list of files in the Media Manager's trash bin. <br/>
265
+ *
266
+ * >**Note:** The Media Manager's trash bin (`TRASH-ROOT` folder) only contains temporarily deleted files, not permanently deleted files.
267
+ * @param - Options to use when listing deleted files from the trash bin.
268
+ */
269
+ (options?: ListDeletedFilesOptions | undefined): Promise<ListDeletedFilesResponse & {
270
+ __validationErrorsType?: ListDeletedFilesValidationErrors | undefined;
271
+ }>;
272
+ }
273
+ declare const onFileDescriptorDeleted$1: EventDefinition<FileDescriptorDeletedEnvelope, "wix.media.site_media.v1.file_descriptor_deleted">;
274
+ declare const onFileDescriptorFileFailed$1: EventDefinition<FileDescriptorFileFailedEnvelope, "wix.media.site_media.v1.file_descriptor_file_failed">;
275
+ declare const onFileDescriptorFileReady$1: EventDefinition<FileDescriptorFileReadyEnvelope, "wix.media.site_media.v1.file_descriptor_file_ready">;
276
+ declare const onFileDescriptorUpdated$1: EventDefinition<FileDescriptorUpdatedEnvelope, "wix.media.site_media.v1.file_descriptor_updated">;
277
+
278
+ declare const generateFilesDownloadUrl: MaybeContext<BuildRESTFunction<typeof generateFilesDownloadUrl$1> & typeof generateFilesDownloadUrl$1>;
279
+ declare const generateFileDownloadUrl: MaybeContext<BuildRESTFunction<typeof generateFileDownloadUrl$1> & typeof generateFileDownloadUrl$1>;
280
+ declare const getFileDescriptor: MaybeContext<BuildRESTFunction<typeof getFileDescriptor$1> & typeof getFileDescriptor$1>;
281
+ declare const getFileDescriptors: MaybeContext<BuildRESTFunction<typeof getFileDescriptors$1> & typeof getFileDescriptors$1>;
282
+ declare const updateFileDescriptor: MaybeContext<BuildRESTFunction<typeof updateFileDescriptor$1> & typeof updateFileDescriptor$1>;
283
+ declare const generateFileUploadUrl: MaybeContext<BuildRESTFunction<typeof generateFileUploadUrl$1> & typeof generateFileUploadUrl$1>;
284
+ declare const generateFileResumableUploadUrl: MaybeContext<BuildRESTFunction<typeof generateFileResumableUploadUrl$1> & typeof generateFileResumableUploadUrl$1>;
285
+ declare const importFile: MaybeContext<BuildRESTFunction<typeof importFile$1> & typeof importFile$1>;
286
+ declare const bulkImportFiles: MaybeContext<BuildRESTFunction<typeof bulkImportFiles$1> & typeof bulkImportFiles$1>;
287
+ declare const bulkImportFile: MaybeContext<BuildRESTFunction<typeof bulkImportFile$1> & typeof bulkImportFile$1>;
288
+ declare const listFiles: MaybeContext<BuildRESTFunction<typeof listFiles$1> & typeof listFiles$1>;
289
+ declare const searchFiles: MaybeContext<BuildRESTFunction<typeof searchFiles$1> & typeof searchFiles$1>;
290
+ declare const generateVideoStreamingUrl: MaybeContext<BuildRESTFunction<typeof generateVideoStreamingUrl$1> & typeof generateVideoStreamingUrl$1>;
291
+ declare const bulkDeleteFiles: MaybeContext<BuildRESTFunction<typeof bulkDeleteFiles$1> & typeof bulkDeleteFiles$1>;
292
+ declare const bulkRestoreFilesFromTrashBin: MaybeContext<BuildRESTFunction<typeof bulkRestoreFilesFromTrashBin$1> & typeof bulkRestoreFilesFromTrashBin$1>;
293
+ declare const listDeletedFiles: MaybeContext<BuildRESTFunction<typeof listDeletedFiles$1> & typeof listDeletedFiles$1>;
294
+ /**
295
+ * Triggered when a file is deleted.
296
+ *
297
+ * If the `movedToTrash` property in the event object `true`, the file was moved to the Media Manager's trash bin. If the `movedToTrash` property in the event object is `false`, the file was permanently deleted.
298
+ */
299
+ declare const onFileDescriptorDeleted: BuildEventDefinition<typeof onFileDescriptorDeleted$1>;
300
+ /**
301
+ * Triggered when a file fails during essential post-upload processing.
302
+ */
303
+ declare const onFileDescriptorFileFailed: BuildEventDefinition<typeof onFileDescriptorFileFailed$1>;
304
+ /**
305
+ * Triggered when a file is ready to be used, after any post-upload processing.
306
+ *
307
+ * This event is also triggred when a file is restored from the Media Manager's trash bin.
308
+ */
309
+ declare const onFileDescriptorFileReady: BuildEventDefinition<typeof onFileDescriptorFileReady$1>;
310
+ /**
311
+ * Triggered when a file is updated, including when a file is moved to a different folder.
312
+ */
313
+ declare const onFileDescriptorUpdated: BuildEventDefinition<typeof onFileDescriptorUpdated$1>;
314
+
315
+ export { BulkDeleteFilesOptions, BulkImportFileOptions, BulkImportFileResponse, BulkImportFilesResponse, FileDescriptor, FileDescriptorDeletedEnvelope, FileDescriptorFileFailedEnvelope, FileDescriptorFileReadyEnvelope, FileDescriptorUpdatedEnvelope, GenerateFileDownloadUrlOptions, GenerateFileDownloadUrlResponse, GenerateFileResumableUploadUrlOptions, GenerateFileResumableUploadUrlResponse, GenerateFileUploadUrlOptions, GenerateFileUploadUrlResponse, GenerateFilesDownloadUrlResponse, GenerateVideoStreamingUrlOptions, GenerateVideoStreamingUrlResponse, GetFileDescriptorsResponse, ImportFileOptions, ImportFileRequest, ImportFileResponse, ListDeletedFilesOptions, ListDeletedFilesResponse, ListFilesOptions, ListFilesResponse, SearchFilesOptions, SearchFilesResponse, bulkDeleteFiles, bulkImportFile, bulkImportFiles, bulkRestoreFilesFromTrashBin, generateFileDownloadUrl, generateFileResumableUploadUrl, generateFileUploadUrl, generateFilesDownloadUrl, generateVideoStreamingUrl, getFileDescriptor, getFileDescriptors, importFile, listDeletedFiles, listFiles, onFileDescriptorDeleted, onFileDescriptorFileFailed, onFileDescriptorFileReady, onFileDescriptorUpdated, searchFiles, updateFileDescriptor };