@wix/auto_sdk_portfolio_projects 1.0.17 → 1.0.19

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.
Files changed (134) hide show
  1. package/build/index.d.mts +120 -0
  2. package/build/index.d.ts +120 -0
  3. package/build/index.js +1439 -0
  4. package/build/index.js.map +1 -0
  5. package/build/index.mjs +1396 -0
  6. package/build/index.mjs.map +1 -0
  7. package/build/internal/index.d.mts +120 -0
  8. package/build/internal/index.d.ts +120 -0
  9. package/build/internal/index.js +1439 -0
  10. package/build/internal/index.js.map +1 -0
  11. package/build/internal/index.mjs +1396 -0
  12. package/build/internal/index.mjs.map +1 -0
  13. package/build/internal/meta.d.mts +515 -0
  14. package/build/internal/meta.d.ts +515 -0
  15. package/build/internal/meta.js +836 -0
  16. package/build/internal/meta.js.map +1 -0
  17. package/build/internal/meta.mjs +801 -0
  18. package/build/internal/meta.mjs.map +1 -0
  19. package/build/internal/{cjs/src/portfolio-projects-v1-project-projects.universal.d.ts → portfolio-projects-v1-project-projects.universal-D18FmjD0.d.mts} +130 -320
  20. package/build/internal/{es/src/portfolio-projects-v1-project-projects.universal.d.ts → portfolio-projects-v1-project-projects.universal-D18FmjD0.d.ts} +130 -320
  21. package/build/meta.d.mts +515 -0
  22. package/build/meta.d.ts +515 -0
  23. package/build/meta.js +836 -0
  24. package/build/meta.js.map +1 -0
  25. package/build/meta.mjs +801 -0
  26. package/build/meta.mjs.map +1 -0
  27. package/build/{cjs/src/portfolio-projects-v1-project-projects.universal.d.ts → portfolio-projects-v1-project-projects.universal-D18FmjD0.d.mts} +130 -320
  28. package/build/{es/src/portfolio-projects-v1-project-projects.universal.d.ts → portfolio-projects-v1-project-projects.universal-D18FmjD0.d.ts} +130 -320
  29. package/package.json +12 -11
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/portfolio-projects-v1-project-projects.context.d.ts +0 -29
  40. package/build/cjs/src/portfolio-projects-v1-project-projects.context.js +0 -40
  41. package/build/cjs/src/portfolio-projects-v1-project-projects.context.js.map +0 -1
  42. package/build/cjs/src/portfolio-projects-v1-project-projects.http.d.ts +0 -42
  43. package/build/cjs/src/portfolio-projects-v1-project-projects.http.js +0 -658
  44. package/build/cjs/src/portfolio-projects-v1-project-projects.http.js.map +0 -1
  45. package/build/cjs/src/portfolio-projects-v1-project-projects.meta.d.ts +0 -30
  46. package/build/cjs/src/portfolio-projects-v1-project-projects.meta.js +0 -202
  47. package/build/cjs/src/portfolio-projects-v1-project-projects.meta.js.map +0 -1
  48. package/build/cjs/src/portfolio-projects-v1-project-projects.public.d.ts +0 -98
  49. package/build/cjs/src/portfolio-projects-v1-project-projects.public.js +0 -176
  50. package/build/cjs/src/portfolio-projects-v1-project-projects.public.js.map +0 -1
  51. package/build/cjs/src/portfolio-projects-v1-project-projects.types.d.ts +0 -1321
  52. package/build/cjs/src/portfolio-projects-v1-project-projects.types.js +0 -143
  53. package/build/cjs/src/portfolio-projects-v1-project-projects.types.js.map +0 -1
  54. package/build/cjs/src/portfolio-projects-v1-project-projects.universal.js +0 -721
  55. package/build/cjs/src/portfolio-projects-v1-project-projects.universal.js.map +0 -1
  56. package/build/es/index.d.ts +0 -1
  57. package/build/es/index.js +0 -2
  58. package/build/es/index.js.map +0 -1
  59. package/build/es/index.typings.d.ts +0 -1
  60. package/build/es/index.typings.js +0 -2
  61. package/build/es/index.typings.js.map +0 -1
  62. package/build/es/meta.d.ts +0 -1
  63. package/build/es/meta.js +0 -2
  64. package/build/es/meta.js.map +0 -1
  65. package/build/es/package.json +0 -3
  66. package/build/es/src/portfolio-projects-v1-project-projects.context.d.ts +0 -29
  67. package/build/es/src/portfolio-projects-v1-project-projects.context.js +0 -29
  68. package/build/es/src/portfolio-projects-v1-project-projects.context.js.map +0 -1
  69. package/build/es/src/portfolio-projects-v1-project-projects.http.d.ts +0 -42
  70. package/build/es/src/portfolio-projects-v1-project-projects.http.js +0 -646
  71. package/build/es/src/portfolio-projects-v1-project-projects.http.js.map +0 -1
  72. package/build/es/src/portfolio-projects-v1-project-projects.meta.d.ts +0 -30
  73. package/build/es/src/portfolio-projects-v1-project-projects.meta.js +0 -167
  74. package/build/es/src/portfolio-projects-v1-project-projects.meta.js.map +0 -1
  75. package/build/es/src/portfolio-projects-v1-project-projects.public.d.ts +0 -98
  76. package/build/es/src/portfolio-projects-v1-project-projects.public.js +0 -156
  77. package/build/es/src/portfolio-projects-v1-project-projects.public.js.map +0 -1
  78. package/build/es/src/portfolio-projects-v1-project-projects.types.d.ts +0 -1321
  79. package/build/es/src/portfolio-projects-v1-project-projects.types.js +0 -140
  80. package/build/es/src/portfolio-projects-v1-project-projects.types.js.map +0 -1
  81. package/build/es/src/portfolio-projects-v1-project-projects.universal.js +0 -686
  82. package/build/es/src/portfolio-projects-v1-project-projects.universal.js.map +0 -1
  83. package/build/internal/cjs/index.d.ts +0 -1
  84. package/build/internal/cjs/index.js +0 -18
  85. package/build/internal/cjs/index.js.map +0 -1
  86. package/build/internal/cjs/index.typings.d.ts +0 -1
  87. package/build/internal/cjs/index.typings.js +0 -18
  88. package/build/internal/cjs/index.typings.js.map +0 -1
  89. package/build/internal/cjs/meta.d.ts +0 -1
  90. package/build/internal/cjs/meta.js +0 -18
  91. package/build/internal/cjs/meta.js.map +0 -1
  92. package/build/internal/cjs/src/portfolio-projects-v1-project-projects.context.d.ts +0 -29
  93. package/build/internal/cjs/src/portfolio-projects-v1-project-projects.context.js +0 -40
  94. package/build/internal/cjs/src/portfolio-projects-v1-project-projects.context.js.map +0 -1
  95. package/build/internal/cjs/src/portfolio-projects-v1-project-projects.http.d.ts +0 -42
  96. package/build/internal/cjs/src/portfolio-projects-v1-project-projects.http.js +0 -658
  97. package/build/internal/cjs/src/portfolio-projects-v1-project-projects.http.js.map +0 -1
  98. package/build/internal/cjs/src/portfolio-projects-v1-project-projects.meta.d.ts +0 -30
  99. package/build/internal/cjs/src/portfolio-projects-v1-project-projects.meta.js +0 -202
  100. package/build/internal/cjs/src/portfolio-projects-v1-project-projects.meta.js.map +0 -1
  101. package/build/internal/cjs/src/portfolio-projects-v1-project-projects.public.d.ts +0 -98
  102. package/build/internal/cjs/src/portfolio-projects-v1-project-projects.public.js +0 -176
  103. package/build/internal/cjs/src/portfolio-projects-v1-project-projects.public.js.map +0 -1
  104. package/build/internal/cjs/src/portfolio-projects-v1-project-projects.types.d.ts +0 -1321
  105. package/build/internal/cjs/src/portfolio-projects-v1-project-projects.types.js +0 -143
  106. package/build/internal/cjs/src/portfolio-projects-v1-project-projects.types.js.map +0 -1
  107. package/build/internal/cjs/src/portfolio-projects-v1-project-projects.universal.js +0 -721
  108. package/build/internal/cjs/src/portfolio-projects-v1-project-projects.universal.js.map +0 -1
  109. package/build/internal/es/index.d.ts +0 -1
  110. package/build/internal/es/index.js +0 -2
  111. package/build/internal/es/index.js.map +0 -1
  112. package/build/internal/es/index.typings.d.ts +0 -1
  113. package/build/internal/es/index.typings.js +0 -2
  114. package/build/internal/es/index.typings.js.map +0 -1
  115. package/build/internal/es/meta.d.ts +0 -1
  116. package/build/internal/es/meta.js +0 -2
  117. package/build/internal/es/meta.js.map +0 -1
  118. package/build/internal/es/src/portfolio-projects-v1-project-projects.context.d.ts +0 -29
  119. package/build/internal/es/src/portfolio-projects-v1-project-projects.context.js +0 -29
  120. package/build/internal/es/src/portfolio-projects-v1-project-projects.context.js.map +0 -1
  121. package/build/internal/es/src/portfolio-projects-v1-project-projects.http.d.ts +0 -42
  122. package/build/internal/es/src/portfolio-projects-v1-project-projects.http.js +0 -646
  123. package/build/internal/es/src/portfolio-projects-v1-project-projects.http.js.map +0 -1
  124. package/build/internal/es/src/portfolio-projects-v1-project-projects.meta.d.ts +0 -30
  125. package/build/internal/es/src/portfolio-projects-v1-project-projects.meta.js +0 -167
  126. package/build/internal/es/src/portfolio-projects-v1-project-projects.meta.js.map +0 -1
  127. package/build/internal/es/src/portfolio-projects-v1-project-projects.public.d.ts +0 -98
  128. package/build/internal/es/src/portfolio-projects-v1-project-projects.public.js +0 -156
  129. package/build/internal/es/src/portfolio-projects-v1-project-projects.public.js.map +0 -1
  130. package/build/internal/es/src/portfolio-projects-v1-project-projects.types.d.ts +0 -1321
  131. package/build/internal/es/src/portfolio-projects-v1-project-projects.types.js +0 -140
  132. package/build/internal/es/src/portfolio-projects-v1-project-projects.types.js.map +0 -1
  133. package/build/internal/es/src/portfolio-projects-v1-project-projects.universal.js +0 -686
  134. package/build/internal/es/src/portfolio-projects-v1-project-projects.universal.js.map +0 -1
@@ -1,1321 +0,0 @@
1
- export interface Project extends ProjectCoverOneOf {
2
- /** Project cover image. */
3
- coverImage?: Image;
4
- /** Project cover video. */
5
- coverVideo?: Video;
6
- /**
7
- * Project ID.
8
- * @readonly
9
- * @format GUID
10
- */
11
- id?: string | null;
12
- /**
13
- * Revision number, which increments by 1 each time the project is updated. To prevent conflicting changes, the existing revision must be passed when updating the project object.
14
- * @readonly
15
- */
16
- revision?: string | null;
17
- /**
18
- * Project title.
19
- * @maxLength 100
20
- */
21
- title?: string | null;
22
- /** Project description. */
23
- description?: string | null;
24
- /** Whether the project is hidden from the portfolio. Default: `false` */
25
- hidden?: boolean | null;
26
- /**
27
- * IDs of the collections that include the project.
28
- * @format GUID
29
- * @maxSize 1000
30
- */
31
- collectionIds?: string[];
32
- /** Project details. */
33
- details?: ProjectDetail[];
34
- /** Project slug. */
35
- slug?: string | null;
36
- /**
37
- * Date and time the project was created.
38
- * @readonly
39
- */
40
- createdDate?: Date | null;
41
- /**
42
- * Date and time the project was updated.
43
- * @readonly
44
- */
45
- updatedDate?: Date | null;
46
- /**
47
- * Project page URL and relative path. Returned when `includePageUrl` is `true` in the request.
48
- * @readonly
49
- */
50
- url?: PageUrlV2;
51
- /** Project SEO data. */
52
- seoData?: SeoSchema;
53
- }
54
- /** @oneof */
55
- export interface ProjectCoverOneOf {
56
- /** Project cover image. */
57
- coverImage?: Image;
58
- /** Project cover video. */
59
- coverVideo?: Video;
60
- }
61
- export interface Image {
62
- /** Information about the Wix Media image. */
63
- imageInfo?: CommonImage;
64
- /** Focal point of the image. */
65
- focalPoint?: Point;
66
- }
67
- export declare enum ImageType {
68
- UNDEFINED = "UNDEFINED",
69
- WIX_MEDIA = "WIX_MEDIA",
70
- EXTERNAL = "EXTERNAL"
71
- }
72
- /** @enumType */
73
- export type ImageTypeWithLiterals = ImageType | 'UNDEFINED' | 'WIX_MEDIA' | 'EXTERNAL';
74
- export interface CommonImage {
75
- /** WixMedia image ID. Required. */
76
- id?: string;
77
- /**
78
- * Image URL.
79
- * @readonly
80
- */
81
- url?: string;
82
- /** Original image height. Required. */
83
- height?: number;
84
- /** Original image width. Required. */
85
- width?: number;
86
- /** Image alt text. */
87
- altText?: string | null;
88
- /** Image filename. */
89
- filename?: string | null;
90
- }
91
- export interface Point {
92
- /** X-coordinate of the focal point. */
93
- x?: number;
94
- /** Y-coordinate of the focal point. */
95
- y?: number;
96
- }
97
- export interface UnsharpMasking {
98
- /**
99
- * Unsharp masking amount. Controls the sharpening strength. <br />
100
- *
101
- * Min: `0` <br />
102
- * Max: `5`
103
- * @max 5
104
- */
105
- amount?: number | null;
106
- /** Unsharp masking radius in pixels. Controls the sharpening width. */
107
- radius?: number | null;
108
- /**
109
- * Unsharp masking threshold. Controls how different neighboring pixels must be for shapening to apply. <br />
110
- *
111
- * Min: `0` <br />
112
- * Max: `1`
113
- * @max 1
114
- */
115
- threshold?: number | null;
116
- }
117
- export interface Video {
118
- /** Information about the Wix Media video. */
119
- videoInfo?: VideoV2;
120
- /** Manually defined Video duration in milliseconds. */
121
- durationInMillis?: number | null;
122
- }
123
- export interface VideoV2 {
124
- /** WixMedia ID. Required. */
125
- id?: string;
126
- /** Video URL. */
127
- url?: string;
128
- /**
129
- * Available resolutions for the video, starting with the optimal resolution.
130
- * @maxSize 100
131
- */
132
- resolutions?: VideoResolution[];
133
- /** Video filename. */
134
- filename?: string | null;
135
- /** Video posters. */
136
- posters?: CommonImage[];
137
- }
138
- export interface VideoResolution {
139
- /** Video URL. Required. */
140
- url?: string;
141
- /** Video height. Required. */
142
- height?: number;
143
- /** Video width. Required. */
144
- width?: number;
145
- /** Video format for example, mp4, hls. Required. */
146
- format?: string;
147
- /** Video quality for example 480p, 720p. */
148
- quality?: string | null;
149
- /** Video filename. */
150
- filename?: string | null;
151
- }
152
- /**
153
- * Project label.
154
- * One of:
155
- * + `text`
156
- * + `link`
157
- */
158
- export interface ProjectDetail extends ProjectDetailValueOneOf {
159
- /** Project label in plain text format. */
160
- text?: string;
161
- /** Project label in link format. */
162
- link?: DetailsLink;
163
- /** Project label. */
164
- label?: string;
165
- }
166
- /** @oneof */
167
- export interface ProjectDetailValueOneOf {
168
- /** Project label in plain text format. */
169
- text?: string;
170
- /** Project label in link format. */
171
- link?: DetailsLink;
172
- }
173
- export interface DetailsLink {
174
- /** Display text of the link. */
175
- text?: string | null;
176
- /**
177
- * Target URL of the link.
178
- * @format WEB_URL
179
- */
180
- url?: string | null;
181
- /**
182
- * Whether the link opens in a new tab or window. One of:
183
- * * `'_blank'`: The link opens in a new tab or window.
184
- * * `'_self'`: The link opens in the same tab or window.
185
- */
186
- target?: string | null;
187
- }
188
- export interface ProjectSource {
189
- /**
190
- * App definition id
191
- * @immutable
192
- */
193
- appDefId?: string;
194
- /**
195
- * External source id
196
- * @immutable
197
- */
198
- externalId?: string;
199
- /**
200
- * Source name
201
- * @maxLength 100
202
- * @immutable
203
- */
204
- sourceName?: string;
205
- /**
206
- * Source description
207
- * @immutable
208
- */
209
- description?: string | null;
210
- /**
211
- * link to external source
212
- * @format WEB_URL
213
- */
214
- link?: string | null;
215
- /** Sync status */
216
- syncStatus?: SyncStatusWithLiterals;
217
- /** fields that are synced from external source, should be blocked to update in UI */
218
- notEditableFields?: string[];
219
- /** last date the project was synced */
220
- lastSync?: Date | null;
221
- }
222
- export declare enum SyncStatus {
223
- SYNCED = "SYNCED",
224
- SYNCING = "SYNCING",
225
- NOT_SYNCED = "NOT_SYNCED"
226
- }
227
- /** @enumType */
228
- export type SyncStatusWithLiterals = SyncStatus | 'SYNCED' | 'SYNCING' | 'NOT_SYNCED';
229
- export interface PageUrlV2 {
230
- /** The relative path for the page within the site. For example, `/product-page/a-product`. */
231
- relativePath?: string;
232
- /** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
233
- url?: string | null;
234
- }
235
- /**
236
- * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
237
- * The search engines use this information for ranking purposes, or to display snippets in the search results.
238
- * This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
239
- */
240
- export interface SeoSchema {
241
- /** SEO tag information. */
242
- tags?: Tag[];
243
- /** SEO general settings. */
244
- settings?: Settings;
245
- }
246
- export interface Keyword {
247
- /** Keyword value. */
248
- term?: string;
249
- /** Whether the keyword is the main focus keyword. */
250
- isMain?: boolean;
251
- /**
252
- * The source that added the keyword terms to the SEO settings.
253
- * @maxLength 1000
254
- */
255
- origin?: string | null;
256
- }
257
- export interface Tag {
258
- /**
259
- * SEO tag type.
260
- *
261
- *
262
- * Supported values: `title`, `meta`, `script`, `link`.
263
- */
264
- type?: string;
265
- /**
266
- * A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.
267
- * For example: `{"name": "description", "content": "the description itself"}`.
268
- */
269
- props?: Record<string, any> | null;
270
- /** SEO tag meta data. For example, `{"height": 300, "width": 240}`. */
271
- meta?: Record<string, any> | null;
272
- /** SEO tag inner content. For example, `<title> inner content </title>`. */
273
- children?: string;
274
- /** Whether the tag is a custom tag. */
275
- custom?: boolean;
276
- /** Whether the tag is disabled. */
277
- disabled?: boolean;
278
- }
279
- export interface Settings {
280
- /**
281
- * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
282
- *
283
- *
284
- * Default: `false` (Auto Redirect is enabled.)
285
- */
286
- preventAutoRedirect?: boolean;
287
- /**
288
- * User-selected keyword terms for a specific page.
289
- * @maxSize 5
290
- */
291
- keywords?: Keyword[];
292
- }
293
- export interface MenuSettingUpdatedEvent {
294
- }
295
- export interface GetProjectPageDataRequest {
296
- /** Slug of the project's current collection */
297
- collectionSlug?: string;
298
- /** Project's slug */
299
- projectSlug?: string;
300
- }
301
- export interface GetProjectPageDataResponse {
302
- /** Project data */
303
- project?: Project;
304
- /** Previous project slug */
305
- previousProject?: ProjectSlug;
306
- /** Next project slug */
307
- nextProject?: ProjectSlug;
308
- }
309
- export interface ProjectSlug {
310
- /**
311
- * Project id
312
- * @format GUID
313
- */
314
- projectId?: string;
315
- /** Project slug */
316
- slug?: string;
317
- }
318
- export interface CreateNewPortfolioAppRequest {
319
- }
320
- export interface CreateNewPortfolioAppResponse {
321
- }
322
- export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
323
- /** Emitted on a meta site creation. */
324
- siteCreated?: SiteCreated;
325
- /** Emitted on a meta site transfer completion. */
326
- siteTransferred?: SiteTransferred;
327
- /** Emitted on a meta site deletion. */
328
- siteDeleted?: SiteDeleted;
329
- /** Emitted on a meta site restoration. */
330
- siteUndeleted?: SiteUndeleted;
331
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
332
- sitePublished?: SitePublished;
333
- /** Emitted on a meta site unpublish. */
334
- siteUnpublished?: SiteUnpublished;
335
- /** Emitted when meta site is marked as template. */
336
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
337
- /** Emitted when meta site is marked as a WixSite. */
338
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
339
- /** Emitted when an application is provisioned (installed). */
340
- serviceProvisioned?: ServiceProvisioned;
341
- /** Emitted when an application is removed (uninstalled). */
342
- serviceRemoved?: ServiceRemoved;
343
- /** Emitted when meta site name (URL slug) is changed. */
344
- siteRenamedPayload?: SiteRenamed;
345
- /** Emitted when meta site was permanently deleted. */
346
- hardDeleted?: SiteHardDeleted;
347
- /** Emitted on a namespace change. */
348
- namespaceChanged?: NamespaceChanged;
349
- /** Emitted when Studio is attached. */
350
- studioAssigned?: StudioAssigned;
351
- /** Emitted when Studio is detached. */
352
- studioUnassigned?: StudioUnassigned;
353
- /**
354
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
355
- * the actual URL.
356
- *
357
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
358
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
359
- */
360
- urlChanged?: SiteUrlChanged;
361
- /** Site is marked as PurgedExternally */
362
- sitePurgedExternally?: SitePurgedExternally;
363
- /** Emitted when Odeditor is attached. */
364
- odeditorAssigned?: OdeditorAssigned;
365
- /** Emitted when Odeditor is detached. */
366
- odeditorUnassigned?: OdeditorUnassigned;
367
- /** Emitted when Picasso is attached. */
368
- picassoAssigned?: PicassoAssigned;
369
- /** Emitted when Picasso is detached. */
370
- picassoUnassigned?: PicassoUnassigned;
371
- /**
372
- * A meta site id.
373
- * @format GUID
374
- */
375
- metaSiteId?: string;
376
- /** A meta site version. Monotonically increasing. */
377
- version?: string;
378
- /** A timestamp of the event. */
379
- timestamp?: string;
380
- /**
381
- * TODO(meta-site): Change validation once validations are disabled for consumers
382
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
383
- * @maxSize 4000
384
- */
385
- assets?: Asset[];
386
- }
387
- /** @oneof */
388
- export interface MetaSiteSpecialEventPayloadOneOf {
389
- /** Emitted on a meta site creation. */
390
- siteCreated?: SiteCreated;
391
- /** Emitted on a meta site transfer completion. */
392
- siteTransferred?: SiteTransferred;
393
- /** Emitted on a meta site deletion. */
394
- siteDeleted?: SiteDeleted;
395
- /** Emitted on a meta site restoration. */
396
- siteUndeleted?: SiteUndeleted;
397
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
398
- sitePublished?: SitePublished;
399
- /** Emitted on a meta site unpublish. */
400
- siteUnpublished?: SiteUnpublished;
401
- /** Emitted when meta site is marked as template. */
402
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
403
- /** Emitted when meta site is marked as a WixSite. */
404
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
405
- /** Emitted when an application is provisioned (installed). */
406
- serviceProvisioned?: ServiceProvisioned;
407
- /** Emitted when an application is removed (uninstalled). */
408
- serviceRemoved?: ServiceRemoved;
409
- /** Emitted when meta site name (URL slug) is changed. */
410
- siteRenamedPayload?: SiteRenamed;
411
- /** Emitted when meta site was permanently deleted. */
412
- hardDeleted?: SiteHardDeleted;
413
- /** Emitted on a namespace change. */
414
- namespaceChanged?: NamespaceChanged;
415
- /** Emitted when Studio is attached. */
416
- studioAssigned?: StudioAssigned;
417
- /** Emitted when Studio is detached. */
418
- studioUnassigned?: StudioUnassigned;
419
- /**
420
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
421
- * the actual URL.
422
- *
423
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
424
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
425
- */
426
- urlChanged?: SiteUrlChanged;
427
- /** Site is marked as PurgedExternally */
428
- sitePurgedExternally?: SitePurgedExternally;
429
- /** Emitted when Odeditor is attached. */
430
- odeditorAssigned?: OdeditorAssigned;
431
- /** Emitted when Odeditor is detached. */
432
- odeditorUnassigned?: OdeditorUnassigned;
433
- /** Emitted when Picasso is attached. */
434
- picassoAssigned?: PicassoAssigned;
435
- /** Emitted when Picasso is detached. */
436
- picassoUnassigned?: PicassoUnassigned;
437
- }
438
- export interface Asset {
439
- /**
440
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
441
- * @maxLength 36
442
- */
443
- appDefId?: string;
444
- /**
445
- * An instance id. For legacy reasons may be UUID or a string.
446
- * @maxLength 200
447
- */
448
- instanceId?: string;
449
- /** An application state. */
450
- state?: StateWithLiterals;
451
- }
452
- export declare enum State {
453
- UNKNOWN = "UNKNOWN",
454
- ENABLED = "ENABLED",
455
- DISABLED = "DISABLED",
456
- PENDING = "PENDING",
457
- DEMO = "DEMO"
458
- }
459
- /** @enumType */
460
- export type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
461
- export interface SiteCreated {
462
- /**
463
- * A template identifier (empty if not created from a template).
464
- * @maxLength 36
465
- */
466
- originTemplateId?: string;
467
- /**
468
- * An account id of the owner.
469
- * @format GUID
470
- */
471
- ownerId?: string;
472
- /** A context in which meta site was created. */
473
- context?: SiteCreatedContextWithLiterals;
474
- /**
475
- * A meta site id from which this site was created.
476
- *
477
- * In case of a creation from a template it's a template id.
478
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
479
- * @format GUID
480
- */
481
- originMetaSiteId?: string | null;
482
- /**
483
- * A meta site name (URL slug).
484
- * @maxLength 20
485
- */
486
- siteName?: string;
487
- /** A namespace. */
488
- namespace?: NamespaceWithLiterals;
489
- }
490
- export declare enum SiteCreatedContext {
491
- /** A valid option, we don't expose all reasons why site might be created. */
492
- OTHER = "OTHER",
493
- /** A meta site was created from template. */
494
- FROM_TEMPLATE = "FROM_TEMPLATE",
495
- /** A meta site was created by copying of the transfferred meta site. */
496
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
497
- /** A copy of existing meta site. */
498
- DUPLICATE = "DUPLICATE",
499
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
500
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
501
- /** deprecated A meta site was created for Flash editor. */
502
- FLASH = "FLASH"
503
- }
504
- /** @enumType */
505
- export type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
506
- export declare enum Namespace {
507
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
508
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
509
- WIX = "WIX",
510
- /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
511
- SHOUT_OUT = "SHOUT_OUT",
512
- /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
513
- ALBUMS = "ALBUMS",
514
- /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
515
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
516
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
517
- HOTELS = "HOTELS",
518
- /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
519
- CLUBS = "CLUBS",
520
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
521
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
522
- /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
523
- DEV_SITE = "DEV_SITE",
524
- /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
525
- LOGOS = "LOGOS",
526
- /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
527
- VIDEO_MAKER = "VIDEO_MAKER",
528
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
529
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
530
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
531
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
532
- /**
533
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
534
- *
535
- * Meta site with this namespace will *not* be shown in a user's site list by default.
536
- */
537
- HTML_DRAFT = "HTML_DRAFT",
538
- /**
539
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
540
- * Will be accessible from Site List and will not have a website app.
541
- * Once the user attaches a site, the site will become a regular wixsite.
542
- */
543
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
544
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
545
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
546
- /** It is to be used in the Business First efforts. */
547
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
548
- /** Bookings business flow with no site. */
549
- ANYWHERE = "ANYWHERE",
550
- /** Namespace for Headless Backoffice with no editor */
551
- HEADLESS = "HEADLESS",
552
- /**
553
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
554
- * The site will be used for account level CSM feature for enterprise
555
- */
556
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
557
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
558
- RISE = "RISE",
559
- /**
560
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
561
- * There's a blank site behind the scene but it's blank).
562
- * The Mobile company will be the owner of this namespace.
563
- */
564
- BRANDED_FIRST = "BRANDED_FIRST",
565
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
566
- NOWNIA = "NOWNIA",
567
- /**
568
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
569
- * The Partners company owns this namespace.
570
- */
571
- UGC_TEMPLATE = "UGC_TEMPLATE",
572
- /** Codux Headless Sites */
573
- CODUX = "CODUX",
574
- /** Bobb - AI Design Creator. */
575
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
576
- /**
577
- * Shared Blog Site is a unique single site across Enterprise account,
578
- * This site will hold all Blog posts related to the Marketing product.
579
- */
580
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
581
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
582
- STANDALONE_FORMS = "STANDALONE_FORMS",
583
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
584
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
585
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
586
- MIMIR = "MIMIR"
587
- }
588
- /** @enumType */
589
- export type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR';
590
- /** Site transferred to another user. */
591
- export interface SiteTransferred {
592
- /**
593
- * A previous owner id (user that transfers meta site).
594
- * @format GUID
595
- */
596
- oldOwnerId?: string;
597
- /**
598
- * A new owner id (user that accepts meta site).
599
- * @format GUID
600
- */
601
- newOwnerId?: string;
602
- }
603
- /** Soft deletion of the meta site. Could be restored. */
604
- export interface SiteDeleted {
605
- /** A deletion context. */
606
- deleteContext?: DeleteContext;
607
- }
608
- export interface DeleteContext {
609
- /** When the meta site was deleted. */
610
- dateDeleted?: Date | null;
611
- /** A status. */
612
- deleteStatus?: DeleteStatusWithLiterals;
613
- /**
614
- * A reason (flow).
615
- * @maxLength 255
616
- */
617
- deleteOrigin?: string;
618
- /**
619
- * A service that deleted it.
620
- * @maxLength 255
621
- */
622
- initiatorId?: string | null;
623
- }
624
- export declare enum DeleteStatus {
625
- UNKNOWN = "UNKNOWN",
626
- TRASH = "TRASH",
627
- DELETED = "DELETED",
628
- PENDING_PURGE = "PENDING_PURGE",
629
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
630
- }
631
- /** @enumType */
632
- export type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
633
- /** Restoration of the meta site. */
634
- export interface SiteUndeleted {
635
- }
636
- /** First publish of a meta site. Or subsequent publish after unpublish. */
637
- export interface SitePublished {
638
- }
639
- export interface SiteUnpublished {
640
- /**
641
- * A list of URLs previously associated with the meta site.
642
- * @maxLength 4000
643
- * @maxSize 10000
644
- */
645
- urls?: string[];
646
- }
647
- export interface SiteMarkedAsTemplate {
648
- }
649
- export interface SiteMarkedAsWixSite {
650
- }
651
- /**
652
- * Represents a service provisioned a site.
653
- *
654
- * Note on `origin_instance_id`:
655
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
656
- * This is because of the following scenario:
657
- *
658
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
659
- * such as a product catalog. When you create a site from this template, you inherit this
660
- * default product catalog. However, if the template's product catalog is modified,
661
- * your site will retain the catalog as it was at the time of site creation. This ensures that
662
- * your site remains consistent with what you initially received and does not include any
663
- * changes made to the original template afterward.
664
- * To ensure this, the TPA on the template gets a new instance_id.
665
- */
666
- export interface ServiceProvisioned {
667
- /**
668
- * Either UUID or EmbeddedServiceType.
669
- * @maxLength 36
670
- */
671
- appDefId?: string;
672
- /**
673
- * Not only UUID. Something here could be something weird.
674
- * @maxLength 36
675
- */
676
- instanceId?: string;
677
- /**
678
- * An instance id from which this instance is originated.
679
- * @maxLength 36
680
- */
681
- originInstanceId?: string;
682
- /**
683
- * A version.
684
- * @maxLength 500
685
- */
686
- version?: string | null;
687
- /**
688
- * The origin meta site id
689
- * @format GUID
690
- */
691
- originMetaSiteId?: string | null;
692
- }
693
- export interface ServiceRemoved {
694
- /**
695
- * Either UUID or EmbeddedServiceType.
696
- * @maxLength 36
697
- */
698
- appDefId?: string;
699
- /**
700
- * Not only UUID. Something here could be something weird.
701
- * @maxLength 36
702
- */
703
- instanceId?: string;
704
- /**
705
- * A version.
706
- * @maxLength 500
707
- */
708
- version?: string | null;
709
- }
710
- /** Rename of the site. Meaning, free public url has been changed as well. */
711
- export interface SiteRenamed {
712
- /**
713
- * A new meta site name (URL slug).
714
- * @maxLength 20
715
- */
716
- newSiteName?: string;
717
- /**
718
- * A previous meta site name (URL slug).
719
- * @maxLength 255
720
- */
721
- oldSiteName?: string;
722
- }
723
- /**
724
- * Hard deletion of the meta site.
725
- *
726
- * Could not be restored. Therefore it's desirable to cleanup data.
727
- */
728
- export interface SiteHardDeleted {
729
- /** A deletion context. */
730
- deleteContext?: DeleteContext;
731
- }
732
- export interface NamespaceChanged {
733
- /** A previous namespace. */
734
- oldNamespace?: NamespaceWithLiterals;
735
- /** A new namespace. */
736
- newNamespace?: NamespaceWithLiterals;
737
- }
738
- /** Assigned Studio editor */
739
- export interface StudioAssigned {
740
- }
741
- /** Unassigned Studio editor */
742
- export interface StudioUnassigned {
743
- }
744
- /**
745
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
746
- *
747
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
748
- * with sites and its urls, you need to listen to another topic/event. Read about it:
749
- *
750
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
751
- */
752
- export interface SiteUrlChanged {
753
- }
754
- /**
755
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
756
- * Consumed by other teams to remove relevant data.
757
- */
758
- export interface SitePurgedExternally {
759
- /**
760
- * @maxLength 2048
761
- * @maxSize 100
762
- * @deprecated
763
- * @targetRemovalDate 2025-04-15
764
- */
765
- appDefId?: string[];
766
- }
767
- /** Assigned Odeditor */
768
- export interface OdeditorAssigned {
769
- }
770
- /** Unassigned Odeditor */
771
- export interface OdeditorUnassigned {
772
- }
773
- /** Assigned Picasso editor */
774
- export interface PicassoAssigned {
775
- }
776
- /** Unassigned Picasso */
777
- export interface PicassoUnassigned {
778
- }
779
- export interface Empty {
780
- }
781
- export interface MessageEnvelope {
782
- /**
783
- * App instance ID.
784
- * @format GUID
785
- */
786
- instanceId?: string | null;
787
- /**
788
- * Event type.
789
- * @maxLength 150
790
- */
791
- eventType?: string;
792
- /** The identification type and identity data. */
793
- identity?: IdentificationData;
794
- /** Stringify payload. */
795
- data?: string;
796
- }
797
- export interface IdentificationData extends IdentificationDataIdOneOf {
798
- /**
799
- * ID of a site visitor that has not logged in to the site.
800
- * @format GUID
801
- */
802
- anonymousVisitorId?: string;
803
- /**
804
- * ID of a site visitor that has logged in to the site.
805
- * @format GUID
806
- */
807
- memberId?: string;
808
- /**
809
- * ID of a Wix user (site owner, contributor, etc.).
810
- * @format GUID
811
- */
812
- wixUserId?: string;
813
- /**
814
- * ID of an app.
815
- * @format GUID
816
- */
817
- appId?: string;
818
- /** @readonly */
819
- identityType?: WebhookIdentityTypeWithLiterals;
820
- }
821
- /** @oneof */
822
- export interface IdentificationDataIdOneOf {
823
- /**
824
- * ID of a site visitor that has not logged in to the site.
825
- * @format GUID
826
- */
827
- anonymousVisitorId?: string;
828
- /**
829
- * ID of a site visitor that has logged in to the site.
830
- * @format GUID
831
- */
832
- memberId?: string;
833
- /**
834
- * ID of a Wix user (site owner, contributor, etc.).
835
- * @format GUID
836
- */
837
- wixUserId?: string;
838
- /**
839
- * ID of an app.
840
- * @format GUID
841
- */
842
- appId?: string;
843
- }
844
- export declare enum WebhookIdentityType {
845
- UNKNOWN = "UNKNOWN",
846
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
847
- MEMBER = "MEMBER",
848
- WIX_USER = "WIX_USER",
849
- APP = "APP"
850
- }
851
- /** @enumType */
852
- export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
853
- export interface InvalidateCache extends InvalidateCacheGetByOneOf {
854
- /**
855
- * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
856
- * @format GUID
857
- */
858
- metaSiteId?: string;
859
- /**
860
- * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
861
- * @format GUID
862
- */
863
- siteId?: string;
864
- /** Invalidate by App */
865
- app?: App;
866
- /** Invalidate by page id */
867
- page?: Page;
868
- /** Invalidate by URI path */
869
- uri?: URI;
870
- /** Invalidate by file (for media files such as PDFs) */
871
- file?: File;
872
- /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
873
- customTag?: CustomTag;
874
- /**
875
- * tell us why you're invalidating the cache. You don't need to add your app name
876
- * @maxLength 256
877
- */
878
- reason?: string | null;
879
- /** Is local DS */
880
- localDc?: boolean;
881
- hardPurge?: boolean;
882
- }
883
- /** @oneof */
884
- export interface InvalidateCacheGetByOneOf {
885
- /**
886
- * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
887
- * @format GUID
888
- */
889
- metaSiteId?: string;
890
- /**
891
- * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
892
- * @format GUID
893
- */
894
- siteId?: string;
895
- /** Invalidate by App */
896
- app?: App;
897
- /** Invalidate by page id */
898
- page?: Page;
899
- /** Invalidate by URI path */
900
- uri?: URI;
901
- /** Invalidate by file (for media files such as PDFs) */
902
- file?: File;
903
- /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
904
- customTag?: CustomTag;
905
- }
906
- export interface App {
907
- /**
908
- * The AppDefId
909
- * @minLength 1
910
- */
911
- appDefId?: string;
912
- /**
913
- * The instance Id
914
- * @format GUID
915
- */
916
- instanceId?: string;
917
- }
918
- export interface Page {
919
- /**
920
- * the msid the page is on
921
- * @format GUID
922
- */
923
- metaSiteId?: string;
924
- /**
925
- * Invalidate by Page ID
926
- * @minLength 1
927
- */
928
- pageId?: string;
929
- }
930
- export interface URI {
931
- /**
932
- * the msid the URI is on
933
- * @format GUID
934
- */
935
- metaSiteId?: string;
936
- /**
937
- * URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
938
- * @minLength 1
939
- */
940
- uriPath?: string;
941
- }
942
- export interface File {
943
- /**
944
- * the msid the file is related to
945
- * @format GUID
946
- */
947
- metaSiteId?: string;
948
- /**
949
- * Invalidate by filename (for media files such as PDFs)
950
- * @minLength 1
951
- * @maxLength 256
952
- */
953
- fileName?: string;
954
- }
955
- export interface CustomTag {
956
- /**
957
- * the msid the tag is related to
958
- * @format GUID
959
- */
960
- metaSiteId?: string;
961
- /**
962
- * Tag to invalidate by
963
- * @minLength 1
964
- * @maxLength 256
965
- */
966
- tag?: string;
967
- }
968
- export interface SyncProjectWithCollectionMappings {
969
- /**
970
- * Id of recently updated Project
971
- * @format GUID
972
- */
973
- projectId?: string;
974
- /**
975
- * fields that were updated in the given project
976
- * @maxSize 100
977
- */
978
- fieldMaskPaths?: string[];
979
- }
980
- export interface DeletedProjectRestored {
981
- /**
982
- * the id of the project that was restored
983
- * @format GUID
984
- */
985
- projectId?: string;
986
- /** timestamp for when the project was originally deleted. */
987
- deletionTimestamp?: Date | null;
988
- }
989
- export interface CreateProjectRequest {
990
- /** Project to create. */
991
- project: Project;
992
- }
993
- export interface CreateProjectResponse {
994
- /** Created project. */
995
- project?: Project;
996
- }
997
- export interface GetProjectRequest {
998
- /**
999
- * ID of the project to retrieve.
1000
- * @format GUID
1001
- */
1002
- projectId: string;
1003
- /** Whether to include the project's relative path and full URL in the response. Default: `false` */
1004
- includePageUrl?: boolean | null;
1005
- }
1006
- export interface GetProjectResponse {
1007
- /** The requested project. */
1008
- project?: Project;
1009
- }
1010
- export interface ListProjectsRequest {
1011
- /** Projects limit per response is maximum 100, In the first request the cursor is None ? */
1012
- paging?: CursorPaging;
1013
- /** Whether to include the project's relative path and full URL in the response. Default: `false` */
1014
- includePageUrl?: boolean | null;
1015
- }
1016
- export interface CursorPaging {
1017
- /**
1018
- * Maximum number of items to return in the results.
1019
- * @max 100
1020
- */
1021
- limit?: number | null;
1022
- /**
1023
- * Pointer to the next or previous page in the list of results.
1024
- *
1025
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
1026
- * Not relevant for the first request.
1027
- * @maxLength 16000
1028
- */
1029
- cursor?: string | null;
1030
- }
1031
- export interface ListProjectsResponse {
1032
- /** List of projects. */
1033
- projects?: Project[];
1034
- /** Paging metadata. */
1035
- metadata?: PagingMetadataV2;
1036
- }
1037
- export interface PagingMetadataV2 {
1038
- /** Number of items returned in the response. */
1039
- count?: number | null;
1040
- /** Offset that was requested. */
1041
- offset?: number | null;
1042
- /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
1043
- total?: number | null;
1044
- /** Flag that indicates the server failed to calculate the `total` field. */
1045
- tooManyToCount?: boolean | null;
1046
- /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
1047
- cursors?: Cursors;
1048
- }
1049
- export interface Cursors {
1050
- /**
1051
- * Cursor string pointing to the next page in the list of results.
1052
- * @maxLength 16000
1053
- */
1054
- next?: string | null;
1055
- /**
1056
- * Cursor pointing to the previous page in the list of results.
1057
- * @maxLength 16000
1058
- */
1059
- prev?: string | null;
1060
- }
1061
- export interface UpdateProjectRequest {
1062
- /** Project to update. */
1063
- project: Project;
1064
- }
1065
- export interface UpdateProjectResponse {
1066
- /** Updated project. */
1067
- project?: Project;
1068
- }
1069
- export interface BulkUpdateProjectsRequest {
1070
- /**
1071
- * Projects to update.
1072
- * @maxSize 100
1073
- */
1074
- projects?: MaskedProject[];
1075
- /** Whether to include the updated projects in the response. Set to `true` to receive the projects in the response. Default: `false` */
1076
- returnFullEntity?: boolean | null;
1077
- }
1078
- export interface MaskedProject {
1079
- /** Project to update. */
1080
- project?: Project;
1081
- }
1082
- export interface BulkUpdateProjectsResponse {
1083
- /** Items created by bulk action. */
1084
- results?: BulkUpdateProjectsResult[];
1085
- /** Bulk action metadata. */
1086
- bulkActionMetadata?: BulkActionMetadata;
1087
- }
1088
- export interface BulkUpdateProjectsResult {
1089
- /** Item metadata. */
1090
- itemMetadata?: ItemMetadata;
1091
- /** Updated project. */
1092
- project?: Project;
1093
- }
1094
- export interface ItemMetadata {
1095
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
1096
- id?: string | null;
1097
- /** Index of the item within the request array. Allows for correlation between request and response items. */
1098
- originalIndex?: number;
1099
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
1100
- success?: boolean;
1101
- /** Details about the error in case of failure. */
1102
- error?: ApplicationError;
1103
- }
1104
- export interface ApplicationError {
1105
- /** Error code. */
1106
- code?: string;
1107
- /** Description of the error. */
1108
- description?: string;
1109
- /** Data related to the error. */
1110
- data?: Record<string, any> | null;
1111
- }
1112
- export interface BulkActionMetadata {
1113
- /** Number of items that were successfully processed. */
1114
- totalSuccesses?: number;
1115
- /** Number of items that couldn't be processed. */
1116
- totalFailures?: number;
1117
- /** Number of failures without details because detailed failure threshold was exceeded. */
1118
- undetailedFailures?: number;
1119
- }
1120
- export interface DeleteProjectRequest {
1121
- /**
1122
- * ID of the project to delete.
1123
- * @format GUID
1124
- */
1125
- projectId: string;
1126
- }
1127
- export interface DeleteProjectResponse {
1128
- /**
1129
- * ID of the deleted project.
1130
- * @format GUID
1131
- */
1132
- projectId?: string;
1133
- }
1134
- export interface QueryProjectsRequest {
1135
- /** Query options. */
1136
- query: QueryV2;
1137
- /** Whether to include the project's relative path and full URL in the response. Default: `false` */
1138
- includePageUrl?: boolean | null;
1139
- }
1140
- export interface QueryV2 extends QueryV2PagingMethodOneOf {
1141
- /** Paging options to limit and skip the number of items. */
1142
- paging?: Paging;
1143
- /** 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`. */
1144
- cursorPaging?: CursorPaging;
1145
- /**
1146
- * Filter object.
1147
- *
1148
- * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
1149
- */
1150
- filter?: Record<string, any> | null;
1151
- /**
1152
- * Sort object.
1153
- *
1154
- * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
1155
- */
1156
- sort?: Sorting[];
1157
- /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
1158
- fields?: string[];
1159
- /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
1160
- fieldsets?: string[];
1161
- }
1162
- /** @oneof */
1163
- export interface QueryV2PagingMethodOneOf {
1164
- /** Paging options to limit and skip the number of items. */
1165
- paging?: Paging;
1166
- /** 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`. */
1167
- cursorPaging?: CursorPaging;
1168
- }
1169
- export interface Sorting {
1170
- /**
1171
- * Name of the field to sort by.
1172
- * @maxLength 512
1173
- */
1174
- fieldName?: string;
1175
- /** Sort order. */
1176
- order?: SortOrderWithLiterals;
1177
- }
1178
- export declare enum SortOrder {
1179
- ASC = "ASC",
1180
- DESC = "DESC"
1181
- }
1182
- /** @enumType */
1183
- export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
1184
- export interface Paging {
1185
- /** Number of items to load. */
1186
- limit?: number | null;
1187
- /** Number of items to skip in the current sort order. */
1188
- offset?: number | null;
1189
- }
1190
- export interface QueryProjectsResponse {
1191
- /** List of projects. */
1192
- projects?: Project[];
1193
- /** Paging metadata. */
1194
- metadata?: PagingMetadataV2;
1195
- }
1196
- export interface UpdateProjectOrderInCollectionRequest {
1197
- /**
1198
- * ID of the project to update.
1199
- * @format GUID
1200
- */
1201
- projectId: string;
1202
- /**
1203
- * Collection ID.
1204
- * @format GUID
1205
- */
1206
- collectionId: string;
1207
- /** Index that determines the placement of a project within the collection. */
1208
- sortOrder: number | null;
1209
- }
1210
- export interface UpdateProjectOrderInCollectionResponse {
1211
- /** Updated project placement within the specified collection. */
1212
- projectInCollection?: ProjectsInCollections;
1213
- }
1214
- export interface ProjectsInCollections {
1215
- /**
1216
- * Collection ID.
1217
- * @format GUID
1218
- */
1219
- collectionId?: string;
1220
- /** Project object. */
1221
- project?: Project;
1222
- /**
1223
- * Index that determines the placement of a project within the collection. <br />
1224
- *
1225
- * Default: [Epoch](https://www.epoch101.com/) timestamp. <br />
1226
- */
1227
- sortOrder?: number | null;
1228
- /**
1229
- * Project placement ID.
1230
- * @readonly
1231
- * @format GUID
1232
- */
1233
- id?: string | null;
1234
- }
1235
- export interface QueryProjectWithCollectionInfoRequest {
1236
- /** WQL expression */
1237
- query: QueryV2;
1238
- /** Include page url */
1239
- includePageUrl?: boolean | null;
1240
- }
1241
- export interface QueryProjectWithCollectionInfoResponse {
1242
- /** The retrieved Projects in Collection */
1243
- projects?: ProjectsInCollections[];
1244
- /** Paging metadata */
1245
- metadata?: PagingMetadataV2;
1246
- }
1247
- export interface RestoreProjectFromTrashBinRequest {
1248
- /**
1249
- * id of deleted project to restore from trash bin.
1250
- * @format GUID
1251
- */
1252
- projectId?: string;
1253
- }
1254
- export interface RestoreProjectFromTrashBinResponse {
1255
- /** project that was restored from trash bin */
1256
- project?: Project;
1257
- }
1258
- export interface DomainEvent extends DomainEventBodyOneOf {
1259
- createdEvent?: EntityCreatedEvent;
1260
- updatedEvent?: EntityUpdatedEvent;
1261
- deletedEvent?: EntityDeletedEvent;
1262
- actionEvent?: ActionEvent;
1263
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
1264
- id?: string;
1265
- /**
1266
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
1267
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
1268
- */
1269
- entityFqdn?: string;
1270
- /**
1271
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
1272
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
1273
- */
1274
- slug?: string;
1275
- /** ID of the entity associated with the event. */
1276
- entityId?: string;
1277
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
1278
- eventTime?: Date | null;
1279
- /**
1280
- * Whether the event was triggered as a result of a privacy regulation application
1281
- * (for example, GDPR).
1282
- */
1283
- triggeredByAnonymizeRequest?: boolean | null;
1284
- /** If present, indicates the action that triggered the event. */
1285
- originatedFrom?: string | null;
1286
- /**
1287
- * 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.
1288
- * 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.
1289
- */
1290
- entityEventSequence?: string | null;
1291
- }
1292
- /** @oneof */
1293
- export interface DomainEventBodyOneOf {
1294
- createdEvent?: EntityCreatedEvent;
1295
- updatedEvent?: EntityUpdatedEvent;
1296
- deletedEvent?: EntityDeletedEvent;
1297
- actionEvent?: ActionEvent;
1298
- }
1299
- export interface EntityCreatedEvent {
1300
- entityAsJson?: string;
1301
- /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
1302
- restoreInfo?: RestoreInfo;
1303
- }
1304
- export interface RestoreInfo {
1305
- deletedDate?: Date | null;
1306
- }
1307
- export interface EntityUpdatedEvent {
1308
- /**
1309
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1310
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1311
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1312
- */
1313
- currentEntityAsJson?: string;
1314
- }
1315
- export interface EntityDeletedEvent {
1316
- /** Entity that was deleted. */
1317
- deletedEntityAsJson?: string | null;
1318
- }
1319
- export interface ActionEvent {
1320
- bodyAsJson?: string;
1321
- }