@wix/auto_sdk_media_files 1.0.15 → 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.
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.context.d.ts +2 -2
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.context.js +2 -2
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.context.js.map +1 -1
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.public.d.ts +1 -1
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.public.js.map +1 -1
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.types.d.ts +181 -178
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.types.js +9 -9
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.types.js.map +1 -1
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.universal.d.ts +187 -184
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.universal.js +9 -9
- package/build/cjs/src/media-site-media-v1-file-descriptor-files.universal.js.map +1 -1
- package/build/es/src/media-site-media-v1-file-descriptor-files.context.d.ts +2 -2
- package/build/es/src/media-site-media-v1-file-descriptor-files.context.js +1 -1
- package/build/es/src/media-site-media-v1-file-descriptor-files.context.js.map +1 -1
- package/build/es/src/media-site-media-v1-file-descriptor-files.public.d.ts +1 -1
- package/build/es/src/media-site-media-v1-file-descriptor-files.public.js.map +1 -1
- package/build/es/src/media-site-media-v1-file-descriptor-files.types.d.ts +181 -178
- package/build/es/src/media-site-media-v1-file-descriptor-files.types.js +8 -8
- package/build/es/src/media-site-media-v1-file-descriptor-files.types.js.map +1 -1
- package/build/es/src/media-site-media-v1-file-descriptor-files.universal.d.ts +187 -184
- package/build/es/src/media-site-media-v1-file-descriptor-files.universal.js +8 -8
- package/build/es/src/media-site-media-v1-file-descriptor-files.universal.js.map +1 -1
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.context.d.ts +2 -2
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.context.js +2 -2
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.context.js.map +1 -1
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.public.d.ts +1 -1
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.public.js.map +1 -1
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.types.d.ts +181 -178
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.types.js +9 -9
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.types.js.map +1 -1
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.universal.d.ts +187 -184
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.universal.js +9 -9
- package/build/internal/cjs/src/media-site-media-v1-file-descriptor-files.universal.js.map +1 -1
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.context.d.ts +2 -2
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.context.js +1 -1
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.context.js.map +1 -1
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.public.d.ts +1 -1
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.public.js.map +1 -1
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.types.d.ts +181 -178
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.types.js +8 -8
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.types.js.map +1 -1
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.universal.d.ts +187 -184
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.universal.js +8 -8
- package/build/internal/es/src/media-site-media-v1-file-descriptor-files.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -44,7 +44,7 @@ export interface FileDescriptor {
|
|
|
44
44
|
* Media file type.
|
|
45
45
|
* @readonly
|
|
46
46
|
*/
|
|
47
|
-
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?:
|
|
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?:
|
|
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?:
|
|
461
|
+
identityType?: IdentityTypeWithLiterals;
|
|
454
462
|
/**
|
|
455
463
|
* User Id. empty when UNKNOWN
|
|
456
464
|
* @format GUID
|
|
@@ -464,165 +472,8 @@ export declare enum IdentityType {
|
|
|
464
472
|
WIX_USER = "WIX_USER",
|
|
465
473
|
APP = "APP"
|
|
466
474
|
}
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
file?: FileDescriptor;
|
|
470
|
-
/** The namespace the file was published to */
|
|
471
|
-
namespace?: Namespace;
|
|
472
|
-
}
|
|
473
|
-
export interface GetUploadUrlRequest {
|
|
474
|
-
/** file size in bytes */
|
|
475
|
-
fileSize?: number;
|
|
476
|
-
/**
|
|
477
|
-
* file name
|
|
478
|
-
* @maxLength 100
|
|
479
|
-
*/
|
|
480
|
-
fileName?: string;
|
|
481
|
-
/**
|
|
482
|
-
* file content type
|
|
483
|
-
* @maxLength 50
|
|
484
|
-
*/
|
|
485
|
-
contentType?: string;
|
|
486
|
-
}
|
|
487
|
-
export interface GetUploadUrlResponse {
|
|
488
|
-
/**
|
|
489
|
-
* file upload url
|
|
490
|
-
* @maxLength 3000
|
|
491
|
-
*/
|
|
492
|
-
uploadUrl?: string;
|
|
493
|
-
}
|
|
494
|
-
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
495
|
-
createdEvent?: EntityCreatedEvent;
|
|
496
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
497
|
-
deletedEvent?: EntityDeletedEvent;
|
|
498
|
-
actionEvent?: ActionEvent;
|
|
499
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
500
|
-
_id?: string;
|
|
501
|
-
/**
|
|
502
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
503
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
504
|
-
*/
|
|
505
|
-
entityFqdn?: string;
|
|
506
|
-
/**
|
|
507
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
508
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
509
|
-
*/
|
|
510
|
-
slug?: string;
|
|
511
|
-
/** ID of the entity associated with the event. */
|
|
512
|
-
entityId?: string;
|
|
513
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
514
|
-
eventTime?: Date | null;
|
|
515
|
-
/**
|
|
516
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
517
|
-
* (for example, GDPR).
|
|
518
|
-
*/
|
|
519
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
520
|
-
/** If present, indicates the action that triggered the event. */
|
|
521
|
-
originatedFrom?: string | null;
|
|
522
|
-
/**
|
|
523
|
-
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
524
|
-
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
525
|
-
*/
|
|
526
|
-
entityEventSequence?: string | null;
|
|
527
|
-
}
|
|
528
|
-
/** @oneof */
|
|
529
|
-
export interface DomainEventBodyOneOf {
|
|
530
|
-
createdEvent?: EntityCreatedEvent;
|
|
531
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
532
|
-
deletedEvent?: EntityDeletedEvent;
|
|
533
|
-
actionEvent?: ActionEvent;
|
|
534
|
-
}
|
|
535
|
-
export interface EntityCreatedEvent {
|
|
536
|
-
entity?: string;
|
|
537
|
-
}
|
|
538
|
-
export interface RestoreInfo {
|
|
539
|
-
deletedDate?: Date | null;
|
|
540
|
-
}
|
|
541
|
-
export interface EntityUpdatedEvent {
|
|
542
|
-
/**
|
|
543
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
544
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
545
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
546
|
-
*/
|
|
547
|
-
currentEntity?: string;
|
|
548
|
-
}
|
|
549
|
-
export interface EntityDeletedEvent {
|
|
550
|
-
/** Entity that was deleted. */
|
|
551
|
-
deletedEntity?: string | null;
|
|
552
|
-
}
|
|
553
|
-
export interface ActionEvent {
|
|
554
|
-
body?: string;
|
|
555
|
-
}
|
|
556
|
-
export interface MessageEnvelope {
|
|
557
|
-
/**
|
|
558
|
-
* App instance ID.
|
|
559
|
-
* @format GUID
|
|
560
|
-
*/
|
|
561
|
-
instanceId?: string | null;
|
|
562
|
-
/**
|
|
563
|
-
* Event type.
|
|
564
|
-
* @maxLength 150
|
|
565
|
-
*/
|
|
566
|
-
eventType?: string;
|
|
567
|
-
/** The identification type and identity data. */
|
|
568
|
-
identity?: IdentificationData;
|
|
569
|
-
/** Stringify payload. */
|
|
570
|
-
data?: string;
|
|
571
|
-
}
|
|
572
|
-
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
573
|
-
/**
|
|
574
|
-
* ID of a site visitor that has not logged in to the site.
|
|
575
|
-
* @format GUID
|
|
576
|
-
*/
|
|
577
|
-
anonymousVisitorId?: string;
|
|
578
|
-
/**
|
|
579
|
-
* ID of a site visitor that has logged in to the site.
|
|
580
|
-
* @format GUID
|
|
581
|
-
*/
|
|
582
|
-
memberId?: string;
|
|
583
|
-
/**
|
|
584
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
585
|
-
* @format GUID
|
|
586
|
-
*/
|
|
587
|
-
wixUserId?: string;
|
|
588
|
-
/**
|
|
589
|
-
* ID of an app.
|
|
590
|
-
* @format GUID
|
|
591
|
-
*/
|
|
592
|
-
appId?: string;
|
|
593
|
-
/** @readonly */
|
|
594
|
-
identityType?: WebhookIdentityType;
|
|
595
|
-
}
|
|
596
|
-
/** @oneof */
|
|
597
|
-
export interface IdentificationDataIdOneOf {
|
|
598
|
-
/**
|
|
599
|
-
* ID of a site visitor that has not logged in to the site.
|
|
600
|
-
* @format GUID
|
|
601
|
-
*/
|
|
602
|
-
anonymousVisitorId?: string;
|
|
603
|
-
/**
|
|
604
|
-
* ID of a site visitor that has logged in to the site.
|
|
605
|
-
* @format GUID
|
|
606
|
-
*/
|
|
607
|
-
memberId?: string;
|
|
608
|
-
/**
|
|
609
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
610
|
-
* @format GUID
|
|
611
|
-
*/
|
|
612
|
-
wixUserId?: string;
|
|
613
|
-
/**
|
|
614
|
-
* ID of an app.
|
|
615
|
-
* @format GUID
|
|
616
|
-
*/
|
|
617
|
-
appId?: string;
|
|
618
|
-
}
|
|
619
|
-
export declare enum WebhookIdentityType {
|
|
620
|
-
UNKNOWN = "UNKNOWN",
|
|
621
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
622
|
-
MEMBER = "MEMBER",
|
|
623
|
-
WIX_USER = "WIX_USER",
|
|
624
|
-
APP = "APP"
|
|
625
|
-
}
|
|
475
|
+
/** @enumType */
|
|
476
|
+
export type IdentityTypeWithLiterals = IdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
626
477
|
export interface FileReady {
|
|
627
478
|
/** File entity that is ready with full information. */
|
|
628
479
|
file?: FileDescriptor;
|
|
@@ -658,6 +509,12 @@ export interface ApplicationError {
|
|
|
658
509
|
/** Data related to the error. */
|
|
659
510
|
data?: Record<string, any> | null;
|
|
660
511
|
}
|
|
512
|
+
export interface DraftFilePublished {
|
|
513
|
+
/** The file after it was published */
|
|
514
|
+
file?: FileDescriptor;
|
|
515
|
+
/** The namespace the file was published to */
|
|
516
|
+
namespace?: NamespaceWithLiterals;
|
|
517
|
+
}
|
|
661
518
|
export interface BulkAnnotateImagesRequest {
|
|
662
519
|
/**
|
|
663
520
|
* The file ids to run detection on
|
|
@@ -671,7 +528,7 @@ export interface BulkAnnotateImagesRequest {
|
|
|
671
528
|
* @minSize 1
|
|
672
529
|
* @maxSize 10
|
|
673
530
|
*/
|
|
674
|
-
annotationTypes?:
|
|
531
|
+
annotationTypes?: ImageAnnotationTypeWithLiterals[];
|
|
675
532
|
/** When true the endpoint will detect listed information even if the image has this information */
|
|
676
533
|
overwrite?: boolean | null;
|
|
677
534
|
/** Should the response return the item following the operation */
|
|
@@ -686,6 +543,8 @@ export declare enum ImageAnnotationType {
|
|
|
686
543
|
COLORS = "COLORS",
|
|
687
544
|
CAPTION = "CAPTION"
|
|
688
545
|
}
|
|
546
|
+
/** @enumType */
|
|
547
|
+
export type ImageAnnotationTypeWithLiterals = ImageAnnotationType | 'UNKNOWN_IMAGE_ANNOTATION_TYPE' | 'CONTAINS_TEXT' | 'IS_ANIMATED' | 'FACES' | 'LABELS' | 'COLORS' | 'CAPTION';
|
|
689
548
|
export interface BulkAnnotateImagesResponse {
|
|
690
549
|
/** Results of individual items */
|
|
691
550
|
results?: BulkAnnotateImageResult[];
|
|
@@ -782,7 +641,7 @@ export interface GenerateFileDownloadUrlRequest {
|
|
|
782
641
|
*
|
|
783
642
|
* Default: `ATTACHMENT`
|
|
784
643
|
*/
|
|
785
|
-
contentDisposition?:
|
|
644
|
+
contentDisposition?: ContentDispositionWithLiterals;
|
|
786
645
|
}
|
|
787
646
|
export declare enum ContentDisposition {
|
|
788
647
|
/** Using the link in the browser will download the file */
|
|
@@ -790,6 +649,8 @@ export declare enum ContentDisposition {
|
|
|
790
649
|
/** Using the link in the browser will open the file in the browser */
|
|
791
650
|
INLINE = "INLINE"
|
|
792
651
|
}
|
|
652
|
+
/** @enumType */
|
|
653
|
+
export type ContentDispositionWithLiterals = ContentDisposition | 'ATTACHMENT' | 'INLINE';
|
|
793
654
|
export interface GenerateFileDownloadUrlResponse {
|
|
794
655
|
/**
|
|
795
656
|
* URL for downloading a specific file in the Media Manager.
|
|
@@ -935,7 +796,7 @@ export interface ImageAnnotationConfigurations {
|
|
|
935
796
|
* Default will be all detections
|
|
936
797
|
* @maxSize 10
|
|
937
798
|
*/
|
|
938
|
-
annotationTypes?:
|
|
799
|
+
annotationTypes?: ImageAnnotationTypeWithLiterals[];
|
|
939
800
|
}
|
|
940
801
|
export interface GenerateFileUploadUrlResponse {
|
|
941
802
|
/**
|
|
@@ -1027,7 +888,7 @@ export interface GenerateFileResumableUploadUrlRequest {
|
|
|
1027
888
|
*/
|
|
1028
889
|
labels?: string[] | null;
|
|
1029
890
|
/** The upload protocol to use for implementing the resumable upload. */
|
|
1030
|
-
uploadProtocol?:
|
|
891
|
+
uploadProtocol?: UploadProtocolWithLiterals;
|
|
1031
892
|
/**
|
|
1032
893
|
* Path to the folder where the file will be stored.
|
|
1033
894
|
* For example, `/videos/2024/december`. <br/>
|
|
@@ -1041,9 +902,11 @@ export declare enum UploadProtocol {
|
|
|
1041
902
|
/** The upload protocol to use for implementing the resumable upload. */
|
|
1042
903
|
TUS = "TUS"
|
|
1043
904
|
}
|
|
905
|
+
/** @enumType */
|
|
906
|
+
export type UploadProtocolWithLiterals = UploadProtocol | 'TUS';
|
|
1044
907
|
export interface GenerateFileResumableUploadUrlResponse {
|
|
1045
908
|
/** The upload protocol to use for implementing the resumable upload. */
|
|
1046
|
-
uploadProtocol?:
|
|
909
|
+
uploadProtocol?: UploadProtocolWithLiterals;
|
|
1047
910
|
/**
|
|
1048
911
|
* The URL for uploading a file to the Media Manager.
|
|
1049
912
|
* @format WEB_URL
|
|
@@ -1065,7 +928,7 @@ export interface ImportFileRequest {
|
|
|
1065
928
|
* Media type of the file to import.
|
|
1066
929
|
* excluding: OTHER media type
|
|
1067
930
|
*/
|
|
1068
|
-
mediaType?:
|
|
931
|
+
mediaType?: MediaTypeWithLiterals;
|
|
1069
932
|
/**
|
|
1070
933
|
* File name that appears in the Media Manager.
|
|
1071
934
|
* @maxLength 200
|
|
@@ -1158,7 +1021,7 @@ export interface ListFilesRequest {
|
|
|
1158
1021
|
* File media type.
|
|
1159
1022
|
* @maxSize 30
|
|
1160
1023
|
*/
|
|
1161
|
-
mediaTypes?:
|
|
1024
|
+
mediaTypes?: MediaTypeWithLiterals[];
|
|
1162
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)). */
|
|
1163
1026
|
private?: boolean | null;
|
|
1164
1027
|
/**
|
|
@@ -1179,12 +1042,14 @@ export interface Sorting {
|
|
|
1179
1042
|
*/
|
|
1180
1043
|
fieldName?: string;
|
|
1181
1044
|
/** Sort order. */
|
|
1182
|
-
order?:
|
|
1045
|
+
order?: SortOrderWithLiterals;
|
|
1183
1046
|
}
|
|
1184
1047
|
export declare enum SortOrder {
|
|
1185
1048
|
ASC = "ASC",
|
|
1186
1049
|
DESC = "DESC"
|
|
1187
1050
|
}
|
|
1051
|
+
/** @enumType */
|
|
1052
|
+
export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
1188
1053
|
export interface CursorPaging {
|
|
1189
1054
|
/**
|
|
1190
1055
|
* Maximum number of items to return in the results.
|
|
@@ -1234,12 +1099,12 @@ export interface SearchFilesRequest {
|
|
|
1234
1099
|
* A root folder in the media manager to search in. <br />
|
|
1235
1100
|
* Default: `MEDIA_ROOT`.
|
|
1236
1101
|
*/
|
|
1237
|
-
rootFolder?:
|
|
1102
|
+
rootFolder?: RootFolderWithLiterals;
|
|
1238
1103
|
/**
|
|
1239
1104
|
* File media type.
|
|
1240
1105
|
* @maxSize 30
|
|
1241
1106
|
*/
|
|
1242
|
-
mediaTypes?:
|
|
1107
|
+
mediaTypes?: MediaTypeWithLiterals[];
|
|
1243
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)). */
|
|
1244
1109
|
private?: boolean | null;
|
|
1245
1110
|
/**
|
|
@@ -1261,6 +1126,8 @@ export declare enum RootFolder {
|
|
|
1261
1126
|
/** Root of all visitor uploads */
|
|
1262
1127
|
VISITOR_UPLOADS_ROOT = "VISITOR_UPLOADS_ROOT"
|
|
1263
1128
|
}
|
|
1129
|
+
/** @enumType */
|
|
1130
|
+
export type RootFolderWithLiterals = RootFolder | 'MEDIA_ROOT' | 'TRASH_ROOT' | 'VISITOR_UPLOADS_ROOT';
|
|
1264
1131
|
export interface SearchFilesResponse {
|
|
1265
1132
|
/**
|
|
1266
1133
|
* Files matching the query.
|
|
@@ -1280,13 +1147,15 @@ export interface GenerateVideoStreamingUrlRequest {
|
|
|
1280
1147
|
*/
|
|
1281
1148
|
fileId: string;
|
|
1282
1149
|
/** Video stream format. */
|
|
1283
|
-
format?:
|
|
1150
|
+
format?: StreamFormatWithLiterals;
|
|
1284
1151
|
}
|
|
1285
1152
|
export declare enum StreamFormat {
|
|
1286
1153
|
UNKNOWN = "UNKNOWN",
|
|
1287
1154
|
HLS = "HLS",
|
|
1288
1155
|
DASH = "DASH"
|
|
1289
1156
|
}
|
|
1157
|
+
/** @enumType */
|
|
1158
|
+
export type StreamFormatWithLiterals = StreamFormat | 'UNKNOWN' | 'HLS' | 'DASH';
|
|
1290
1159
|
export interface GenerateVideoStreamingUrlResponse {
|
|
1291
1160
|
/** URL for streaming a specific file in the Media Manager. */
|
|
1292
1161
|
downloadUrl?: DownloadUrl;
|
|
@@ -1342,7 +1211,7 @@ export interface ListDeletedFilesRequest {
|
|
|
1342
1211
|
* File media type.
|
|
1343
1212
|
* @maxSize 30
|
|
1344
1213
|
*/
|
|
1345
|
-
mediaTypes?:
|
|
1214
|
+
mediaTypes?: MediaTypeWithLiterals[];
|
|
1346
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)). */
|
|
1347
1216
|
private?: boolean | null;
|
|
1348
1217
|
/**
|
|
@@ -1379,7 +1248,7 @@ export interface BulkPublishDraftFilesRequest {
|
|
|
1379
1248
|
* The namespace the files will be published to
|
|
1380
1249
|
* Note, private files must have a namespace
|
|
1381
1250
|
*/
|
|
1382
|
-
namespace?:
|
|
1251
|
+
namespace?: NamespaceWithLiterals;
|
|
1383
1252
|
/**
|
|
1384
1253
|
* ID of the file's parent folder. <br />
|
|
1385
1254
|
* This folder is the path root for the `filePath`. <br />
|
|
@@ -1444,6 +1313,140 @@ export interface UpdateFileResponse {
|
|
|
1444
1313
|
/** Information about the updated file. */
|
|
1445
1314
|
file?: FileDescriptor;
|
|
1446
1315
|
}
|
|
1316
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
1317
|
+
createdEvent?: EntityCreatedEvent;
|
|
1318
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
1319
|
+
deletedEvent?: EntityDeletedEvent;
|
|
1320
|
+
actionEvent?: ActionEvent;
|
|
1321
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1322
|
+
_id?: string;
|
|
1323
|
+
/**
|
|
1324
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
1325
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
1326
|
+
*/
|
|
1327
|
+
entityFqdn?: string;
|
|
1328
|
+
/**
|
|
1329
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
1330
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
1331
|
+
*/
|
|
1332
|
+
slug?: string;
|
|
1333
|
+
/** ID of the entity associated with the event. */
|
|
1334
|
+
entityId?: string;
|
|
1335
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
1336
|
+
eventTime?: Date | null;
|
|
1337
|
+
/**
|
|
1338
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1339
|
+
* (for example, GDPR).
|
|
1340
|
+
*/
|
|
1341
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1342
|
+
/** If present, indicates the action that triggered the event. */
|
|
1343
|
+
originatedFrom?: string | null;
|
|
1344
|
+
/**
|
|
1345
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
1346
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
1347
|
+
*/
|
|
1348
|
+
entityEventSequence?: string | null;
|
|
1349
|
+
}
|
|
1350
|
+
/** @oneof */
|
|
1351
|
+
export interface DomainEventBodyOneOf {
|
|
1352
|
+
createdEvent?: EntityCreatedEvent;
|
|
1353
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
1354
|
+
deletedEvent?: EntityDeletedEvent;
|
|
1355
|
+
actionEvent?: ActionEvent;
|
|
1356
|
+
}
|
|
1357
|
+
export interface EntityCreatedEvent {
|
|
1358
|
+
entity?: string;
|
|
1359
|
+
}
|
|
1360
|
+
export interface RestoreInfo {
|
|
1361
|
+
deletedDate?: Date | null;
|
|
1362
|
+
}
|
|
1363
|
+
export interface EntityUpdatedEvent {
|
|
1364
|
+
/**
|
|
1365
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1366
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1367
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1368
|
+
*/
|
|
1369
|
+
currentEntity?: string;
|
|
1370
|
+
}
|
|
1371
|
+
export interface EntityDeletedEvent {
|
|
1372
|
+
/** Entity that was deleted. */
|
|
1373
|
+
deletedEntity?: string | null;
|
|
1374
|
+
}
|
|
1375
|
+
export interface ActionEvent {
|
|
1376
|
+
body?: string;
|
|
1377
|
+
}
|
|
1378
|
+
export interface MessageEnvelope {
|
|
1379
|
+
/**
|
|
1380
|
+
* App instance ID.
|
|
1381
|
+
* @format GUID
|
|
1382
|
+
*/
|
|
1383
|
+
instanceId?: string | null;
|
|
1384
|
+
/**
|
|
1385
|
+
* Event type.
|
|
1386
|
+
* @maxLength 150
|
|
1387
|
+
*/
|
|
1388
|
+
eventType?: string;
|
|
1389
|
+
/** The identification type and identity data. */
|
|
1390
|
+
identity?: IdentificationData;
|
|
1391
|
+
/** Stringify payload. */
|
|
1392
|
+
data?: string;
|
|
1393
|
+
}
|
|
1394
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1395
|
+
/**
|
|
1396
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1397
|
+
* @format GUID
|
|
1398
|
+
*/
|
|
1399
|
+
anonymousVisitorId?: string;
|
|
1400
|
+
/**
|
|
1401
|
+
* ID of a site visitor that has logged in to the site.
|
|
1402
|
+
* @format GUID
|
|
1403
|
+
*/
|
|
1404
|
+
memberId?: string;
|
|
1405
|
+
/**
|
|
1406
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1407
|
+
* @format GUID
|
|
1408
|
+
*/
|
|
1409
|
+
wixUserId?: string;
|
|
1410
|
+
/**
|
|
1411
|
+
* ID of an app.
|
|
1412
|
+
* @format GUID
|
|
1413
|
+
*/
|
|
1414
|
+
appId?: string;
|
|
1415
|
+
/** @readonly */
|
|
1416
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1417
|
+
}
|
|
1418
|
+
/** @oneof */
|
|
1419
|
+
export interface IdentificationDataIdOneOf {
|
|
1420
|
+
/**
|
|
1421
|
+
* ID of a site visitor that has not logged in to the site.
|
|
1422
|
+
* @format GUID
|
|
1423
|
+
*/
|
|
1424
|
+
anonymousVisitorId?: string;
|
|
1425
|
+
/**
|
|
1426
|
+
* ID of a site visitor that has logged in to the site.
|
|
1427
|
+
* @format GUID
|
|
1428
|
+
*/
|
|
1429
|
+
memberId?: string;
|
|
1430
|
+
/**
|
|
1431
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
1432
|
+
* @format GUID
|
|
1433
|
+
*/
|
|
1434
|
+
wixUserId?: string;
|
|
1435
|
+
/**
|
|
1436
|
+
* ID of an app.
|
|
1437
|
+
* @format GUID
|
|
1438
|
+
*/
|
|
1439
|
+
appId?: string;
|
|
1440
|
+
}
|
|
1441
|
+
export declare enum WebhookIdentityType {
|
|
1442
|
+
UNKNOWN = "UNKNOWN",
|
|
1443
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1444
|
+
MEMBER = "MEMBER",
|
|
1445
|
+
WIX_USER = "WIX_USER",
|
|
1446
|
+
APP = "APP"
|
|
1447
|
+
}
|
|
1448
|
+
/** @enumType */
|
|
1449
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1447
1450
|
export interface BaseEventMetadata {
|
|
1448
1451
|
/**
|
|
1449
1452
|
* App instance ID.
|
|
@@ -1738,7 +1741,7 @@ export interface GenerateFileDownloadUrlOptions {
|
|
|
1738
1741
|
*
|
|
1739
1742
|
* Default: `ATTACHMENT`
|
|
1740
1743
|
*/
|
|
1741
|
-
contentDisposition?:
|
|
1744
|
+
contentDisposition?: ContentDispositionWithLiterals;
|
|
1742
1745
|
}
|
|
1743
1746
|
/**
|
|
1744
1747
|
* Gets information about a specific file in the Media Manager.
|
|
@@ -1979,7 +1982,7 @@ export interface GenerateFileResumableUploadUrlOptions {
|
|
|
1979
1982
|
*/
|
|
1980
1983
|
labels?: string[] | null;
|
|
1981
1984
|
/** The upload protocol to use for implementing the resumable upload. */
|
|
1982
|
-
uploadProtocol?:
|
|
1985
|
+
uploadProtocol?: UploadProtocolWithLiterals;
|
|
1983
1986
|
/**
|
|
1984
1987
|
* Path to the folder where the file will be stored.
|
|
1985
1988
|
* For example, `/videos/2024/december`. <br/>
|
|
@@ -2039,7 +2042,7 @@ export interface ImportFileOptions {
|
|
|
2039
2042
|
* Media type of the file to import.
|
|
2040
2043
|
* excluding: OTHER media type
|
|
2041
2044
|
*/
|
|
2042
|
-
mediaType?:
|
|
2045
|
+
mediaType?: MediaTypeWithLiterals;
|
|
2043
2046
|
/**
|
|
2044
2047
|
* File name that appears in the Media Manager.
|
|
2045
2048
|
* @maxLength 200
|
|
@@ -2225,7 +2228,7 @@ export interface ListFilesOptions {
|
|
|
2225
2228
|
* File media type.
|
|
2226
2229
|
* @maxSize 30
|
|
2227
2230
|
*/
|
|
2228
|
-
mediaTypes?:
|
|
2231
|
+
mediaTypes?: MediaTypeWithLiterals[];
|
|
2229
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)). */
|
|
2230
2233
|
private?: boolean | null;
|
|
2231
2234
|
/**
|
|
@@ -2284,12 +2287,12 @@ export interface SearchFilesOptions {
|
|
|
2284
2287
|
* A root folder in the media manager to search in. <br />
|
|
2285
2288
|
* Default: `MEDIA_ROOT`.
|
|
2286
2289
|
*/
|
|
2287
|
-
rootFolder?:
|
|
2290
|
+
rootFolder?: RootFolderWithLiterals;
|
|
2288
2291
|
/**
|
|
2289
2292
|
* File media type.
|
|
2290
2293
|
* @maxSize 30
|
|
2291
2294
|
*/
|
|
2292
|
-
mediaTypes?:
|
|
2295
|
+
mediaTypes?: MediaTypeWithLiterals[];
|
|
2293
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)). */
|
|
2294
2297
|
private?: boolean | null;
|
|
2295
2298
|
/**
|
|
@@ -2341,7 +2344,7 @@ export interface SearchFilesOptions {
|
|
|
2341
2344
|
export declare function generateVideoStreamingUrl(fileId: string, options?: GenerateVideoStreamingUrlOptions): Promise<NonNullablePaths<GenerateVideoStreamingUrlResponse, `downloadUrl.url` | `downloadUrl.assetKey`>>;
|
|
2342
2345
|
export interface GenerateVideoStreamingUrlOptions {
|
|
2343
2346
|
/** Video stream format. */
|
|
2344
|
-
format?:
|
|
2347
|
+
format?: StreamFormatWithLiterals;
|
|
2345
2348
|
}
|
|
2346
2349
|
/**
|
|
2347
2350
|
* Deletes the specified files from the Media Manager. <br/>
|
|
@@ -2466,7 +2469,7 @@ export interface ListDeletedFilesOptions {
|
|
|
2466
2469
|
* File media type.
|
|
2467
2470
|
* @maxSize 30
|
|
2468
2471
|
*/
|
|
2469
|
-
mediaTypes?:
|
|
2472
|
+
mediaTypes?: MediaTypeWithLiterals[];
|
|
2470
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)). */
|
|
2471
2474
|
private?: boolean | null;
|
|
2472
2475
|
/**
|
|
@@ -75,14 +75,6 @@ export var IdentityType;
|
|
|
75
75
|
IdentityType["WIX_USER"] = "WIX_USER";
|
|
76
76
|
IdentityType["APP"] = "APP";
|
|
77
77
|
})(IdentityType || (IdentityType = {}));
|
|
78
|
-
export var WebhookIdentityType;
|
|
79
|
-
(function (WebhookIdentityType) {
|
|
80
|
-
WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
|
|
81
|
-
WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
|
|
82
|
-
WebhookIdentityType["MEMBER"] = "MEMBER";
|
|
83
|
-
WebhookIdentityType["WIX_USER"] = "WIX_USER";
|
|
84
|
-
WebhookIdentityType["APP"] = "APP";
|
|
85
|
-
})(WebhookIdentityType || (WebhookIdentityType = {}));
|
|
86
78
|
export var ImageAnnotationType;
|
|
87
79
|
(function (ImageAnnotationType) {
|
|
88
80
|
ImageAnnotationType["UNKNOWN_IMAGE_ANNOTATION_TYPE"] = "UNKNOWN_IMAGE_ANNOTATION_TYPE";
|
|
@@ -125,6 +117,14 @@ export var StreamFormat;
|
|
|
125
117
|
StreamFormat["HLS"] = "HLS";
|
|
126
118
|
StreamFormat["DASH"] = "DASH";
|
|
127
119
|
})(StreamFormat || (StreamFormat = {}));
|
|
120
|
+
export var WebhookIdentityType;
|
|
121
|
+
(function (WebhookIdentityType) {
|
|
122
|
+
WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
|
|
123
|
+
WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
|
|
124
|
+
WebhookIdentityType["MEMBER"] = "MEMBER";
|
|
125
|
+
WebhookIdentityType["WIX_USER"] = "WIX_USER";
|
|
126
|
+
WebhookIdentityType["APP"] = "APP";
|
|
127
|
+
})(WebhookIdentityType || (WebhookIdentityType = {}));
|
|
128
128
|
/**
|
|
129
129
|
* Generates a URL for downloading a compressed file containing specific files in the Media Manager.
|
|
130
130
|
*
|