@wix/auto_sdk_media-collections_media-collections 1.0.0 → 1.0.1
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/collections-v1-collection-media-collections.types.d.ts +295 -71
- package/build/cjs/src/collections-v1-collection-media-collections.types.js.map +1 -1
- package/build/cjs/src/collections-v1-collection-media-collections.universal.d.ts +341 -81
- package/build/cjs/src/collections-v1-collection-media-collections.universal.js.map +1 -1
- package/build/es/src/collections-v1-collection-media-collections.types.d.ts +295 -71
- package/build/es/src/collections-v1-collection-media-collections.types.js.map +1 -1
- package/build/es/src/collections-v1-collection-media-collections.universal.d.ts +341 -81
- package/build/es/src/collections-v1-collection-media-collections.universal.js.map +1 -1
- package/build/internal/cjs/src/collections-v1-collection-media-collections.types.d.ts +295 -71
- package/build/internal/cjs/src/collections-v1-collection-media-collections.types.js.map +1 -1
- package/build/internal/cjs/src/collections-v1-collection-media-collections.universal.d.ts +341 -81
- package/build/internal/cjs/src/collections-v1-collection-media-collections.universal.js.map +1 -1
- package/build/internal/es/src/collections-v1-collection-media-collections.types.d.ts +295 -71
- package/build/internal/es/src/collections-v1-collection-media-collections.types.js.map +1 -1
- package/build/internal/es/src/collections-v1-collection-media-collections.universal.d.ts +341 -81
- package/build/internal/es/src/collections-v1-collection-media-collections.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -2,10 +2,15 @@ export interface MediaCollection {
|
|
|
2
2
|
/**
|
|
3
3
|
* Collection id
|
|
4
4
|
* @readonly
|
|
5
|
+
* @format GUID
|
|
5
6
|
*/
|
|
6
7
|
id?: string;
|
|
7
|
-
/**
|
|
8
|
+
/**
|
|
9
|
+
* Collection name
|
|
10
|
+
* @maxLength 100
|
|
11
|
+
*/
|
|
8
12
|
name?: string;
|
|
13
|
+
/** @maxLength 500 */
|
|
9
14
|
description?: string | null;
|
|
10
15
|
/**
|
|
11
16
|
* total count of MediaCollection members
|
|
@@ -38,13 +43,23 @@ export interface CollectionMember {
|
|
|
38
43
|
/**
|
|
39
44
|
* Member id
|
|
40
45
|
* @readonly
|
|
46
|
+
* @format GUID
|
|
41
47
|
*/
|
|
42
48
|
memberId?: string;
|
|
43
|
-
/**
|
|
49
|
+
/**
|
|
50
|
+
* Member nickname
|
|
51
|
+
* @maxLength 100
|
|
52
|
+
*/
|
|
44
53
|
nickname?: string | null;
|
|
45
|
-
/**
|
|
54
|
+
/**
|
|
55
|
+
* Member slug
|
|
56
|
+
* @maxLength 100
|
|
57
|
+
*/
|
|
46
58
|
slug?: string | null;
|
|
47
|
-
/**
|
|
59
|
+
/**
|
|
60
|
+
* Member photo url
|
|
61
|
+
* @maxLength 200
|
|
62
|
+
*/
|
|
48
63
|
photoUrl?: string | null;
|
|
49
64
|
}
|
|
50
65
|
export interface MediaCollectionItem extends MediaCollectionItemMetadataOneOf {
|
|
@@ -57,6 +72,7 @@ export interface MediaCollectionItem extends MediaCollectionItemMetadataOneOf {
|
|
|
57
72
|
/**
|
|
58
73
|
* item id
|
|
59
74
|
* @readonly
|
|
75
|
+
* @format GUID
|
|
60
76
|
*/
|
|
61
77
|
id?: string | null;
|
|
62
78
|
/** item url for photos or video */
|
|
@@ -167,7 +183,10 @@ export interface WixLinkLinkOneOf {
|
|
|
167
183
|
tpaPage?: TpaPageLink;
|
|
168
184
|
}
|
|
169
185
|
export interface ExternalLink {
|
|
170
|
-
/**
|
|
186
|
+
/**
|
|
187
|
+
* The url of the page
|
|
188
|
+
* @format WEB_URL
|
|
189
|
+
*/
|
|
171
190
|
url?: string;
|
|
172
191
|
/** Where this link should open, supports _self and _blank or any name the user chooses. _self means same page, _blank means new page. */
|
|
173
192
|
target?: string | null;
|
|
@@ -194,7 +213,10 @@ export interface PageLink {
|
|
|
194
213
|
pageId?: string;
|
|
195
214
|
/** Where this link should open, supports _self and _blank or any name the user chooses. _self means same page, _blank means new page. */
|
|
196
215
|
target?: string | null;
|
|
197
|
-
/**
|
|
216
|
+
/**
|
|
217
|
+
* rel of link
|
|
218
|
+
* @maxSize 20
|
|
219
|
+
*/
|
|
198
220
|
rel?: LinkRel[];
|
|
199
221
|
}
|
|
200
222
|
export interface AnchorLink {
|
|
@@ -204,7 +226,10 @@ export interface AnchorLink {
|
|
|
204
226
|
anchorDataId?: string;
|
|
205
227
|
/** The page id we want from the site */
|
|
206
228
|
pageId?: string;
|
|
207
|
-
/**
|
|
229
|
+
/**
|
|
230
|
+
* rel of link
|
|
231
|
+
* @maxSize 20
|
|
232
|
+
*/
|
|
208
233
|
rel?: LinkRel[];
|
|
209
234
|
}
|
|
210
235
|
export interface DynamicPageLink {
|
|
@@ -214,7 +239,10 @@ export interface DynamicPageLink {
|
|
|
214
239
|
innerRoute?: string;
|
|
215
240
|
/** The data id (from the JSON page) of the anchor that should be used */
|
|
216
241
|
anchorDataId?: string | null;
|
|
217
|
-
/**
|
|
242
|
+
/**
|
|
243
|
+
* rel of link
|
|
244
|
+
* @maxSize 20
|
|
245
|
+
*/
|
|
218
246
|
rel?: LinkRel[];
|
|
219
247
|
}
|
|
220
248
|
export interface DocumentLink {
|
|
@@ -226,7 +254,10 @@ export interface DocumentLink {
|
|
|
226
254
|
indexable?: boolean;
|
|
227
255
|
}
|
|
228
256
|
export interface EmailLink {
|
|
229
|
-
/**
|
|
257
|
+
/**
|
|
258
|
+
* The email we will be sending a message to
|
|
259
|
+
* @format EMAIL
|
|
260
|
+
*/
|
|
230
261
|
recipient?: string;
|
|
231
262
|
/** The subject of the email */
|
|
232
263
|
subject?: string | null;
|
|
@@ -234,7 +265,11 @@ export interface EmailLink {
|
|
|
234
265
|
body?: string | null;
|
|
235
266
|
}
|
|
236
267
|
export interface PhoneLink {
|
|
237
|
-
/**
|
|
268
|
+
/**
|
|
269
|
+
* The phone number we want to link to
|
|
270
|
+
* @format PHONE
|
|
271
|
+
* @maxLength 100
|
|
272
|
+
*/
|
|
238
273
|
phoneNumber?: string;
|
|
239
274
|
}
|
|
240
275
|
export interface AddressLink {
|
|
@@ -242,7 +277,10 @@ export interface AddressLink {
|
|
|
242
277
|
address?: string;
|
|
243
278
|
}
|
|
244
279
|
export interface WhatsAppLink {
|
|
245
|
-
/**
|
|
280
|
+
/**
|
|
281
|
+
* The whatsApp phone number we want to connect with
|
|
282
|
+
* @format PHONE
|
|
283
|
+
*/
|
|
246
284
|
phoneNumber?: string;
|
|
247
285
|
}
|
|
248
286
|
/** Link to a TPA page */
|
|
@@ -257,7 +295,10 @@ export interface TpaPageLink {
|
|
|
257
295
|
appDefinitionId?: string;
|
|
258
296
|
/** The relativepath of linked page */
|
|
259
297
|
path?: string;
|
|
260
|
-
/**
|
|
298
|
+
/**
|
|
299
|
+
* rel of link
|
|
300
|
+
* @maxSize 20
|
|
301
|
+
*/
|
|
261
302
|
rel?: LinkRel[];
|
|
262
303
|
}
|
|
263
304
|
export declare enum DataType {
|
|
@@ -275,7 +316,11 @@ export interface PhotoMetadata {
|
|
|
275
316
|
focalPoint?: Point;
|
|
276
317
|
/** aka Exchangeable image file format */
|
|
277
318
|
exif?: Record<string, any> | null;
|
|
278
|
-
/**
|
|
319
|
+
/**
|
|
320
|
+
* the image quality
|
|
321
|
+
* @min 30
|
|
322
|
+
* @max 100
|
|
323
|
+
*/
|
|
279
324
|
quality?: number | null;
|
|
280
325
|
/** photo sharpening */
|
|
281
326
|
unsharpMasking?: UnsharpMasking;
|
|
@@ -289,11 +334,17 @@ export interface Point {
|
|
|
289
334
|
y?: number;
|
|
290
335
|
}
|
|
291
336
|
export interface UnsharpMasking {
|
|
292
|
-
/**
|
|
337
|
+
/**
|
|
338
|
+
* number controls the amount of contrast that is added at the edges.
|
|
339
|
+
* @max 5
|
|
340
|
+
*/
|
|
293
341
|
amount?: number | null;
|
|
294
342
|
/** number in pixels. The size of the edges to be enhanced */
|
|
295
343
|
radius?: number | null;
|
|
296
|
-
/**
|
|
344
|
+
/**
|
|
345
|
+
* The minimal level of brightness change that will be sharpened
|
|
346
|
+
* @max 1
|
|
347
|
+
*/
|
|
297
348
|
threshold?: number | null;
|
|
298
349
|
}
|
|
299
350
|
export interface VideoMetadata {
|
|
@@ -373,6 +424,7 @@ export declare enum PrivacySettings {
|
|
|
373
424
|
Secret = "Secret"
|
|
374
425
|
}
|
|
375
426
|
export interface PermanentSiteDeletedResponse {
|
|
427
|
+
/** @format GUID */
|
|
376
428
|
requestId?: string;
|
|
377
429
|
uniqueServiceIdentifier?: string;
|
|
378
430
|
status?: Status;
|
|
@@ -459,9 +511,15 @@ export interface ActionEvent {
|
|
|
459
511
|
bodyAsJson?: string;
|
|
460
512
|
}
|
|
461
513
|
export interface MessageEnvelope {
|
|
462
|
-
/**
|
|
514
|
+
/**
|
|
515
|
+
* App instance ID.
|
|
516
|
+
* @format GUID
|
|
517
|
+
*/
|
|
463
518
|
instanceId?: string | null;
|
|
464
|
-
/**
|
|
519
|
+
/**
|
|
520
|
+
* Event type.
|
|
521
|
+
* @maxLength 150
|
|
522
|
+
*/
|
|
465
523
|
eventType?: string;
|
|
466
524
|
/** The identification type and identity data. */
|
|
467
525
|
identity?: IdentificationData;
|
|
@@ -469,26 +527,50 @@ export interface MessageEnvelope {
|
|
|
469
527
|
data?: string;
|
|
470
528
|
}
|
|
471
529
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
472
|
-
/**
|
|
530
|
+
/**
|
|
531
|
+
* ID of a site visitor that has not logged in to the site.
|
|
532
|
+
* @format GUID
|
|
533
|
+
*/
|
|
473
534
|
anonymousVisitorId?: string;
|
|
474
|
-
/**
|
|
535
|
+
/**
|
|
536
|
+
* ID of a site visitor that has logged in to the site.
|
|
537
|
+
* @format GUID
|
|
538
|
+
*/
|
|
475
539
|
memberId?: string;
|
|
476
|
-
/**
|
|
540
|
+
/**
|
|
541
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
542
|
+
* @format GUID
|
|
543
|
+
*/
|
|
477
544
|
wixUserId?: string;
|
|
478
|
-
/**
|
|
545
|
+
/**
|
|
546
|
+
* ID of an app.
|
|
547
|
+
* @format GUID
|
|
548
|
+
*/
|
|
479
549
|
appId?: string;
|
|
480
550
|
/** @readonly */
|
|
481
551
|
identityType?: WebhookIdentityType;
|
|
482
552
|
}
|
|
483
553
|
/** @oneof */
|
|
484
554
|
export interface IdentificationDataIdOneOf {
|
|
485
|
-
/**
|
|
555
|
+
/**
|
|
556
|
+
* ID of a site visitor that has not logged in to the site.
|
|
557
|
+
* @format GUID
|
|
558
|
+
*/
|
|
486
559
|
anonymousVisitorId?: string;
|
|
487
|
-
/**
|
|
560
|
+
/**
|
|
561
|
+
* ID of a site visitor that has logged in to the site.
|
|
562
|
+
* @format GUID
|
|
563
|
+
*/
|
|
488
564
|
memberId?: string;
|
|
489
|
-
/**
|
|
565
|
+
/**
|
|
566
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
567
|
+
* @format GUID
|
|
568
|
+
*/
|
|
490
569
|
wixUserId?: string;
|
|
491
|
-
/**
|
|
570
|
+
/**
|
|
571
|
+
* ID of an app.
|
|
572
|
+
* @format GUID
|
|
573
|
+
*/
|
|
492
574
|
appId?: string;
|
|
493
575
|
}
|
|
494
576
|
export declare enum WebhookIdentityType {
|
|
@@ -524,19 +606,37 @@ export interface CollectionEventEventTypeOneOf {
|
|
|
524
606
|
memberLeftCollection?: MemberLeftCollection;
|
|
525
607
|
}
|
|
526
608
|
export interface CollectionItemId {
|
|
527
|
-
/**
|
|
609
|
+
/**
|
|
610
|
+
* Id of the gallery in ProGallery
|
|
611
|
+
* @format GUID
|
|
612
|
+
*/
|
|
528
613
|
galleryId?: string;
|
|
529
|
-
/**
|
|
614
|
+
/**
|
|
615
|
+
* Id of the item in ProGallery
|
|
616
|
+
* @format GUID
|
|
617
|
+
*/
|
|
530
618
|
itemId?: string;
|
|
531
619
|
}
|
|
532
620
|
export interface CollectionCreated {
|
|
533
|
-
/**
|
|
621
|
+
/**
|
|
622
|
+
* Collection id
|
|
623
|
+
* @format GUID
|
|
624
|
+
*/
|
|
534
625
|
id?: string;
|
|
535
|
-
/**
|
|
626
|
+
/**
|
|
627
|
+
* Collection name
|
|
628
|
+
* @maxLength 100
|
|
629
|
+
*/
|
|
536
630
|
name?: string;
|
|
537
|
-
/**
|
|
631
|
+
/**
|
|
632
|
+
* Collection description
|
|
633
|
+
* @maxLength 500
|
|
634
|
+
*/
|
|
538
635
|
description?: string | null;
|
|
539
|
-
/**
|
|
636
|
+
/**
|
|
637
|
+
* Id of the member who created the collection
|
|
638
|
+
* @format GUID
|
|
639
|
+
*/
|
|
540
640
|
creatorMemberId?: string;
|
|
541
641
|
/** When the collection was created */
|
|
542
642
|
createdDate?: Date | null;
|
|
@@ -544,9 +644,15 @@ export interface CollectionCreated {
|
|
|
544
644
|
privacySettings?: PrivacySettings;
|
|
545
645
|
}
|
|
546
646
|
export interface ItemsAddedToCollection {
|
|
547
|
-
/**
|
|
647
|
+
/**
|
|
648
|
+
* Id of the collection
|
|
649
|
+
* @format GUID
|
|
650
|
+
*/
|
|
548
651
|
collectionId?: string;
|
|
549
|
-
/**
|
|
652
|
+
/**
|
|
653
|
+
* Id of the member who added items
|
|
654
|
+
* @format GUID
|
|
655
|
+
*/
|
|
550
656
|
addedByMember?: string;
|
|
551
657
|
/** Ids of the items that were added */
|
|
552
658
|
collectionItemIds?: CollectionItemId[];
|
|
@@ -554,37 +660,65 @@ export interface ItemsAddedToCollection {
|
|
|
554
660
|
addedDate?: Date | null;
|
|
555
661
|
}
|
|
556
662
|
export interface ItemsRemovedFromCollection {
|
|
557
|
-
/**
|
|
663
|
+
/**
|
|
664
|
+
* Id of the collection
|
|
665
|
+
* @format GUID
|
|
666
|
+
*/
|
|
558
667
|
collectionId?: string;
|
|
559
|
-
/**
|
|
668
|
+
/**
|
|
669
|
+
* Id of the member who removed items
|
|
670
|
+
* @format GUID
|
|
671
|
+
*/
|
|
560
672
|
removedByMember?: string;
|
|
561
|
-
/**
|
|
673
|
+
/**
|
|
674
|
+
* Ids of the items that were removed
|
|
675
|
+
* @format GUID
|
|
676
|
+
*/
|
|
562
677
|
itemIds?: string[];
|
|
563
678
|
/** When the items were removed */
|
|
564
679
|
removedDate?: Date | null;
|
|
565
680
|
}
|
|
566
681
|
export interface MemberJoinedToCollection {
|
|
567
|
-
/**
|
|
682
|
+
/**
|
|
683
|
+
* Id of the collection
|
|
684
|
+
* @format GUID
|
|
685
|
+
*/
|
|
568
686
|
collectionId?: string;
|
|
569
|
-
/**
|
|
687
|
+
/**
|
|
688
|
+
* Id of the member who joined
|
|
689
|
+
* @format GUID
|
|
690
|
+
*/
|
|
570
691
|
memberId?: string;
|
|
571
692
|
/** When the member was joined */
|
|
572
693
|
joinedDate?: Date | null;
|
|
573
694
|
}
|
|
574
695
|
export interface MemberLeftCollection {
|
|
575
|
-
/**
|
|
696
|
+
/**
|
|
697
|
+
* Id of the collection
|
|
698
|
+
* @format GUID
|
|
699
|
+
*/
|
|
576
700
|
collectionId?: string;
|
|
577
|
-
/**
|
|
701
|
+
/**
|
|
702
|
+
* Id of the member who left
|
|
703
|
+
* @format GUID
|
|
704
|
+
*/
|
|
578
705
|
memberId?: string;
|
|
579
706
|
/** When the member left */
|
|
580
707
|
leftDate?: Date | null;
|
|
581
708
|
}
|
|
582
709
|
export interface GetMediaCollectionRequest {
|
|
583
|
-
/**
|
|
710
|
+
/**
|
|
711
|
+
* Collection id
|
|
712
|
+
* @format GUID
|
|
713
|
+
*/
|
|
584
714
|
mediaCollectionId: string;
|
|
585
715
|
/** number of items to skip in the current sort order, default is 0 */
|
|
586
716
|
offset?: number | null;
|
|
587
|
-
/**
|
|
717
|
+
/**
|
|
718
|
+
* The amount of items per response, default is 50
|
|
719
|
+
* @min 1
|
|
720
|
+
* @max 200
|
|
721
|
+
*/
|
|
588
722
|
limit?: number | null;
|
|
589
723
|
}
|
|
590
724
|
export interface GetMediaCollectionResponse {
|
|
@@ -604,9 +738,15 @@ export declare enum MemberStatus {
|
|
|
604
738
|
ADMIN = "ADMIN"
|
|
605
739
|
}
|
|
606
740
|
export interface ListCollectionsForItemRequest {
|
|
607
|
-
/**
|
|
741
|
+
/**
|
|
742
|
+
* Gallery id
|
|
743
|
+
* @format GUID
|
|
744
|
+
*/
|
|
608
745
|
galleryId?: string;
|
|
609
|
-
/**
|
|
746
|
+
/**
|
|
747
|
+
* Item id
|
|
748
|
+
* @format GUID
|
|
749
|
+
*/
|
|
610
750
|
itemId: string;
|
|
611
751
|
}
|
|
612
752
|
export interface ListCollectionsForItemResponse {
|
|
@@ -614,9 +754,16 @@ export interface ListCollectionsForItemResponse {
|
|
|
614
754
|
itemInCollections?: ItemInCollection[];
|
|
615
755
|
}
|
|
616
756
|
export interface ItemInCollection {
|
|
617
|
-
/**
|
|
757
|
+
/**
|
|
758
|
+
* Collection id
|
|
759
|
+
* @format GUID
|
|
760
|
+
*/
|
|
618
761
|
mediaCollectionId?: string;
|
|
619
|
-
/**
|
|
762
|
+
/**
|
|
763
|
+
* Collection name
|
|
764
|
+
* @minLength 1
|
|
765
|
+
* @maxLength 100
|
|
766
|
+
*/
|
|
620
767
|
name?: string;
|
|
621
768
|
/** Is the item in the collection */
|
|
622
769
|
isItemInCollection?: boolean;
|
|
@@ -628,13 +775,22 @@ export interface ItemInCollection {
|
|
|
628
775
|
totalItemsCount?: number | null;
|
|
629
776
|
/** The first item in the collection */
|
|
630
777
|
firstItem?: MediaCollectionItem;
|
|
631
|
-
/**
|
|
778
|
+
/**
|
|
779
|
+
* The creator's nickname
|
|
780
|
+
* @maxLength 100
|
|
781
|
+
*/
|
|
632
782
|
creatorNickname?: string | null;
|
|
633
783
|
}
|
|
634
784
|
export interface GetCollectionItemRequest {
|
|
635
|
-
/**
|
|
785
|
+
/**
|
|
786
|
+
* Collection id
|
|
787
|
+
* @format GUID
|
|
788
|
+
*/
|
|
636
789
|
mediaCollectionId: string;
|
|
637
|
-
/**
|
|
790
|
+
/**
|
|
791
|
+
* Item id
|
|
792
|
+
* @format GUID
|
|
793
|
+
*/
|
|
638
794
|
itemId: string;
|
|
639
795
|
}
|
|
640
796
|
export interface GetCollectionItemResponse {
|
|
@@ -642,7 +798,11 @@ export interface GetCollectionItemResponse {
|
|
|
642
798
|
item?: MediaCollectionItem;
|
|
643
799
|
}
|
|
644
800
|
export interface ListMediaCollectionsRequest {
|
|
645
|
-
/**
|
|
801
|
+
/**
|
|
802
|
+
* the amount of collections per response, default is 1000
|
|
803
|
+
* @min 1
|
|
804
|
+
* @max 2000
|
|
805
|
+
*/
|
|
646
806
|
limit?: number | null;
|
|
647
807
|
/** number of collections to skip in the current sort order, default is 0 */
|
|
648
808
|
offset?: number | null;
|
|
@@ -671,9 +831,16 @@ export interface CollectionAndStatus {
|
|
|
671
831
|
memberStatus?: MemberStatus;
|
|
672
832
|
}
|
|
673
833
|
export interface CreateMediaCollectionRequest {
|
|
674
|
-
/**
|
|
834
|
+
/**
|
|
835
|
+
* Name of the collection
|
|
836
|
+
* @minLength 1
|
|
837
|
+
* @maxLength 100
|
|
838
|
+
*/
|
|
675
839
|
name: string;
|
|
676
|
-
/**
|
|
840
|
+
/**
|
|
841
|
+
* Description of the collection
|
|
842
|
+
* @maxLength 500
|
|
843
|
+
*/
|
|
677
844
|
description?: string | null;
|
|
678
845
|
/** Privacy settings of the collection */
|
|
679
846
|
privacySettings?: PrivacySettings;
|
|
@@ -681,15 +848,24 @@ export interface CreateMediaCollectionRequest {
|
|
|
681
848
|
items?: AddItem[];
|
|
682
849
|
}
|
|
683
850
|
export interface AddItem {
|
|
684
|
-
/**
|
|
851
|
+
/**
|
|
852
|
+
* Gallery id
|
|
853
|
+
* @format GUID
|
|
854
|
+
*/
|
|
685
855
|
galleryId?: string;
|
|
686
|
-
/**
|
|
856
|
+
/**
|
|
857
|
+
* Item id
|
|
858
|
+
* @format GUID
|
|
859
|
+
*/
|
|
687
860
|
itemId?: string;
|
|
688
861
|
/** Order index of the item */
|
|
689
862
|
orderIndex?: number | null;
|
|
690
863
|
}
|
|
691
864
|
export interface CreateMediaCollectionResponse {
|
|
692
|
-
/**
|
|
865
|
+
/**
|
|
866
|
+
* id of the collection that was created
|
|
867
|
+
* @format GUID
|
|
868
|
+
*/
|
|
693
869
|
mediaCollectionId?: string;
|
|
694
870
|
}
|
|
695
871
|
export interface PartiallyUpdateMediaCollectionRequest {
|
|
@@ -704,7 +880,10 @@ export interface PartiallyUpdateMediaCollectionRequest {
|
|
|
704
880
|
export interface PartiallyUpdateMediaCollectionResponse {
|
|
705
881
|
}
|
|
706
882
|
export interface UpdateCollectionLockRequest {
|
|
707
|
-
/**
|
|
883
|
+
/**
|
|
884
|
+
* Collection to lock
|
|
885
|
+
* @format GUID
|
|
886
|
+
*/
|
|
708
887
|
mediaCollectionId?: string;
|
|
709
888
|
/** Lock status */
|
|
710
889
|
locked?: boolean;
|
|
@@ -712,13 +891,19 @@ export interface UpdateCollectionLockRequest {
|
|
|
712
891
|
export interface UpdateCollectionLockResponse {
|
|
713
892
|
}
|
|
714
893
|
export interface DeleteMediaCollectionRequest {
|
|
715
|
-
/**
|
|
894
|
+
/**
|
|
895
|
+
* the collection to delete
|
|
896
|
+
* @format GUID
|
|
897
|
+
*/
|
|
716
898
|
mediaCollectionId: string;
|
|
717
899
|
}
|
|
718
900
|
export interface DeleteMediaCollectionResponse {
|
|
719
901
|
}
|
|
720
902
|
export interface ListCollectionMembersRequest {
|
|
721
|
-
/**
|
|
903
|
+
/**
|
|
904
|
+
* the collection to get its members
|
|
905
|
+
* @format GUID
|
|
906
|
+
*/
|
|
722
907
|
mediaCollectionId: string;
|
|
723
908
|
/** Filter the members by their role in the collection */
|
|
724
909
|
filterBy?: FilterBy;
|
|
@@ -738,7 +923,10 @@ export interface MemberAndStatus {
|
|
|
738
923
|
memberStatus?: MemberStatus;
|
|
739
924
|
}
|
|
740
925
|
export interface AddItemsRequest {
|
|
741
|
-
/**
|
|
926
|
+
/**
|
|
927
|
+
* Collection to add items
|
|
928
|
+
* @format GUID
|
|
929
|
+
*/
|
|
742
930
|
mediaCollectionId: string;
|
|
743
931
|
/** Items to add */
|
|
744
932
|
items?: AddItem[];
|
|
@@ -746,20 +934,32 @@ export interface AddItemsRequest {
|
|
|
746
934
|
export interface AddItemsResponse {
|
|
747
935
|
}
|
|
748
936
|
export interface RemoveItemsRequest {
|
|
749
|
-
/**
|
|
937
|
+
/**
|
|
938
|
+
* Collection to remove items from
|
|
939
|
+
* @format GUID
|
|
940
|
+
*/
|
|
750
941
|
mediaCollectionId: string;
|
|
751
|
-
/**
|
|
942
|
+
/**
|
|
943
|
+
* Items to remove
|
|
944
|
+
* @format GUID
|
|
945
|
+
*/
|
|
752
946
|
itemsIds?: string[];
|
|
753
947
|
}
|
|
754
948
|
export interface RemoveItemsResponse {
|
|
755
949
|
}
|
|
756
950
|
export interface UpdateItemsRequest {
|
|
757
|
-
/**
|
|
951
|
+
/**
|
|
952
|
+
* Collection to update items
|
|
953
|
+
* @format GUID
|
|
954
|
+
*/
|
|
758
955
|
mediaCollectionId?: string;
|
|
759
956
|
items?: UpdateItem[];
|
|
760
957
|
}
|
|
761
958
|
export interface UpdateItem {
|
|
762
|
-
/**
|
|
959
|
+
/**
|
|
960
|
+
* Item to update
|
|
961
|
+
* @format GUID
|
|
962
|
+
*/
|
|
763
963
|
itemId?: string;
|
|
764
964
|
/** New order index of the item */
|
|
765
965
|
orderIndex?: number;
|
|
@@ -767,27 +967,42 @@ export interface UpdateItem {
|
|
|
767
967
|
export interface UpdateItemsResponse {
|
|
768
968
|
}
|
|
769
969
|
export interface JoinToCollectionRequest {
|
|
770
|
-
/**
|
|
970
|
+
/**
|
|
971
|
+
* Collection to join
|
|
972
|
+
* @format GUID
|
|
973
|
+
*/
|
|
771
974
|
mediaCollectionId: string;
|
|
772
975
|
}
|
|
773
976
|
export interface JoinToCollectionResponse {
|
|
774
977
|
}
|
|
775
978
|
export interface RemoveMemberFromCollectionRequest {
|
|
776
|
-
/**
|
|
979
|
+
/**
|
|
980
|
+
* Collection the member will be removed from being a member
|
|
981
|
+
* @format GUID
|
|
982
|
+
*/
|
|
777
983
|
mediaCollectionId?: string;
|
|
778
|
-
/**
|
|
984
|
+
/**
|
|
985
|
+
* Member id to remove from the collection
|
|
986
|
+
* @format GUID
|
|
987
|
+
*/
|
|
779
988
|
memberId?: string;
|
|
780
989
|
}
|
|
781
990
|
export interface RemoveMemberFromCollectionResponse {
|
|
782
991
|
}
|
|
783
992
|
export interface LeaveCollectionRequest {
|
|
784
|
-
/**
|
|
993
|
+
/**
|
|
994
|
+
* Collection the member will be leaving
|
|
995
|
+
* @format GUID
|
|
996
|
+
*/
|
|
785
997
|
mediaCollectionId: string;
|
|
786
998
|
}
|
|
787
999
|
export interface LeaveCollectionResponse {
|
|
788
1000
|
}
|
|
789
1001
|
export interface ListCollectionItemsRequest {
|
|
790
|
-
/**
|
|
1002
|
+
/**
|
|
1003
|
+
* Collection to get its items
|
|
1004
|
+
* @format GUID
|
|
1005
|
+
*/
|
|
791
1006
|
mediaCollectionId: string;
|
|
792
1007
|
}
|
|
793
1008
|
export interface ListCollectionItemsResponse {
|
|
@@ -795,9 +1010,15 @@ export interface ListCollectionItemsResponse {
|
|
|
795
1010
|
collectionItems?: CollectionItem[];
|
|
796
1011
|
}
|
|
797
1012
|
export interface CollectionItem {
|
|
798
|
-
/**
|
|
1013
|
+
/**
|
|
1014
|
+
* Gallery id
|
|
1015
|
+
* @format GUID
|
|
1016
|
+
*/
|
|
799
1017
|
galleryId?: string;
|
|
800
|
-
/**
|
|
1018
|
+
/**
|
|
1019
|
+
* Item id
|
|
1020
|
+
* @format GUID
|
|
1021
|
+
*/
|
|
801
1022
|
itemId?: string;
|
|
802
1023
|
/** Order index of the item */
|
|
803
1024
|
orderIndex?: number | null;
|
|
@@ -807,7 +1028,10 @@ export interface CollectionItem {
|
|
|
807
1028
|
export interface ListAllItemsBelongToCollectionRequest {
|
|
808
1029
|
}
|
|
809
1030
|
export interface ListAllItemsBelongToCollectionResponse {
|
|
810
|
-
/**
|
|
1031
|
+
/**
|
|
1032
|
+
* List of the item ids that belong to one or more collection
|
|
1033
|
+
* @format GUID
|
|
1034
|
+
*/
|
|
811
1035
|
itemIds?: string[];
|
|
812
1036
|
}
|
|
813
1037
|
interface CollectionMemberNonNullableFields {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"collections-v1-collection-media-collections.types.js","sourceRoot":"","sources":["../../../../src/collections-v1-collection-media-collections.types.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"collections-v1-collection-media-collections.types.js","sourceRoot":"","sources":["../../../../src/collections-v1-collection-media-collections.types.ts"],"names":[],"mappings":"AAuIA,MAAM,CAAN,IAAY,IAOX;AAPD,WAAY,IAAI;IACd,gBAAgB;IAChB,+BAAuB,CAAA;IACvB,oBAAoB;IACpB,6BAAqB,CAAA;IACrB,wBAAwB;IACxB,6BAAqB,CAAA;AACvB,CAAC,EAPW,IAAI,KAAJ,IAAI,QAOf;AA4DD;;;;GAIG;AACH,MAAM,CAAN,IAAY,OAWX;AAXD,WAAY,OAAO;IACjB,gCAAgC;IAChC,gDAAqC,CAAA;IACrC,mHAAmH;IACnH,gCAAqB,CAAA;IACrB,gJAAgJ;IAChJ,gCAAqB,CAAA;IACrB,yFAAyF;IACzF,oCAAyB,CAAA;IACzB,6EAA6E;IAC7E,kCAAuB,CAAA;AACzB,CAAC,EAXW,OAAO,KAAP,OAAO,QAWlB;AAwGD,MAAM,CAAN,IAAY,QAKX;AALD,WAAY,QAAQ;IAClB,mCAAuB,CAAA;IACvB,2BAAe,CAAA;IACf,2BAAe,CAAA;IACf,yBAAa,CAAA;AACf,CAAC,EALW,QAAQ,KAAR,QAAQ,QAKnB;AA8DD,MAAM,CAAN,IAAY,MASX;AATD,WAAY,MAAM;IAChB,gBAAgB;IAChB,iCAAuB,CAAA;IACvB,cAAc;IACd,6BAAmB,CAAA;IACnB,YAAY;IACZ,yBAAe,CAAA;IACf,aAAa;IACb,2BAAiB,CAAA;AACnB,CAAC,EATW,MAAM,KAAN,MAAM,QASjB;AAqCD,MAAM,CAAN,IAAY,UASX;AATD,WAAY,UAAU;IACpB,gBAAgB;IAChB,qCAAuB,CAAA;IACvB,UAAU;IACV,yBAAW,CAAA;IACX,iBAAiB;IACjB,uCAAyB,CAAA;IACzB,aAAa;IACb,+BAAiB,CAAA;AACnB,CAAC,EATW,UAAU,KAAV,UAAU,QASrB;AAED,MAAM,CAAN,IAAY,eAOX;AAPD,WAAY,eAAe;IACzB,gBAAgB;IAChB,0CAAuB,CAAA;IACvB,aAAa;IACb,oCAAiB,CAAA;IACjB,aAAa;IACb,oCAAiB,CAAA;AACnB,CAAC,EAPW,eAAe,KAAf,eAAe,QAO1B;AAWD,MAAM,CAAN,IAAY,MAIX;AAJD,WAAY,MAAM;IAChB,6BAAmB,CAAA;IACnB,6BAAmB,CAAA;IACnB,iDAAuC,CAAA;AACzC,CAAC,EAJW,MAAM,KAAN,MAAM,QAIjB;AAqJD,MAAM,CAAN,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,KAAnB,mBAAmB,QAM9B;AA+JD,MAAM,CAAN,IAAY,YASX;AATD,WAAY,YAAY;IACtB,gBAAgB;IAChB,uCAAuB,CAAA;IACvB,mBAAmB;IACnB,yCAAyB,CAAA;IACzB,aAAa;IACb,iCAAiB,CAAA;IACjB,YAAY;IACZ,+BAAe,CAAA;AACjB,CAAC,EATW,YAAY,KAAZ,YAAY,QASvB"}
|