@wix/auto_sdk_fast-gallery_galleries 1.0.0
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/fastgallery-gallery-v1-gallery-galleries.universal-D2SCxAXG.d.ts +707 -0
- package/build/cjs/index.d.ts +136 -0
- package/build/cjs/index.js +1030 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/meta.d.ts +404 -0
- package/build/cjs/meta.js +736 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/es/fastgallery-gallery-v1-gallery-galleries.universal-D2SCxAXG.d.mts +707 -0
- package/build/es/index.d.mts +136 -0
- package/build/es/index.mjs +990 -0
- package/build/es/index.mjs.map +1 -0
- package/build/es/meta.d.mts +404 -0
- package/build/es/meta.mjs +697 -0
- package/build/es/meta.mjs.map +1 -0
- package/build/es/package.json +3 -0
- package/build/internal/cjs/fastgallery-gallery-v1-gallery-galleries.universal-D2SCxAXG.d.ts +707 -0
- package/build/internal/cjs/index.d.ts +136 -0
- package/build/internal/cjs/index.js +1030 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +404 -0
- package/build/internal/cjs/meta.js +736 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/es/fastgallery-gallery-v1-gallery-galleries.universal-D2SCxAXG.d.mts +707 -0
- package/build/internal/es/index.d.mts +136 -0
- package/build/internal/es/index.mjs +990 -0
- package/build/internal/es/index.mjs.map +1 -0
- package/build/internal/es/meta.d.mts +404 -0
- package/build/internal/es/meta.mjs +697 -0
- package/build/internal/es/meta.mjs.map +1 -0
- package/meta/package.json +3 -0
- package/package.json +53 -0
|
@@ -0,0 +1,707 @@
|
|
|
1
|
+
/** Gallery is the main entity of GalleryService */
|
|
2
|
+
interface Gallery {
|
|
3
|
+
/**
|
|
4
|
+
* Gallery ID.
|
|
5
|
+
* @format GUID
|
|
6
|
+
* @readonly
|
|
7
|
+
*/
|
|
8
|
+
_id?: string | null;
|
|
9
|
+
/**
|
|
10
|
+
* Represents the current state of the Gallery. Each time the gallery is modified, its `revision` changes by the server. for an update operation to succeed, you MUST pass the latest revision
|
|
11
|
+
* @readonly
|
|
12
|
+
*/
|
|
13
|
+
revision?: string | null;
|
|
14
|
+
/**
|
|
15
|
+
* DraftGallery ID this Gallery was published from
|
|
16
|
+
* @format GUID
|
|
17
|
+
* @immutable
|
|
18
|
+
*/
|
|
19
|
+
draftGalleryId?: string | null;
|
|
20
|
+
/**
|
|
21
|
+
* The site version the gallery was published to
|
|
22
|
+
* @readonly
|
|
23
|
+
*/
|
|
24
|
+
siteVersion?: string | null;
|
|
25
|
+
/** Total number of items this Gallery contains */
|
|
26
|
+
itemsCount?: number | null;
|
|
27
|
+
/**
|
|
28
|
+
* Represents the time this Gallery was created
|
|
29
|
+
* @readonly
|
|
30
|
+
*/
|
|
31
|
+
_createdDate?: Date | null;
|
|
32
|
+
/**
|
|
33
|
+
* Represents the time this Gallery was last updated
|
|
34
|
+
* @readonly
|
|
35
|
+
*/
|
|
36
|
+
_updatedDate?: Date | null;
|
|
37
|
+
/** Data extensions ExtendedFields */
|
|
38
|
+
extendedFields?: ExtendedFields;
|
|
39
|
+
/**
|
|
40
|
+
* Variant of the gallery, whether it's a live or RC
|
|
41
|
+
* @immutable
|
|
42
|
+
*/
|
|
43
|
+
variant?: VariantWithLiterals;
|
|
44
|
+
}
|
|
45
|
+
interface ExtendedFields {
|
|
46
|
+
/**
|
|
47
|
+
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
48
|
+
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
49
|
+
*
|
|
50
|
+
* You can only access fields for which you have the appropriate permissions.
|
|
51
|
+
*
|
|
52
|
+
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
53
|
+
*/
|
|
54
|
+
namespaces?: Record<string, Record<string, any>>;
|
|
55
|
+
}
|
|
56
|
+
declare enum Variant {
|
|
57
|
+
/** Default value, unused */
|
|
58
|
+
UNKNOWN_VARIANT = "UNKNOWN_VARIANT",
|
|
59
|
+
/** Live version, there can be only one live */
|
|
60
|
+
LIVE = "LIVE",
|
|
61
|
+
/** Release Candidate version */
|
|
62
|
+
RC = "RC"
|
|
63
|
+
}
|
|
64
|
+
/** @enumType */
|
|
65
|
+
type VariantWithLiterals = Variant | 'UNKNOWN_VARIANT' | 'LIVE' | 'RC';
|
|
66
|
+
interface GalleryRemovedFromTrashBin {
|
|
67
|
+
/** The Gallery that was removed from the trash bin */
|
|
68
|
+
gallery?: Gallery;
|
|
69
|
+
}
|
|
70
|
+
interface CreateGalleryRequest {
|
|
71
|
+
/** Gallery to be created. */
|
|
72
|
+
gallery: Gallery;
|
|
73
|
+
}
|
|
74
|
+
interface CreateGalleryResponse {
|
|
75
|
+
/** The created Gallery. */
|
|
76
|
+
gallery?: Gallery;
|
|
77
|
+
}
|
|
78
|
+
interface GetGalleryRequest {
|
|
79
|
+
/**
|
|
80
|
+
* ID of the Gallery to retrieve.
|
|
81
|
+
* @format GUID
|
|
82
|
+
*/
|
|
83
|
+
galleryId: string;
|
|
84
|
+
}
|
|
85
|
+
interface GetGalleryResponse {
|
|
86
|
+
/** The requested Gallery. */
|
|
87
|
+
gallery?: Gallery;
|
|
88
|
+
}
|
|
89
|
+
interface GetGalleryByDraftGalleryIdRequest {
|
|
90
|
+
/**
|
|
91
|
+
* Id of the draftGallery the Gallery originates from
|
|
92
|
+
* @format GUID
|
|
93
|
+
*/
|
|
94
|
+
draftGalleryId: string;
|
|
95
|
+
}
|
|
96
|
+
interface GetGalleryByDraftGalleryIdResponse {
|
|
97
|
+
/** The retrieved Gallery */
|
|
98
|
+
gallery?: Gallery;
|
|
99
|
+
}
|
|
100
|
+
interface UpdateGalleryRequest {
|
|
101
|
+
/** Gallery to be updated, may be partial. */
|
|
102
|
+
gallery: Gallery;
|
|
103
|
+
}
|
|
104
|
+
interface UpdateGalleryResponse {
|
|
105
|
+
/** Updated Gallery. */
|
|
106
|
+
gallery?: Gallery;
|
|
107
|
+
}
|
|
108
|
+
interface DeleteGalleryRequest {
|
|
109
|
+
/**
|
|
110
|
+
* Id of the Gallery to delete.
|
|
111
|
+
* @format GUID
|
|
112
|
+
*/
|
|
113
|
+
galleryId?: string;
|
|
114
|
+
}
|
|
115
|
+
interface DeleteGalleryResponse {
|
|
116
|
+
}
|
|
117
|
+
interface QueryGalleriesRequest {
|
|
118
|
+
/** WQL expression. */
|
|
119
|
+
query?: CursorQuery;
|
|
120
|
+
}
|
|
121
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
122
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
123
|
+
cursorPaging?: CursorPaging;
|
|
124
|
+
/**
|
|
125
|
+
* Filter object in the following format:
|
|
126
|
+
* `"filter" : {
|
|
127
|
+
* "fieldName1": "value1",
|
|
128
|
+
* "fieldName2":{"$operator":"value2"}
|
|
129
|
+
* }`
|
|
130
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
131
|
+
*/
|
|
132
|
+
filter?: Record<string, any> | null;
|
|
133
|
+
/**
|
|
134
|
+
* Sort object in the following format:
|
|
135
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
136
|
+
* @maxSize 5
|
|
137
|
+
*/
|
|
138
|
+
sort?: Sorting[];
|
|
139
|
+
}
|
|
140
|
+
/** @oneof */
|
|
141
|
+
interface CursorQueryPagingMethodOneOf {
|
|
142
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
143
|
+
cursorPaging?: CursorPaging;
|
|
144
|
+
}
|
|
145
|
+
interface Sorting {
|
|
146
|
+
/**
|
|
147
|
+
* Name of the field to sort by.
|
|
148
|
+
* @maxLength 512
|
|
149
|
+
*/
|
|
150
|
+
fieldName?: string;
|
|
151
|
+
/** Sort order. */
|
|
152
|
+
order?: SortOrderWithLiterals;
|
|
153
|
+
}
|
|
154
|
+
declare enum SortOrder {
|
|
155
|
+
ASC = "ASC",
|
|
156
|
+
DESC = "DESC"
|
|
157
|
+
}
|
|
158
|
+
/** @enumType */
|
|
159
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
160
|
+
interface CursorPaging {
|
|
161
|
+
/**
|
|
162
|
+
* Maximum number of items to return in the results.
|
|
163
|
+
* @max 100
|
|
164
|
+
*/
|
|
165
|
+
limit?: number | null;
|
|
166
|
+
/**
|
|
167
|
+
* Pointer to the next or previous page in the list of results.
|
|
168
|
+
*
|
|
169
|
+
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
170
|
+
* Not relevant for the first request.
|
|
171
|
+
* @maxLength 16000
|
|
172
|
+
*/
|
|
173
|
+
cursor?: string | null;
|
|
174
|
+
}
|
|
175
|
+
interface QueryGalleriesResponse {
|
|
176
|
+
/** List of Galleries. */
|
|
177
|
+
galleries?: Gallery[];
|
|
178
|
+
/** Paging metadata */
|
|
179
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
180
|
+
}
|
|
181
|
+
interface CursorPagingMetadata {
|
|
182
|
+
/** Number of items returned in the response. */
|
|
183
|
+
count?: number | null;
|
|
184
|
+
/** Cursor strings that point to the next page, previous page, or both. */
|
|
185
|
+
cursors?: Cursors;
|
|
186
|
+
/**
|
|
187
|
+
* Whether there are more pages to retrieve following the current page.
|
|
188
|
+
*
|
|
189
|
+
* + `true`: Another page of results can be retrieved.
|
|
190
|
+
* + `false`: This is the last page.
|
|
191
|
+
*/
|
|
192
|
+
hasNext?: boolean | null;
|
|
193
|
+
}
|
|
194
|
+
interface Cursors {
|
|
195
|
+
/**
|
|
196
|
+
* Cursor string pointing to the next page in the list of results.
|
|
197
|
+
* @maxLength 16000
|
|
198
|
+
*/
|
|
199
|
+
next?: string | null;
|
|
200
|
+
/**
|
|
201
|
+
* Cursor pointing to the previous page in the list of results.
|
|
202
|
+
* @maxLength 16000
|
|
203
|
+
*/
|
|
204
|
+
prev?: string | null;
|
|
205
|
+
}
|
|
206
|
+
interface UpdateExtendedFieldsRequest {
|
|
207
|
+
/** ID of the entity to update. */
|
|
208
|
+
_id: string;
|
|
209
|
+
/** Identifier for the app whose extended fields are being updated. */
|
|
210
|
+
namespace: string;
|
|
211
|
+
/** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
|
|
212
|
+
namespaceData: Record<string, any> | null;
|
|
213
|
+
}
|
|
214
|
+
interface UpdateExtendedFieldsResponse {
|
|
215
|
+
/** Updated Gallery. */
|
|
216
|
+
gallery?: Gallery;
|
|
217
|
+
}
|
|
218
|
+
interface BulkCreateGalleriesRequest {
|
|
219
|
+
/**
|
|
220
|
+
* List of Galleries to be created
|
|
221
|
+
* @minSize 1
|
|
222
|
+
* @maxSize 100
|
|
223
|
+
*/
|
|
224
|
+
galleries: Gallery[];
|
|
225
|
+
/** set to `true` if you wish to receive back the created Galleries in the response */
|
|
226
|
+
returnEntity?: boolean;
|
|
227
|
+
}
|
|
228
|
+
interface BulkCreateGalleriesResponse {
|
|
229
|
+
/**
|
|
230
|
+
* List of the bulk create operation results including the Galleries and metadata.
|
|
231
|
+
* @minSize 1
|
|
232
|
+
* @maxSize 100
|
|
233
|
+
*/
|
|
234
|
+
results?: BulkGalleryResult[];
|
|
235
|
+
/** Metadata regarding the bulk create operation */
|
|
236
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
237
|
+
}
|
|
238
|
+
interface ItemMetadata {
|
|
239
|
+
/**
|
|
240
|
+
* Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
|
|
241
|
+
* @format GUID
|
|
242
|
+
*/
|
|
243
|
+
_id?: string | null;
|
|
244
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
245
|
+
originalIndex?: number;
|
|
246
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
247
|
+
success?: boolean;
|
|
248
|
+
/** Details about the error in case of failure. */
|
|
249
|
+
error?: ApplicationError;
|
|
250
|
+
}
|
|
251
|
+
interface ApplicationError {
|
|
252
|
+
/** Error code. */
|
|
253
|
+
code?: string;
|
|
254
|
+
/** Description of the error. */
|
|
255
|
+
description?: string;
|
|
256
|
+
/** Data related to the error. */
|
|
257
|
+
data?: Record<string, any> | null;
|
|
258
|
+
}
|
|
259
|
+
interface BulkGalleryResult {
|
|
260
|
+
/** Metadata regarding the specific single create operation */
|
|
261
|
+
itemMetadata?: ItemMetadata;
|
|
262
|
+
/** Only exists if `returnEntity` was set to true in the request */
|
|
263
|
+
item?: Gallery;
|
|
264
|
+
}
|
|
265
|
+
interface BulkActionMetadata {
|
|
266
|
+
/** Number of items that were successfully processed. */
|
|
267
|
+
totalSuccesses?: number;
|
|
268
|
+
/** Number of items that couldn't be processed. */
|
|
269
|
+
totalFailures?: number;
|
|
270
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
271
|
+
undetailedFailures?: number;
|
|
272
|
+
}
|
|
273
|
+
interface BulkUpdateGalleriesRequest {
|
|
274
|
+
/**
|
|
275
|
+
* List of Galleries to be updated.
|
|
276
|
+
* @minSize 1
|
|
277
|
+
* @maxSize 100
|
|
278
|
+
*/
|
|
279
|
+
galleries: MaskedGallery[];
|
|
280
|
+
/** set to `true` if you wish to receive back the updated Galleries in the response */
|
|
281
|
+
returnEntity?: boolean;
|
|
282
|
+
}
|
|
283
|
+
interface MaskedGallery {
|
|
284
|
+
/** Gallery to be updated, may be partial */
|
|
285
|
+
gallery?: Gallery;
|
|
286
|
+
}
|
|
287
|
+
interface BulkUpdateGalleriesResponse {
|
|
288
|
+
/**
|
|
289
|
+
* Results
|
|
290
|
+
* @minSize 1
|
|
291
|
+
* @maxSize 100
|
|
292
|
+
*/
|
|
293
|
+
results?: BulkUpdateGalleriesResponseBulkGalleryResult[];
|
|
294
|
+
/** Metadata regarding the bulk update operation */
|
|
295
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
296
|
+
}
|
|
297
|
+
interface BulkUpdateGalleriesResponseBulkGalleryResult {
|
|
298
|
+
/** Metadata regarding the specific single update operation */
|
|
299
|
+
itemMetadata?: ItemMetadata;
|
|
300
|
+
/** Only exists if `returnEntity` was set to true in the request */
|
|
301
|
+
item?: Gallery;
|
|
302
|
+
}
|
|
303
|
+
interface BulkDeleteGalleriesRequest {
|
|
304
|
+
/**
|
|
305
|
+
* Gallery ids to be deleted
|
|
306
|
+
* @minSize 1
|
|
307
|
+
* @maxSize 100
|
|
308
|
+
* @format GUID
|
|
309
|
+
*/
|
|
310
|
+
galleryIds: string[];
|
|
311
|
+
}
|
|
312
|
+
interface BulkDeleteGalleriesResponse {
|
|
313
|
+
/**
|
|
314
|
+
* Results
|
|
315
|
+
* @minSize 1
|
|
316
|
+
* @maxSize 100
|
|
317
|
+
*/
|
|
318
|
+
results?: BulkDeleteGalleriesResponseBulkGalleryResult[];
|
|
319
|
+
/** Metadata regarding the bulk delete operation */
|
|
320
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
321
|
+
}
|
|
322
|
+
interface BulkDeleteGalleriesResponseBulkGalleryResult {
|
|
323
|
+
/** Metadata regarding the specific single delete operation */
|
|
324
|
+
itemMetadata?: ItemMetadata;
|
|
325
|
+
}
|
|
326
|
+
interface GetDeletedGalleryRequest {
|
|
327
|
+
/**
|
|
328
|
+
* Id of the deleted Gallery to retrieve
|
|
329
|
+
* @format GUID
|
|
330
|
+
*/
|
|
331
|
+
galleryId: string;
|
|
332
|
+
}
|
|
333
|
+
interface GetDeletedGalleryResponse {
|
|
334
|
+
/** The retrieved Gallery */
|
|
335
|
+
gallery?: Gallery;
|
|
336
|
+
}
|
|
337
|
+
interface ListDeletedGalleriesRequest {
|
|
338
|
+
/** WQL expression */
|
|
339
|
+
cursorPaging?: CursorPaging;
|
|
340
|
+
/**
|
|
341
|
+
* gallery ids to list
|
|
342
|
+
* @format GUID
|
|
343
|
+
* @maxSize 100
|
|
344
|
+
*/
|
|
345
|
+
galleryIds?: string[];
|
|
346
|
+
}
|
|
347
|
+
interface ListDeletedGalleriesResponse {
|
|
348
|
+
/**
|
|
349
|
+
* The retrieved deleted Galleries
|
|
350
|
+
* @maxSize 100
|
|
351
|
+
*/
|
|
352
|
+
galleries?: Gallery[];
|
|
353
|
+
/** WQL expression */
|
|
354
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
355
|
+
}
|
|
356
|
+
interface RestoreGalleryFromTrashBinRequest {
|
|
357
|
+
/**
|
|
358
|
+
* Id of the deleted Gallery to restore
|
|
359
|
+
* @format GUID
|
|
360
|
+
*/
|
|
361
|
+
galleryId: string;
|
|
362
|
+
}
|
|
363
|
+
interface RestoreGalleryFromTrashBinResponse {
|
|
364
|
+
/** The retrieved Gallery */
|
|
365
|
+
gallery?: Gallery;
|
|
366
|
+
}
|
|
367
|
+
interface RemoveGalleryFromTrashBinRequest {
|
|
368
|
+
/**
|
|
369
|
+
* Id of the Gallery to delete permanently
|
|
370
|
+
* @format GUID
|
|
371
|
+
*/
|
|
372
|
+
galleryId: string;
|
|
373
|
+
}
|
|
374
|
+
interface RemoveGalleryFromTrashBinResponse {
|
|
375
|
+
}
|
|
376
|
+
interface DeleteOutdatedGalleryVersionsRequest {
|
|
377
|
+
/** galleries with site version smaller than this will be deleted */
|
|
378
|
+
publishedSiteVersion?: string;
|
|
379
|
+
}
|
|
380
|
+
interface DeleteOutdatedGalleryVersionsResponse {
|
|
381
|
+
}
|
|
382
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
383
|
+
createdEvent?: EntityCreatedEvent;
|
|
384
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
385
|
+
deletedEvent?: EntityDeletedEvent;
|
|
386
|
+
actionEvent?: ActionEvent;
|
|
387
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
388
|
+
_id?: string;
|
|
389
|
+
/**
|
|
390
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
391
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
392
|
+
*/
|
|
393
|
+
entityFqdn?: string;
|
|
394
|
+
/**
|
|
395
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
396
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
397
|
+
*/
|
|
398
|
+
slug?: string;
|
|
399
|
+
/** ID of the entity associated with the event. */
|
|
400
|
+
entityId?: string;
|
|
401
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
402
|
+
eventTime?: Date | null;
|
|
403
|
+
/**
|
|
404
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
405
|
+
* (for example, GDPR).
|
|
406
|
+
*/
|
|
407
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
408
|
+
/** If present, indicates the action that triggered the event. */
|
|
409
|
+
originatedFrom?: string | null;
|
|
410
|
+
/**
|
|
411
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
412
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
413
|
+
*/
|
|
414
|
+
entityEventSequence?: string | null;
|
|
415
|
+
}
|
|
416
|
+
/** @oneof */
|
|
417
|
+
interface DomainEventBodyOneOf {
|
|
418
|
+
createdEvent?: EntityCreatedEvent;
|
|
419
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
420
|
+
deletedEvent?: EntityDeletedEvent;
|
|
421
|
+
actionEvent?: ActionEvent;
|
|
422
|
+
}
|
|
423
|
+
interface EntityCreatedEvent {
|
|
424
|
+
entity?: string;
|
|
425
|
+
}
|
|
426
|
+
interface RestoreInfo {
|
|
427
|
+
deletedDate?: Date | null;
|
|
428
|
+
}
|
|
429
|
+
interface EntityUpdatedEvent {
|
|
430
|
+
/**
|
|
431
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
432
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
433
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
434
|
+
*/
|
|
435
|
+
currentEntity?: string;
|
|
436
|
+
}
|
|
437
|
+
interface EntityDeletedEvent {
|
|
438
|
+
/** Entity that was deleted. */
|
|
439
|
+
deletedEntity?: string | null;
|
|
440
|
+
}
|
|
441
|
+
interface ActionEvent {
|
|
442
|
+
body?: string;
|
|
443
|
+
}
|
|
444
|
+
interface MessageEnvelope {
|
|
445
|
+
/**
|
|
446
|
+
* App instance ID.
|
|
447
|
+
* @format GUID
|
|
448
|
+
*/
|
|
449
|
+
instanceId?: string | null;
|
|
450
|
+
/**
|
|
451
|
+
* Event type.
|
|
452
|
+
* @maxLength 150
|
|
453
|
+
*/
|
|
454
|
+
eventType?: string;
|
|
455
|
+
/** The identification type and identity data. */
|
|
456
|
+
identity?: IdentificationData;
|
|
457
|
+
/** Stringify payload. */
|
|
458
|
+
data?: string;
|
|
459
|
+
}
|
|
460
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
461
|
+
/**
|
|
462
|
+
* ID of a site visitor that has not logged in to the site.
|
|
463
|
+
* @format GUID
|
|
464
|
+
*/
|
|
465
|
+
anonymousVisitorId?: string;
|
|
466
|
+
/**
|
|
467
|
+
* ID of a site visitor that has logged in to the site.
|
|
468
|
+
* @format GUID
|
|
469
|
+
*/
|
|
470
|
+
memberId?: string;
|
|
471
|
+
/**
|
|
472
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
473
|
+
* @format GUID
|
|
474
|
+
*/
|
|
475
|
+
wixUserId?: string;
|
|
476
|
+
/**
|
|
477
|
+
* ID of an app.
|
|
478
|
+
* @format GUID
|
|
479
|
+
*/
|
|
480
|
+
appId?: string;
|
|
481
|
+
/** @readonly */
|
|
482
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
483
|
+
}
|
|
484
|
+
/** @oneof */
|
|
485
|
+
interface IdentificationDataIdOneOf {
|
|
486
|
+
/**
|
|
487
|
+
* ID of a site visitor that has not logged in to the site.
|
|
488
|
+
* @format GUID
|
|
489
|
+
*/
|
|
490
|
+
anonymousVisitorId?: string;
|
|
491
|
+
/**
|
|
492
|
+
* ID of a site visitor that has logged in to the site.
|
|
493
|
+
* @format GUID
|
|
494
|
+
*/
|
|
495
|
+
memberId?: string;
|
|
496
|
+
/**
|
|
497
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
498
|
+
* @format GUID
|
|
499
|
+
*/
|
|
500
|
+
wixUserId?: string;
|
|
501
|
+
/**
|
|
502
|
+
* ID of an app.
|
|
503
|
+
* @format GUID
|
|
504
|
+
*/
|
|
505
|
+
appId?: string;
|
|
506
|
+
}
|
|
507
|
+
declare enum WebhookIdentityType {
|
|
508
|
+
UNKNOWN = "UNKNOWN",
|
|
509
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
510
|
+
MEMBER = "MEMBER",
|
|
511
|
+
WIX_USER = "WIX_USER",
|
|
512
|
+
APP = "APP"
|
|
513
|
+
}
|
|
514
|
+
/** @enumType */
|
|
515
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
516
|
+
interface BaseEventMetadata {
|
|
517
|
+
/**
|
|
518
|
+
* App instance ID.
|
|
519
|
+
* @format GUID
|
|
520
|
+
*/
|
|
521
|
+
instanceId?: string | null;
|
|
522
|
+
/**
|
|
523
|
+
* Event type.
|
|
524
|
+
* @maxLength 150
|
|
525
|
+
*/
|
|
526
|
+
eventType?: string;
|
|
527
|
+
/** The identification type and identity data. */
|
|
528
|
+
identity?: IdentificationData;
|
|
529
|
+
}
|
|
530
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
531
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
532
|
+
_id?: string;
|
|
533
|
+
/**
|
|
534
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
535
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
536
|
+
*/
|
|
537
|
+
entityFqdn?: string;
|
|
538
|
+
/**
|
|
539
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
540
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
541
|
+
*/
|
|
542
|
+
slug?: string;
|
|
543
|
+
/** ID of the entity associated with the event. */
|
|
544
|
+
entityId?: string;
|
|
545
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
546
|
+
eventTime?: Date | null;
|
|
547
|
+
/**
|
|
548
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
549
|
+
* (for example, GDPR).
|
|
550
|
+
*/
|
|
551
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
552
|
+
/** If present, indicates the action that triggered the event. */
|
|
553
|
+
originatedFrom?: string | null;
|
|
554
|
+
/**
|
|
555
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
556
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
557
|
+
*/
|
|
558
|
+
entityEventSequence?: string | null;
|
|
559
|
+
}
|
|
560
|
+
interface GalleryRemovedFromTrashBinEnvelope {
|
|
561
|
+
data: GalleryRemovedFromTrashBin;
|
|
562
|
+
metadata: EventMetadata;
|
|
563
|
+
}
|
|
564
|
+
interface UpdateGallery {
|
|
565
|
+
/**
|
|
566
|
+
* Gallery ID.
|
|
567
|
+
* @format GUID
|
|
568
|
+
* @readonly
|
|
569
|
+
*/
|
|
570
|
+
_id?: string | null;
|
|
571
|
+
/**
|
|
572
|
+
* Represents the current state of the Gallery. Each time the gallery is modified, its `revision` changes by the server. for an update operation to succeed, you MUST pass the latest revision
|
|
573
|
+
* @readonly
|
|
574
|
+
*/
|
|
575
|
+
revision?: string | null;
|
|
576
|
+
/**
|
|
577
|
+
* DraftGallery ID this Gallery was published from
|
|
578
|
+
* @format GUID
|
|
579
|
+
* @immutable
|
|
580
|
+
*/
|
|
581
|
+
draftGalleryId?: string | null;
|
|
582
|
+
/**
|
|
583
|
+
* The site version the gallery was published to
|
|
584
|
+
* @readonly
|
|
585
|
+
*/
|
|
586
|
+
siteVersion?: string | null;
|
|
587
|
+
/** Total number of items this Gallery contains */
|
|
588
|
+
itemsCount?: number | null;
|
|
589
|
+
/**
|
|
590
|
+
* Represents the time this Gallery was created
|
|
591
|
+
* @readonly
|
|
592
|
+
*/
|
|
593
|
+
_createdDate?: Date | null;
|
|
594
|
+
/**
|
|
595
|
+
* Represents the time this Gallery was last updated
|
|
596
|
+
* @readonly
|
|
597
|
+
*/
|
|
598
|
+
_updatedDate?: Date | null;
|
|
599
|
+
/** Data extensions ExtendedFields */
|
|
600
|
+
extendedFields?: ExtendedFields;
|
|
601
|
+
/**
|
|
602
|
+
* Variant of the gallery, whether it's a live or RC
|
|
603
|
+
* @immutable
|
|
604
|
+
*/
|
|
605
|
+
variant?: VariantWithLiterals;
|
|
606
|
+
}
|
|
607
|
+
interface QueryCursorResult {
|
|
608
|
+
cursors: Cursors;
|
|
609
|
+
hasNext: () => boolean;
|
|
610
|
+
hasPrev: () => boolean;
|
|
611
|
+
length: number;
|
|
612
|
+
pageSize: number;
|
|
613
|
+
}
|
|
614
|
+
interface GalleriesQueryResult extends QueryCursorResult {
|
|
615
|
+
items: Gallery[];
|
|
616
|
+
query: GalleriesQueryBuilder;
|
|
617
|
+
next: () => Promise<GalleriesQueryResult>;
|
|
618
|
+
prev: () => Promise<GalleriesQueryResult>;
|
|
619
|
+
}
|
|
620
|
+
interface GalleriesQueryBuilder {
|
|
621
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
622
|
+
* @param value - Value to compare against.
|
|
623
|
+
* @documentationMaturity preview
|
|
624
|
+
*/
|
|
625
|
+
eq: (propertyName: '_id' | 'siteVersion' | '_createdDate' | '_updatedDate', value: any) => GalleriesQueryBuilder;
|
|
626
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
627
|
+
* @param value - Value to compare against.
|
|
628
|
+
* @documentationMaturity preview
|
|
629
|
+
*/
|
|
630
|
+
ne: (propertyName: '_id' | 'siteVersion' | '_createdDate' | '_updatedDate', value: any) => GalleriesQueryBuilder;
|
|
631
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
632
|
+
* @param value - Value to compare against.
|
|
633
|
+
* @documentationMaturity preview
|
|
634
|
+
*/
|
|
635
|
+
ge: (propertyName: '_id' | 'siteVersion' | '_createdDate' | '_updatedDate', value: any) => GalleriesQueryBuilder;
|
|
636
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
637
|
+
* @param value - Value to compare against.
|
|
638
|
+
* @documentationMaturity preview
|
|
639
|
+
*/
|
|
640
|
+
gt: (propertyName: '_id' | 'siteVersion' | '_createdDate' | '_updatedDate', value: any) => GalleriesQueryBuilder;
|
|
641
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
642
|
+
* @param value - Value to compare against.
|
|
643
|
+
* @documentationMaturity preview
|
|
644
|
+
*/
|
|
645
|
+
le: (propertyName: '_id' | 'siteVersion' | '_createdDate' | '_updatedDate', value: any) => GalleriesQueryBuilder;
|
|
646
|
+
/** @param propertyName - Property whose value is compared with `value`.
|
|
647
|
+
* @param value - Value to compare against.
|
|
648
|
+
* @documentationMaturity preview
|
|
649
|
+
*/
|
|
650
|
+
lt: (propertyName: '_id' | 'siteVersion' | '_createdDate' | '_updatedDate', value: any) => GalleriesQueryBuilder;
|
|
651
|
+
/** @param propertyName - Property whose value is compared with `string`.
|
|
652
|
+
* @param string - String to compare against. Case-insensitive.
|
|
653
|
+
* @documentationMaturity preview
|
|
654
|
+
*/
|
|
655
|
+
startsWith: (propertyName: '_id', value: string) => GalleriesQueryBuilder;
|
|
656
|
+
/** @param propertyName - Property whose value is compared with `values`.
|
|
657
|
+
* @param values - List of values to compare against.
|
|
658
|
+
* @documentationMaturity preview
|
|
659
|
+
*/
|
|
660
|
+
hasSome: (propertyName: '_id' | 'siteVersion' | '_createdDate' | '_updatedDate', value: any[]) => GalleriesQueryBuilder;
|
|
661
|
+
/** @documentationMaturity preview */
|
|
662
|
+
in: (propertyName: '_id' | 'siteVersion' | '_createdDate' | '_updatedDate', value: any) => GalleriesQueryBuilder;
|
|
663
|
+
/** @documentationMaturity preview */
|
|
664
|
+
exists: (propertyName: '_id' | 'siteVersion' | '_createdDate' | '_updatedDate', value: boolean) => GalleriesQueryBuilder;
|
|
665
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
666
|
+
* @documentationMaturity preview
|
|
667
|
+
*/
|
|
668
|
+
ascending: (...propertyNames: Array<'_id' | 'siteVersion' | '_createdDate' | '_updatedDate'>) => GalleriesQueryBuilder;
|
|
669
|
+
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
|
|
670
|
+
* @documentationMaturity preview
|
|
671
|
+
*/
|
|
672
|
+
descending: (...propertyNames: Array<'_id' | 'siteVersion' | '_createdDate' | '_updatedDate'>) => GalleriesQueryBuilder;
|
|
673
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
674
|
+
* @documentationMaturity preview
|
|
675
|
+
*/
|
|
676
|
+
limit: (limit: number) => GalleriesQueryBuilder;
|
|
677
|
+
/** @param cursor - A pointer to specific record
|
|
678
|
+
* @documentationMaturity preview
|
|
679
|
+
*/
|
|
680
|
+
skipTo: (cursor: string) => GalleriesQueryBuilder;
|
|
681
|
+
/** @documentationMaturity preview */
|
|
682
|
+
find: () => Promise<GalleriesQueryResult>;
|
|
683
|
+
}
|
|
684
|
+
interface UpdateExtendedFieldsOptions {
|
|
685
|
+
/** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
|
|
686
|
+
namespaceData: Record<string, any> | null;
|
|
687
|
+
}
|
|
688
|
+
interface BulkCreateGalleriesOptions {
|
|
689
|
+
/** set to `true` if you wish to receive back the created Galleries in the response */
|
|
690
|
+
returnEntity?: boolean;
|
|
691
|
+
}
|
|
692
|
+
interface BulkUpdateGalleriesOptions {
|
|
693
|
+
/** set to `true` if you wish to receive back the updated Galleries in the response */
|
|
694
|
+
returnEntity?: boolean;
|
|
695
|
+
}
|
|
696
|
+
interface ListDeletedGalleriesOptions {
|
|
697
|
+
/** WQL expression */
|
|
698
|
+
cursorPaging?: CursorPaging;
|
|
699
|
+
/**
|
|
700
|
+
* gallery ids to list
|
|
701
|
+
* @format GUID
|
|
702
|
+
* @maxSize 100
|
|
703
|
+
*/
|
|
704
|
+
galleryIds?: string[];
|
|
705
|
+
}
|
|
706
|
+
|
|
707
|
+
export { type RemoveGalleryFromTrashBinResponse as $, type UpdateExtendedFieldsRequest as A, type BulkCreateGalleriesOptions as B, type CreateGalleryRequest as C, type DeleteGalleryRequest as D, type ExtendedFields as E, type BulkCreateGalleriesRequest as F, type Gallery as G, type ApplicationError as H, type ItemMetadata as I, type BulkGalleryResult as J, type BulkActionMetadata as K, type ListDeletedGalleriesOptions as L, type MaskedGallery as M, type BulkUpdateGalleriesRequest as N, type BulkUpdateGalleriesResponseBulkGalleryResult as O, type BulkDeleteGalleriesRequest as P, type QueryGalleriesRequest as Q, type RestoreGalleryFromTrashBinResponse as R, SortOrder as S, type BulkDeleteGalleriesResponseBulkGalleryResult as T, type UpdateGallery as U, Variant as V, WebhookIdentityType as W, type GetDeletedGalleryRequest as X, type ListDeletedGalleriesRequest as Y, type RestoreGalleryFromTrashBinRequest as Z, type RemoveGalleryFromTrashBinRequest as _, type GetGalleryByDraftGalleryIdResponse as a, type DeleteOutdatedGalleryVersionsRequest as a0, type DeleteOutdatedGalleryVersionsResponse as a1, type DomainEvent as a2, type DomainEventBodyOneOf as a3, type EntityCreatedEvent as a4, type RestoreInfo as a5, type EntityUpdatedEvent as a6, type EntityDeletedEvent as a7, type ActionEvent as a8, type MessageEnvelope as a9, type IdentificationData as aa, type IdentificationDataIdOneOf as ab, type BaseEventMetadata as ac, type EventMetadata as ad, type GalleriesQueryResult as ae, type GalleriesQueryBuilder as b, type UpdateExtendedFieldsOptions as c, type UpdateExtendedFieldsResponse as d, type BulkCreateGalleriesResponse as e, type BulkUpdateGalleriesOptions as f, type BulkUpdateGalleriesResponse as g, type BulkDeleteGalleriesResponse as h, type GetDeletedGalleryResponse as i, type ListDeletedGalleriesResponse as j, type GalleryRemovedFromTrashBinEnvelope as k, type GalleryRemovedFromTrashBin as l, type CreateGalleryResponse as m, type GetGalleryRequest as n, type GetGalleryResponse as o, type GetGalleryByDraftGalleryIdRequest as p, type UpdateGalleryRequest as q, type UpdateGalleryResponse as r, type DeleteGalleryResponse as s, type CursorQuery as t, type CursorQueryPagingMethodOneOf as u, type Sorting as v, type CursorPaging as w, type QueryGalleriesResponse as x, type CursorPagingMetadata as y, type Cursors as z };
|