@wix/auto_sdk_pro-gallery_pro-gallery 1.0.22 → 1.0.24

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.
@@ -1,8 +1,7 @@
1
1
  import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
2
2
  import { ListGalleriesOptions, ListGalleriesResponse, GetGalleryOptions, Gallery, ListGalleryItemsOptions, ListGalleryItemsResponse, GetGalleryItemIdentifiers, Item, CreateGalleryOptions, UpdateGallery, DeleteGalleryResponse, DeleteGalleryItemsOptions, DeleteGalleryItemsResponse, BulkDeleteGalleryItemsResponse, UpdateGalleryItemIdentifiers, UpdateGalleryItem, DeleteGalleryItemIdentifiers, DeleteGalleryItemResponse, GalleryCreatedEnvelope, GalleryDeletedEnvelope, GalleryItemCreatedEnvelope, GalleryItemDeletedEnvelope, GalleryItemUpdatedEnvelope, GalleryUpdatedEnvelope } from './index.typings.mjs';
3
- export { ActionEvent, AddressLink, AnchorLink, App, BaseEventMetadata, BulkDeleteGalleryItemsRequest, CleanDeletedGalleriesEvent, CreateGalleryItemRequest, CreateGalleryItemResponse, CreateGalleryItemsRequest, CreateGalleryItemsResponse, CreateGalleryRequest, CreateGalleryResponse, CustomTag, DeleteByFilterOperation, DeleteByIdsOperation, DeleteGalleryItemRequest, DeleteGalleryItemsRequest, DeleteGalleryRequest, DocumentImage, DocumentLink, DocumentPayload, DocumentUpdateOperation, DomainEvent, DomainEventBodyOneOf, DynamicPageLink, EmailLink, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, Enum, EventMetadata, EventsPage, ExternalLink, File, GalleryItemCreated, GalleryItemDeleted, GalleryItemUpdated, GalleryPublished, GetActiveGalleryRevisionRequest, GetActiveGalleryRevisionResponse, GetGalleryItemRequest, GetGalleryItemResponse, GetGalleryOptionsVersionOneOf, GetGalleryRequest, GetGalleryRequestVersionOneOf, GetGalleryResponse, GetGalleryRevisionRequest, GetGalleryRevisionResponse, HtmlSitePublished, HtmlSiteRCPublished, IdentificationData, IdentificationDataIdOneOf, Image, ImageType, IndexDocument, InvalidateCache, InvalidateCacheGetByOneOf, ItemId, ItemMetadataOneOf, ItemsInGallery, Link, LinkRel, LinkType, ListGalleriesItemsRequest, ListGalleriesItemsResponse, ListGalleriesRequest, ListGalleryItemsRequest, MessageEnvelope, Page, PageLink, PhoneLink, Point, ProgallerypublisherPublishGalleryRequest, ProgallerypublisherPublishGalleryResponse, PublishGalleryItemRequest, PublishGalleryItemResponse, PublishGalleryItemsRequest, PublishGalleryItemsResponse, PublishGalleryRequest, PublishGalleryResponse, RCLabel, RestoreAllGalleriesEvent, RestoreInfo, SearchIndexingNotification, SearchIndexingNotificationState, SecondaryMedia, SecondaryMediaMetadataOneOf, State, Tags, Text, TpaPageLink, TriggerRestoreAllGalleriesAsyncRequest, TriggerRestoreAllGalleriesAsyncResponse, Type, URI, UnsharpMasking, UpdateByFilterOperation, UpdateDocumentsEvent, UpdateDocumentsEventOperationOneOf, UpdateExistingOperation, UpdateGalleryItemRequest, UpdateGalleryItemResponse, UpdateGalleryRequest, UpdateGalleryResponse, Video, VideoResolution, VideoType, WebhookIdentityType, WhatsAppLink, WixLink, WixLinkLinkOneOf } from './index.typings.mjs';
3
+ export { ActionEvent, AddressLink, AnchorLink, App, BaseEventMetadata, BulkDeleteGalleryItemsRequest, CleanDeletedGalleriesEvent, CreateGalleryItemRequest, CreateGalleryItemResponse, CreateGalleryItemsRequest, CreateGalleryItemsResponse, CreateGalleryRequest, CreateGalleryResponse, CustomTag, DeleteByFilterOperation, DeleteByIdsOperation, DeleteGalleryItemRequest, DeleteGalleryItemsRequest, DeleteGalleryRequest, DocumentImage, DocumentLink, DocumentPayload, DocumentUpdateOperation, DomainEvent, DomainEventBodyOneOf, DynamicPageLink, EmailLink, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, Enum, EnumWithLiterals, EventMetadata, EventsPage, ExternalLink, File, GalleryItemCreated, GalleryItemDeleted, GalleryItemUpdated, GalleryPublished, GetActiveGalleryRevisionRequest, GetActiveGalleryRevisionResponse, GetGalleryItemRequest, GetGalleryItemResponse, GetGalleryOptionsVersionOneOf, GetGalleryRequest, GetGalleryRequestVersionOneOf, GetGalleryResponse, GetGalleryRevisionRequest, GetGalleryRevisionResponse, HtmlSitePublished, HtmlSiteRCPublished, IdentificationData, IdentificationDataIdOneOf, Image, ImageType, ImageTypeWithLiterals, IndexDocument, InvalidateCache, InvalidateCacheGetByOneOf, ItemId, ItemMetadataOneOf, ItemsInGallery, Link, LinkRel, LinkRelWithLiterals, LinkType, LinkTypeWithLiterals, ListGalleriesItemsRequest, ListGalleriesItemsResponse, ListGalleriesRequest, ListGalleryItemsRequest, MessageEnvelope, Page, PageLink, PhoneLink, Point, ProgallerypublisherPublishGalleryRequest, ProgallerypublisherPublishGalleryResponse, PublishGalleryItemRequest, PublishGalleryItemResponse, PublishGalleryItemsRequest, PublishGalleryItemsResponse, PublishGalleryRequest, PublishGalleryResponse, RCLabel, RCLabelWithLiterals, RestoreAllGalleriesEvent, RestoreInfo, SearchIndexingNotification, SearchIndexingNotificationState, SearchIndexingNotificationStateWithLiterals, SecondaryMedia, SecondaryMediaMetadataOneOf, State, StateWithLiterals, Tags, Text, TpaPageLink, TriggerRestoreAllGalleriesAsyncRequest, TriggerRestoreAllGalleriesAsyncResponse, Type, TypeWithLiterals, URI, UnsharpMasking, UpdateByFilterOperation, UpdateDocumentsEvent, UpdateDocumentsEventOperationOneOf, UpdateExistingOperation, UpdateGalleryItemRequest, UpdateGalleryItemResponse, UpdateGalleryRequest, UpdateGalleryResponse, Video, VideoResolution, VideoType, VideoTypeWithLiterals, WebhookIdentityType, WebhookIdentityTypeWithLiterals, WhatsAppLink, WixLink, WixLinkLinkOneOf } from './index.typings.mjs';
4
4
 
5
- type GalleryNonNullablePaths = `items` | `items.${number}.image.focalPoint.x` | `items.${number}.image.focalPoint.y` | `items.${number}.video.type` | `items.${number}.type`;
6
5
  declare function listGalleries$1(httpClient: HttpClient): ListGalleriesSignature;
7
6
  interface ListGalleriesSignature {
8
7
  /**
@@ -11,9 +10,7 @@ interface ListGalleriesSignature {
11
10
  * This function retrieves a list of up to 10 galleries at a given time. To list the next 10 galleries in your site's backend, use the `offset` parameter.
12
11
  * @param - Options to use when getting the list of galleries.
13
12
  */
14
- (options?: ListGalleriesOptions): Promise<NonNullablePaths<ListGalleriesResponse, {
15
- [P in GalleryNonNullablePaths]: `galleries.${number}.${P}`;
16
- }[GalleryNonNullablePaths]>>;
13
+ (options?: ListGalleriesOptions): Promise<NonNullablePaths<ListGalleriesResponse, `galleries`, 2>>;
17
14
  }
18
15
  declare function getGallery$1(httpClient: HttpClient): GetGallerySignature;
19
16
  interface GetGallerySignature {
@@ -23,7 +20,7 @@ interface GetGallerySignature {
23
20
  * @param - Options to use when getting the gallery.
24
21
  * @returns Returned gallery.
25
22
  */
26
- (galleryId: string, options?: GetGalleryOptions): Promise<NonNullablePaths<Gallery, GalleryNonNullablePaths>>;
23
+ (galleryId: string, options?: GetGalleryOptions): Promise<NonNullablePaths<Gallery, `items` | `items.${number}.image.focalPoint.x` | `items.${number}.image.focalPoint.y` | `items.${number}.video.type` | `items.${number}.type`, 6>>;
27
24
  }
28
25
  declare function listGalleryItems$1(httpClient: HttpClient): ListGalleryItemsSignature;
29
26
  interface ListGalleryItemsSignature {
@@ -34,7 +31,7 @@ interface ListGalleryItemsSignature {
34
31
  * @param - Gallery ID.
35
32
  * @param - Options to use when getting the list of gallery items.
36
33
  */
37
- (galleryId: string, options?: ListGalleryItemsOptions): Promise<NonNullablePaths<ListGalleryItemsResponse, `items` | `items.${number}.image.focalPoint.x` | `items.${number}.image.focalPoint.y` | `items.${number}.video.type` | `items.${number}.type`>>;
34
+ (galleryId: string, options?: ListGalleryItemsOptions): Promise<NonNullablePaths<ListGalleryItemsResponse, `items` | `items.${number}.image.focalPoint.x` | `items.${number}.image.focalPoint.y` | `items.${number}.video.type` | `items.${number}.type`, 6>>;
38
35
  }
39
36
  declare function getGalleryItem$1(httpClient: HttpClient): GetGalleryItemSignature;
40
37
  interface GetGalleryItemSignature {
@@ -43,7 +40,7 @@ interface GetGalleryItemSignature {
43
40
  * @param - Gallery ID and Item ID.
44
41
  * @returns Returned media item.
45
42
  */
46
- (identifiers: NonNullablePaths<GetGalleryItemIdentifiers, `galleryId` | `itemId`>): Promise<NonNullablePaths<Item, `image.focalPoint.x` | `image.focalPoint.y` | `video.type` | `type` | `tags.values`>>;
43
+ (identifiers: NonNullablePaths<GetGalleryItemIdentifiers, `galleryId` | `itemId`, 2>): Promise<NonNullablePaths<Item, `image.focalPoint.x` | `image.focalPoint.y` | `video.type` | `type` | `tags.values`, 4>>;
47
44
  }
48
45
  declare function createGallery$1(httpClient: HttpClient): CreateGallerySignature;
49
46
  interface CreateGallerySignature {
@@ -63,7 +60,7 @@ interface CreateGallerySignature {
63
60
  * @param - Options to use when creating the gallery.
64
61
  * @returns Created gallery.
65
62
  */
66
- (options?: NonNullablePaths<CreateGalleryOptions, `gallery.items.${number}.image.imageInfo` | `gallery.items.${number}.text.html` | `gallery.items.${number}.video.videoInfo`>): Promise<NonNullablePaths<Gallery, GalleryNonNullablePaths>>;
63
+ (options?: NonNullablePaths<CreateGalleryOptions, `gallery.items.${number}.image.imageInfo` | `gallery.items.${number}.text.html` | `gallery.items.${number}.video.videoInfo`, 6>): Promise<NonNullablePaths<Gallery, `items` | `items.${number}.image.focalPoint.x` | `items.${number}.image.focalPoint.y` | `items.${number}.video.type` | `items.${number}.type`, 6>>;
67
64
  }
68
65
  declare function updateGallery$1(httpClient: HttpClient): UpdateGallerySignature;
69
66
  interface UpdateGallerySignature {
@@ -82,7 +79,7 @@ interface UpdateGallerySignature {
82
79
  * @param - The information for the gallery being updated.
83
80
  * @returns Updated gallery.
84
81
  */
85
- (_id: string, gallery: NonNullablePaths<UpdateGallery, `items.${number}.image.imageInfo` | `items.${number}.text.html` | `items.${number}.video.videoInfo`>): Promise<NonNullablePaths<Gallery, GalleryNonNullablePaths>>;
82
+ (_id: string, gallery: NonNullablePaths<UpdateGallery, `items.${number}.image.imageInfo` | `items.${number}.text.html` | `items.${number}.video.videoInfo`, 5>): Promise<NonNullablePaths<Gallery, `items` | `items.${number}.image.focalPoint.x` | `items.${number}.image.focalPoint.y` | `items.${number}.video.type` | `items.${number}.type`, 6>>;
86
83
  }
87
84
  declare function deleteGallery$1(httpClient: HttpClient): DeleteGallerySignature;
88
85
  interface DeleteGallerySignature {
@@ -92,7 +89,7 @@ interface DeleteGallerySignature {
92
89
  * When a gallery is deleted, the deleted gallery is no longer returned when calling the [`listGalleries()`](/pro-gallery/list-galleries) function.
93
90
  * @param - ID of the gallery to delete.
94
91
  */
95
- (galleryId: string): Promise<NonNullablePaths<DeleteGalleryResponse, `galleryId`>>;
92
+ (galleryId: string): Promise<NonNullablePaths<DeleteGalleryResponse, `galleryId`, 2>>;
96
93
  }
97
94
  declare function deleteGalleryItems$1(httpClient: HttpClient): DeleteGalleryItemsSignature;
98
95
  interface DeleteGalleryItemsSignature {
@@ -101,9 +98,7 @@ interface DeleteGalleryItemsSignature {
101
98
  * @param - Gallery ID.
102
99
  * @deprecated
103
100
  */
104
- (galleryId: string, options?: DeleteGalleryItemsOptions): Promise<NonNullablePaths<DeleteGalleryItemsResponse, {
105
- [P in GalleryNonNullablePaths]: `gallery.${P}`;
106
- }[GalleryNonNullablePaths]>>;
101
+ (galleryId: string, options?: DeleteGalleryItemsOptions): Promise<NonNullablePaths<DeleteGalleryItemsResponse, `gallery.items` | `gallery.items.${number}.image.focalPoint.x` | `gallery.items.${number}.image.focalPoint.y` | `gallery.items.${number}.video.type` | `gallery.items.${number}.type`, 7>>;
107
102
  }
108
103
  declare function bulkDeleteGalleryItems$1(httpClient: HttpClient): BulkDeleteGalleryItemsSignature;
109
104
  interface BulkDeleteGalleryItemsSignature {
@@ -112,7 +107,7 @@ interface BulkDeleteGalleryItemsSignature {
112
107
  * @param - Gallery ID.
113
108
  * @param - IDs of the media items to delete.
114
109
  */
115
- (galleryId: string, itemIds: string[]): Promise<NonNullablePaths<BulkDeleteGalleryItemsResponse, `itemIds`>>;
110
+ (galleryId: string, itemIds: string[]): Promise<NonNullablePaths<BulkDeleteGalleryItemsResponse, `itemIds`, 2>>;
116
111
  }
117
112
  declare function createGalleryItem$1(httpClient: HttpClient): CreateGalleryItemSignature;
118
113
  interface CreateGalleryItemSignature {
@@ -131,7 +126,7 @@ interface CreateGalleryItemSignature {
131
126
  * @param - Media item to create.
132
127
  * @returns Created media item.
133
128
  */
134
- (galleryId: string, item: NonNullablePaths<Item, `image.imageInfo` | `text.html` | `video.videoInfo`>): Promise<NonNullablePaths<Item, `image.focalPoint.x` | `image.focalPoint.y` | `video.type` | `type` | `tags.values`>>;
129
+ (galleryId: string, item: NonNullablePaths<Item, `image.imageInfo` | `text.html` | `video.videoInfo`, 3>): Promise<NonNullablePaths<Item, `image.focalPoint.x` | `image.focalPoint.y` | `video.type` | `type` | `tags.values`, 4>>;
135
130
  }
136
131
  declare function updateGalleryItem$1(httpClient: HttpClient): UpdateGalleryItemSignature;
137
132
  interface UpdateGalleryItemSignature {
@@ -150,7 +145,7 @@ interface UpdateGalleryItemSignature {
150
145
  * @param - Gallery ID and Item ID.
151
146
  * @returns Updated media item.
152
147
  */
153
- (identifiers: NonNullablePaths<UpdateGalleryItemIdentifiers, `galleryId` | `itemId`>, item: NonNullablePaths<UpdateGalleryItem, `image.imageInfo` | `text.html` | `video.videoInfo`>): Promise<NonNullablePaths<Item, `image.focalPoint.x` | `image.focalPoint.y` | `video.type` | `type` | `tags.values`>>;
148
+ (identifiers: NonNullablePaths<UpdateGalleryItemIdentifiers, `galleryId` | `itemId`, 2>, item: NonNullablePaths<UpdateGalleryItem, `image.imageInfo` | `text.html` | `video.videoInfo`, 3>): Promise<NonNullablePaths<Item, `image.focalPoint.x` | `image.focalPoint.y` | `video.type` | `type` | `tags.values`, 4>>;
154
149
  }
155
150
  declare function deleteGalleryItem$1(httpClient: HttpClient): DeleteGalleryItemSignature;
156
151
  interface DeleteGalleryItemSignature {
@@ -160,7 +155,7 @@ interface DeleteGalleryItemSignature {
160
155
  * When a gallery item is deleted, the deleted gallery item is no longer returned when calling the [`listGalleryItems()`](/pro-gallery/list-gallery-items) function.
161
156
  * @param - Gallery ID and Item ID.
162
157
  */
163
- (identifiers: NonNullablePaths<DeleteGalleryItemIdentifiers, `galleryId` | `itemId`>): Promise<NonNullablePaths<DeleteGalleryItemResponse, `itemId`>>;
158
+ (identifiers: NonNullablePaths<DeleteGalleryItemIdentifiers, `galleryId` | `itemId`, 2>): Promise<NonNullablePaths<DeleteGalleryItemResponse, `itemId`, 2>>;
164
159
  }
165
160
  declare const onGalleryCreated$1: EventDefinition<GalleryCreatedEnvelope, "wix.pro_gallery.gallery_v2_created">;
166
161
  declare const onGalleryDeleted$1: EventDefinition<GalleryDeletedEnvelope, "wix.pro_gallery.gallery_v2_deleted">;
@@ -187,32 +182,32 @@ declare const deleteGalleryItem: MaybeContext<BuildRESTFunction<typeof deleteGal
187
182
  * > __Note:__ The event data doesn't include gallery items or their IDs.
188
183
  * > To receive information about the created items you need to listen to the [Gallery Item Created webhook](https://dev.wix.com/api/rest/site-content/pro-gallery/gallery-item-created-webhook).
189
184
  */
190
- declare const onGalleryCreated: BuildEventDefinition<typeof onGalleryCreated$1>;
185
+ declare const onGalleryCreated: BuildEventDefinition<typeof onGalleryCreated$1> & typeof onGalleryCreated$1;
191
186
  /**
192
187
  * Triggered when a gallery is deleted.
193
188
  */
194
- declare const onGalleryDeleted: BuildEventDefinition<typeof onGalleryDeleted$1>;
189
+ declare const onGalleryDeleted: BuildEventDefinition<typeof onGalleryDeleted$1> & typeof onGalleryDeleted$1;
195
190
  /**
196
191
  * Triggered when a media item in a specified gallery is created.
197
192
  */
198
- declare const onGalleryItemCreated: BuildEventDefinition<typeof onGalleryItemCreated$1>;
193
+ declare const onGalleryItemCreated: BuildEventDefinition<typeof onGalleryItemCreated$1> & typeof onGalleryItemCreated$1;
199
194
  /**
200
195
  * Triggered when a media item in a specified gallery is deleted.
201
196
  *
202
197
  * > __Note:__ The event is triggered when a gallery item is deleted individually and when a gallery item is deleted because its gallery is deleted.
203
198
  * > 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.
204
199
  */
205
- declare const onGalleryItemDeleted: BuildEventDefinition<typeof onGalleryItemDeleted$1>;
200
+ declare const onGalleryItemDeleted: BuildEventDefinition<typeof onGalleryItemDeleted$1> & typeof onGalleryItemDeleted$1;
206
201
  /**
207
202
  * Triggered when a media item in a specified gallery is updated.
208
203
  */
209
- declare const onGalleryItemUpdated: BuildEventDefinition<typeof onGalleryItemUpdated$1>;
204
+ declare const onGalleryItemUpdated: BuildEventDefinition<typeof onGalleryItemUpdated$1> & typeof onGalleryItemUpdated$1;
210
205
  /**
211
206
  * Triggered when a gallery is updated.
212
207
  *
213
208
  * > __Note:__ The event data doesn't include gallery items or their IDs.
214
209
  * > 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).
215
210
  */
216
- declare const onGalleryUpdated: BuildEventDefinition<typeof onGalleryUpdated$1>;
211
+ declare const onGalleryUpdated: BuildEventDefinition<typeof onGalleryUpdated$1> & typeof onGalleryUpdated$1;
217
212
 
218
213
  export { BulkDeleteGalleryItemsResponse, CreateGalleryOptions, DeleteGalleryItemIdentifiers, DeleteGalleryItemResponse, DeleteGalleryItemsOptions, DeleteGalleryItemsResponse, DeleteGalleryResponse, Gallery, GalleryCreatedEnvelope, GalleryDeletedEnvelope, GalleryItemCreatedEnvelope, GalleryItemDeletedEnvelope, GalleryItemUpdatedEnvelope, GalleryUpdatedEnvelope, GetGalleryItemIdentifiers, GetGalleryOptions, Item, ListGalleriesOptions, ListGalleriesResponse, ListGalleryItemsOptions, ListGalleryItemsResponse, UpdateGallery, UpdateGalleryItem, UpdateGalleryItemIdentifiers, bulkDeleteGalleryItems, createGallery, createGalleryItem, deleteGallery, deleteGalleryItem, deleteGalleryItems, getGallery, getGalleryItem, listGalleries, listGalleryItems, onGalleryCreated, onGalleryDeleted, onGalleryItemCreated, onGalleryItemDeleted, onGalleryItemUpdated, onGalleryUpdated, updateGallery, updateGalleryItem };
@@ -1764,9 +1764,15 @@ var updateGalleryItem4 = /* @__PURE__ */ createRESTModule(updateGalleryItem3);
1764
1764
  var deleteGalleryItem4 = /* @__PURE__ */ createRESTModule(deleteGalleryItem3);
1765
1765
  var onGalleryCreated2 = createEventModule(onGalleryCreated);
1766
1766
  var onGalleryDeleted2 = createEventModule(onGalleryDeleted);
1767
- var onGalleryItemCreated2 = createEventModule(onGalleryItemCreated);
1768
- var onGalleryItemDeleted2 = createEventModule(onGalleryItemDeleted);
1769
- var onGalleryItemUpdated2 = createEventModule(onGalleryItemUpdated);
1767
+ var onGalleryItemCreated2 = createEventModule(
1768
+ onGalleryItemCreated
1769
+ );
1770
+ var onGalleryItemDeleted2 = createEventModule(
1771
+ onGalleryItemDeleted
1772
+ );
1773
+ var onGalleryItemUpdated2 = createEventModule(
1774
+ onGalleryItemUpdated
1775
+ );
1770
1776
  var onGalleryUpdated2 = createEventModule(onGalleryUpdated);
1771
1777
  export {
1772
1778
  Enum,