@wix/auto_sdk_media_files 1.0.16 → 1.0.17

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.
@@ -43,7 +43,7 @@ export interface FileDescriptor {
43
43
  * Media file type.
44
44
  * @readonly
45
45
  */
46
- mediaType?: MediaType;
46
+ mediaType?: MediaTypeWithLiterals;
47
47
  /**
48
48
  * Media file content.
49
49
  * @readonly
@@ -56,7 +56,7 @@ export interface FileDescriptor {
56
56
  * * `PENDING`: The file is processing and the URLs are not yet available. This response is returned when importing a file.
57
57
  * @readonly
58
58
  */
59
- operationStatus?: OperationStatus;
59
+ operationStatus?: OperationStatusWithLiterals;
60
60
  /**
61
61
  * URL where the file was uploaded from.
62
62
  * @readonly
@@ -95,7 +95,7 @@ export interface FileDescriptor {
95
95
  * State of the file.
96
96
  * @readonly
97
97
  */
98
- state?: State;
98
+ state?: StateWithLiterals;
99
99
  }
100
100
  export declare enum MediaType {
101
101
  UNKNOWN = "UNKNOWN",
@@ -108,6 +108,8 @@ export declare enum MediaType {
108
108
  MODEL3D = "MODEL3D",
109
109
  OTHER = "OTHER"
110
110
  }
111
+ /** @enumType */
112
+ export type MediaTypeWithLiterals = MediaType | 'UNKNOWN' | 'IMAGE' | 'VIDEO' | 'AUDIO' | 'DOCUMENT' | 'VECTOR' | 'ARCHIVE' | 'MODEL3D' | 'OTHER';
111
113
  export interface FileMedia extends FileMediaMediaOneOf {
112
114
  /** Information about the image. */
113
115
  image?: ImageMedia;
@@ -495,12 +497,16 @@ export declare enum OperationStatus {
495
497
  /** File is waiting for processing or currently being processed */
496
498
  PENDING = "PENDING"
497
499
  }
500
+ /** @enumType */
501
+ export type OperationStatusWithLiterals = OperationStatus | 'FAILED' | 'READY' | 'PENDING';
498
502
  export declare enum State {
499
503
  /** File is ready for consumption */
500
504
  OK = "OK",
501
505
  /** Deleted file */
502
506
  DELETED = "DELETED"
503
507
  }
508
+ /** @enumType */
509
+ export type StateWithLiterals = State | 'OK' | 'DELETED';
504
510
  export declare enum Namespace {
505
511
  NO_NAMESPACE = "NO_NAMESPACE",
506
512
  OTHERS = "OTHERS",
@@ -529,9 +535,11 @@ export declare enum Namespace {
529
535
  /** _nsWixLegends */
530
536
  WIX_LEGENDS = "WIX_LEGENDS"
531
537
  }
538
+ /** @enumType */
539
+ export type NamespaceWithLiterals = Namespace | 'NO_NAMESPACE' | 'OTHERS' | 'WIX_VIDEO' | 'WIX_MUSIC' | 'ALBUMS_AND_ART_STORE' | 'WIX_ECOM' | 'PHOTO_SHARE_APP' | 'SHARING_APP' | 'CHAT' | 'LOGO_BUILDER' | 'ALBUMS_OLD' | 'CHAT_MOBILE' | 'WIX_FORMS' | 'WIX_LEGENDS';
532
540
  export interface IdentityInfo {
533
541
  /** The type of the user that uploaded the file */
534
- identityType?: IdentityType;
542
+ identityType?: IdentityTypeWithLiterals;
535
543
  /**
536
544
  * User Id. empty when UNKNOWN
537
545
  * @format GUID
@@ -545,6 +553,8 @@ export declare enum IdentityType {
545
553
  WIX_USER = "WIX_USER",
546
554
  APP = "APP"
547
555
  }
556
+ /** @enumType */
557
+ export type IdentityTypeWithLiterals = IdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
548
558
  export interface FileReady {
549
559
  /** File entity that is ready with full information. */
550
560
  file?: FileDescriptor;
@@ -584,7 +594,7 @@ export interface DraftFilePublished {
584
594
  /** The file after it was published */
585
595
  file?: FileDescriptor;
586
596
  /** The namespace the file was published to */
587
- namespace?: Namespace;
597
+ namespace?: NamespaceWithLiterals;
588
598
  }
589
599
  export interface BulkAnnotateImagesRequest {
590
600
  /**
@@ -599,7 +609,7 @@ export interface BulkAnnotateImagesRequest {
599
609
  * @minSize 1
600
610
  * @maxSize 10
601
611
  */
602
- annotationTypes?: ImageAnnotationType[];
612
+ annotationTypes?: ImageAnnotationTypeWithLiterals[];
603
613
  /** When true the endpoint will detect listed information even if the image has this information */
604
614
  overwrite?: boolean | null;
605
615
  /** Should the response return the item following the operation */
@@ -614,6 +624,8 @@ export declare enum ImageAnnotationType {
614
624
  COLORS = "COLORS",
615
625
  CAPTION = "CAPTION"
616
626
  }
627
+ /** @enumType */
628
+ export type ImageAnnotationTypeWithLiterals = ImageAnnotationType | 'UNKNOWN_IMAGE_ANNOTATION_TYPE' | 'CONTAINS_TEXT' | 'IS_ANIMATED' | 'FACES' | 'LABELS' | 'COLORS' | 'CAPTION';
617
629
  export interface BulkAnnotateImagesResponse {
618
630
  /** Results of individual items */
619
631
  results?: BulkAnnotateImageResult[];
@@ -710,7 +722,7 @@ export interface GenerateFileDownloadUrlRequest {
710
722
  *
711
723
  * Default: `ATTACHMENT`
712
724
  */
713
- contentDisposition?: ContentDisposition;
725
+ contentDisposition?: ContentDispositionWithLiterals;
714
726
  }
715
727
  export declare enum ContentDisposition {
716
728
  /** Using the link in the browser will download the file */
@@ -718,6 +730,8 @@ export declare enum ContentDisposition {
718
730
  /** Using the link in the browser will open the file in the browser */
719
731
  INLINE = "INLINE"
720
732
  }
733
+ /** @enumType */
734
+ export type ContentDispositionWithLiterals = ContentDisposition | 'ATTACHMENT' | 'INLINE';
721
735
  export interface GenerateFileDownloadUrlResponse {
722
736
  /**
723
737
  * URL for downloading a specific file in the Media Manager.
@@ -863,7 +877,7 @@ export interface ImageAnnotationConfigurations {
863
877
  * Default will be all detections
864
878
  * @maxSize 10
865
879
  */
866
- annotationTypes?: ImageAnnotationType[];
880
+ annotationTypes?: ImageAnnotationTypeWithLiterals[];
867
881
  }
868
882
  export interface GenerateFileUploadUrlResponse {
869
883
  /**
@@ -955,7 +969,7 @@ export interface GenerateFileResumableUploadUrlRequest {
955
969
  */
956
970
  labels?: string[] | null;
957
971
  /** The upload protocol to use for implementing the resumable upload. */
958
- uploadProtocol?: UploadProtocol;
972
+ uploadProtocol?: UploadProtocolWithLiterals;
959
973
  /**
960
974
  * Path to the folder where the file will be stored.
961
975
  * For example, `/videos/2024/december`. <br/>
@@ -969,9 +983,11 @@ export declare enum UploadProtocol {
969
983
  /** The upload protocol to use for implementing the resumable upload. */
970
984
  TUS = "TUS"
971
985
  }
986
+ /** @enumType */
987
+ export type UploadProtocolWithLiterals = UploadProtocol | 'TUS';
972
988
  export interface GenerateFileResumableUploadUrlResponse {
973
989
  /** The upload protocol to use for implementing the resumable upload. */
974
- uploadProtocol?: UploadProtocol;
990
+ uploadProtocol?: UploadProtocolWithLiterals;
975
991
  /**
976
992
  * The URL for uploading a file to the Media Manager.
977
993
  * @format WEB_URL
@@ -993,7 +1009,7 @@ export interface ImportFileRequest {
993
1009
  * Media type of the file to import.
994
1010
  * excluding: OTHER media type
995
1011
  */
996
- mediaType?: MediaType;
1012
+ mediaType?: MediaTypeWithLiterals;
997
1013
  /**
998
1014
  * File name that appears in the Media Manager.
999
1015
  * @maxLength 200
@@ -1086,7 +1102,7 @@ export interface ListFilesRequest {
1086
1102
  * File media type.
1087
1103
  * @maxSize 30
1088
1104
  */
1089
- mediaTypes?: MediaType[];
1105
+ mediaTypes?: MediaTypeWithLiterals[];
1090
1106
  /** \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)). */
1091
1107
  private?: boolean | null;
1092
1108
  /**
@@ -1107,12 +1123,14 @@ export interface Sorting {
1107
1123
  */
1108
1124
  fieldName?: string;
1109
1125
  /** Sort order. */
1110
- order?: SortOrder;
1126
+ order?: SortOrderWithLiterals;
1111
1127
  }
1112
1128
  export declare enum SortOrder {
1113
1129
  ASC = "ASC",
1114
1130
  DESC = "DESC"
1115
1131
  }
1132
+ /** @enumType */
1133
+ export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
1116
1134
  export interface CursorPaging {
1117
1135
  /**
1118
1136
  * Maximum number of items to return in the results.
@@ -1162,12 +1180,12 @@ export interface SearchFilesRequest {
1162
1180
  * A root folder in the media manager to search in. <br />
1163
1181
  * Default: `MEDIA_ROOT`.
1164
1182
  */
1165
- rootFolder?: RootFolder;
1183
+ rootFolder?: RootFolderWithLiterals;
1166
1184
  /**
1167
1185
  * File media type.
1168
1186
  * @maxSize 30
1169
1187
  */
1170
- mediaTypes?: MediaType[];
1188
+ mediaTypes?: MediaTypeWithLiterals[];
1171
1189
  /** \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)). */
1172
1190
  private?: boolean | null;
1173
1191
  /**
@@ -1189,6 +1207,8 @@ export declare enum RootFolder {
1189
1207
  /** Root of all visitor uploads */
1190
1208
  VISITOR_UPLOADS_ROOT = "VISITOR_UPLOADS_ROOT"
1191
1209
  }
1210
+ /** @enumType */
1211
+ export type RootFolderWithLiterals = RootFolder | 'MEDIA_ROOT' | 'TRASH_ROOT' | 'VISITOR_UPLOADS_ROOT';
1192
1212
  export interface SearchFilesResponse {
1193
1213
  /**
1194
1214
  * Files matching the query.
@@ -1208,13 +1228,15 @@ export interface GenerateVideoStreamingUrlRequest {
1208
1228
  */
1209
1229
  fileId: string;
1210
1230
  /** Video stream format. */
1211
- format?: StreamFormat;
1231
+ format?: StreamFormatWithLiterals;
1212
1232
  }
1213
1233
  export declare enum StreamFormat {
1214
1234
  UNKNOWN = "UNKNOWN",
1215
1235
  HLS = "HLS",
1216
1236
  DASH = "DASH"
1217
1237
  }
1238
+ /** @enumType */
1239
+ export type StreamFormatWithLiterals = StreamFormat | 'UNKNOWN' | 'HLS' | 'DASH';
1218
1240
  export interface GenerateVideoStreamingUrlResponse {
1219
1241
  /** URL for streaming a specific file in the Media Manager. */
1220
1242
  downloadUrl?: DownloadUrl;
@@ -1270,7 +1292,7 @@ export interface ListDeletedFilesRequest {
1270
1292
  * File media type.
1271
1293
  * @maxSize 30
1272
1294
  */
1273
- mediaTypes?: MediaType[];
1295
+ mediaTypes?: MediaTypeWithLiterals[];
1274
1296
  /** \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)). */
1275
1297
  private?: boolean | null;
1276
1298
  /**
@@ -1307,7 +1329,7 @@ export interface BulkPublishDraftFilesRequest {
1307
1329
  * The namespace the files will be published to
1308
1330
  * Note, private files must have a namespace
1309
1331
  */
1310
- namespace?: Namespace;
1332
+ namespace?: NamespaceWithLiterals;
1311
1333
  /**
1312
1334
  * ID of the file's parent folder. <br />
1313
1335
  * This folder is the path root for the `filePath`. <br />
@@ -1474,7 +1496,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
1474
1496
  */
1475
1497
  appId?: string;
1476
1498
  /** @readonly */
1477
- identityType?: WebhookIdentityType;
1499
+ identityType?: WebhookIdentityTypeWithLiterals;
1478
1500
  }
1479
1501
  /** @oneof */
1480
1502
  export interface IdentificationDataIdOneOf {
@@ -1506,3 +1528,5 @@ export declare enum WebhookIdentityType {
1506
1528
  WIX_USER = "WIX_USER",
1507
1529
  APP = "APP"
1508
1530
  }
1531
+ /** @enumType */
1532
+ export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
@@ -1 +1 @@
1
- {"version":3,"file":"media-site-media-v1-file-descriptor-files.types.js","sourceRoot":"","sources":["../../../src/media-site-media-v1-file-descriptor-files.types.ts"],"names":[],"mappings":";;;AAoGA,IAAY,SAUX;AAVD,WAAY,SAAS;IACnB,gCAAmB,CAAA;IACnB,4BAAe,CAAA;IACf,4BAAe,CAAA;IACf,4BAAe,CAAA;IACf,kCAAqB,CAAA;IACrB,8BAAiB,CAAA;IACjB,gCAAmB,CAAA;IACnB,gCAAmB,CAAA;IACnB,4BAAe,CAAA;AACjB,CAAC,EAVW,SAAS,yBAAT,SAAS,QAUpB;AAgZD,IAAY,eAOX;AAPD,WAAY,eAAe;IACzB,uCAAuC;IACvC,oCAAiB,CAAA;IACjB,oCAAoC;IACpC,kCAAe,CAAA;IACf,kEAAkE;IAClE,sCAAmB,CAAA;AACrB,CAAC,EAPW,eAAe,+BAAf,eAAe,QAO1B;AAED,IAAY,KAKX;AALD,WAAY,KAAK;IACf,oCAAoC;IACpC,kBAAS,CAAA;IACT,mBAAmB;IACnB,4BAAmB,CAAA;AACrB,CAAC,EALW,KAAK,qBAAL,KAAK,QAKhB;AAED,IAAY,SA2BX;AA3BD,WAAY,SAAS;IACnB,0CAA6B,CAAA;IAC7B,8BAAiB,CAAA;IACjB,eAAe;IACf,oCAAuB,CAAA;IACvB,kBAAkB;IAClB,oCAAuB,CAAA;IACvB,kBAAkB;IAClB,0DAA6C,CAAA;IAC7C,wBAAwB;IACxB,kCAAqB,CAAA;IACrB,uBAAuB;IACvB,gDAAmC,CAAA;IACnC,qBAAqB;IACrB,wCAA2B,CAAA;IAC3B,aAAa;IACb,0BAAa,CAAA;IACb,kBAAkB;IAClB,0CAA6B,CAAA;IAC7B,kBAAkB;IAClB,sCAAyB,CAAA;IACzB,0BAA0B;IAC1B,wCAA2B,CAAA;IAC3B,kBAAkB;IAClB,oCAAuB,CAAA;IACvB,oBAAoB;IACpB,wCAA2B,CAAA;AAC7B,CAAC,EA3BW,SAAS,yBAAT,SAAS,QA2BpB;AAYD,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,uDAAuC,CAAA;IACvC,iCAAiB,CAAA;IACjB,qCAAqB,CAAA;IACrB,2BAAW,CAAA;AACb,CAAC,EANW,YAAY,4BAAZ,YAAY,QAMvB;AAoED,IAAY,mBAQX;AARD,WAAY,mBAAmB;IAC7B,sFAA+D,CAAA;IAC/D,sDAA+B,CAAA;IAC/B,kDAA2B,CAAA;IAC3B,sCAAe,CAAA;IACf,wCAAiB,CAAA;IACjB,wCAAiB,CAAA;IACjB,0CAAmB,CAAA;AACrB,CAAC,EARW,mBAAmB,mCAAnB,mBAAmB,QAQ9B;AA2GD,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,2DAA2D;IAC3D,+CAAyB,CAAA;IACzB,sEAAsE;IACtE,uCAAiB,CAAA;AACnB,CAAC,EALW,kBAAkB,kCAAlB,kBAAkB,QAK7B;AA2QD,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,wEAAwE;IACxE,6BAAW,CAAA;AACb,CAAC,EAHW,cAAc,8BAAd,cAAc,QAGzB;AAwJD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AA2ED,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,6BAA6B;IAC7B,uCAAyB,CAAA;IACzB,sCAAsC;IACtC,uCAAyB,CAAA;IACzB,kCAAkC;IAClC,2DAA6C,CAAA;AAC/C,CAAC,EAPW,UAAU,0BAAV,UAAU,QAOrB;AAyBD,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,2BAAW,CAAA;IACX,6BAAa,CAAA;AACf,CAAC,EAJW,YAAY,4BAAZ,YAAY,QAIvB;AAmTD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
1
+ {"version":3,"file":"media-site-media-v1-file-descriptor-files.types.js","sourceRoot":"","sources":["../../../src/media-site-media-v1-file-descriptor-files.types.ts"],"names":[],"mappings":";;;AAoGA,IAAY,SAUX;AAVD,WAAY,SAAS;IACnB,gCAAmB,CAAA;IACnB,4BAAe,CAAA;IACf,4BAAe,CAAA;IACf,4BAAe,CAAA;IACf,kCAAqB,CAAA;IACrB,8BAAiB,CAAA;IACjB,gCAAmB,CAAA;IACnB,gCAAmB,CAAA;IACnB,4BAAe,CAAA;AACjB,CAAC,EAVW,SAAS,yBAAT,SAAS,QAUpB;AA6ZD,IAAY,eAOX;AAPD,WAAY,eAAe;IACzB,uCAAuC;IACvC,oCAAiB,CAAA;IACjB,oCAAoC;IACpC,kCAAe,CAAA;IACf,kEAAkE;IAClE,sCAAmB,CAAA;AACrB,CAAC,EAPW,eAAe,+BAAf,eAAe,QAO1B;AASD,IAAY,KAKX;AALD,WAAY,KAAK;IACf,oCAAoC;IACpC,kBAAS,CAAA;IACT,mBAAmB;IACnB,4BAAmB,CAAA;AACrB,CAAC,EALW,KAAK,qBAAL,KAAK,QAKhB;AAKD,IAAY,SA2BX;AA3BD,WAAY,SAAS;IACnB,0CAA6B,CAAA;IAC7B,8BAAiB,CAAA;IACjB,eAAe;IACf,oCAAuB,CAAA;IACvB,kBAAkB;IAClB,oCAAuB,CAAA;IACvB,kBAAkB;IAClB,0DAA6C,CAAA;IAC7C,wBAAwB;IACxB,kCAAqB,CAAA;IACrB,uBAAuB;IACvB,gDAAmC,CAAA;IACnC,qBAAqB;IACrB,wCAA2B,CAAA;IAC3B,aAAa;IACb,0BAAa,CAAA;IACb,kBAAkB;IAClB,0CAA6B,CAAA;IAC7B,kBAAkB;IAClB,sCAAyB,CAAA;IACzB,0BAA0B;IAC1B,wCAA2B,CAAA;IAC3B,kBAAkB;IAClB,oCAAuB,CAAA;IACvB,oBAAoB;IACpB,wCAA2B,CAAA;AAC7B,CAAC,EA3BW,SAAS,yBAAT,SAAS,QA2BpB;AA8BD,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,uDAAuC,CAAA;IACvC,iCAAiB,CAAA;IACjB,qCAAqB,CAAA;IACrB,2BAAW,CAAA;AACb,CAAC,EANW,YAAY,4BAAZ,YAAY,QAMvB;AA6ED,IAAY,mBAQX;AARD,WAAY,mBAAmB;IAC7B,sFAA+D,CAAA;IAC/D,sDAA+B,CAAA;IAC/B,kDAA2B,CAAA;IAC3B,sCAAe,CAAA;IACf,wCAAiB,CAAA;IACjB,wCAAiB,CAAA;IACjB,0CAAmB,CAAA;AACrB,CAAC,EARW,mBAAmB,mCAAnB,mBAAmB,QAQ9B;AAsHD,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,2DAA2D;IAC3D,+CAAyB,CAAA;IACzB,sEAAsE;IACtE,uCAAiB,CAAA;AACnB,CAAC,EALW,kBAAkB,kCAAlB,kBAAkB,QAK7B;AAiRD,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,wEAAwE;IACxE,6BAAW,CAAA;AACb,CAAC,EAHW,cAAc,8BAAd,cAAc,QAGzB;AA2JD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AA8ED,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,6BAA6B;IAC7B,uCAAyB,CAAA;IACzB,sCAAsC;IACtC,uCAAyB,CAAA;IACzB,kCAAkC;IAClC,2DAA6C,CAAA;AAC/C,CAAC,EAPW,UAAU,0BAAV,UAAU,QAOrB;AAgCD,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,2BAAW,CAAA;IACX,6BAAa,CAAA;AACf,CAAC,EAJW,YAAY,4BAAZ,YAAY,QAIvB;AA0TD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
@@ -44,7 +44,7 @@ export interface FileDescriptor {
44
44
  * Media file type.
45
45
  * @readonly
46
46
  */
47
- mediaType?: MediaType;
47
+ mediaType?: MediaTypeWithLiterals;
48
48
  /**
49
49
  * Media file content.
50
50
  * @readonly
@@ -57,7 +57,7 @@ export interface FileDescriptor {
57
57
  * * `PENDING`: The file is processing and the URLs are not yet available. This response is returned when importing a file.
58
58
  * @readonly
59
59
  */
60
- operationStatus?: OperationStatus;
60
+ operationStatus?: OperationStatusWithLiterals;
61
61
  /**
62
62
  * URL where the file was uploaded from.
63
63
  * @readonly
@@ -96,7 +96,7 @@ export interface FileDescriptor {
96
96
  * State of the file.
97
97
  * @readonly
98
98
  */
99
- state?: State;
99
+ state?: StateWithLiterals;
100
100
  }
101
101
  export declare enum MediaType {
102
102
  UNKNOWN = "UNKNOWN",
@@ -109,6 +109,8 @@ export declare enum MediaType {
109
109
  MODEL3D = "MODEL3D",
110
110
  OTHER = "OTHER"
111
111
  }
112
+ /** @enumType */
113
+ export type MediaTypeWithLiterals = MediaType | 'UNKNOWN' | 'IMAGE' | 'VIDEO' | 'AUDIO' | 'DOCUMENT' | 'VECTOR' | 'ARCHIVE' | 'MODEL3D' | 'OTHER';
112
114
  export interface FileMedia extends FileMediaMediaOneOf {
113
115
  /** Information about the image. */
114
116
  image?: ImageMedia;
@@ -414,12 +416,16 @@ export declare enum OperationStatus {
414
416
  /** File is waiting for processing or currently being processed */
415
417
  PENDING = "PENDING"
416
418
  }
419
+ /** @enumType */
420
+ export type OperationStatusWithLiterals = OperationStatus | 'FAILED' | 'READY' | 'PENDING';
417
421
  export declare enum State {
418
422
  /** File is ready for consumption */
419
423
  OK = "OK",
420
424
  /** Deleted file */
421
425
  DELETED = "DELETED"
422
426
  }
427
+ /** @enumType */
428
+ export type StateWithLiterals = State | 'OK' | 'DELETED';
423
429
  export declare enum Namespace {
424
430
  NO_NAMESPACE = "NO_NAMESPACE",
425
431
  OTHERS = "OTHERS",
@@ -448,9 +454,11 @@ export declare enum Namespace {
448
454
  /** _nsWixLegends */
449
455
  WIX_LEGENDS = "WIX_LEGENDS"
450
456
  }
457
+ /** @enumType */
458
+ export type NamespaceWithLiterals = Namespace | 'NO_NAMESPACE' | 'OTHERS' | 'WIX_VIDEO' | 'WIX_MUSIC' | 'ALBUMS_AND_ART_STORE' | 'WIX_ECOM' | 'PHOTO_SHARE_APP' | 'SHARING_APP' | 'CHAT' | 'LOGO_BUILDER' | 'ALBUMS_OLD' | 'CHAT_MOBILE' | 'WIX_FORMS' | 'WIX_LEGENDS';
451
459
  export interface IdentityInfo {
452
460
  /** The type of the user that uploaded the file */
453
- identityType?: IdentityType;
461
+ identityType?: IdentityTypeWithLiterals;
454
462
  /**
455
463
  * User Id. empty when UNKNOWN
456
464
  * @format GUID
@@ -464,6 +472,8 @@ export declare enum IdentityType {
464
472
  WIX_USER = "WIX_USER",
465
473
  APP = "APP"
466
474
  }
475
+ /** @enumType */
476
+ export type IdentityTypeWithLiterals = IdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
467
477
  export interface FileReady {
468
478
  /** File entity that is ready with full information. */
469
479
  file?: FileDescriptor;
@@ -503,7 +513,7 @@ export interface DraftFilePublished {
503
513
  /** The file after it was published */
504
514
  file?: FileDescriptor;
505
515
  /** The namespace the file was published to */
506
- namespace?: Namespace;
516
+ namespace?: NamespaceWithLiterals;
507
517
  }
508
518
  export interface BulkAnnotateImagesRequest {
509
519
  /**
@@ -518,7 +528,7 @@ export interface BulkAnnotateImagesRequest {
518
528
  * @minSize 1
519
529
  * @maxSize 10
520
530
  */
521
- annotationTypes?: ImageAnnotationType[];
531
+ annotationTypes?: ImageAnnotationTypeWithLiterals[];
522
532
  /** When true the endpoint will detect listed information even if the image has this information */
523
533
  overwrite?: boolean | null;
524
534
  /** Should the response return the item following the operation */
@@ -533,6 +543,8 @@ export declare enum ImageAnnotationType {
533
543
  COLORS = "COLORS",
534
544
  CAPTION = "CAPTION"
535
545
  }
546
+ /** @enumType */
547
+ export type ImageAnnotationTypeWithLiterals = ImageAnnotationType | 'UNKNOWN_IMAGE_ANNOTATION_TYPE' | 'CONTAINS_TEXT' | 'IS_ANIMATED' | 'FACES' | 'LABELS' | 'COLORS' | 'CAPTION';
536
548
  export interface BulkAnnotateImagesResponse {
537
549
  /** Results of individual items */
538
550
  results?: BulkAnnotateImageResult[];
@@ -629,7 +641,7 @@ export interface GenerateFileDownloadUrlRequest {
629
641
  *
630
642
  * Default: `ATTACHMENT`
631
643
  */
632
- contentDisposition?: ContentDisposition;
644
+ contentDisposition?: ContentDispositionWithLiterals;
633
645
  }
634
646
  export declare enum ContentDisposition {
635
647
  /** Using the link in the browser will download the file */
@@ -637,6 +649,8 @@ export declare enum ContentDisposition {
637
649
  /** Using the link in the browser will open the file in the browser */
638
650
  INLINE = "INLINE"
639
651
  }
652
+ /** @enumType */
653
+ export type ContentDispositionWithLiterals = ContentDisposition | 'ATTACHMENT' | 'INLINE';
640
654
  export interface GenerateFileDownloadUrlResponse {
641
655
  /**
642
656
  * URL for downloading a specific file in the Media Manager.
@@ -782,7 +796,7 @@ export interface ImageAnnotationConfigurations {
782
796
  * Default will be all detections
783
797
  * @maxSize 10
784
798
  */
785
- annotationTypes?: ImageAnnotationType[];
799
+ annotationTypes?: ImageAnnotationTypeWithLiterals[];
786
800
  }
787
801
  export interface GenerateFileUploadUrlResponse {
788
802
  /**
@@ -874,7 +888,7 @@ export interface GenerateFileResumableUploadUrlRequest {
874
888
  */
875
889
  labels?: string[] | null;
876
890
  /** The upload protocol to use for implementing the resumable upload. */
877
- uploadProtocol?: UploadProtocol;
891
+ uploadProtocol?: UploadProtocolWithLiterals;
878
892
  /**
879
893
  * Path to the folder where the file will be stored.
880
894
  * For example, `/videos/2024/december`. <br/>
@@ -888,9 +902,11 @@ export declare enum UploadProtocol {
888
902
  /** The upload protocol to use for implementing the resumable upload. */
889
903
  TUS = "TUS"
890
904
  }
905
+ /** @enumType */
906
+ export type UploadProtocolWithLiterals = UploadProtocol | 'TUS';
891
907
  export interface GenerateFileResumableUploadUrlResponse {
892
908
  /** The upload protocol to use for implementing the resumable upload. */
893
- uploadProtocol?: UploadProtocol;
909
+ uploadProtocol?: UploadProtocolWithLiterals;
894
910
  /**
895
911
  * The URL for uploading a file to the Media Manager.
896
912
  * @format WEB_URL
@@ -912,7 +928,7 @@ export interface ImportFileRequest {
912
928
  * Media type of the file to import.
913
929
  * excluding: OTHER media type
914
930
  */
915
- mediaType?: MediaType;
931
+ mediaType?: MediaTypeWithLiterals;
916
932
  /**
917
933
  * File name that appears in the Media Manager.
918
934
  * @maxLength 200
@@ -1005,7 +1021,7 @@ export interface ListFilesRequest {
1005
1021
  * File media type.
1006
1022
  * @maxSize 30
1007
1023
  */
1008
- mediaTypes?: MediaType[];
1024
+ mediaTypes?: MediaTypeWithLiterals[];
1009
1025
  /** \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)). */
1010
1026
  private?: boolean | null;
1011
1027
  /**
@@ -1026,12 +1042,14 @@ export interface Sorting {
1026
1042
  */
1027
1043
  fieldName?: string;
1028
1044
  /** Sort order. */
1029
- order?: SortOrder;
1045
+ order?: SortOrderWithLiterals;
1030
1046
  }
1031
1047
  export declare enum SortOrder {
1032
1048
  ASC = "ASC",
1033
1049
  DESC = "DESC"
1034
1050
  }
1051
+ /** @enumType */
1052
+ export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
1035
1053
  export interface CursorPaging {
1036
1054
  /**
1037
1055
  * Maximum number of items to return in the results.
@@ -1081,12 +1099,12 @@ export interface SearchFilesRequest {
1081
1099
  * A root folder in the media manager to search in. <br />
1082
1100
  * Default: `MEDIA_ROOT`.
1083
1101
  */
1084
- rootFolder?: RootFolder;
1102
+ rootFolder?: RootFolderWithLiterals;
1085
1103
  /**
1086
1104
  * File media type.
1087
1105
  * @maxSize 30
1088
1106
  */
1089
- mediaTypes?: MediaType[];
1107
+ mediaTypes?: MediaTypeWithLiterals[];
1090
1108
  /** \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)). */
1091
1109
  private?: boolean | null;
1092
1110
  /**
@@ -1108,6 +1126,8 @@ export declare enum RootFolder {
1108
1126
  /** Root of all visitor uploads */
1109
1127
  VISITOR_UPLOADS_ROOT = "VISITOR_UPLOADS_ROOT"
1110
1128
  }
1129
+ /** @enumType */
1130
+ export type RootFolderWithLiterals = RootFolder | 'MEDIA_ROOT' | 'TRASH_ROOT' | 'VISITOR_UPLOADS_ROOT';
1111
1131
  export interface SearchFilesResponse {
1112
1132
  /**
1113
1133
  * Files matching the query.
@@ -1127,13 +1147,15 @@ export interface GenerateVideoStreamingUrlRequest {
1127
1147
  */
1128
1148
  fileId: string;
1129
1149
  /** Video stream format. */
1130
- format?: StreamFormat;
1150
+ format?: StreamFormatWithLiterals;
1131
1151
  }
1132
1152
  export declare enum StreamFormat {
1133
1153
  UNKNOWN = "UNKNOWN",
1134
1154
  HLS = "HLS",
1135
1155
  DASH = "DASH"
1136
1156
  }
1157
+ /** @enumType */
1158
+ export type StreamFormatWithLiterals = StreamFormat | 'UNKNOWN' | 'HLS' | 'DASH';
1137
1159
  export interface GenerateVideoStreamingUrlResponse {
1138
1160
  /** URL for streaming a specific file in the Media Manager. */
1139
1161
  downloadUrl?: DownloadUrl;
@@ -1189,7 +1211,7 @@ export interface ListDeletedFilesRequest {
1189
1211
  * File media type.
1190
1212
  * @maxSize 30
1191
1213
  */
1192
- mediaTypes?: MediaType[];
1214
+ mediaTypes?: MediaTypeWithLiterals[];
1193
1215
  /** \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)). */
1194
1216
  private?: boolean | null;
1195
1217
  /**
@@ -1226,7 +1248,7 @@ export interface BulkPublishDraftFilesRequest {
1226
1248
  * The namespace the files will be published to
1227
1249
  * Note, private files must have a namespace
1228
1250
  */
1229
- namespace?: Namespace;
1251
+ namespace?: NamespaceWithLiterals;
1230
1252
  /**
1231
1253
  * ID of the file's parent folder. <br />
1232
1254
  * This folder is the path root for the `filePath`. <br />
@@ -1391,7 +1413,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
1391
1413
  */
1392
1414
  appId?: string;
1393
1415
  /** @readonly */
1394
- identityType?: WebhookIdentityType;
1416
+ identityType?: WebhookIdentityTypeWithLiterals;
1395
1417
  }
1396
1418
  /** @oneof */
1397
1419
  export interface IdentificationDataIdOneOf {
@@ -1423,6 +1445,8 @@ export declare enum WebhookIdentityType {
1423
1445
  WIX_USER = "WIX_USER",
1424
1446
  APP = "APP"
1425
1447
  }
1448
+ /** @enumType */
1449
+ export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1426
1450
  export interface BaseEventMetadata {
1427
1451
  /**
1428
1452
  * App instance ID.
@@ -1717,7 +1741,7 @@ export interface GenerateFileDownloadUrlOptions {
1717
1741
  *
1718
1742
  * Default: `ATTACHMENT`
1719
1743
  */
1720
- contentDisposition?: ContentDisposition;
1744
+ contentDisposition?: ContentDispositionWithLiterals;
1721
1745
  }
1722
1746
  /**
1723
1747
  * Gets information about a specific file in the Media Manager.
@@ -1958,7 +1982,7 @@ export interface GenerateFileResumableUploadUrlOptions {
1958
1982
  */
1959
1983
  labels?: string[] | null;
1960
1984
  /** The upload protocol to use for implementing the resumable upload. */
1961
- uploadProtocol?: UploadProtocol;
1985
+ uploadProtocol?: UploadProtocolWithLiterals;
1962
1986
  /**
1963
1987
  * Path to the folder where the file will be stored.
1964
1988
  * For example, `/videos/2024/december`. <br/>
@@ -2018,7 +2042,7 @@ export interface ImportFileOptions {
2018
2042
  * Media type of the file to import.
2019
2043
  * excluding: OTHER media type
2020
2044
  */
2021
- mediaType?: MediaType;
2045
+ mediaType?: MediaTypeWithLiterals;
2022
2046
  /**
2023
2047
  * File name that appears in the Media Manager.
2024
2048
  * @maxLength 200
@@ -2204,7 +2228,7 @@ export interface ListFilesOptions {
2204
2228
  * File media type.
2205
2229
  * @maxSize 30
2206
2230
  */
2207
- mediaTypes?: MediaType[];
2231
+ mediaTypes?: MediaTypeWithLiterals[];
2208
2232
  /** \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)). */
2209
2233
  private?: boolean | null;
2210
2234
  /**
@@ -2263,12 +2287,12 @@ export interface SearchFilesOptions {
2263
2287
  * A root folder in the media manager to search in. <br />
2264
2288
  * Default: `MEDIA_ROOT`.
2265
2289
  */
2266
- rootFolder?: RootFolder;
2290
+ rootFolder?: RootFolderWithLiterals;
2267
2291
  /**
2268
2292
  * File media type.
2269
2293
  * @maxSize 30
2270
2294
  */
2271
- mediaTypes?: MediaType[];
2295
+ mediaTypes?: MediaTypeWithLiterals[];
2272
2296
  /** \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)). */
2273
2297
  private?: boolean | null;
2274
2298
  /**
@@ -2320,7 +2344,7 @@ export interface SearchFilesOptions {
2320
2344
  export declare function generateVideoStreamingUrl(fileId: string, options?: GenerateVideoStreamingUrlOptions): Promise<NonNullablePaths<GenerateVideoStreamingUrlResponse, `downloadUrl.url` | `downloadUrl.assetKey`>>;
2321
2345
  export interface GenerateVideoStreamingUrlOptions {
2322
2346
  /** Video stream format. */
2323
- format?: StreamFormat;
2347
+ format?: StreamFormatWithLiterals;
2324
2348
  }
2325
2349
  /**
2326
2350
  * Deletes the specified files from the Media Manager. <br/>
@@ -2445,7 +2469,7 @@ export interface ListDeletedFilesOptions {
2445
2469
  * File media type.
2446
2470
  * @maxSize 30
2447
2471
  */
2448
- mediaTypes?: MediaType[];
2472
+ mediaTypes?: MediaTypeWithLiterals[];
2449
2473
  /** \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)). */
2450
2474
  private?: boolean | null;
2451
2475
  /**