@wix/pro-gallery 1.0.64 → 1.0.65

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/pro-gallery",
3
- "version": "1.0.64",
3
+ "version": "1.0.65",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -21,7 +21,7 @@
21
21
  "type-bundles"
22
22
  ],
23
23
  "dependencies": {
24
- "@wix/pro-gallery_pro-gallery": "1.0.33"
24
+ "@wix/pro-gallery_pro-gallery": "1.0.34"
25
25
  },
26
26
  "devDependencies": {
27
27
  "glob": "^10.4.1",
@@ -46,5 +46,5 @@
46
46
  "fqdn": ""
47
47
  }
48
48
  },
49
- "falconPackageHash": "40310c38601d3b94560f608d84d2e9e212e2f4fd0bcaa56d4b0b9dfd"
49
+ "falconPackageHash": "95f3cd4f7c513f03afd4ed51fed9c887e6fef9eaf83744254d1341b8"
50
50
  }
@@ -529,7 +529,10 @@ interface Item extends ItemMetadataOneOf {
529
529
  description?: string | null;
530
530
  /** Link from the item. You can link to Wix sites or external URLs. */
531
531
  link?: Link;
532
- /** @readonly */
532
+ /**
533
+ * Type of item.
534
+ * @readonly
535
+ */
533
536
  type?: Type;
534
537
  /**
535
538
  * Date and time the item was created.
@@ -561,9 +564,9 @@ interface Link {
561
564
  }
562
565
  declare enum LinkType {
563
566
  UNDEFINED = "UNDEFINED",
564
- /** external link */
567
+ /** External link. */
565
568
  EXTERNAL = "EXTERNAL",
566
- /** for internal usage using wixLinkData */
569
+ /** For internal usage using wixLinkData. */
567
570
  INTERNAL = "INTERNAL"
568
571
  }
569
572
  /** The link object generated by panels in the editor and used by applications in Wix */
@@ -751,7 +754,7 @@ interface UnsharpMasking {
751
754
  /** Unsharp masking radius in pixels. Controls the sharpening width. */
752
755
  radius?: number | null;
753
756
  /**
754
- * Unsharp masking threshold. Controls how different neighboring pixels must be for shapening to apply. <br />
757
+ * Unsharp masking threshold. Controls how different neighboring pixels must be for sharpening to apply. <br />
755
758
  *
756
759
  * Min: `0` <br />
757
760
  * Max: `1`
@@ -759,6 +762,7 @@ interface UnsharpMasking {
759
762
  threshold?: number | null;
760
763
  }
761
764
  interface Video {
765
+ /** Type of video. */
762
766
  type?: VideoType;
763
767
  /**
764
768
  * The video's URL. Either a Wix media URL, or a supported https external URL in the following formats:
@@ -1086,121 +1090,6 @@ declare enum WebhookIdentityType {
1086
1090
  WIX_USER = "WIX_USER",
1087
1091
  APP = "APP"
1088
1092
  }
1089
- interface UpdateDocumentsEvent extends UpdateDocumentsEventOperationOneOf {
1090
- /** insert/update documents */
1091
- update?: DocumentUpdateOperation;
1092
- /** delete by document ids */
1093
- deleteByIds?: DeleteByIdsOperation;
1094
- /** delete documents matching filter */
1095
- deleteByFilter?: DeleteByFilterOperation;
1096
- /** update documents matching filter */
1097
- updateByFilter?: UpdateByFilterOperation;
1098
- /** update only existing documents */
1099
- updateExisting?: UpdateExistingOperation;
1100
- /** application which owns documents */
1101
- appDefId?: string | null;
1102
- /** type of the documents */
1103
- documentType?: string | null;
1104
- /** language of the documents */
1105
- language?: string | null;
1106
- /** site documents belong to */
1107
- msId?: string | null;
1108
- }
1109
- /** @oneof */
1110
- interface UpdateDocumentsEventOperationOneOf {
1111
- /** insert/update documents */
1112
- update?: DocumentUpdateOperation;
1113
- /** delete by document ids */
1114
- deleteByIds?: DeleteByIdsOperation;
1115
- /** delete documents matching filter */
1116
- deleteByFilter?: DeleteByFilterOperation;
1117
- /** update documents matching filter */
1118
- updateByFilter?: UpdateByFilterOperation;
1119
- /** update only existing documents */
1120
- updateExisting?: UpdateExistingOperation;
1121
- }
1122
- interface DocumentUpdateOperation {
1123
- /** documents to index or update */
1124
- documents?: IndexDocument[];
1125
- }
1126
- interface IndexDocument {
1127
- /** data bag with non-searchable fields (url, image) */
1128
- payload?: DocumentPayload;
1129
- /** what type of users should documents be visible to */
1130
- exposure?: Enum;
1131
- /** document with mandatory fields (id, title, description) and with fields specific to the type of the document */
1132
- document?: Record<string, any> | null;
1133
- /** what member groups is the document exposed to. Used only with GROUP_PROTECTED exposure */
1134
- permittedMemberGroups?: string[];
1135
- /** if true SEO is disabled for this document */
1136
- seoHidden?: boolean | null;
1137
- /** if true the page is a lightbox popup */
1138
- isPopup?: boolean | null;
1139
- }
1140
- interface DocumentPayload {
1141
- /** url of the page representing the document */
1142
- url?: string | null;
1143
- /** image which represents the document */
1144
- documentImage?: DocumentImage;
1145
- }
1146
- interface DocumentImage {
1147
- /** the name of the image */
1148
- name?: string;
1149
- /** the width of the image */
1150
- width?: number;
1151
- /** the height of the image */
1152
- height?: number;
1153
- }
1154
- declare enum Enum {
1155
- /** Default value. Means that permission not set */
1156
- UNKNOWN = "UNKNOWN",
1157
- /** Protected exposure. Exposed to members and owners */
1158
- PROTECTED = "PROTECTED",
1159
- /** Private exposure. Exposed to owners */
1160
- PRIVATE = "PRIVATE",
1161
- /** Public exposure. Visible to everyone */
1162
- PUBLIC = "PUBLIC",
1163
- /** Used for partial updates, to state that exposure is not changing */
1164
- UNCHANGED = "UNCHANGED",
1165
- /** Protected to members of permitted groups and owners */
1166
- GROUP_PROTECTED = "GROUP_PROTECTED"
1167
- }
1168
- interface DeleteByIdsOperation {
1169
- /** ids of the documents to delete */
1170
- documentIds?: string[];
1171
- }
1172
- interface DeleteByFilterOperation {
1173
- /** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
1174
- filter?: Record<string, any> | null;
1175
- }
1176
- interface UpdateByFilterOperation {
1177
- /** documents matching this filter will be updated */
1178
- filter?: Record<string, any> | null;
1179
- /** partial document to apply */
1180
- document?: IndexDocument;
1181
- }
1182
- interface UpdateExistingOperation {
1183
- /** documents to update */
1184
- documents?: IndexDocument[];
1185
- }
1186
- interface SearchIndexingNotification {
1187
- /** new state of indexing for the site specified in ms_id */
1188
- indexState?: SearchIndexingNotificationState;
1189
- /** type of the document the notification is targeted for. Applies to all types if not provided */
1190
- documentType?: string | null;
1191
- /** languaInternalDocumentUpdateByFilterOperationge the notification is targeted for. Applies to all languages if not provided */
1192
- language?: string | null;
1193
- /** site for which notification is targeted */
1194
- msId?: string | null;
1195
- }
1196
- declare enum SearchIndexingNotificationState {
1197
- /** default state */
1198
- Unknown = "Unknown",
1199
- /** metasite does not require site search indexing */
1200
- Off = "Off",
1201
- /** metasite requires site search indexing */
1202
- On = "On"
1203
- }
1204
1093
  interface ListGalleriesItemsRequest {
1205
1094
  /** IDs of the media items to retrieve. */
1206
1095
  itemsId?: ItemId[];
@@ -1242,10 +1131,11 @@ interface ListGalleriesRequest {
1242
1131
  limit?: number | null;
1243
1132
  }
1244
1133
  declare enum State {
1134
+ /** Undefined state. */
1245
1135
  UNDEFINED = "UNDEFINED",
1246
- /** The gallery in the Editor segment */
1136
+ /** The gallery in the Editor. */
1247
1137
  SAVED = "SAVED",
1248
- /** The gallery in the LiveSite segment */
1138
+ /** The gallery in the LiveSite. */
1249
1139
  PUBLISHED = "PUBLISHED"
1250
1140
  }
1251
1141
  interface ListGalleriesResponse {
@@ -1406,6 +1296,121 @@ interface PublishGalleryResponse {
1406
1296
  /** Published gallery. */
1407
1297
  gallery?: Gallery;
1408
1298
  }
1299
+ interface UpdateDocumentsEvent extends UpdateDocumentsEventOperationOneOf {
1300
+ /** insert/update documents */
1301
+ update?: DocumentUpdateOperation;
1302
+ /** delete by document ids */
1303
+ deleteByIds?: DeleteByIdsOperation;
1304
+ /** delete documents matching filter */
1305
+ deleteByFilter?: DeleteByFilterOperation;
1306
+ /** update documents matching filter */
1307
+ updateByFilter?: UpdateByFilterOperation;
1308
+ /** update only existing documents */
1309
+ updateExisting?: UpdateExistingOperation;
1310
+ /** application which owns documents */
1311
+ appDefId?: string | null;
1312
+ /** type of the documents */
1313
+ documentType?: string | null;
1314
+ /** language of the documents */
1315
+ language?: string | null;
1316
+ /** site documents belong to */
1317
+ msId?: string | null;
1318
+ }
1319
+ /** @oneof */
1320
+ interface UpdateDocumentsEventOperationOneOf {
1321
+ /** insert/update documents */
1322
+ update?: DocumentUpdateOperation;
1323
+ /** delete by document ids */
1324
+ deleteByIds?: DeleteByIdsOperation;
1325
+ /** delete documents matching filter */
1326
+ deleteByFilter?: DeleteByFilterOperation;
1327
+ /** update documents matching filter */
1328
+ updateByFilter?: UpdateByFilterOperation;
1329
+ /** update only existing documents */
1330
+ updateExisting?: UpdateExistingOperation;
1331
+ }
1332
+ interface DocumentUpdateOperation {
1333
+ /** documents to index or update */
1334
+ documents?: IndexDocument[];
1335
+ }
1336
+ interface IndexDocument {
1337
+ /** data bag with non-searchable fields (url, image) */
1338
+ payload?: DocumentPayload;
1339
+ /** what type of users should documents be visible to */
1340
+ exposure?: Enum;
1341
+ /** document with mandatory fields (id, title, description) and with fields specific to the type of the document */
1342
+ document?: Record<string, any> | null;
1343
+ /** what member groups is the document exposed to. Used only with GROUP_PROTECTED exposure */
1344
+ permittedMemberGroups?: string[];
1345
+ /** if true SEO is disabled for this document */
1346
+ seoHidden?: boolean | null;
1347
+ /** if true the page is a lightbox popup */
1348
+ isPopup?: boolean | null;
1349
+ }
1350
+ interface DocumentPayload {
1351
+ /** url of the page representing the document */
1352
+ url?: string | null;
1353
+ /** image which represents the document */
1354
+ documentImage?: DocumentImage;
1355
+ }
1356
+ interface DocumentImage {
1357
+ /** the name of the image */
1358
+ name?: string;
1359
+ /** the width of the image */
1360
+ width?: number;
1361
+ /** the height of the image */
1362
+ height?: number;
1363
+ }
1364
+ declare enum Enum {
1365
+ /** Default value. Means that permission not set */
1366
+ UNKNOWN = "UNKNOWN",
1367
+ /** Protected exposure. Exposed to members and owners */
1368
+ PROTECTED = "PROTECTED",
1369
+ /** Private exposure. Exposed to owners */
1370
+ PRIVATE = "PRIVATE",
1371
+ /** Public exposure. Visible to everyone */
1372
+ PUBLIC = "PUBLIC",
1373
+ /** Used for partial updates, to state that exposure is not changing */
1374
+ UNCHANGED = "UNCHANGED",
1375
+ /** Protected to members of permitted groups and owners */
1376
+ GROUP_PROTECTED = "GROUP_PROTECTED"
1377
+ }
1378
+ interface DeleteByIdsOperation {
1379
+ /** ids of the documents to delete */
1380
+ documentIds?: string[];
1381
+ }
1382
+ interface DeleteByFilterOperation {
1383
+ /** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
1384
+ filter?: Record<string, any> | null;
1385
+ }
1386
+ interface UpdateByFilterOperation {
1387
+ /** documents matching this filter will be updated */
1388
+ filter?: Record<string, any> | null;
1389
+ /** partial document to apply */
1390
+ document?: IndexDocument;
1391
+ }
1392
+ interface UpdateExistingOperation {
1393
+ /** documents to update */
1394
+ documents?: IndexDocument[];
1395
+ }
1396
+ interface SearchIndexingNotification {
1397
+ /** new state of indexing for the site specified in ms_id */
1398
+ indexState?: SearchIndexingNotificationState;
1399
+ /** type of the document the notification is targeted for. Applies to all types if not provided */
1400
+ documentType?: string | null;
1401
+ /** languaInternalDocumentUpdateByFilterOperationge the notification is targeted for. Applies to all languages if not provided */
1402
+ language?: string | null;
1403
+ /** site for which notification is targeted */
1404
+ msId?: string | null;
1405
+ }
1406
+ declare enum SearchIndexingNotificationState {
1407
+ /** default state */
1408
+ Unknown = "Unknown",
1409
+ /** metasite does not require site search indexing */
1410
+ Off = "Off",
1411
+ /** metasite requires site search indexing */
1412
+ On = "On"
1413
+ }
1409
1414
  interface PointNonNullableFields {
1410
1415
  x: number;
1411
1416
  y: number;
@@ -1580,10 +1585,6 @@ interface GalleryCreatedEnvelope {
1580
1585
  entity: Gallery;
1581
1586
  metadata: EventMetadata;
1582
1587
  }
1583
- interface GalleryUpdatedEnvelope {
1584
- entity: Gallery;
1585
- metadata: EventMetadata;
1586
- }
1587
1588
  interface GalleryDeletedEnvelope {
1588
1589
  metadata: EventMetadata;
1589
1590
  }
@@ -1591,12 +1592,16 @@ interface GalleryItemCreatedEnvelope {
1591
1592
  data: GalleryItemCreated;
1592
1593
  metadata: EventMetadata;
1593
1594
  }
1595
+ interface GalleryItemDeletedEnvelope {
1596
+ data: GalleryItemDeleted;
1597
+ metadata: EventMetadata;
1598
+ }
1594
1599
  interface GalleryItemUpdatedEnvelope {
1595
1600
  data: GalleryItemUpdated;
1596
1601
  metadata: EventMetadata;
1597
1602
  }
1598
- interface GalleryItemDeletedEnvelope {
1599
- data: GalleryItemDeleted;
1603
+ interface GalleryUpdatedEnvelope {
1604
+ entity: Gallery;
1600
1605
  metadata: EventMetadata;
1601
1606
  }
1602
1607
  interface ListGalleriesOptions {
@@ -1709,7 +1714,10 @@ interface UpdateGalleryItem {
1709
1714
  description?: string | null;
1710
1715
  /** Link from the item. You can link to Wix sites or external URLs. */
1711
1716
  link?: Link;
1712
- /** @readonly */
1717
+ /**
1718
+ * Type of item.
1719
+ * @readonly
1720
+ */
1713
1721
  type?: Type;
1714
1722
  /**
1715
1723
  * Date and time the item was created.
@@ -1887,11 +1895,11 @@ interface DeleteGalleryItemSignature {
1887
1895
  (identifiers: DeleteGalleryItemIdentifiers): Promise<DeleteGalleryItemResponse & DeleteGalleryItemResponseNonNullableFields>;
1888
1896
  }
1889
1897
  declare const onGalleryCreated$1: EventDefinition<GalleryCreatedEnvelope, "wix.pro_gallery.gallery_v2_created">;
1890
- declare const onGalleryUpdated$1: EventDefinition<GalleryUpdatedEnvelope, "wix.pro_gallery.gallery_v2_updated">;
1891
1898
  declare const onGalleryDeleted$1: EventDefinition<GalleryDeletedEnvelope, "wix.pro_gallery.gallery_v2_deleted">;
1892
1899
  declare const onGalleryItemCreated$1: EventDefinition<GalleryItemCreatedEnvelope, "wix.pro_gallery.gallery_v2_gallery_item_created">;
1893
- declare const onGalleryItemUpdated$1: EventDefinition<GalleryItemUpdatedEnvelope, "wix.pro_gallery.gallery_v2_gallery_item_updated">;
1894
1900
  declare const onGalleryItemDeleted$1: EventDefinition<GalleryItemDeletedEnvelope, "wix.pro_gallery.gallery_v2_gallery_item_deleted">;
1901
+ declare const onGalleryItemUpdated$1: EventDefinition<GalleryItemUpdatedEnvelope, "wix.pro_gallery.gallery_v2_gallery_item_updated">;
1902
+ declare const onGalleryUpdated$1: EventDefinition<GalleryUpdatedEnvelope, "wix.pro_gallery.gallery_v2_updated">;
1895
1903
 
1896
1904
  declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
1897
1905
 
@@ -1917,15 +1925,6 @@ type _publicOnGalleryCreatedType = typeof onGalleryCreated$1;
1917
1925
  */
1918
1926
  declare const onGalleryCreated: ReturnType<typeof createEventModule<_publicOnGalleryCreatedType>>;
1919
1927
 
1920
- type _publicOnGalleryUpdatedType = typeof onGalleryUpdated$1;
1921
- /**
1922
- * Triggered when a gallery is updated.
1923
- *
1924
- * > __Note:__ The event data doesn't include gallery items or their IDs.
1925
- * > To receive information about the updated items you need to listen to the [Gallery Item Updated webhook](https://dev.wix.com/api/rest/site-content/pro-gallery/gallery-item-updated-webhook).
1926
- */
1927
- declare const onGalleryUpdated: ReturnType<typeof createEventModule<_publicOnGalleryUpdatedType>>;
1928
-
1929
1928
  type _publicOnGalleryDeletedType = typeof onGalleryDeleted$1;
1930
1929
  /**
1931
1930
  * Triggered when a gallery is deleted.
@@ -1938,20 +1937,29 @@ type _publicOnGalleryItemCreatedType = typeof onGalleryItemCreated$1;
1938
1937
  */
1939
1938
  declare const onGalleryItemCreated: ReturnType<typeof createEventModule<_publicOnGalleryItemCreatedType>>;
1940
1939
 
1940
+ type _publicOnGalleryItemDeletedType = typeof onGalleryItemDeleted$1;
1941
+ /**
1942
+ * Triggered when a media item in a specified gallery is deleted.
1943
+ *
1944
+ * > __Note:__ The event is triggered when a gallery item is deleted individually and when a gallery item is deleted because its gallery is deleted.
1945
+ * > The property `originatedFrom` has the value `Gallery Deleted` if the entire gallery is deleted. If the gallery item is deleted individually, this field is empty.
1946
+ */
1947
+ declare const onGalleryItemDeleted: ReturnType<typeof createEventModule<_publicOnGalleryItemDeletedType>>;
1948
+
1941
1949
  type _publicOnGalleryItemUpdatedType = typeof onGalleryItemUpdated$1;
1942
1950
  /**
1943
1951
  * Triggered when a media item in a specified gallery is updated.
1944
1952
  */
1945
1953
  declare const onGalleryItemUpdated: ReturnType<typeof createEventModule<_publicOnGalleryItemUpdatedType>>;
1946
1954
 
1947
- type _publicOnGalleryItemDeletedType = typeof onGalleryItemDeleted$1;
1955
+ type _publicOnGalleryUpdatedType = typeof onGalleryUpdated$1;
1948
1956
  /**
1949
- * Triggered when a media item in a specified gallery is deleted.
1957
+ * Triggered when a gallery is updated.
1950
1958
  *
1951
- * > __Note:__ The event is triggered when a gallery item is deleted individually and when a gallery item is deleted because its gallery is deleted.
1952
- * > The property `originatedFrom` has the value `Gallery Deleted` if the entire gallery is deleted. If the gallery item is deleted individually, this field is empty.
1959
+ * > __Note:__ The event data doesn't include gallery items or their IDs.
1960
+ * > To receive information about the updated items you need to listen to the [Gallery Item Updated webhook](https://dev.wix.com/api/rest/site-content/pro-gallery/gallery-item-updated-webhook).
1953
1961
  */
1954
- declare const onGalleryItemDeleted: ReturnType<typeof createEventModule<_publicOnGalleryItemDeletedType>>;
1962
+ declare const onGalleryUpdated: ReturnType<typeof createEventModule<_publicOnGalleryUpdatedType>>;
1955
1963
 
1956
1964
  type context_ActionEvent = ActionEvent;
1957
1965
  type context_AddressLink = AddressLink;
@@ -529,7 +529,10 @@ interface Item extends ItemMetadataOneOf {
529
529
  description?: string | null;
530
530
  /** Link from the item. You can link to Wix sites or external URLs. */
531
531
  link?: Link;
532
- /** @readonly */
532
+ /**
533
+ * Type of item.
534
+ * @readonly
535
+ */
533
536
  type?: Type;
534
537
  /**
535
538
  * Date and time the item was created.
@@ -561,9 +564,9 @@ interface Link {
561
564
  }
562
565
  declare enum LinkType {
563
566
  UNDEFINED = "UNDEFINED",
564
- /** external link */
567
+ /** External link. */
565
568
  EXTERNAL = "EXTERNAL",
566
- /** for internal usage using wixLinkData */
569
+ /** For internal usage using wixLinkData. */
567
570
  INTERNAL = "INTERNAL"
568
571
  }
569
572
  /** The link object generated by panels in the editor and used by applications in Wix */
@@ -751,7 +754,7 @@ interface UnsharpMasking {
751
754
  /** Unsharp masking radius in pixels. Controls the sharpening width. */
752
755
  radius?: number | null;
753
756
  /**
754
- * Unsharp masking threshold. Controls how different neighboring pixels must be for shapening to apply. <br />
757
+ * Unsharp masking threshold. Controls how different neighboring pixels must be for sharpening to apply. <br />
755
758
  *
756
759
  * Min: `0` <br />
757
760
  * Max: `1`
@@ -759,6 +762,7 @@ interface UnsharpMasking {
759
762
  threshold?: number | null;
760
763
  }
761
764
  interface Video {
765
+ /** Type of video. */
762
766
  type?: VideoType;
763
767
  /**
764
768
  * The video's URL. Either a Wix media URL, or a supported https external URL in the following formats:
@@ -1086,121 +1090,6 @@ declare enum WebhookIdentityType {
1086
1090
  WIX_USER = "WIX_USER",
1087
1091
  APP = "APP"
1088
1092
  }
1089
- interface UpdateDocumentsEvent extends UpdateDocumentsEventOperationOneOf {
1090
- /** insert/update documents */
1091
- update?: DocumentUpdateOperation;
1092
- /** delete by document ids */
1093
- deleteByIds?: DeleteByIdsOperation;
1094
- /** delete documents matching filter */
1095
- deleteByFilter?: DeleteByFilterOperation;
1096
- /** update documents matching filter */
1097
- updateByFilter?: UpdateByFilterOperation;
1098
- /** update only existing documents */
1099
- updateExisting?: UpdateExistingOperation;
1100
- /** application which owns documents */
1101
- appDefId?: string | null;
1102
- /** type of the documents */
1103
- documentType?: string | null;
1104
- /** language of the documents */
1105
- language?: string | null;
1106
- /** site documents belong to */
1107
- msId?: string | null;
1108
- }
1109
- /** @oneof */
1110
- interface UpdateDocumentsEventOperationOneOf {
1111
- /** insert/update documents */
1112
- update?: DocumentUpdateOperation;
1113
- /** delete by document ids */
1114
- deleteByIds?: DeleteByIdsOperation;
1115
- /** delete documents matching filter */
1116
- deleteByFilter?: DeleteByFilterOperation;
1117
- /** update documents matching filter */
1118
- updateByFilter?: UpdateByFilterOperation;
1119
- /** update only existing documents */
1120
- updateExisting?: UpdateExistingOperation;
1121
- }
1122
- interface DocumentUpdateOperation {
1123
- /** documents to index or update */
1124
- documents?: IndexDocument[];
1125
- }
1126
- interface IndexDocument {
1127
- /** data bag with non-searchable fields (url, image) */
1128
- payload?: DocumentPayload;
1129
- /** what type of users should documents be visible to */
1130
- exposure?: Enum;
1131
- /** document with mandatory fields (id, title, description) and with fields specific to the type of the document */
1132
- document?: Record<string, any> | null;
1133
- /** what member groups is the document exposed to. Used only with GROUP_PROTECTED exposure */
1134
- permittedMemberGroups?: string[];
1135
- /** if true SEO is disabled for this document */
1136
- seoHidden?: boolean | null;
1137
- /** if true the page is a lightbox popup */
1138
- isPopup?: boolean | null;
1139
- }
1140
- interface DocumentPayload {
1141
- /** url of the page representing the document */
1142
- url?: string | null;
1143
- /** image which represents the document */
1144
- documentImage?: DocumentImage;
1145
- }
1146
- interface DocumentImage {
1147
- /** the name of the image */
1148
- name?: string;
1149
- /** the width of the image */
1150
- width?: number;
1151
- /** the height of the image */
1152
- height?: number;
1153
- }
1154
- declare enum Enum {
1155
- /** Default value. Means that permission not set */
1156
- UNKNOWN = "UNKNOWN",
1157
- /** Protected exposure. Exposed to members and owners */
1158
- PROTECTED = "PROTECTED",
1159
- /** Private exposure. Exposed to owners */
1160
- PRIVATE = "PRIVATE",
1161
- /** Public exposure. Visible to everyone */
1162
- PUBLIC = "PUBLIC",
1163
- /** Used for partial updates, to state that exposure is not changing */
1164
- UNCHANGED = "UNCHANGED",
1165
- /** Protected to members of permitted groups and owners */
1166
- GROUP_PROTECTED = "GROUP_PROTECTED"
1167
- }
1168
- interface DeleteByIdsOperation {
1169
- /** ids of the documents to delete */
1170
- documentIds?: string[];
1171
- }
1172
- interface DeleteByFilterOperation {
1173
- /** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
1174
- filter?: Record<string, any> | null;
1175
- }
1176
- interface UpdateByFilterOperation {
1177
- /** documents matching this filter will be updated */
1178
- filter?: Record<string, any> | null;
1179
- /** partial document to apply */
1180
- document?: IndexDocument;
1181
- }
1182
- interface UpdateExistingOperation {
1183
- /** documents to update */
1184
- documents?: IndexDocument[];
1185
- }
1186
- interface SearchIndexingNotification {
1187
- /** new state of indexing for the site specified in ms_id */
1188
- indexState?: SearchIndexingNotificationState;
1189
- /** type of the document the notification is targeted for. Applies to all types if not provided */
1190
- documentType?: string | null;
1191
- /** languaInternalDocumentUpdateByFilterOperationge the notification is targeted for. Applies to all languages if not provided */
1192
- language?: string | null;
1193
- /** site for which notification is targeted */
1194
- msId?: string | null;
1195
- }
1196
- declare enum SearchIndexingNotificationState {
1197
- /** default state */
1198
- Unknown = "Unknown",
1199
- /** metasite does not require site search indexing */
1200
- Off = "Off",
1201
- /** metasite requires site search indexing */
1202
- On = "On"
1203
- }
1204
1093
  interface ListGalleriesItemsRequest {
1205
1094
  /** IDs of the media items to retrieve. */
1206
1095
  itemsId?: ItemId[];
@@ -1242,10 +1131,11 @@ interface ListGalleriesRequest {
1242
1131
  limit?: number | null;
1243
1132
  }
1244
1133
  declare enum State {
1134
+ /** Undefined state. */
1245
1135
  UNDEFINED = "UNDEFINED",
1246
- /** The gallery in the Editor segment */
1136
+ /** The gallery in the Editor. */
1247
1137
  SAVED = "SAVED",
1248
- /** The gallery in the LiveSite segment */
1138
+ /** The gallery in the LiveSite. */
1249
1139
  PUBLISHED = "PUBLISHED"
1250
1140
  }
1251
1141
  interface ListGalleriesResponse {
@@ -1406,6 +1296,121 @@ interface PublishGalleryResponse {
1406
1296
  /** Published gallery. */
1407
1297
  gallery?: Gallery;
1408
1298
  }
1299
+ interface UpdateDocumentsEvent extends UpdateDocumentsEventOperationOneOf {
1300
+ /** insert/update documents */
1301
+ update?: DocumentUpdateOperation;
1302
+ /** delete by document ids */
1303
+ deleteByIds?: DeleteByIdsOperation;
1304
+ /** delete documents matching filter */
1305
+ deleteByFilter?: DeleteByFilterOperation;
1306
+ /** update documents matching filter */
1307
+ updateByFilter?: UpdateByFilterOperation;
1308
+ /** update only existing documents */
1309
+ updateExisting?: UpdateExistingOperation;
1310
+ /** application which owns documents */
1311
+ appDefId?: string | null;
1312
+ /** type of the documents */
1313
+ documentType?: string | null;
1314
+ /** language of the documents */
1315
+ language?: string | null;
1316
+ /** site documents belong to */
1317
+ msId?: string | null;
1318
+ }
1319
+ /** @oneof */
1320
+ interface UpdateDocumentsEventOperationOneOf {
1321
+ /** insert/update documents */
1322
+ update?: DocumentUpdateOperation;
1323
+ /** delete by document ids */
1324
+ deleteByIds?: DeleteByIdsOperation;
1325
+ /** delete documents matching filter */
1326
+ deleteByFilter?: DeleteByFilterOperation;
1327
+ /** update documents matching filter */
1328
+ updateByFilter?: UpdateByFilterOperation;
1329
+ /** update only existing documents */
1330
+ updateExisting?: UpdateExistingOperation;
1331
+ }
1332
+ interface DocumentUpdateOperation {
1333
+ /** documents to index or update */
1334
+ documents?: IndexDocument[];
1335
+ }
1336
+ interface IndexDocument {
1337
+ /** data bag with non-searchable fields (url, image) */
1338
+ payload?: DocumentPayload;
1339
+ /** what type of users should documents be visible to */
1340
+ exposure?: Enum;
1341
+ /** document with mandatory fields (id, title, description) and with fields specific to the type of the document */
1342
+ document?: Record<string, any> | null;
1343
+ /** what member groups is the document exposed to. Used only with GROUP_PROTECTED exposure */
1344
+ permittedMemberGroups?: string[];
1345
+ /** if true SEO is disabled for this document */
1346
+ seoHidden?: boolean | null;
1347
+ /** if true the page is a lightbox popup */
1348
+ isPopup?: boolean | null;
1349
+ }
1350
+ interface DocumentPayload {
1351
+ /** url of the page representing the document */
1352
+ url?: string | null;
1353
+ /** image which represents the document */
1354
+ documentImage?: DocumentImage;
1355
+ }
1356
+ interface DocumentImage {
1357
+ /** the name of the image */
1358
+ name?: string;
1359
+ /** the width of the image */
1360
+ width?: number;
1361
+ /** the height of the image */
1362
+ height?: number;
1363
+ }
1364
+ declare enum Enum {
1365
+ /** Default value. Means that permission not set */
1366
+ UNKNOWN = "UNKNOWN",
1367
+ /** Protected exposure. Exposed to members and owners */
1368
+ PROTECTED = "PROTECTED",
1369
+ /** Private exposure. Exposed to owners */
1370
+ PRIVATE = "PRIVATE",
1371
+ /** Public exposure. Visible to everyone */
1372
+ PUBLIC = "PUBLIC",
1373
+ /** Used for partial updates, to state that exposure is not changing */
1374
+ UNCHANGED = "UNCHANGED",
1375
+ /** Protected to members of permitted groups and owners */
1376
+ GROUP_PROTECTED = "GROUP_PROTECTED"
1377
+ }
1378
+ interface DeleteByIdsOperation {
1379
+ /** ids of the documents to delete */
1380
+ documentIds?: string[];
1381
+ }
1382
+ interface DeleteByFilterOperation {
1383
+ /** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
1384
+ filter?: Record<string, any> | null;
1385
+ }
1386
+ interface UpdateByFilterOperation {
1387
+ /** documents matching this filter will be updated */
1388
+ filter?: Record<string, any> | null;
1389
+ /** partial document to apply */
1390
+ document?: IndexDocument;
1391
+ }
1392
+ interface UpdateExistingOperation {
1393
+ /** documents to update */
1394
+ documents?: IndexDocument[];
1395
+ }
1396
+ interface SearchIndexingNotification {
1397
+ /** new state of indexing for the site specified in ms_id */
1398
+ indexState?: SearchIndexingNotificationState;
1399
+ /** type of the document the notification is targeted for. Applies to all types if not provided */
1400
+ documentType?: string | null;
1401
+ /** languaInternalDocumentUpdateByFilterOperationge the notification is targeted for. Applies to all languages if not provided */
1402
+ language?: string | null;
1403
+ /** site for which notification is targeted */
1404
+ msId?: string | null;
1405
+ }
1406
+ declare enum SearchIndexingNotificationState {
1407
+ /** default state */
1408
+ Unknown = "Unknown",
1409
+ /** metasite does not require site search indexing */
1410
+ Off = "Off",
1411
+ /** metasite requires site search indexing */
1412
+ On = "On"
1413
+ }
1409
1414
  interface PointNonNullableFields {
1410
1415
  x: number;
1411
1416
  y: number;
@@ -1580,10 +1585,6 @@ interface GalleryCreatedEnvelope {
1580
1585
  entity: Gallery;
1581
1586
  metadata: EventMetadata;
1582
1587
  }
1583
- interface GalleryUpdatedEnvelope {
1584
- entity: Gallery;
1585
- metadata: EventMetadata;
1586
- }
1587
1588
  interface GalleryDeletedEnvelope {
1588
1589
  metadata: EventMetadata;
1589
1590
  }
@@ -1591,12 +1592,16 @@ interface GalleryItemCreatedEnvelope {
1591
1592
  data: GalleryItemCreated;
1592
1593
  metadata: EventMetadata;
1593
1594
  }
1595
+ interface GalleryItemDeletedEnvelope {
1596
+ data: GalleryItemDeleted;
1597
+ metadata: EventMetadata;
1598
+ }
1594
1599
  interface GalleryItemUpdatedEnvelope {
1595
1600
  data: GalleryItemUpdated;
1596
1601
  metadata: EventMetadata;
1597
1602
  }
1598
- interface GalleryItemDeletedEnvelope {
1599
- data: GalleryItemDeleted;
1603
+ interface GalleryUpdatedEnvelope {
1604
+ entity: Gallery;
1600
1605
  metadata: EventMetadata;
1601
1606
  }
1602
1607
  interface ListGalleriesOptions {
@@ -1709,7 +1714,10 @@ interface UpdateGalleryItem {
1709
1714
  description?: string | null;
1710
1715
  /** Link from the item. You can link to Wix sites or external URLs. */
1711
1716
  link?: Link;
1712
- /** @readonly */
1717
+ /**
1718
+ * Type of item.
1719
+ * @readonly
1720
+ */
1713
1721
  type?: Type;
1714
1722
  /**
1715
1723
  * Date and time the item was created.
@@ -1887,11 +1895,11 @@ interface DeleteGalleryItemSignature {
1887
1895
  (identifiers: DeleteGalleryItemIdentifiers): Promise<DeleteGalleryItemResponse & DeleteGalleryItemResponseNonNullableFields>;
1888
1896
  }
1889
1897
  declare const onGalleryCreated$1: EventDefinition<GalleryCreatedEnvelope, "wix.pro_gallery.gallery_v2_created">;
1890
- declare const onGalleryUpdated$1: EventDefinition<GalleryUpdatedEnvelope, "wix.pro_gallery.gallery_v2_updated">;
1891
1898
  declare const onGalleryDeleted$1: EventDefinition<GalleryDeletedEnvelope, "wix.pro_gallery.gallery_v2_deleted">;
1892
1899
  declare const onGalleryItemCreated$1: EventDefinition<GalleryItemCreatedEnvelope, "wix.pro_gallery.gallery_v2_gallery_item_created">;
1893
- declare const onGalleryItemUpdated$1: EventDefinition<GalleryItemUpdatedEnvelope, "wix.pro_gallery.gallery_v2_gallery_item_updated">;
1894
1900
  declare const onGalleryItemDeleted$1: EventDefinition<GalleryItemDeletedEnvelope, "wix.pro_gallery.gallery_v2_gallery_item_deleted">;
1901
+ declare const onGalleryItemUpdated$1: EventDefinition<GalleryItemUpdatedEnvelope, "wix.pro_gallery.gallery_v2_gallery_item_updated">;
1902
+ declare const onGalleryUpdated$1: EventDefinition<GalleryUpdatedEnvelope, "wix.pro_gallery.gallery_v2_updated">;
1895
1903
 
1896
1904
  declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
1897
1905
 
@@ -1917,15 +1925,6 @@ type _publicOnGalleryCreatedType = typeof onGalleryCreated$1;
1917
1925
  */
1918
1926
  declare const onGalleryCreated: ReturnType<typeof createEventModule<_publicOnGalleryCreatedType>>;
1919
1927
 
1920
- type _publicOnGalleryUpdatedType = typeof onGalleryUpdated$1;
1921
- /**
1922
- * Triggered when a gallery is updated.
1923
- *
1924
- * > __Note:__ The event data doesn't include gallery items or their IDs.
1925
- * > To receive information about the updated items you need to listen to the [Gallery Item Updated webhook](https://dev.wix.com/api/rest/site-content/pro-gallery/gallery-item-updated-webhook).
1926
- */
1927
- declare const onGalleryUpdated: ReturnType<typeof createEventModule<_publicOnGalleryUpdatedType>>;
1928
-
1929
1928
  type _publicOnGalleryDeletedType = typeof onGalleryDeleted$1;
1930
1929
  /**
1931
1930
  * Triggered when a gallery is deleted.
@@ -1938,20 +1937,29 @@ type _publicOnGalleryItemCreatedType = typeof onGalleryItemCreated$1;
1938
1937
  */
1939
1938
  declare const onGalleryItemCreated: ReturnType<typeof createEventModule<_publicOnGalleryItemCreatedType>>;
1940
1939
 
1940
+ type _publicOnGalleryItemDeletedType = typeof onGalleryItemDeleted$1;
1941
+ /**
1942
+ * Triggered when a media item in a specified gallery is deleted.
1943
+ *
1944
+ * > __Note:__ The event is triggered when a gallery item is deleted individually and when a gallery item is deleted because its gallery is deleted.
1945
+ * > The property `originatedFrom` has the value `Gallery Deleted` if the entire gallery is deleted. If the gallery item is deleted individually, this field is empty.
1946
+ */
1947
+ declare const onGalleryItemDeleted: ReturnType<typeof createEventModule<_publicOnGalleryItemDeletedType>>;
1948
+
1941
1949
  type _publicOnGalleryItemUpdatedType = typeof onGalleryItemUpdated$1;
1942
1950
  /**
1943
1951
  * Triggered when a media item in a specified gallery is updated.
1944
1952
  */
1945
1953
  declare const onGalleryItemUpdated: ReturnType<typeof createEventModule<_publicOnGalleryItemUpdatedType>>;
1946
1954
 
1947
- type _publicOnGalleryItemDeletedType = typeof onGalleryItemDeleted$1;
1955
+ type _publicOnGalleryUpdatedType = typeof onGalleryUpdated$1;
1948
1956
  /**
1949
- * Triggered when a media item in a specified gallery is deleted.
1957
+ * Triggered when a gallery is updated.
1950
1958
  *
1951
- * > __Note:__ The event is triggered when a gallery item is deleted individually and when a gallery item is deleted because its gallery is deleted.
1952
- * > The property `originatedFrom` has the value `Gallery Deleted` if the entire gallery is deleted. If the gallery item is deleted individually, this field is empty.
1959
+ * > __Note:__ The event data doesn't include gallery items or their IDs.
1960
+ * > To receive information about the updated items you need to listen to the [Gallery Item Updated webhook](https://dev.wix.com/api/rest/site-content/pro-gallery/gallery-item-updated-webhook).
1953
1961
  */
1954
- declare const onGalleryItemDeleted: ReturnType<typeof createEventModule<_publicOnGalleryItemDeletedType>>;
1962
+ declare const onGalleryUpdated: ReturnType<typeof createEventModule<_publicOnGalleryUpdatedType>>;
1955
1963
 
1956
1964
  type index_d_ActionEvent = ActionEvent;
1957
1965
  type index_d_AddressLink = AddressLink;
@@ -51,7 +51,10 @@ interface Item$1 extends ItemMetadataOneOf$1 {
51
51
  description?: string | null;
52
52
  /** Link from the item. You can link to Wix sites or external URLs. */
53
53
  link?: Link$1;
54
- /** @readonly */
54
+ /**
55
+ * Type of item.
56
+ * @readonly
57
+ */
55
58
  type?: Type$1;
56
59
  /**
57
60
  * Date and time the item was created.
@@ -83,9 +86,9 @@ interface Link$1 {
83
86
  }
84
87
  declare enum LinkType$1 {
85
88
  UNDEFINED = "UNDEFINED",
86
- /** external link */
89
+ /** External link. */
87
90
  EXTERNAL = "EXTERNAL",
88
- /** for internal usage using wixLinkData */
91
+ /** For internal usage using wixLinkData. */
89
92
  INTERNAL = "INTERNAL"
90
93
  }
91
94
  /**
@@ -167,7 +170,7 @@ interface UnsharpMasking$1 {
167
170
  /** Unsharp masking radius in pixels. Controls the sharpening width. */
168
171
  radius?: number | null;
169
172
  /**
170
- * Unsharp masking threshold. Controls how different neighboring pixels must be for shapening to apply. <br />
173
+ * Unsharp masking threshold. Controls how different neighboring pixels must be for sharpening to apply. <br />
171
174
  *
172
175
  * Min: `0` <br />
173
176
  * Max: `1`
@@ -175,6 +178,7 @@ interface UnsharpMasking$1 {
175
178
  threshold?: number | null;
176
179
  }
177
180
  interface Video$1 {
181
+ /** Type of video. */
178
182
  type?: VideoType$1;
179
183
  /** Information about the video. */
180
184
  videoInfo?: VideoV2;
@@ -600,7 +604,10 @@ interface Item extends ItemMetadataOneOf {
600
604
  description?: string | null;
601
605
  /** Link from the item. You can link to Wix sites or external URLs. */
602
606
  link?: Link;
603
- /** @readonly */
607
+ /**
608
+ * Type of item.
609
+ * @readonly
610
+ */
604
611
  type?: Type;
605
612
  /**
606
613
  * Date and time the item was created.
@@ -632,9 +639,9 @@ interface Link {
632
639
  }
633
640
  declare enum LinkType {
634
641
  UNDEFINED = "UNDEFINED",
635
- /** external link */
642
+ /** External link. */
636
643
  EXTERNAL = "EXTERNAL",
637
- /** for internal usage using wixLinkData */
644
+ /** For internal usage using wixLinkData. */
638
645
  INTERNAL = "INTERNAL"
639
646
  }
640
647
  /**
@@ -699,7 +706,7 @@ interface UnsharpMasking {
699
706
  /** Unsharp masking radius in pixels. Controls the sharpening width. */
700
707
  radius?: number | null;
701
708
  /**
702
- * Unsharp masking threshold. Controls how different neighboring pixels must be for shapening to apply. <br />
709
+ * Unsharp masking threshold. Controls how different neighboring pixels must be for sharpening to apply. <br />
703
710
  *
704
711
  * Min: `0` <br />
705
712
  * Max: `1`
@@ -707,6 +714,7 @@ interface UnsharpMasking {
707
714
  threshold?: number | null;
708
715
  }
709
716
  interface Video {
717
+ /** Type of video. */
710
718
  type?: VideoType;
711
719
  /**
712
720
  * The video's URL. Either a Wix media URL, or a supported https external URL in the following formats: