@wix/auto_sdk_portfolio_project-items 1.0.0 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/portfolio-project-items-v1-project-item-project-items.context.d.ts +2 -2
- package/build/cjs/src/portfolio-project-items-v1-project-item-project-items.context.js +2 -2
- package/build/cjs/src/portfolio-project-items-v1-project-item-project-items.context.js.map +1 -1
- package/build/cjs/src/portfolio-project-items-v1-project-item-project-items.types.d.ts +316 -161
- package/build/cjs/src/portfolio-project-items-v1-project-item-project-items.types.js +6 -6
- package/build/cjs/src/portfolio-project-items-v1-project-item-project-items.types.js.map +1 -1
- package/build/cjs/src/portfolio-project-items-v1-project-item-project-items.universal.d.ts +345 -165
- package/build/cjs/src/portfolio-project-items-v1-project-item-project-items.universal.js +6 -6
- package/build/cjs/src/portfolio-project-items-v1-project-item-project-items.universal.js.map +1 -1
- package/build/es/src/portfolio-project-items-v1-project-item-project-items.context.d.ts +2 -2
- package/build/es/src/portfolio-project-items-v1-project-item-project-items.context.js +1 -1
- package/build/es/src/portfolio-project-items-v1-project-item-project-items.context.js.map +1 -1
- package/build/es/src/portfolio-project-items-v1-project-item-project-items.types.d.ts +316 -161
- package/build/es/src/portfolio-project-items-v1-project-item-project-items.types.js +5 -5
- package/build/es/src/portfolio-project-items-v1-project-item-project-items.types.js.map +1 -1
- package/build/es/src/portfolio-project-items-v1-project-item-project-items.universal.d.ts +345 -165
- package/build/es/src/portfolio-project-items-v1-project-item-project-items.universal.js +5 -5
- package/build/es/src/portfolio-project-items-v1-project-item-project-items.universal.js.map +1 -1
- package/build/internal/cjs/src/portfolio-project-items-v1-project-item-project-items.context.d.ts +2 -2
- package/build/internal/cjs/src/portfolio-project-items-v1-project-item-project-items.context.js +2 -2
- package/build/internal/cjs/src/portfolio-project-items-v1-project-item-project-items.context.js.map +1 -1
- package/build/internal/cjs/src/portfolio-project-items-v1-project-item-project-items.types.d.ts +316 -161
- package/build/internal/cjs/src/portfolio-project-items-v1-project-item-project-items.types.js +6 -6
- package/build/internal/cjs/src/portfolio-project-items-v1-project-item-project-items.types.js.map +1 -1
- package/build/internal/cjs/src/portfolio-project-items-v1-project-item-project-items.universal.d.ts +345 -165
- package/build/internal/cjs/src/portfolio-project-items-v1-project-item-project-items.universal.js +6 -6
- package/build/internal/cjs/src/portfolio-project-items-v1-project-item-project-items.universal.js.map +1 -1
- package/build/internal/es/src/portfolio-project-items-v1-project-item-project-items.context.d.ts +2 -2
- package/build/internal/es/src/portfolio-project-items-v1-project-item-project-items.context.js +1 -1
- package/build/internal/es/src/portfolio-project-items-v1-project-item-project-items.context.js.map +1 -1
- package/build/internal/es/src/portfolio-project-items-v1-project-item-project-items.types.d.ts +316 -161
- package/build/internal/es/src/portfolio-project-items-v1-project-item-project-items.types.js +5 -5
- package/build/internal/es/src/portfolio-project-items-v1-project-item-project-items.types.js.map +1 -1
- package/build/internal/es/src/portfolio-project-items-v1-project-item-project-items.universal.d.ts +345 -165
- package/build/internal/es/src/portfolio-project-items-v1-project-item-project-items.universal.js +5 -5
- package/build/internal/es/src/portfolio-project-items-v1-project-item-project-items.universal.js.map +1 -1
- package/package.json +2 -2
package/build/internal/cjs/src/portfolio-project-items-v1-project-item-project-items.universal.d.ts
CHANGED
|
@@ -3,11 +3,15 @@ export interface Item extends ItemMetadataOneOf {
|
|
|
3
3
|
image?: Image;
|
|
4
4
|
/** Information about the Wix Media video. */
|
|
5
5
|
video?: Video;
|
|
6
|
-
/**
|
|
6
|
+
/**
|
|
7
|
+
* Project ID.
|
|
8
|
+
* @format GUID
|
|
9
|
+
*/
|
|
7
10
|
projectId?: string | null;
|
|
8
11
|
/**
|
|
9
12
|
* Project item ID.
|
|
10
13
|
* @readonly
|
|
14
|
+
* @format GUID
|
|
11
15
|
*/
|
|
12
16
|
_id?: string | null;
|
|
13
17
|
/**
|
|
@@ -76,6 +80,7 @@ export interface UnsharpMasking {
|
|
|
76
80
|
*
|
|
77
81
|
* Min: `0` <br />
|
|
78
82
|
* Max: `5`
|
|
83
|
+
* @max 5
|
|
79
84
|
*/
|
|
80
85
|
amount?: number | null;
|
|
81
86
|
/** Unsharp masking radius in pixels. Controls the sharpening width. */
|
|
@@ -85,6 +90,7 @@ export interface UnsharpMasking {
|
|
|
85
90
|
*
|
|
86
91
|
* Min: `0` <br />
|
|
87
92
|
* Max: `1`
|
|
93
|
+
* @max 1
|
|
88
94
|
*/
|
|
89
95
|
threshold?: number | null;
|
|
90
96
|
}
|
|
@@ -109,149 +115,39 @@ export interface VideoResolution {
|
|
|
109
115
|
filename?: string | null;
|
|
110
116
|
}
|
|
111
117
|
export interface Tags {
|
|
112
|
-
/**
|
|
118
|
+
/**
|
|
119
|
+
* List of tags assigned to the media item.
|
|
120
|
+
* @maxSize 50
|
|
121
|
+
* @maxLength 100
|
|
122
|
+
*/
|
|
113
123
|
values?: string[];
|
|
114
124
|
}
|
|
115
125
|
export interface Link {
|
|
116
126
|
/** Display text of the link. */
|
|
117
127
|
text?: string | null;
|
|
118
|
-
/**
|
|
128
|
+
/**
|
|
129
|
+
* Target URL of the link.
|
|
130
|
+
* @format WEB_URL
|
|
131
|
+
*/
|
|
119
132
|
url?: string | null;
|
|
120
133
|
/**
|
|
121
134
|
* Whether the link opens in a new tab or window. One of:
|
|
122
135
|
* * `'_blank'`: The link opens in a new tab or window.
|
|
123
136
|
* * `'_self'`: The link opens in the same tab or window.
|
|
137
|
+
* @maxLength 50
|
|
124
138
|
*/
|
|
125
139
|
target?: string | null;
|
|
126
140
|
}
|
|
127
|
-
export interface
|
|
128
|
-
/** Media ids of requested project items */
|
|
129
|
-
mediaIds?: string[];
|
|
130
|
-
}
|
|
131
|
-
export interface GenerateTokenForProjectItemsResponse {
|
|
132
|
-
/** Generated media tokens for project items */
|
|
133
|
-
mediaTokens?: ProjectItemMediaToken[];
|
|
134
|
-
}
|
|
135
|
-
export interface ProjectItemMediaToken {
|
|
136
|
-
/** Media id of project item */
|
|
137
|
-
mediaId?: string;
|
|
138
|
-
/** Generated media token for project item */
|
|
139
|
-
mediaToken?: string;
|
|
140
|
-
}
|
|
141
|
-
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
142
|
-
createdEvent?: EntityCreatedEvent;
|
|
143
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
144
|
-
deletedEvent?: EntityDeletedEvent;
|
|
145
|
-
actionEvent?: ActionEvent;
|
|
146
|
-
/**
|
|
147
|
-
* Unique event ID.
|
|
148
|
-
* Allows clients to ignore duplicate webhooks.
|
|
149
|
-
*/
|
|
150
|
-
_id?: string;
|
|
151
|
-
/**
|
|
152
|
-
* Assumes actions are also always typed to an entity_type
|
|
153
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
154
|
-
*/
|
|
155
|
-
entityFqdn?: string;
|
|
156
|
-
/**
|
|
157
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
158
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
159
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
160
|
-
*/
|
|
161
|
-
slug?: string;
|
|
162
|
-
/** ID of the entity associated with the event. */
|
|
163
|
-
entityId?: string;
|
|
164
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
165
|
-
eventTime?: Date | null;
|
|
141
|
+
export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
166
142
|
/**
|
|
167
|
-
*
|
|
168
|
-
*
|
|
143
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
144
|
+
* @format GUID
|
|
169
145
|
*/
|
|
170
|
-
|
|
171
|
-
/** If present, indicates the action that triggered the event. */
|
|
172
|
-
originatedFrom?: string | null;
|
|
173
|
-
/**
|
|
174
|
-
* A sequence number defining the order of updates to the underlying entity.
|
|
175
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
176
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
177
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
178
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
179
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
180
|
-
*/
|
|
181
|
-
entityEventSequence?: string | null;
|
|
182
|
-
}
|
|
183
|
-
/** @oneof */
|
|
184
|
-
export interface DomainEventBodyOneOf {
|
|
185
|
-
createdEvent?: EntityCreatedEvent;
|
|
186
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
187
|
-
deletedEvent?: EntityDeletedEvent;
|
|
188
|
-
actionEvent?: ActionEvent;
|
|
189
|
-
}
|
|
190
|
-
export interface EntityCreatedEvent {
|
|
191
|
-
entity?: string;
|
|
192
|
-
}
|
|
193
|
-
export interface RestoreInfo {
|
|
194
|
-
deletedDate?: Date | null;
|
|
195
|
-
}
|
|
196
|
-
export interface EntityUpdatedEvent {
|
|
146
|
+
metaSiteId?: string;
|
|
197
147
|
/**
|
|
198
|
-
*
|
|
199
|
-
*
|
|
200
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
148
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
149
|
+
* @format GUID
|
|
201
150
|
*/
|
|
202
|
-
currentEntity?: string;
|
|
203
|
-
}
|
|
204
|
-
export interface EntityDeletedEvent {
|
|
205
|
-
/** Entity that was deleted */
|
|
206
|
-
deletedEntity?: string | null;
|
|
207
|
-
}
|
|
208
|
-
export interface ActionEvent {
|
|
209
|
-
body?: string;
|
|
210
|
-
}
|
|
211
|
-
export interface MessageEnvelope {
|
|
212
|
-
/** App instance ID. */
|
|
213
|
-
instanceId?: string | null;
|
|
214
|
-
/** Event type. */
|
|
215
|
-
eventType?: string;
|
|
216
|
-
/** The identification type and identity data. */
|
|
217
|
-
identity?: IdentificationData;
|
|
218
|
-
/** Stringify payload. */
|
|
219
|
-
data?: string;
|
|
220
|
-
}
|
|
221
|
-
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
222
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
223
|
-
anonymousVisitorId?: string;
|
|
224
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
225
|
-
memberId?: string;
|
|
226
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
227
|
-
wixUserId?: string;
|
|
228
|
-
/** ID of an app. */
|
|
229
|
-
appId?: string;
|
|
230
|
-
/** @readonly */
|
|
231
|
-
identityType?: WebhookIdentityType;
|
|
232
|
-
}
|
|
233
|
-
/** @oneof */
|
|
234
|
-
export interface IdentificationDataIdOneOf {
|
|
235
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
236
|
-
anonymousVisitorId?: string;
|
|
237
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
238
|
-
memberId?: string;
|
|
239
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
240
|
-
wixUserId?: string;
|
|
241
|
-
/** ID of an app. */
|
|
242
|
-
appId?: string;
|
|
243
|
-
}
|
|
244
|
-
export declare enum WebhookIdentityType {
|
|
245
|
-
UNKNOWN = "UNKNOWN",
|
|
246
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
247
|
-
MEMBER = "MEMBER",
|
|
248
|
-
WIX_USER = "WIX_USER",
|
|
249
|
-
APP = "APP"
|
|
250
|
-
}
|
|
251
|
-
export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
252
|
-
/** Invalidate by msId. NOT recommended, as this will invalidate the entire site cache! */
|
|
253
|
-
metaSiteId?: string;
|
|
254
|
-
/** Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache! */
|
|
255
151
|
siteId?: string;
|
|
256
152
|
/** Invalidate by App */
|
|
257
153
|
app?: App;
|
|
@@ -261,7 +157,10 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
|
261
157
|
uri?: URI;
|
|
262
158
|
/** Invalidate by file (for media files such as PDFs) */
|
|
263
159
|
file?: File;
|
|
264
|
-
/**
|
|
160
|
+
/**
|
|
161
|
+
* tell us why you're invalidating the cache. You don't need to add your app name
|
|
162
|
+
* @maxLength 256
|
|
163
|
+
*/
|
|
265
164
|
reason?: string | null;
|
|
266
165
|
/** Is local DS */
|
|
267
166
|
localDc?: boolean;
|
|
@@ -269,9 +168,15 @@ export interface InvalidateCache extends InvalidateCacheGetByOneOf {
|
|
|
269
168
|
}
|
|
270
169
|
/** @oneof */
|
|
271
170
|
export interface InvalidateCacheGetByOneOf {
|
|
272
|
-
/**
|
|
171
|
+
/**
|
|
172
|
+
* Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
|
|
173
|
+
* @format GUID
|
|
174
|
+
*/
|
|
273
175
|
metaSiteId?: string;
|
|
274
|
-
/**
|
|
176
|
+
/**
|
|
177
|
+
* Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
|
|
178
|
+
* @format GUID
|
|
179
|
+
*/
|
|
275
180
|
siteId?: string;
|
|
276
181
|
/** Invalidate by App */
|
|
277
182
|
app?: App;
|
|
@@ -283,27 +188,52 @@ export interface InvalidateCacheGetByOneOf {
|
|
|
283
188
|
file?: File;
|
|
284
189
|
}
|
|
285
190
|
export interface App {
|
|
286
|
-
/**
|
|
191
|
+
/**
|
|
192
|
+
* The AppDefId
|
|
193
|
+
* @minLength 1
|
|
194
|
+
*/
|
|
287
195
|
appDefId?: string;
|
|
288
|
-
/**
|
|
196
|
+
/**
|
|
197
|
+
* The instance Id
|
|
198
|
+
* @format GUID
|
|
199
|
+
*/
|
|
289
200
|
instanceId?: string;
|
|
290
201
|
}
|
|
291
202
|
export interface Page {
|
|
292
|
-
/**
|
|
203
|
+
/**
|
|
204
|
+
* the msid the page is on
|
|
205
|
+
* @format GUID
|
|
206
|
+
*/
|
|
293
207
|
metaSiteId?: string;
|
|
294
|
-
/**
|
|
208
|
+
/**
|
|
209
|
+
* Invalidate by Page ID
|
|
210
|
+
* @minLength 1
|
|
211
|
+
*/
|
|
295
212
|
pageId?: string;
|
|
296
213
|
}
|
|
297
214
|
export interface URI {
|
|
298
|
-
/**
|
|
215
|
+
/**
|
|
216
|
+
* the msid the URI is on
|
|
217
|
+
* @format GUID
|
|
218
|
+
*/
|
|
299
219
|
metaSiteId?: string;
|
|
300
|
-
/**
|
|
220
|
+
/**
|
|
221
|
+
* URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
|
|
222
|
+
* @minLength 1
|
|
223
|
+
*/
|
|
301
224
|
uriPath?: string;
|
|
302
225
|
}
|
|
303
226
|
export interface File {
|
|
304
|
-
/**
|
|
227
|
+
/**
|
|
228
|
+
* the msid the file is related to
|
|
229
|
+
* @format GUID
|
|
230
|
+
*/
|
|
305
231
|
metaSiteId?: string;
|
|
306
|
-
/**
|
|
232
|
+
/**
|
|
233
|
+
* Invalidate by filename (for media files such as PDFs)
|
|
234
|
+
* @minLength 1
|
|
235
|
+
* @maxLength 256
|
|
236
|
+
*/
|
|
307
237
|
fileName?: string;
|
|
308
238
|
}
|
|
309
239
|
export interface CreateProjectItemRequest {
|
|
@@ -315,7 +245,11 @@ export interface CreateProjectItemResponse {
|
|
|
315
245
|
item?: Item;
|
|
316
246
|
}
|
|
317
247
|
export interface BulkCreateProjectItemsRequest {
|
|
318
|
-
/**
|
|
248
|
+
/**
|
|
249
|
+
* Project items to create.
|
|
250
|
+
* @minSize 1
|
|
251
|
+
* @maxSize 1000
|
|
252
|
+
*/
|
|
319
253
|
items: Item[];
|
|
320
254
|
/** Whether to include the created project items in the response. Set to `true` to receive the project items in the response. Default: `false` */
|
|
321
255
|
returnFullEntity?: boolean | null;
|
|
@@ -359,7 +293,10 @@ export interface BulkActionMetadata {
|
|
|
359
293
|
undetailedFailures?: number;
|
|
360
294
|
}
|
|
361
295
|
export interface GetProjectItemRequest {
|
|
362
|
-
/**
|
|
296
|
+
/**
|
|
297
|
+
* Project item ID.
|
|
298
|
+
* @format GUID
|
|
299
|
+
*/
|
|
363
300
|
itemId: string;
|
|
364
301
|
}
|
|
365
302
|
export interface GetProjectItemResponse {
|
|
@@ -367,7 +304,10 @@ export interface GetProjectItemResponse {
|
|
|
367
304
|
item?: Item;
|
|
368
305
|
}
|
|
369
306
|
export interface ListProjectItemsRequest {
|
|
370
|
-
/**
|
|
307
|
+
/**
|
|
308
|
+
* Project ID.
|
|
309
|
+
* @format GUID
|
|
310
|
+
*/
|
|
371
311
|
projectId: string;
|
|
372
312
|
/** Maximum number of items to return in the results. */
|
|
373
313
|
paging?: Paging;
|
|
@@ -402,9 +342,15 @@ export interface PagingMetadataV2 {
|
|
|
402
342
|
cursors?: Cursors;
|
|
403
343
|
}
|
|
404
344
|
export interface Cursors {
|
|
405
|
-
/**
|
|
345
|
+
/**
|
|
346
|
+
* Cursor string pointing to the next page in the list of results.
|
|
347
|
+
* @maxLength 16000
|
|
348
|
+
*/
|
|
406
349
|
next?: string | null;
|
|
407
|
-
/**
|
|
350
|
+
/**
|
|
351
|
+
* Cursor pointing to the previous page in the list of results.
|
|
352
|
+
* @maxLength 16000
|
|
353
|
+
*/
|
|
408
354
|
prev?: string | null;
|
|
409
355
|
}
|
|
410
356
|
export interface QueryProjectItemsRequest {
|
|
@@ -441,7 +387,10 @@ export interface QueryV2PagingMethodOneOf {
|
|
|
441
387
|
cursorPaging?: CursorPaging;
|
|
442
388
|
}
|
|
443
389
|
export interface Sorting {
|
|
444
|
-
/**
|
|
390
|
+
/**
|
|
391
|
+
* Name of the field to sort by.
|
|
392
|
+
* @maxLength 512
|
|
393
|
+
*/
|
|
445
394
|
fieldName?: string;
|
|
446
395
|
/** Sort order. */
|
|
447
396
|
order?: SortOrder;
|
|
@@ -451,13 +400,17 @@ export declare enum SortOrder {
|
|
|
451
400
|
DESC = "DESC"
|
|
452
401
|
}
|
|
453
402
|
export interface CursorPaging {
|
|
454
|
-
/**
|
|
403
|
+
/**
|
|
404
|
+
* Maximum number of items to return in the results.
|
|
405
|
+
* @max 100
|
|
406
|
+
*/
|
|
455
407
|
limit?: number | null;
|
|
456
408
|
/**
|
|
457
409
|
* Pointer to the next or previous page in the list of results.
|
|
458
410
|
*
|
|
459
411
|
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
460
412
|
* Not relevant for the first request.
|
|
413
|
+
* @maxLength 16000
|
|
461
414
|
*/
|
|
462
415
|
cursor?: string | null;
|
|
463
416
|
}
|
|
@@ -476,7 +429,10 @@ export interface UpdateProjectItemResponse {
|
|
|
476
429
|
item?: Item;
|
|
477
430
|
}
|
|
478
431
|
export interface BulkUpdateProjectItemsRequest {
|
|
479
|
-
/**
|
|
432
|
+
/**
|
|
433
|
+
* items to be updated.
|
|
434
|
+
* @maxSize 100
|
|
435
|
+
*/
|
|
480
436
|
items?: MaskedItem[];
|
|
481
437
|
/** Whether to include the updated project items in the response. Set to `true` to receive the project items in the response. Default: `false` */
|
|
482
438
|
returnFullEntity?: boolean | null;
|
|
@@ -498,17 +454,31 @@ export interface BulkUpdateProjectItemResult {
|
|
|
498
454
|
item?: Item;
|
|
499
455
|
}
|
|
500
456
|
export interface DeleteProjectItemRequest {
|
|
501
|
-
/**
|
|
457
|
+
/**
|
|
458
|
+
* ID of the project item to delete.
|
|
459
|
+
* @format GUID
|
|
460
|
+
*/
|
|
502
461
|
itemId: string;
|
|
503
462
|
}
|
|
504
463
|
export interface DeleteProjectItemResponse {
|
|
505
|
-
/**
|
|
464
|
+
/**
|
|
465
|
+
* Project ID.
|
|
466
|
+
* @format GUID
|
|
467
|
+
*/
|
|
506
468
|
projectId?: string;
|
|
507
|
-
/**
|
|
469
|
+
/**
|
|
470
|
+
* ID of the deleted project item.
|
|
471
|
+
* @format GUID
|
|
472
|
+
*/
|
|
508
473
|
itemId?: string;
|
|
509
474
|
}
|
|
510
475
|
export interface BulkDeleteProjectItemsRequest {
|
|
511
|
-
/**
|
|
476
|
+
/**
|
|
477
|
+
* Project item IDs.
|
|
478
|
+
* @format GUID
|
|
479
|
+
* @minSize 1
|
|
480
|
+
* @maxLength 100
|
|
481
|
+
*/
|
|
512
482
|
itemIds: string[];
|
|
513
483
|
}
|
|
514
484
|
export interface BulkDeleteProjectItemsResponse {
|
|
@@ -520,39 +490,221 @@ export interface BulkDeleteProjectItemsResponse {
|
|
|
520
490
|
export interface BulkDeleteProjectItemResult {
|
|
521
491
|
/** Information about successful action or error for failure. */
|
|
522
492
|
itemMetadata?: ItemMetadata;
|
|
523
|
-
/**
|
|
493
|
+
/**
|
|
494
|
+
* Project item ID.
|
|
495
|
+
* @format GUID
|
|
496
|
+
*/
|
|
524
497
|
itemId?: string;
|
|
525
498
|
}
|
|
526
499
|
export interface CreateProjectGalleryRequest {
|
|
527
|
-
/**
|
|
500
|
+
/**
|
|
501
|
+
* Id of Project to create
|
|
502
|
+
* @format GUID
|
|
503
|
+
*/
|
|
528
504
|
projectId?: string;
|
|
529
505
|
}
|
|
530
506
|
export interface CreateProjectGalleryResponse {
|
|
531
|
-
/**
|
|
507
|
+
/**
|
|
508
|
+
* Id of created Project
|
|
509
|
+
* @format GUID
|
|
510
|
+
*/
|
|
532
511
|
projectId?: string;
|
|
533
|
-
/**
|
|
512
|
+
/**
|
|
513
|
+
* Id of created gallery
|
|
514
|
+
* @format GUID
|
|
515
|
+
*/
|
|
534
516
|
galleryId?: string;
|
|
535
517
|
}
|
|
518
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
519
|
+
createdEvent?: EntityCreatedEvent;
|
|
520
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
521
|
+
deletedEvent?: EntityDeletedEvent;
|
|
522
|
+
actionEvent?: ActionEvent;
|
|
523
|
+
/**
|
|
524
|
+
* Unique event ID.
|
|
525
|
+
* Allows clients to ignore duplicate webhooks.
|
|
526
|
+
*/
|
|
527
|
+
_id?: string;
|
|
528
|
+
/**
|
|
529
|
+
* Assumes actions are also always typed to an entity_type
|
|
530
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
531
|
+
*/
|
|
532
|
+
entityFqdn?: string;
|
|
533
|
+
/**
|
|
534
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
535
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
536
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
537
|
+
*/
|
|
538
|
+
slug?: string;
|
|
539
|
+
/** ID of the entity associated with the event. */
|
|
540
|
+
entityId?: string;
|
|
541
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
542
|
+
eventTime?: Date | null;
|
|
543
|
+
/**
|
|
544
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
545
|
+
* (for example, GDPR).
|
|
546
|
+
*/
|
|
547
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
548
|
+
/** If present, indicates the action that triggered the event. */
|
|
549
|
+
originatedFrom?: string | null;
|
|
550
|
+
/**
|
|
551
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
552
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
553
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
554
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
555
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
556
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
557
|
+
*/
|
|
558
|
+
entityEventSequence?: string | null;
|
|
559
|
+
}
|
|
560
|
+
/** @oneof */
|
|
561
|
+
export interface DomainEventBodyOneOf {
|
|
562
|
+
createdEvent?: EntityCreatedEvent;
|
|
563
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
564
|
+
deletedEvent?: EntityDeletedEvent;
|
|
565
|
+
actionEvent?: ActionEvent;
|
|
566
|
+
}
|
|
567
|
+
export interface EntityCreatedEvent {
|
|
568
|
+
entity?: string;
|
|
569
|
+
}
|
|
570
|
+
export interface RestoreInfo {
|
|
571
|
+
deletedDate?: Date | null;
|
|
572
|
+
}
|
|
573
|
+
export interface EntityUpdatedEvent {
|
|
574
|
+
/**
|
|
575
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
576
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
577
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
578
|
+
*/
|
|
579
|
+
currentEntity?: string;
|
|
580
|
+
}
|
|
581
|
+
export interface EntityDeletedEvent {
|
|
582
|
+
/** Entity that was deleted */
|
|
583
|
+
deletedEntity?: string | null;
|
|
584
|
+
}
|
|
585
|
+
export interface ActionEvent {
|
|
586
|
+
body?: string;
|
|
587
|
+
}
|
|
536
588
|
export interface Empty {
|
|
537
589
|
}
|
|
538
590
|
export interface DeletedProjectRestored {
|
|
539
|
-
/**
|
|
591
|
+
/**
|
|
592
|
+
* the id of the project that was restored
|
|
593
|
+
* @format GUID
|
|
594
|
+
*/
|
|
540
595
|
projectId?: string;
|
|
541
596
|
/** timestamp for when the project was originally deleted. */
|
|
542
597
|
deletionTimestamp?: Date | null;
|
|
543
598
|
}
|
|
544
599
|
export interface DuplicateProjectItemsRequest {
|
|
545
|
-
/**
|
|
600
|
+
/**
|
|
601
|
+
* ID of the project containing the items to duplicate.
|
|
602
|
+
* @format GUID
|
|
603
|
+
*/
|
|
546
604
|
originProjectId: string;
|
|
547
|
-
/**
|
|
605
|
+
/**
|
|
606
|
+
* ID of the project where the duplicated items will be added.
|
|
607
|
+
* @format GUID
|
|
608
|
+
*/
|
|
548
609
|
targetProjectId: string;
|
|
549
610
|
}
|
|
550
611
|
export interface DuplicateProjectItemsResponse {
|
|
551
|
-
/**
|
|
612
|
+
/**
|
|
613
|
+
* Project ID where the duplicated items have been added.
|
|
614
|
+
* @format GUID
|
|
615
|
+
*/
|
|
552
616
|
projectId?: string;
|
|
553
617
|
/** Bulk action metadata. */
|
|
554
618
|
bulkActionMetadata?: BulkActionMetadata;
|
|
555
619
|
}
|
|
620
|
+
export interface MessageEnvelope {
|
|
621
|
+
/**
|
|
622
|
+
* App instance ID.
|
|
623
|
+
* @format GUID
|
|
624
|
+
*/
|
|
625
|
+
instanceId?: string | null;
|
|
626
|
+
/**
|
|
627
|
+
* Event type.
|
|
628
|
+
* @maxLength 150
|
|
629
|
+
*/
|
|
630
|
+
eventType?: string;
|
|
631
|
+
/** The identification type and identity data. */
|
|
632
|
+
identity?: IdentificationData;
|
|
633
|
+
/** Stringify payload. */
|
|
634
|
+
data?: string;
|
|
635
|
+
}
|
|
636
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
637
|
+
/**
|
|
638
|
+
* ID of a site visitor that has not logged in to the site.
|
|
639
|
+
* @format GUID
|
|
640
|
+
*/
|
|
641
|
+
anonymousVisitorId?: string;
|
|
642
|
+
/**
|
|
643
|
+
* ID of a site visitor that has logged in to the site.
|
|
644
|
+
* @format GUID
|
|
645
|
+
*/
|
|
646
|
+
memberId?: string;
|
|
647
|
+
/**
|
|
648
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
649
|
+
* @format GUID
|
|
650
|
+
*/
|
|
651
|
+
wixUserId?: string;
|
|
652
|
+
/**
|
|
653
|
+
* ID of an app.
|
|
654
|
+
* @format GUID
|
|
655
|
+
*/
|
|
656
|
+
appId?: string;
|
|
657
|
+
/** @readonly */
|
|
658
|
+
identityType?: WebhookIdentityType;
|
|
659
|
+
}
|
|
660
|
+
/** @oneof */
|
|
661
|
+
export interface IdentificationDataIdOneOf {
|
|
662
|
+
/**
|
|
663
|
+
* ID of a site visitor that has not logged in to the site.
|
|
664
|
+
* @format GUID
|
|
665
|
+
*/
|
|
666
|
+
anonymousVisitorId?: string;
|
|
667
|
+
/**
|
|
668
|
+
* ID of a site visitor that has logged in to the site.
|
|
669
|
+
* @format GUID
|
|
670
|
+
*/
|
|
671
|
+
memberId?: string;
|
|
672
|
+
/**
|
|
673
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
674
|
+
* @format GUID
|
|
675
|
+
*/
|
|
676
|
+
wixUserId?: string;
|
|
677
|
+
/**
|
|
678
|
+
* ID of an app.
|
|
679
|
+
* @format GUID
|
|
680
|
+
*/
|
|
681
|
+
appId?: string;
|
|
682
|
+
}
|
|
683
|
+
export declare enum WebhookIdentityType {
|
|
684
|
+
UNKNOWN = "UNKNOWN",
|
|
685
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
686
|
+
MEMBER = "MEMBER",
|
|
687
|
+
WIX_USER = "WIX_USER",
|
|
688
|
+
APP = "APP"
|
|
689
|
+
}
|
|
690
|
+
export interface GenerateTokenForProjectItemsRequest {
|
|
691
|
+
/**
|
|
692
|
+
* Media ids of requested project items
|
|
693
|
+
* @minSize 1
|
|
694
|
+
* @maxLength 100
|
|
695
|
+
*/
|
|
696
|
+
mediaIds?: string[];
|
|
697
|
+
}
|
|
698
|
+
export interface GenerateTokenForProjectItemsResponse {
|
|
699
|
+
/** Generated media tokens for project items */
|
|
700
|
+
mediaTokens?: ProjectItemMediaToken[];
|
|
701
|
+
}
|
|
702
|
+
export interface ProjectItemMediaToken {
|
|
703
|
+
/** Media id of project item */
|
|
704
|
+
mediaId?: string;
|
|
705
|
+
/** Generated media token for project item */
|
|
706
|
+
mediaToken?: string;
|
|
707
|
+
}
|
|
556
708
|
interface PointNonNullableFields {
|
|
557
709
|
x: number;
|
|
558
710
|
y: number;
|
|
@@ -640,9 +792,15 @@ export interface DuplicateProjectItemsResponseNonNullableFields {
|
|
|
640
792
|
bulkActionMetadata?: BulkActionMetadataNonNullableFields;
|
|
641
793
|
}
|
|
642
794
|
export interface BaseEventMetadata {
|
|
643
|
-
/**
|
|
795
|
+
/**
|
|
796
|
+
* App instance ID.
|
|
797
|
+
* @format GUID
|
|
798
|
+
*/
|
|
644
799
|
instanceId?: string | null;
|
|
645
|
-
/**
|
|
800
|
+
/**
|
|
801
|
+
* Event type.
|
|
802
|
+
* @maxLength 150
|
|
803
|
+
*/
|
|
646
804
|
eventType?: string;
|
|
647
805
|
/** The identification type and identity data. */
|
|
648
806
|
identity?: IdentificationData;
|
|
@@ -696,6 +854,7 @@ export interface ProjectItemCreatedEnvelope {
|
|
|
696
854
|
* @permissionId PORTFOLIO.PROJECT_ITEM_READ
|
|
697
855
|
* @webhook
|
|
698
856
|
* @eventType wix.portfolio.project_items.v1.project_item_created
|
|
857
|
+
* @slug created
|
|
699
858
|
* @documentationMaturity preview
|
|
700
859
|
*/
|
|
701
860
|
export declare function onProjectItemCreated(handler: (event: ProjectItemCreatedEnvelope) => void | Promise<void>): void;
|
|
@@ -709,6 +868,7 @@ export interface ProjectItemDeletedEnvelope {
|
|
|
709
868
|
* @permissionId PORTFOLIO.PROJECT_ITEM_READ
|
|
710
869
|
* @webhook
|
|
711
870
|
* @eventType wix.portfolio.project_items.v1.project_item_deleted
|
|
871
|
+
* @slug deleted
|
|
712
872
|
* @documentationMaturity preview
|
|
713
873
|
*/
|
|
714
874
|
export declare function onProjectItemDeleted(handler: (event: ProjectItemDeletedEnvelope) => void | Promise<void>): void;
|
|
@@ -723,6 +883,7 @@ export interface ProjectItemUpdatedEnvelope {
|
|
|
723
883
|
* @permissionId PORTFOLIO.PROJECT_ITEM_READ
|
|
724
884
|
* @webhook
|
|
725
885
|
* @eventType wix.portfolio.project_items.v1.project_item_updated
|
|
886
|
+
* @slug updated
|
|
726
887
|
* @documentationMaturity preview
|
|
727
888
|
*/
|
|
728
889
|
export declare function onProjectItemUpdated(handler: (event: ProjectItemUpdatedEnvelope) => void | Promise<void>): void;
|
|
@@ -753,7 +914,11 @@ export declare function createProjectItem(item: Item): Promise<Item & ItemNonNul
|
|
|
753
914
|
*/
|
|
754
915
|
export declare function bulkCreateProjectItems(options?: BulkCreateProjectItemsOptions): Promise<BulkCreateProjectItemsResponse & BulkCreateProjectItemsResponseNonNullableFields>;
|
|
755
916
|
export interface BulkCreateProjectItemsOptions {
|
|
756
|
-
/**
|
|
917
|
+
/**
|
|
918
|
+
* Project items to create.
|
|
919
|
+
* @minSize 1
|
|
920
|
+
* @maxSize 1000
|
|
921
|
+
*/
|
|
757
922
|
items: Item[];
|
|
758
923
|
/** Whether to include the created project items in the response. Set to `true` to receive the project items in the response. Default: `false` */
|
|
759
924
|
returnFullEntity?: boolean | null;
|
|
@@ -811,11 +976,15 @@ export interface UpdateProjectItem {
|
|
|
811
976
|
image?: Image;
|
|
812
977
|
/** Information about the Wix Media video. */
|
|
813
978
|
video?: Video;
|
|
814
|
-
/**
|
|
979
|
+
/**
|
|
980
|
+
* Project ID.
|
|
981
|
+
* @format GUID
|
|
982
|
+
*/
|
|
815
983
|
projectId?: string | null;
|
|
816
984
|
/**
|
|
817
985
|
* Project item ID.
|
|
818
986
|
* @readonly
|
|
987
|
+
* @format GUID
|
|
819
988
|
*/
|
|
820
989
|
_id?: string | null;
|
|
821
990
|
/**
|
|
@@ -860,7 +1029,10 @@ export interface UpdateProjectItem {
|
|
|
860
1029
|
*/
|
|
861
1030
|
export declare function bulkUpdateProjectItems(options?: BulkUpdateProjectItemsOptions): Promise<BulkUpdateProjectItemsResponse & BulkUpdateProjectItemsResponseNonNullableFields>;
|
|
862
1031
|
export interface BulkUpdateProjectItemsOptions {
|
|
863
|
-
/**
|
|
1032
|
+
/**
|
|
1033
|
+
* items to be updated.
|
|
1034
|
+
* @maxSize 100
|
|
1035
|
+
*/
|
|
864
1036
|
items?: MaskedItem[];
|
|
865
1037
|
/** Whether to include the updated project items in the response. Set to `true` to receive the project items in the response. Default: `false` */
|
|
866
1038
|
returnFullEntity?: boolean | null;
|
|
@@ -892,7 +1064,12 @@ export declare function deleteProjectItem(itemId: string): Promise<DeleteProject
|
|
|
892
1064
|
*/
|
|
893
1065
|
export declare function bulkDeleteProjectItems(options: BulkDeleteProjectItemsOptions): Promise<BulkDeleteProjectItemsResponse & BulkDeleteProjectItemsResponseNonNullableFields>;
|
|
894
1066
|
export interface BulkDeleteProjectItemsOptions {
|
|
895
|
-
/**
|
|
1067
|
+
/**
|
|
1068
|
+
* Project item IDs.
|
|
1069
|
+
* @format GUID
|
|
1070
|
+
* @minSize 1
|
|
1071
|
+
* @maxLength 100
|
|
1072
|
+
*/
|
|
896
1073
|
itemIds: string[];
|
|
897
1074
|
}
|
|
898
1075
|
/**
|
|
@@ -917,7 +1094,10 @@ export interface BulkDeleteProjectItemsOptions {
|
|
|
917
1094
|
*/
|
|
918
1095
|
export declare function duplicateProjectItems(originProjectId: string, options: DuplicateProjectItemsOptions): Promise<DuplicateProjectItemsResponse & DuplicateProjectItemsResponseNonNullableFields>;
|
|
919
1096
|
export interface DuplicateProjectItemsOptions {
|
|
920
|
-
/**
|
|
1097
|
+
/**
|
|
1098
|
+
* ID of the project where the duplicated items will be added.
|
|
1099
|
+
* @format GUID
|
|
1100
|
+
*/
|
|
921
1101
|
targetProjectId: string;
|
|
922
1102
|
}
|
|
923
1103
|
export {};
|