@wix/auto_sdk_pro-gallery_pro-gallery 1.0.1 → 1.0.3
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/pro-gallery-v2-gallery-pro-gallery.context.d.ts +2 -2
- package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.context.js +2 -2
- package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.context.js.map +1 -1
- package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.http.d.ts +1 -1
- package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.http.js +56 -2
- package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.http.js.map +1 -1
- package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.public.d.ts +1 -1
- package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.public.js.map +1 -1
- package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.types.d.ts +445 -182
- package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.types.js +10 -10
- package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.types.js.map +1 -1
- package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.universal.d.ts +505 -196
- package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.universal.js +11 -11
- package/build/cjs/src/pro-gallery-v2-gallery-pro-gallery.universal.js.map +1 -1
- package/build/es/src/pro-gallery-v2-gallery-pro-gallery.context.d.ts +2 -2
- package/build/es/src/pro-gallery-v2-gallery-pro-gallery.context.js +1 -1
- package/build/es/src/pro-gallery-v2-gallery-pro-gallery.context.js.map +1 -1
- package/build/es/src/pro-gallery-v2-gallery-pro-gallery.http.d.ts +1 -1
- package/build/es/src/pro-gallery-v2-gallery-pro-gallery.http.js +56 -2
- package/build/es/src/pro-gallery-v2-gallery-pro-gallery.http.js.map +1 -1
- package/build/es/src/pro-gallery-v2-gallery-pro-gallery.public.d.ts +1 -1
- package/build/es/src/pro-gallery-v2-gallery-pro-gallery.public.js.map +1 -1
- package/build/es/src/pro-gallery-v2-gallery-pro-gallery.types.d.ts +445 -182
- package/build/es/src/pro-gallery-v2-gallery-pro-gallery.types.js +9 -9
- package/build/es/src/pro-gallery-v2-gallery-pro-gallery.types.js.map +1 -1
- package/build/es/src/pro-gallery-v2-gallery-pro-gallery.universal.d.ts +505 -196
- package/build/es/src/pro-gallery-v2-gallery-pro-gallery.universal.js +10 -10
- package/build/es/src/pro-gallery-v2-gallery-pro-gallery.universal.js.map +1 -1
- package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.context.d.ts +2 -2
- package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.context.js +2 -2
- package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.context.js.map +1 -1
- package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.http.d.ts +1 -1
- package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.http.js +56 -2
- package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.http.js.map +1 -1
- package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.public.d.ts +1 -1
- package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.public.js.map +1 -1
- package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.types.d.ts +445 -182
- package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.types.js +10 -10
- package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.types.js.map +1 -1
- package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.universal.d.ts +505 -196
- package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.universal.js +11 -11
- package/build/internal/cjs/src/pro-gallery-v2-gallery-pro-gallery.universal.js.map +1 -1
- package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.context.d.ts +2 -2
- package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.context.js +1 -1
- package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.context.js.map +1 -1
- package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.http.d.ts +1 -1
- package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.http.js +56 -2
- package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.http.js.map +1 -1
- package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.public.d.ts +1 -1
- package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.public.js.map +1 -1
- package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.types.d.ts +445 -182
- package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.types.js +9 -9
- package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.types.js.map +1 -1
- package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.universal.d.ts +505 -196
- package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.universal.js +10 -10
- package/build/internal/es/src/pro-gallery-v2-gallery-pro-gallery.universal.js.map +1 -1
- package/package.json +2 -2
@@ -2,6 +2,7 @@ export interface Gallery {
|
|
2
2
|
/**
|
3
3
|
* Gallery ID.
|
4
4
|
* @readonly
|
5
|
+
* @format GUID
|
5
6
|
*/
|
6
7
|
_id?: string | null;
|
7
8
|
/** Gallery name. */
|
@@ -35,6 +36,7 @@ export interface Item extends ItemMetadataOneOf {
|
|
35
36
|
/**
|
36
37
|
* Item ID.
|
37
38
|
* @readonly
|
39
|
+
* @format GUID
|
38
40
|
*/
|
39
41
|
_id?: string | null;
|
40
42
|
/**
|
@@ -138,7 +140,10 @@ export interface WixLinkLinkOneOf {
|
|
138
140
|
tpaPage?: TpaPageLink;
|
139
141
|
}
|
140
142
|
export interface ExternalLink {
|
141
|
-
/**
|
143
|
+
/**
|
144
|
+
* The url of the page
|
145
|
+
* @format WEB_URL
|
146
|
+
*/
|
142
147
|
url?: string;
|
143
148
|
/** Where this link should open, supports _self and _blank or any name the user chooses. _self means same page, _blank means new page. */
|
144
149
|
target?: string | null;
|
@@ -165,7 +170,10 @@ export interface PageLink {
|
|
165
170
|
pageId?: string;
|
166
171
|
/** Where this link should open, supports _self and _blank or any name the user chooses. _self means same page, _blank means new page. */
|
167
172
|
target?: string | null;
|
168
|
-
/**
|
173
|
+
/**
|
174
|
+
* rel of link
|
175
|
+
* @maxSize 20
|
176
|
+
*/
|
169
177
|
rel?: LinkRel[];
|
170
178
|
}
|
171
179
|
export interface AnchorLink {
|
@@ -175,7 +183,10 @@ export interface AnchorLink {
|
|
175
183
|
anchorDataId?: string;
|
176
184
|
/** The page id we want from the site */
|
177
185
|
pageId?: string;
|
178
|
-
/**
|
186
|
+
/**
|
187
|
+
* rel of link
|
188
|
+
* @maxSize 20
|
189
|
+
*/
|
179
190
|
rel?: LinkRel[];
|
180
191
|
}
|
181
192
|
export interface DynamicPageLink {
|
@@ -185,7 +196,10 @@ export interface DynamicPageLink {
|
|
185
196
|
innerRoute?: string;
|
186
197
|
/** The data id (from the JSON page) of the anchor that should be used */
|
187
198
|
anchorDataId?: string | null;
|
188
|
-
/**
|
199
|
+
/**
|
200
|
+
* rel of link
|
201
|
+
* @maxSize 20
|
202
|
+
*/
|
189
203
|
rel?: LinkRel[];
|
190
204
|
}
|
191
205
|
export interface DocumentLink {
|
@@ -197,7 +211,10 @@ export interface DocumentLink {
|
|
197
211
|
indexable?: boolean;
|
198
212
|
}
|
199
213
|
export interface EmailLink {
|
200
|
-
/**
|
214
|
+
/**
|
215
|
+
* The email we will be sending a message to
|
216
|
+
* @format EMAIL
|
217
|
+
*/
|
201
218
|
recipient?: string;
|
202
219
|
/** The subject of the email */
|
203
220
|
subject?: string | null;
|
@@ -205,7 +222,11 @@ export interface EmailLink {
|
|
205
222
|
body?: string | null;
|
206
223
|
}
|
207
224
|
export interface PhoneLink {
|
208
|
-
/**
|
225
|
+
/**
|
226
|
+
* The phone number we want to link to
|
227
|
+
* @format PHONE
|
228
|
+
* @maxLength 100
|
229
|
+
*/
|
209
230
|
phoneNumber?: string;
|
210
231
|
}
|
211
232
|
export interface AddressLink {
|
@@ -213,7 +234,10 @@ export interface AddressLink {
|
|
213
234
|
address?: string;
|
214
235
|
}
|
215
236
|
export interface WhatsAppLink {
|
216
|
-
/**
|
237
|
+
/**
|
238
|
+
* The whatsApp phone number we want to connect with
|
239
|
+
* @format PHONE
|
240
|
+
*/
|
217
241
|
phoneNumber?: string;
|
218
242
|
}
|
219
243
|
/** Link to a TPA page */
|
@@ -228,7 +252,10 @@ export interface TpaPageLink {
|
|
228
252
|
appDefinitionId?: string;
|
229
253
|
/** The relativepath of linked page */
|
230
254
|
path?: string;
|
231
|
-
/**
|
255
|
+
/**
|
256
|
+
* rel of link
|
257
|
+
* @maxSize 20
|
258
|
+
*/
|
232
259
|
rel?: LinkRel[];
|
233
260
|
}
|
234
261
|
export declare enum Type {
|
@@ -249,6 +276,8 @@ export interface Image {
|
|
249
276
|
*
|
250
277
|
* Min: `30` <br />
|
251
278
|
* Max: `100`
|
279
|
+
* @min 30
|
280
|
+
* @max 100
|
252
281
|
*/
|
253
282
|
quality?: number | null;
|
254
283
|
/** [Unsharp masking](https://en.wikipedia.org/wiki/Unsharp_masking) values of the image. */
|
@@ -271,6 +300,7 @@ export interface UnsharpMasking {
|
|
271
300
|
*
|
272
301
|
* Min: `0` <br />
|
273
302
|
* Max: `5`
|
303
|
+
* @max 5
|
274
304
|
*/
|
275
305
|
amount?: number | null;
|
276
306
|
/** Unsharp masking radius in pixels. Controls the sharpening width. */
|
@@ -280,6 +310,7 @@ export interface UnsharpMasking {
|
|
280
310
|
*
|
281
311
|
* Min: `0` <br />
|
282
312
|
* Max: `1`
|
313
|
+
* @max 1
|
283
314
|
*/
|
284
315
|
threshold?: number | null;
|
285
316
|
}
|
@@ -351,9 +382,15 @@ export interface SecondaryMediaMetadataOneOf {
|
|
351
382
|
text?: Text;
|
352
383
|
}
|
353
384
|
export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
354
|
-
/**
|
385
|
+
/**
|
386
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
387
|
+
* @format GUID
|
388
|
+
*/
|
355
389
|
metaSiteId?: string;
|
356
|
-
/**
|
390
|
+
/**
|
391
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
392
|
+
* @format GUID
|
393
|
+
*/
|
357
394
|
siteId?: string;
|
358
395
|
/** Invalidate by App */
|
359
396
|
app?: App;
|
@@ -363,7 +400,10 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
363
400
|
uri?: URI;
|
364
401
|
/** Invalidate by file (for media files such as PDFs) */
|
365
402
|
file?: File;
|
366
|
-
/**
|
403
|
+
/**
|
404
|
+
* tell us why you're invalidating the cache. You don't need to add your app name
|
405
|
+
* @maxLength 256
|
406
|
+
*/
|
367
407
|
reason?: string | null;
|
368
408
|
/** Is local DS */
|
369
409
|
localDc?: boolean;
|
@@ -371,9 +411,15 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
371
411
|
}
|
372
412
|
/** @oneof */
|
373
413
|
export interface InvalidateCacheGetByOneOf {
|
374
|
-
/**
|
414
|
+
/**
|
415
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
416
|
+
* @format GUID
|
417
|
+
*/
|
375
418
|
metaSiteId?: string;
|
376
|
-
/**
|
419
|
+
/**
|
420
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
421
|
+
* @format GUID
|
422
|
+
*/
|
377
423
|
siteId?: string;
|
378
424
|
/** Invalidate by App */
|
379
425
|
app?: App;
|
@@ -385,33 +431,59 @@ export interface InvalidateCacheGetByOneOf {
|
|
385
431
|
file?: File;
|
386
432
|
}
|
387
433
|
export interface App {
|
388
|
-
/**
|
434
|
+
/**
|
435
|
+
* The AppDefId
|
436
|
+
* @minLength 1
|
437
|
+
*/
|
389
438
|
appDefId?: string;
|
390
|
-
/**
|
439
|
+
/**
|
440
|
+
* The instance Id
|
441
|
+
* @format GUID
|
442
|
+
*/
|
391
443
|
instanceId?: string;
|
392
444
|
}
|
393
445
|
export interface Page {
|
394
|
-
/**
|
446
|
+
/**
|
447
|
+
* the msid the page is on
|
448
|
+
* @format GUID
|
449
|
+
*/
|
395
450
|
metaSiteId?: string;
|
396
|
-
/**
|
451
|
+
/**
|
452
|
+
* Invalidate by Page ID
|
453
|
+
* @minLength 1
|
454
|
+
*/
|
397
455
|
pageId?: string;
|
398
456
|
}
|
399
457
|
export interface URI {
|
400
|
-
/**
|
458
|
+
/**
|
459
|
+
* the msid the URI is on
|
460
|
+
* @format GUID
|
461
|
+
*/
|
401
462
|
metaSiteId?: string;
|
402
|
-
/**
|
463
|
+
/**
|
464
|
+
* URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
|
465
|
+
* @minLength 1
|
466
|
+
*/
|
403
467
|
uriPath?: string;
|
404
468
|
}
|
405
469
|
export interface File {
|
406
|
-
/**
|
470
|
+
/**
|
471
|
+
* the msid the file is related to
|
472
|
+
* @format GUID
|
473
|
+
*/
|
407
474
|
metaSiteId?: string;
|
408
|
-
/**
|
475
|
+
/**
|
476
|
+
* Invalidate by filename (for media files such as PDFs)
|
477
|
+
* @minLength 1
|
478
|
+
* @maxLength 256
|
479
|
+
*/
|
409
480
|
fileName?: string;
|
410
481
|
}
|
411
482
|
export interface GalleryPublished {
|
412
483
|
/**
|
413
484
|
* id of the gallery that will be published
|
414
485
|
* @readonly
|
486
|
+
* @format GUID
|
415
487
|
*/
|
416
488
|
galleryId?: string;
|
417
489
|
isRc?: boolean;
|
@@ -421,9 +493,15 @@ export interface GalleryPublished {
|
|
421
493
|
oldRevision?: Date | null;
|
422
494
|
}
|
423
495
|
export interface CleanDeletedGalleriesEvent {
|
424
|
-
/**
|
496
|
+
/**
|
497
|
+
* @readonly
|
498
|
+
* @format GUID
|
499
|
+
*/
|
425
500
|
instanceId?: string;
|
426
|
-
/**
|
501
|
+
/**
|
502
|
+
* @readonly
|
503
|
+
* @format GUID
|
504
|
+
*/
|
427
505
|
metaSiteId?: string;
|
428
506
|
/** @readonly */
|
429
507
|
htmlSiteRevision?: string;
|
@@ -431,12 +509,16 @@ export interface CleanDeletedGalleriesEvent {
|
|
431
509
|
timeSitePublished?: Date | null;
|
432
510
|
}
|
433
511
|
export interface ProgallerypublisherPublishGalleryRequest {
|
434
|
-
/**
|
512
|
+
/**
|
513
|
+
* id of the gallery that will be published
|
514
|
+
* @format GUID
|
515
|
+
*/
|
435
516
|
galleryId?: string;
|
436
517
|
}
|
437
518
|
export interface ProgallerypublisherPublishGalleryResponse {
|
438
519
|
}
|
439
520
|
export interface GetActiveGalleryRevisionRequest {
|
521
|
+
/** @format GUID */
|
440
522
|
galleryId?: string;
|
441
523
|
}
|
442
524
|
export interface GetActiveGalleryRevisionResponse {
|
@@ -444,25 +526,41 @@ export interface GetActiveGalleryRevisionResponse {
|
|
444
526
|
htmlSiteRevision?: string | null;
|
445
527
|
}
|
446
528
|
export interface GetGalleryRevisionRequest {
|
529
|
+
/** @format GUID */
|
447
530
|
galleryId?: string;
|
448
531
|
revision?: Date | null;
|
449
532
|
}
|
450
533
|
export interface GetGalleryRevisionResponse {
|
451
534
|
htmlSiteRevision?: string | null;
|
535
|
+
/** @format GUID */
|
452
536
|
instanceId?: string | null;
|
453
537
|
}
|
454
538
|
export interface PublishGalleryItemRequest {
|
455
|
-
/**
|
539
|
+
/**
|
540
|
+
* id of the gallery that will be published
|
541
|
+
* @format GUID
|
542
|
+
*/
|
456
543
|
galleryId?: string;
|
457
|
-
/**
|
544
|
+
/**
|
545
|
+
* id of the item that will be published
|
546
|
+
* @format GUID
|
547
|
+
*/
|
458
548
|
itemId?: string;
|
459
549
|
}
|
460
550
|
export interface PublishGalleryItemResponse {
|
461
551
|
}
|
462
552
|
export interface PublishGalleryItemsRequest {
|
463
|
-
/**
|
553
|
+
/**
|
554
|
+
* id of the gallery that will be published
|
555
|
+
* @format GUID
|
556
|
+
*/
|
464
557
|
galleryId?: string;
|
465
|
-
/**
|
558
|
+
/**
|
559
|
+
* ids of the items that will be published
|
560
|
+
* @format GUID
|
561
|
+
* @minSize 1
|
562
|
+
* @maxSize 100
|
563
|
+
*/
|
466
564
|
itemIds?: string[];
|
467
565
|
}
|
468
566
|
export interface PublishGalleryItemsResponse {
|
@@ -470,15 +568,27 @@ export interface PublishGalleryItemsResponse {
|
|
470
568
|
export interface Empty {
|
471
569
|
}
|
472
570
|
export interface HtmlSitePublished {
|
473
|
-
/**
|
571
|
+
/**
|
572
|
+
* Application instance ID
|
573
|
+
* @maxLength 50
|
574
|
+
*/
|
474
575
|
appInstanceId?: string;
|
475
|
-
/**
|
576
|
+
/**
|
577
|
+
* Application type
|
578
|
+
* @maxLength 100
|
579
|
+
*/
|
476
580
|
appType?: string;
|
477
581
|
/** Revision */
|
478
582
|
revision?: string;
|
479
|
-
/**
|
583
|
+
/**
|
584
|
+
* MSID
|
585
|
+
* @maxLength 100
|
586
|
+
*/
|
480
587
|
metaSiteId?: string | null;
|
481
|
-
/**
|
588
|
+
/**
|
589
|
+
* optional branch id if publish is done from branch
|
590
|
+
* @format GUID
|
591
|
+
*/
|
482
592
|
branchId?: string | null;
|
483
593
|
/** The site's last transactionId */
|
484
594
|
lastTransactionId?: string | null;
|
@@ -488,15 +598,24 @@ export interface HtmlSitePublished {
|
|
488
598
|
publishDate?: string;
|
489
599
|
}
|
490
600
|
export interface EventsPage {
|
491
|
-
/**
|
601
|
+
/**
|
602
|
+
* Page's Id
|
603
|
+
* @maxLength 100
|
604
|
+
*/
|
492
605
|
_id?: string;
|
493
606
|
}
|
494
607
|
export interface HtmlSiteRCPublished {
|
495
|
-
/**
|
608
|
+
/**
|
609
|
+
* Application instance ID
|
610
|
+
* @maxLength 50
|
611
|
+
*/
|
496
612
|
appInstanceId?: string;
|
497
613
|
/** Revision */
|
498
614
|
revision?: string;
|
499
|
-
/**
|
615
|
+
/**
|
616
|
+
* Optional branch Id
|
617
|
+
* @format GUID
|
618
|
+
*/
|
500
619
|
branchId?: string | null;
|
501
620
|
/** Site's publish date */
|
502
621
|
publishDate?: string;
|
@@ -585,9 +704,15 @@ export interface ActionEvent {
|
|
585
704
|
body?: string;
|
586
705
|
}
|
587
706
|
export interface MessageEnvelope {
|
588
|
-
/**
|
707
|
+
/**
|
708
|
+
* App instance ID.
|
709
|
+
* @format GUID
|
710
|
+
*/
|
589
711
|
instanceId?: string | null;
|
590
|
-
/**
|
712
|
+
/**
|
713
|
+
* Event type.
|
714
|
+
* @maxLength 150
|
715
|
+
*/
|
591
716
|
eventType?: string;
|
592
717
|
/** The identification type and identity data. */
|
593
718
|
identity?: IdentificationData;
|
@@ -595,26 +720,50 @@ export interface MessageEnvelope {
|
|
595
720
|
data?: string;
|
596
721
|
}
|
597
722
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
598
|
-
/**
|
723
|
+
/**
|
724
|
+
* ID of a site visitor that has not logged in to the site.
|
725
|
+
* @format GUID
|
726
|
+
*/
|
599
727
|
anonymousVisitorId?: string;
|
600
|
-
/**
|
728
|
+
/**
|
729
|
+
* ID of a site visitor that has logged in to the site.
|
730
|
+
* @format GUID
|
731
|
+
*/
|
601
732
|
memberId?: string;
|
602
|
-
/**
|
733
|
+
/**
|
734
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
735
|
+
* @format GUID
|
736
|
+
*/
|
603
737
|
wixUserId?: string;
|
604
|
-
/**
|
738
|
+
/**
|
739
|
+
* ID of an app.
|
740
|
+
* @format GUID
|
741
|
+
*/
|
605
742
|
appId?: string;
|
606
743
|
/** @readonly */
|
607
744
|
identityType?: WebhookIdentityType;
|
608
745
|
}
|
609
746
|
/** @oneof */
|
610
747
|
export interface IdentificationDataIdOneOf {
|
611
|
-
/**
|
748
|
+
/**
|
749
|
+
* ID of a site visitor that has not logged in to the site.
|
750
|
+
* @format GUID
|
751
|
+
*/
|
612
752
|
anonymousVisitorId?: string;
|
613
|
-
/**
|
753
|
+
/**
|
754
|
+
* ID of a site visitor that has logged in to the site.
|
755
|
+
* @format GUID
|
756
|
+
*/
|
614
757
|
memberId?: string;
|
615
|
-
/**
|
758
|
+
/**
|
759
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
760
|
+
* @format GUID
|
761
|
+
*/
|
616
762
|
wixUserId?: string;
|
617
|
-
/**
|
763
|
+
/**
|
764
|
+
* ID of an app.
|
765
|
+
* @format GUID
|
766
|
+
*/
|
618
767
|
appId?: string;
|
619
768
|
}
|
620
769
|
export declare enum WebhookIdentityType {
|
@@ -624,129 +773,31 @@ export declare enum WebhookIdentityType {
|
|
624
773
|
WIX_USER = "WIX_USER",
|
625
774
|
APP = "APP"
|
626
775
|
}
|
627
|
-
export interface
|
628
|
-
/**
|
629
|
-
|
630
|
-
|
631
|
-
|
632
|
-
|
633
|
-
deleteByFilter?: DeleteByFilterOperation;
|
634
|
-
/** update documents matching filter */
|
635
|
-
updateByFilter?: UpdateByFilterOperation;
|
636
|
-
/** update only existing documents */
|
637
|
-
updateExisting?: UpdateExistingOperation;
|
638
|
-
/** application which owns documents */
|
639
|
-
appDefId?: string | null;
|
640
|
-
/** type of the documents */
|
641
|
-
documentType?: string | null;
|
642
|
-
/** language of the documents */
|
643
|
-
language?: string | null;
|
644
|
-
/** site documents belong to */
|
645
|
-
msId?: string | null;
|
646
|
-
}
|
647
|
-
/** @oneof */
|
648
|
-
export interface UpdateDocumentsEventOperationOneOf {
|
649
|
-
/** insert/update documents */
|
650
|
-
update?: DocumentUpdateOperation;
|
651
|
-
/** delete by document ids */
|
652
|
-
deleteByIds?: DeleteByIdsOperation;
|
653
|
-
/** delete documents matching filter */
|
654
|
-
deleteByFilter?: DeleteByFilterOperation;
|
655
|
-
/** update documents matching filter */
|
656
|
-
updateByFilter?: UpdateByFilterOperation;
|
657
|
-
/** update only existing documents */
|
658
|
-
updateExisting?: UpdateExistingOperation;
|
659
|
-
}
|
660
|
-
export interface DocumentUpdateOperation {
|
661
|
-
/** documents to index or update */
|
662
|
-
documents?: IndexDocument[];
|
663
|
-
}
|
664
|
-
export interface IndexDocument {
|
665
|
-
/** data bag with non-searchable fields (url, image) */
|
666
|
-
payload?: DocumentPayload;
|
667
|
-
/** what type of users should documents be visible to */
|
668
|
-
exposure?: Enum;
|
669
|
-
/** document with mandatory fields (id, title, description) and with fields specific to the type of the document */
|
670
|
-
document?: Record<string, any> | null;
|
671
|
-
/** what member groups is the document exposed to. Used only with GROUP_PROTECTED exposure */
|
672
|
-
permittedMemberGroups?: string[];
|
673
|
-
/** if true SEO is disabled for this document */
|
674
|
-
seoHidden?: boolean | null;
|
675
|
-
/** if true the page is a lightbox popup */
|
676
|
-
isPopup?: boolean | null;
|
677
|
-
}
|
678
|
-
export interface DocumentPayload {
|
679
|
-
/** url of the page representing the document */
|
680
|
-
url?: string | null;
|
681
|
-
/** image which represents the document */
|
682
|
-
documentImage?: DocumentImage;
|
683
|
-
}
|
684
|
-
export interface DocumentImage {
|
685
|
-
/** the name of the image */
|
686
|
-
name?: string;
|
687
|
-
/** the width of the image */
|
688
|
-
width?: number;
|
689
|
-
/** the height of the image */
|
690
|
-
height?: number;
|
691
|
-
}
|
692
|
-
export declare enum Enum {
|
693
|
-
/** Default value. Means that permission not set */
|
694
|
-
UNKNOWN = "UNKNOWN",
|
695
|
-
/** Protected exposure. Exposed to members and owners */
|
696
|
-
PROTECTED = "PROTECTED",
|
697
|
-
/** Private exposure. Exposed to owners */
|
698
|
-
PRIVATE = "PRIVATE",
|
699
|
-
/** Public exposure. Visible to everyone */
|
700
|
-
PUBLIC = "PUBLIC",
|
701
|
-
/** Used for partial updates, to state that exposure is not changing */
|
702
|
-
UNCHANGED = "UNCHANGED",
|
703
|
-
/** Protected to members of permitted groups and owners */
|
704
|
-
GROUP_PROTECTED = "GROUP_PROTECTED"
|
705
|
-
}
|
706
|
-
export interface DeleteByIdsOperation {
|
707
|
-
/** ids of the documents to delete */
|
708
|
-
documentIds?: string[];
|
709
|
-
}
|
710
|
-
export interface DeleteByFilterOperation {
|
711
|
-
/** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
|
712
|
-
filter?: Record<string, any> | null;
|
713
|
-
}
|
714
|
-
export interface UpdateByFilterOperation {
|
715
|
-
/** documents matching this filter will be updated */
|
716
|
-
filter?: Record<string, any> | null;
|
717
|
-
/** partial document to apply */
|
718
|
-
document?: IndexDocument;
|
719
|
-
}
|
720
|
-
export interface UpdateExistingOperation {
|
721
|
-
/** documents to update */
|
722
|
-
documents?: IndexDocument[];
|
723
|
-
}
|
724
|
-
export interface SearchIndexingNotification {
|
725
|
-
/** new state of indexing for the site specified in ms_id */
|
726
|
-
indexState?: SearchIndexingNotificationState;
|
727
|
-
/** type of the document the notification is targeted for. Applies to all types if not provided */
|
728
|
-
documentType?: string | null;
|
729
|
-
/** languaInternalDocumentUpdateByFilterOperationge the notification is targeted for. Applies to all languages if not provided */
|
730
|
-
language?: string | null;
|
731
|
-
/** site for which notification is targeted */
|
732
|
-
msId?: string | null;
|
733
|
-
}
|
734
|
-
export declare enum SearchIndexingNotificationState {
|
735
|
-
/** default state */
|
736
|
-
Unknown = "Unknown",
|
737
|
-
/** metasite does not require site search indexing */
|
738
|
-
Off = "Off",
|
739
|
-
/** metasite requires site search indexing */
|
740
|
-
On = "On"
|
776
|
+
export interface RestoreAllGalleriesEvent {
|
777
|
+
/**
|
778
|
+
* instance id of galleries to restore
|
779
|
+
* @format GUID
|
780
|
+
*/
|
781
|
+
instanceId?: string;
|
741
782
|
}
|
742
783
|
export interface ListGalleriesItemsRequest {
|
743
|
-
/**
|
784
|
+
/**
|
785
|
+
* IDs of the media items to retrieve.
|
786
|
+
* @minSize 1
|
787
|
+
* @maxSize 100
|
788
|
+
*/
|
744
789
|
itemsId?: ItemId[];
|
745
790
|
}
|
746
791
|
export interface ItemId {
|
747
|
-
/**
|
792
|
+
/**
|
793
|
+
* Gallery ID.
|
794
|
+
* @format GUID
|
795
|
+
*/
|
748
796
|
galleryId?: string;
|
749
|
-
/**
|
797
|
+
/**
|
798
|
+
* Item ID.
|
799
|
+
* @format GUID
|
800
|
+
*/
|
750
801
|
itemId?: string;
|
751
802
|
}
|
752
803
|
export interface ListGalleriesItemsResponse {
|
@@ -754,11 +805,23 @@ export interface ListGalleriesItemsResponse {
|
|
754
805
|
itemsInGalleries?: ItemsInGallery[];
|
755
806
|
}
|
756
807
|
export interface ItemsInGallery {
|
757
|
-
/**
|
808
|
+
/**
|
809
|
+
* Gallery ID.
|
810
|
+
* @format GUID
|
811
|
+
*/
|
758
812
|
galleryId?: string;
|
759
813
|
/** Retrieved media items. */
|
760
814
|
items?: Item[];
|
761
815
|
}
|
816
|
+
export interface TriggerRestoreAllGalleriesAsyncRequest {
|
817
|
+
/**
|
818
|
+
* instance id of galleries to restore
|
819
|
+
* @format GUID
|
820
|
+
*/
|
821
|
+
instanceId?: string;
|
822
|
+
}
|
823
|
+
export interface TriggerRestoreAllGalleriesAsyncResponse {
|
824
|
+
}
|
762
825
|
export interface GalleryItemCreated {
|
763
826
|
/** Created gallery item. */
|
764
827
|
item?: Item;
|
@@ -768,15 +831,26 @@ export interface GalleryItemUpdated {
|
|
768
831
|
updatedItem?: Item;
|
769
832
|
}
|
770
833
|
export interface GalleryItemDeleted {
|
771
|
-
/**
|
834
|
+
/**
|
835
|
+
* ID of the deleted gallery item.
|
836
|
+
* @format GUID
|
837
|
+
*/
|
772
838
|
itemId?: string;
|
773
839
|
}
|
774
840
|
export interface ListGalleriesRequest {
|
775
|
-
/**
|
841
|
+
/**
|
842
|
+
* Number of galleries to list. Defaults to `10`.
|
843
|
+
* @min 1
|
844
|
+
* @max 100
|
845
|
+
*/
|
776
846
|
itemLimit?: number | null;
|
777
847
|
/** Number of galleries to skip in the returns. Defaults to `0`. */
|
778
848
|
offset?: number | null;
|
779
|
-
/**
|
849
|
+
/**
|
850
|
+
* Number of galleries to list. Defaults to `10`.
|
851
|
+
* @min 1
|
852
|
+
* @max 10
|
853
|
+
*/
|
780
854
|
limit?: number | null;
|
781
855
|
}
|
782
856
|
export declare enum State {
|
@@ -794,7 +868,10 @@ export interface ListGalleriesResponse {
|
|
794
868
|
galleries?: Gallery[];
|
795
869
|
}
|
796
870
|
export interface GetGalleryRequest extends GetGalleryRequestVersionOneOf {
|
797
|
-
/**
|
871
|
+
/**
|
872
|
+
* Gallery ID.
|
873
|
+
* @format GUID
|
874
|
+
*/
|
798
875
|
galleryId: string;
|
799
876
|
/** Number of media items to skip in the returns. Defaults to `0`. */
|
800
877
|
itemOffset?: number | null;
|
@@ -804,6 +881,8 @@ export interface GetGalleryRequest extends GetGalleryRequestVersionOneOf {
|
|
804
881
|
* Min: `1` <br />
|
805
882
|
* Max: `100` <br />
|
806
883
|
* Default: `50`
|
884
|
+
* @min 1
|
885
|
+
* @max 200
|
807
886
|
*/
|
808
887
|
itemLimit?: number | null;
|
809
888
|
}
|
@@ -815,7 +894,10 @@ export interface GetGalleryResponse {
|
|
815
894
|
gallery?: Gallery;
|
816
895
|
}
|
817
896
|
export interface ListGalleryItemsRequest {
|
818
|
-
/**
|
897
|
+
/**
|
898
|
+
* Gallery ID.
|
899
|
+
* @format GUID
|
900
|
+
*/
|
819
901
|
galleryId: string;
|
820
902
|
/** Number of media items to skip in the returns. Defaults to `0`. */
|
821
903
|
itemOffset?: number | null;
|
@@ -825,6 +907,8 @@ export interface ListGalleryItemsRequest {
|
|
825
907
|
* Min: `1` <br />
|
826
908
|
* Max: `100` <br />
|
827
909
|
* Default: `50`
|
910
|
+
* @min 1
|
911
|
+
* @max 200
|
828
912
|
*/
|
829
913
|
itemLimit?: number | null;
|
830
914
|
}
|
@@ -833,9 +917,15 @@ export interface ListGalleryItemsResponse {
|
|
833
917
|
items?: Item[];
|
834
918
|
}
|
835
919
|
export interface GetGalleryItemRequest {
|
836
|
-
/**
|
920
|
+
/**
|
921
|
+
* Gallery ID.
|
922
|
+
* @format GUID
|
923
|
+
*/
|
837
924
|
galleryId: string;
|
838
|
-
/**
|
925
|
+
/**
|
926
|
+
* Item ID.
|
927
|
+
* @format GUID
|
928
|
+
*/
|
839
929
|
itemId: string;
|
840
930
|
}
|
841
931
|
export interface GetGalleryItemResponse {
|
@@ -845,7 +935,10 @@ export interface GetGalleryItemResponse {
|
|
845
935
|
export interface CreateGalleryRequest {
|
846
936
|
/** Gallery to create. */
|
847
937
|
gallery?: Gallery;
|
848
|
-
/**
|
938
|
+
/**
|
939
|
+
* Gallery ID to clone from.
|
940
|
+
* @format GUID
|
941
|
+
*/
|
849
942
|
cloneFromGalleryId?: string | null;
|
850
943
|
}
|
851
944
|
export interface CreateGalleryResponse {
|
@@ -861,20 +954,30 @@ export interface UpdateGalleryResponse {
|
|
861
954
|
gallery?: Gallery;
|
862
955
|
}
|
863
956
|
export interface DeleteGalleryRequest {
|
864
|
-
/**
|
957
|
+
/**
|
958
|
+
* ID of the gallery to delete.
|
959
|
+
* @format GUID
|
960
|
+
*/
|
865
961
|
galleryId: string;
|
866
962
|
}
|
867
963
|
export interface DeleteGalleryResponse {
|
868
964
|
/**
|
869
965
|
* ID of the deleted gallery.
|
870
966
|
* @readonly
|
967
|
+
* @format GUID
|
871
968
|
*/
|
872
969
|
galleryId?: string;
|
873
970
|
}
|
874
971
|
export interface DeleteGalleryItemsRequest {
|
875
|
-
/**
|
972
|
+
/**
|
973
|
+
* Gallery ID.
|
974
|
+
* @format GUID
|
975
|
+
*/
|
876
976
|
galleryId: string;
|
877
|
-
/**
|
977
|
+
/**
|
978
|
+
* ID of the media item to delete.
|
979
|
+
* @format GUID
|
980
|
+
*/
|
878
981
|
itemsIds?: string[];
|
879
982
|
}
|
880
983
|
export interface DeleteGalleryItemsResponse {
|
@@ -882,20 +985,32 @@ export interface DeleteGalleryItemsResponse {
|
|
882
985
|
gallery?: Gallery;
|
883
986
|
}
|
884
987
|
export interface BulkDeleteGalleryItemsRequest {
|
885
|
-
/**
|
988
|
+
/**
|
989
|
+
* Gallery ID.
|
990
|
+
* @format GUID
|
991
|
+
*/
|
886
992
|
galleryId: string;
|
887
|
-
/**
|
993
|
+
/**
|
994
|
+
* IDs of the media items to delete.
|
995
|
+
* @format GUID
|
996
|
+
* @minSize 1
|
997
|
+
* @maxSize 1000
|
998
|
+
*/
|
888
999
|
itemIds: string[];
|
889
1000
|
}
|
890
1001
|
export interface BulkDeleteGalleryItemsResponse {
|
891
1002
|
/**
|
892
1003
|
* IDs of the deleted media items.
|
893
1004
|
* @readonly
|
1005
|
+
* @format GUID
|
894
1006
|
*/
|
895
1007
|
itemIds?: string[];
|
896
1008
|
}
|
897
1009
|
export interface CreateGalleryItemRequest {
|
898
|
-
/**
|
1010
|
+
/**
|
1011
|
+
* Gallery ID.
|
1012
|
+
* @format GUID
|
1013
|
+
*/
|
899
1014
|
galleryId: string;
|
900
1015
|
/** Media item to create. */
|
901
1016
|
item: Item;
|
@@ -905,9 +1020,15 @@ export interface CreateGalleryItemResponse {
|
|
905
1020
|
item?: Item;
|
906
1021
|
}
|
907
1022
|
export interface CreateGalleryItemsRequest {
|
908
|
-
/**
|
1023
|
+
/**
|
1024
|
+
* Gallery ID.
|
1025
|
+
* @format GUID
|
1026
|
+
*/
|
909
1027
|
galleryId?: string;
|
910
|
-
/**
|
1028
|
+
/**
|
1029
|
+
* Media items to create.
|
1030
|
+
* @maxSize 50
|
1031
|
+
*/
|
911
1032
|
items?: Item[];
|
912
1033
|
}
|
913
1034
|
export interface CreateGalleryItemsResponse {
|
@@ -915,7 +1036,10 @@ export interface CreateGalleryItemsResponse {
|
|
915
1036
|
items?: Item[];
|
916
1037
|
}
|
917
1038
|
export interface UpdateGalleryItemRequest {
|
918
|
-
/**
|
1039
|
+
/**
|
1040
|
+
* Gallery ID.
|
1041
|
+
* @format GUID
|
1042
|
+
*/
|
919
1043
|
galleryId: string;
|
920
1044
|
/** The information for the media item being updated. */
|
921
1045
|
item: Item;
|
@@ -925,26 +1049,166 @@ export interface UpdateGalleryItemResponse {
|
|
925
1049
|
item?: Item;
|
926
1050
|
}
|
927
1051
|
export interface DeleteGalleryItemRequest {
|
928
|
-
/**
|
1052
|
+
/**
|
1053
|
+
* Gallery ID.
|
1054
|
+
* @format GUID
|
1055
|
+
*/
|
929
1056
|
galleryId: string;
|
930
|
-
/**
|
1057
|
+
/**
|
1058
|
+
* ID of the media item to delete.
|
1059
|
+
* @format GUID
|
1060
|
+
*/
|
931
1061
|
itemId: string;
|
932
1062
|
}
|
933
1063
|
export interface DeleteGalleryItemResponse {
|
934
1064
|
/**
|
935
1065
|
* ID of the deleted media item.
|
936
1066
|
* @readonly
|
1067
|
+
* @format GUID
|
937
1068
|
*/
|
938
1069
|
itemId?: string;
|
939
1070
|
}
|
940
1071
|
export interface PublishGalleryRequest {
|
941
|
-
/**
|
1072
|
+
/**
|
1073
|
+
* ID of the gallery to publish.
|
1074
|
+
* @format GUID
|
1075
|
+
*/
|
942
1076
|
galleryId?: string;
|
943
1077
|
}
|
944
1078
|
export interface PublishGalleryResponse {
|
945
1079
|
/** Published gallery. */
|
946
1080
|
gallery?: Gallery;
|
947
1081
|
}
|
1082
|
+
export interface UpdateDocumentsEvent extends UpdateDocumentsEventOperationOneOf {
|
1083
|
+
/** insert/update documents */
|
1084
|
+
update?: DocumentUpdateOperation;
|
1085
|
+
/** delete by document ids */
|
1086
|
+
deleteByIds?: DeleteByIdsOperation;
|
1087
|
+
/** delete documents matching filter */
|
1088
|
+
deleteByFilter?: DeleteByFilterOperation;
|
1089
|
+
/** update documents matching filter */
|
1090
|
+
updateByFilter?: UpdateByFilterOperation;
|
1091
|
+
/** update only existing documents */
|
1092
|
+
updateExisting?: UpdateExistingOperation;
|
1093
|
+
/**
|
1094
|
+
* application which owns documents
|
1095
|
+
* @minLength 2
|
1096
|
+
*/
|
1097
|
+
appDefId?: string | null;
|
1098
|
+
/**
|
1099
|
+
* type of the documents
|
1100
|
+
* @minLength 2
|
1101
|
+
*/
|
1102
|
+
documentType?: string | null;
|
1103
|
+
/**
|
1104
|
+
* language of the documents
|
1105
|
+
* @minLength 2
|
1106
|
+
*/
|
1107
|
+
language?: string | null;
|
1108
|
+
/**
|
1109
|
+
* site documents belong to
|
1110
|
+
* @minLength 2
|
1111
|
+
*/
|
1112
|
+
msId?: string | null;
|
1113
|
+
}
|
1114
|
+
/** @oneof */
|
1115
|
+
export interface UpdateDocumentsEventOperationOneOf {
|
1116
|
+
/** insert/update documents */
|
1117
|
+
update?: DocumentUpdateOperation;
|
1118
|
+
/** delete by document ids */
|
1119
|
+
deleteByIds?: DeleteByIdsOperation;
|
1120
|
+
/** delete documents matching filter */
|
1121
|
+
deleteByFilter?: DeleteByFilterOperation;
|
1122
|
+
/** update documents matching filter */
|
1123
|
+
updateByFilter?: UpdateByFilterOperation;
|
1124
|
+
/** update only existing documents */
|
1125
|
+
updateExisting?: UpdateExistingOperation;
|
1126
|
+
}
|
1127
|
+
export interface DocumentUpdateOperation {
|
1128
|
+
/** documents to index or update */
|
1129
|
+
documents?: IndexDocument[];
|
1130
|
+
}
|
1131
|
+
export interface IndexDocument {
|
1132
|
+
/** data bag with non-searchable fields (url, image) */
|
1133
|
+
payload?: DocumentPayload;
|
1134
|
+
/** what type of users should documents be visible to */
|
1135
|
+
exposure?: Enum;
|
1136
|
+
/** document with mandatory fields (id, title, description) and with fields specific to the type of the document */
|
1137
|
+
document?: Record<string, any> | null;
|
1138
|
+
/** what member groups is the document exposed to. Used only with GROUP_PROTECTED exposure */
|
1139
|
+
permittedMemberGroups?: string[];
|
1140
|
+
/** if true SEO is disabled for this document */
|
1141
|
+
seoHidden?: boolean | null;
|
1142
|
+
/** if true the page is a lightbox popup */
|
1143
|
+
isPopup?: boolean | null;
|
1144
|
+
}
|
1145
|
+
export interface DocumentPayload {
|
1146
|
+
/** url of the page representing the document */
|
1147
|
+
url?: string | null;
|
1148
|
+
/** image which represents the document */
|
1149
|
+
documentImage?: DocumentImage;
|
1150
|
+
}
|
1151
|
+
export interface DocumentImage {
|
1152
|
+
/** the name of the image */
|
1153
|
+
name?: string;
|
1154
|
+
/** the width of the image */
|
1155
|
+
width?: number;
|
1156
|
+
/** the height of the image */
|
1157
|
+
height?: number;
|
1158
|
+
}
|
1159
|
+
export declare enum Enum {
|
1160
|
+
/** Default value. Means that permission not set */
|
1161
|
+
UNKNOWN = "UNKNOWN",
|
1162
|
+
/** Protected exposure. Exposed to members and owners */
|
1163
|
+
PROTECTED = "PROTECTED",
|
1164
|
+
/** Private exposure. Exposed to owners */
|
1165
|
+
PRIVATE = "PRIVATE",
|
1166
|
+
/** Public exposure. Visible to everyone */
|
1167
|
+
PUBLIC = "PUBLIC",
|
1168
|
+
/** Used for partial updates, to state that exposure is not changing */
|
1169
|
+
UNCHANGED = "UNCHANGED",
|
1170
|
+
/** Protected to members of permitted groups and owners */
|
1171
|
+
GROUP_PROTECTED = "GROUP_PROTECTED"
|
1172
|
+
}
|
1173
|
+
export interface DeleteByIdsOperation {
|
1174
|
+
/** ids of the documents to delete */
|
1175
|
+
documentIds?: string[];
|
1176
|
+
}
|
1177
|
+
export interface DeleteByFilterOperation {
|
1178
|
+
/** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
|
1179
|
+
filter?: Record<string, any> | null;
|
1180
|
+
}
|
1181
|
+
export interface UpdateByFilterOperation {
|
1182
|
+
/** documents matching this filter will be updated */
|
1183
|
+
filter?: Record<string, any> | null;
|
1184
|
+
/** partial document to apply */
|
1185
|
+
document?: IndexDocument;
|
1186
|
+
}
|
1187
|
+
export interface UpdateExistingOperation {
|
1188
|
+
/** documents to update */
|
1189
|
+
documents?: IndexDocument[];
|
1190
|
+
}
|
1191
|
+
export interface SearchIndexingNotification {
|
1192
|
+
/** new state of indexing for the site specified in ms_id */
|
1193
|
+
indexState?: SearchIndexingNotificationState;
|
1194
|
+
/** type of the document the notification is targeted for. Applies to all types if not provided */
|
1195
|
+
documentType?: string | null;
|
1196
|
+
/** languaInternalDocumentUpdateByFilterOperationge the notification is targeted for. Applies to all languages if not provided */
|
1197
|
+
language?: string | null;
|
1198
|
+
/**
|
1199
|
+
* site for which notification is targeted
|
1200
|
+
* @minLength 2
|
1201
|
+
*/
|
1202
|
+
msId?: string | null;
|
1203
|
+
}
|
1204
|
+
export declare enum SearchIndexingNotificationState {
|
1205
|
+
/** default state */
|
1206
|
+
Unknown = "Unknown",
|
1207
|
+
/** metasite does not require site search indexing */
|
1208
|
+
Off = "Off",
|
1209
|
+
/** metasite requires site search indexing */
|
1210
|
+
On = "On"
|
1211
|
+
}
|
948
1212
|
interface PointNonNullableFields {
|
949
1213
|
x: number;
|
950
1214
|
y: number;
|
@@ -1071,9 +1335,15 @@ export interface DeleteGalleryItemResponseNonNullableFields {
|
|
1071
1335
|
itemId: string;
|
1072
1336
|
}
|
1073
1337
|
export interface BaseEventMetadata {
|
1074
|
-
/**
|
1338
|
+
/**
|
1339
|
+
* App instance ID.
|
1340
|
+
* @format GUID
|
1341
|
+
*/
|
1075
1342
|
instanceId?: string | null;
|
1076
|
-
/**
|
1343
|
+
/**
|
1344
|
+
* Event type.
|
1345
|
+
* @maxLength 150
|
1346
|
+
*/
|
1077
1347
|
eventType?: string;
|
1078
1348
|
/** The identification type and identity data. */
|
1079
1349
|
identity?: IdentificationData;
|
@@ -1250,11 +1520,19 @@ export declare function onGalleryUpdated(handler: (event: GalleryUpdatedEnvelope
|
|
1250
1520
|
*/
|
1251
1521
|
export declare function listGalleries(options?: ListGalleriesOptions): Promise<ListGalleriesResponse & ListGalleriesResponseNonNullableFields>;
|
1252
1522
|
export interface ListGalleriesOptions {
|
1253
|
-
/**
|
1523
|
+
/**
|
1524
|
+
* Number of galleries to list. Defaults to `10`.
|
1525
|
+
* @min 1
|
1526
|
+
* @max 100
|
1527
|
+
*/
|
1254
1528
|
itemLimit?: number | null;
|
1255
1529
|
/** Number of galleries to skip in the returns. Defaults to `0`. */
|
1256
1530
|
offset?: number | null;
|
1257
|
-
/**
|
1531
|
+
/**
|
1532
|
+
* Number of galleries to list. Defaults to `10`.
|
1533
|
+
* @min 1
|
1534
|
+
* @max 10
|
1535
|
+
*/
|
1258
1536
|
limit?: number | null;
|
1259
1537
|
}
|
1260
1538
|
/**
|
@@ -1275,7 +1553,7 @@ export interface ListGalleriesOptions {
|
|
1275
1553
|
* @fqn com.wixpress.exposure.progallery.ProGallery.GetGallery
|
1276
1554
|
*/
|
1277
1555
|
export declare function getGallery(galleryId: string, options?: GetGalleryOptions): Promise<Gallery & GalleryNonNullableFields>;
|
1278
|
-
export interface GetGalleryOptions extends
|
1556
|
+
export interface GetGalleryOptions extends GetGalleryOptionsVersionOneOf {
|
1279
1557
|
/** Number of media items to skip in the returns. Defaults to `0`. */
|
1280
1558
|
itemOffset?: number | null;
|
1281
1559
|
/**
|
@@ -1284,9 +1562,14 @@ export interface GetGalleryOptions extends GetGalleryRequestVersionOneOf {
|
|
1284
1562
|
* Min: `1` <br />
|
1285
1563
|
* Max: `100` <br />
|
1286
1564
|
* Default: `50`
|
1565
|
+
* @min 1
|
1566
|
+
* @max 200
|
1287
1567
|
*/
|
1288
1568
|
itemLimit?: number | null;
|
1289
1569
|
}
|
1570
|
+
/** @oneof */
|
1571
|
+
export interface GetGalleryOptionsVersionOneOf {
|
1572
|
+
}
|
1290
1573
|
/**
|
1291
1574
|
* Retrieves a list of media items in a specified gallery.
|
1292
1575
|
*
|
@@ -1315,6 +1598,8 @@ export interface ListGalleryItemsOptions {
|
|
1315
1598
|
* Min: `1` <br />
|
1316
1599
|
* Max: `100` <br />
|
1317
1600
|
* Default: `50`
|
1601
|
+
* @min 1
|
1602
|
+
* @max 200
|
1318
1603
|
*/
|
1319
1604
|
itemLimit?: number | null;
|
1320
1605
|
}
|
@@ -1338,9 +1623,15 @@ export interface ListGalleryItemsOptions {
|
|
1338
1623
|
*/
|
1339
1624
|
export declare function getGalleryItem(identifiers: GetGalleryItemIdentifiers): Promise<Item & ItemNonNullableFields>;
|
1340
1625
|
export interface GetGalleryItemIdentifiers {
|
1341
|
-
/**
|
1626
|
+
/**
|
1627
|
+
* Gallery ID.
|
1628
|
+
* @format GUID
|
1629
|
+
*/
|
1342
1630
|
galleryId: string;
|
1343
|
-
/**
|
1631
|
+
/**
|
1632
|
+
* Item ID.
|
1633
|
+
* @format GUID
|
1634
|
+
*/
|
1344
1635
|
itemId: string;
|
1345
1636
|
}
|
1346
1637
|
/**
|
@@ -1373,7 +1664,10 @@ export declare function createGallery(options?: CreateGalleryOptions): Promise<G
|
|
1373
1664
|
export interface CreateGalleryOptions {
|
1374
1665
|
/** Gallery to create. */
|
1375
1666
|
gallery?: Gallery;
|
1376
|
-
/**
|
1667
|
+
/**
|
1668
|
+
* Gallery ID to clone from.
|
1669
|
+
* @format GUID
|
1670
|
+
*/
|
1377
1671
|
cloneFromGalleryId?: string | null;
|
1378
1672
|
}
|
1379
1673
|
/**
|
@@ -1408,6 +1702,7 @@ export interface UpdateGallery {
|
|
1408
1702
|
/**
|
1409
1703
|
* Gallery ID.
|
1410
1704
|
* @readonly
|
1705
|
+
* @format GUID
|
1411
1706
|
*/
|
1412
1707
|
_id?: string | null;
|
1413
1708
|
/** Gallery name. */
|
@@ -1458,12 +1753,15 @@ export declare function deleteGallery(galleryId: string): Promise<DeleteGalleryR
|
|
1458
1753
|
* @applicableIdentity APP
|
1459
1754
|
* @fqn com.wixpress.exposure.progallery.ProGallery.DeleteGalleryItems
|
1460
1755
|
* @deprecated
|
1461
|
-
* @replacedBy .
|
1756
|
+
* @replacedBy wix.pro_gallery.v2.gallery.BulkDeleteGalleryItems
|
1462
1757
|
* @targetRemovalDate 2024-08-15
|
1463
1758
|
*/
|
1464
1759
|
export declare function deleteGalleryItems(galleryId: string, options?: DeleteGalleryItemsOptions): Promise<DeleteGalleryItemsResponse & DeleteGalleryItemsResponseNonNullableFields>;
|
1465
1760
|
export interface DeleteGalleryItemsOptions {
|
1466
|
-
/**
|
1761
|
+
/**
|
1762
|
+
* ID of the media item to delete.
|
1763
|
+
* @format GUID
|
1764
|
+
*/
|
1467
1765
|
itemsIds?: string[];
|
1468
1766
|
}
|
1469
1767
|
/**
|
@@ -1540,11 +1838,15 @@ export declare function createGalleryItem(galleryId: string, item: Item): Promis
|
|
1540
1838
|
*/
|
1541
1839
|
export declare function updateGalleryItem(identifiers: UpdateGalleryItemIdentifiers, item: UpdateGalleryItem): Promise<Item & ItemNonNullableFields>;
|
1542
1840
|
export interface UpdateGalleryItemIdentifiers {
|
1543
|
-
/**
|
1841
|
+
/**
|
1842
|
+
* ID of the gallery containing the item to update.
|
1843
|
+
* @format GUID
|
1844
|
+
*/
|
1544
1845
|
galleryId: string;
|
1545
1846
|
/**
|
1546
1847
|
* ID of the item to update.
|
1547
1848
|
* @readonly
|
1849
|
+
* @format GUID
|
1548
1850
|
*/
|
1549
1851
|
itemId?: string | null;
|
1550
1852
|
}
|
@@ -1558,6 +1860,7 @@ export interface UpdateGalleryItem {
|
|
1558
1860
|
/**
|
1559
1861
|
* Item ID.
|
1560
1862
|
* @readonly
|
1863
|
+
* @format GUID
|
1561
1864
|
*/
|
1562
1865
|
_id?: string | null;
|
1563
1866
|
/**
|
@@ -1610,9 +1913,15 @@ export interface UpdateGalleryItem {
|
|
1610
1913
|
*/
|
1611
1914
|
export declare function deleteGalleryItem(identifiers: DeleteGalleryItemIdentifiers): Promise<DeleteGalleryItemResponse & DeleteGalleryItemResponseNonNullableFields>;
|
1612
1915
|
export interface DeleteGalleryItemIdentifiers {
|
1613
|
-
/**
|
1916
|
+
/**
|
1917
|
+
* Gallery ID.
|
1918
|
+
* @format GUID
|
1919
|
+
*/
|
1614
1920
|
galleryId: string;
|
1615
|
-
/**
|
1921
|
+
/**
|
1922
|
+
* ID of the media item to delete.
|
1923
|
+
* @format GUID
|
1924
|
+
*/
|
1616
1925
|
itemId: string;
|
1617
1926
|
}
|
1618
1927
|
export {};
|