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