@wix/auto_sdk_portfolio_synced-project 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-syncedprojects-v1-synced-project-synced-project.context.d.ts +9 -0
  11. package/build/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.context.js +18 -0
  12. package/build/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.context.js.map +1 -0
  13. package/build/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.http.d.ts +11 -0
  14. package/build/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.http.js +142 -0
  15. package/build/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.http.js.map +1 -0
  16. package/build/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.meta.d.ts +28 -0
  17. package/build/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.meta.js +123 -0
  18. package/build/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.meta.js.map +1 -0
  19. package/build/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.public.d.ts +43 -0
  20. package/build/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.public.js +43 -0
  21. package/build/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.public.js.map +1 -0
  22. package/build/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.types.d.ts +650 -0
  23. package/build/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.types.js +130 -0
  24. package/build/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.types.js.map +1 -0
  25. package/build/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.universal.d.ts +738 -0
  26. package/build/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.universal.js +350 -0
  27. package/build/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.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-syncedprojects-v1-synced-project-synced-project.context.d.ts +9 -0
  39. package/build/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.context.js +9 -0
  40. package/build/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.context.js.map +1 -0
  41. package/build/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.http.d.ts +11 -0
  42. package/build/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.http.js +134 -0
  43. package/build/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.http.js.map +1 -0
  44. package/build/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.meta.d.ts +28 -0
  45. package/build/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.meta.js +92 -0
  46. package/build/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.meta.js.map +1 -0
  47. package/build/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.public.d.ts +43 -0
  48. package/build/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.public.js +29 -0
  49. package/build/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.public.js.map +1 -0
  50. package/build/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.types.d.ts +650 -0
  51. package/build/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.types.js +127 -0
  52. package/build/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.types.js.map +1 -0
  53. package/build/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.universal.d.ts +738 -0
  54. package/build/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.universal.js +319 -0
  55. package/build/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.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-syncedprojects-v1-synced-project-synced-project.context.d.ts +9 -0
  66. package/build/internal/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.context.js +18 -0
  67. package/build/internal/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.context.js.map +1 -0
  68. package/build/internal/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.http.d.ts +11 -0
  69. package/build/internal/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.http.js +142 -0
  70. package/build/internal/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.http.js.map +1 -0
  71. package/build/internal/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.meta.d.ts +28 -0
  72. package/build/internal/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.meta.js +123 -0
  73. package/build/internal/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.meta.js.map +1 -0
  74. package/build/internal/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.public.d.ts +43 -0
  75. package/build/internal/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.public.js +43 -0
  76. package/build/internal/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.public.js.map +1 -0
  77. package/build/internal/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.types.d.ts +650 -0
  78. package/build/internal/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.types.js +130 -0
  79. package/build/internal/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.types.js.map +1 -0
  80. package/build/internal/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.universal.d.ts +738 -0
  81. package/build/internal/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.universal.js +350 -0
  82. package/build/internal/cjs/src/portfolio-syncedprojects-v1-synced-project-synced-project.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-syncedprojects-v1-synced-project-synced-project.context.d.ts +9 -0
  93. package/build/internal/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.context.js +9 -0
  94. package/build/internal/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.context.js.map +1 -0
  95. package/build/internal/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.http.d.ts +11 -0
  96. package/build/internal/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.http.js +134 -0
  97. package/build/internal/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.http.js.map +1 -0
  98. package/build/internal/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.meta.d.ts +28 -0
  99. package/build/internal/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.meta.js +92 -0
  100. package/build/internal/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.meta.js.map +1 -0
  101. package/build/internal/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.public.d.ts +43 -0
  102. package/build/internal/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.public.js +29 -0
  103. package/build/internal/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.public.js.map +1 -0
  104. package/build/internal/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.types.d.ts +650 -0
  105. package/build/internal/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.types.js +127 -0
  106. package/build/internal/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.types.js.map +1 -0
  107. package/build/internal/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.universal.d.ts +738 -0
  108. package/build/internal/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.universal.js +319 -0
  109. package/build/internal/es/src/portfolio-syncedprojects-v1-synced-project-synced-project.universal.js.map +1 -0
  110. package/meta/package.json +3 -0
  111. package/package.json +52 -0
@@ -0,0 +1,738 @@
1
+ export interface SyncedProject {
2
+ /** Project ID in Portfolio - if project was yet to be create, will be None */
3
+ portfolioProjectId?: string | null;
4
+ /** External Project ID */
5
+ externalId?: string;
6
+ /** Project name */
7
+ title?: string | null;
8
+ /** Project media count */
9
+ mediaCount?: number;
10
+ /** Project image url */
11
+ coverImage?: string | null;
12
+ /** Project url in external */
13
+ link?: string | null;
14
+ /**
15
+ * Represents the last time project was synced - returned only if external project is synced
16
+ * @readonly
17
+ */
18
+ lastSynced?: Date | null;
19
+ /** External Project synced status */
20
+ status?: SyncStatus;
21
+ }
22
+ export declare enum SyncStatus {
23
+ /** Project was not synced */
24
+ NOT_SYNCED = "NOT_SYNCED",
25
+ /** Project is in pending state */
26
+ PENDING = "PENDING",
27
+ /** Project is in syncing state */
28
+ SYNCING = "SYNCING",
29
+ /** Project was synced */
30
+ SYNCED = "SYNCED"
31
+ }
32
+ export interface SyncingProjectEvent {
33
+ /** Provider appDefId */
34
+ appDefId?: string;
35
+ /** External Project ID */
36
+ externalProjectId?: string;
37
+ /** Portfolio Project ID */
38
+ portfolioProjectId?: string;
39
+ /** When the first event was produced, and started syncing */
40
+ firstProduceTimestamp?: Date | null;
41
+ /** Project Revision */
42
+ projectSyncRevision?: Date | null;
43
+ }
44
+ export interface SyncProjectPagingEvent {
45
+ /** Provider appDefId */
46
+ appDefId?: string;
47
+ /** External Project ID */
48
+ externalProjectId?: string;
49
+ /** Portfolio Project ID */
50
+ portfolioProjectId?: string;
51
+ /** Next page cursor */
52
+ nextPageCursor?: string | null;
53
+ /** Project Revision */
54
+ projectSyncRevision?: Date | null;
55
+ }
56
+ export interface SyncSiteEvent {
57
+ /** Portfolio instance id */
58
+ instanceId?: string;
59
+ /** Paging */
60
+ paging?: CursorPaging;
61
+ }
62
+ export interface CursorPaging {
63
+ /** Maximum number of items to return in the results. */
64
+ limit?: number | null;
65
+ /**
66
+ * Pointer to the next or previous page in the list of results.
67
+ *
68
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
69
+ * Not relevant for the first request.
70
+ */
71
+ cursor?: string | null;
72
+ }
73
+ export interface SyncProjectRequest {
74
+ /** Provider appDefId */
75
+ appDefId: string;
76
+ /** External Project ID */
77
+ externalId: string;
78
+ }
79
+ export interface GetProjectsRequest {
80
+ /** Provider appDefId */
81
+ appDefId: string;
82
+ /** Paging */
83
+ paging?: CursorPaging;
84
+ }
85
+ export interface GetProjectsResponse {
86
+ /** Provider appDefId */
87
+ projects?: SyncedProject[];
88
+ /** Paging metadata */
89
+ metadata?: PagingMetadataV2;
90
+ }
91
+ export interface PagingMetadataV2 {
92
+ /** Number of items returned in the response. */
93
+ count?: number | null;
94
+ /** Offset that was requested. */
95
+ offset?: number | null;
96
+ /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
97
+ total?: number | null;
98
+ /** Flag that indicates the server failed to calculate the `total` field. */
99
+ tooManyToCount?: boolean | null;
100
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
101
+ cursors?: Cursors;
102
+ }
103
+ export interface Cursors {
104
+ /** Cursor string pointing to the next page in the list of results. */
105
+ next?: string | null;
106
+ /** Cursor pointing to the previous page in the list of results. */
107
+ prev?: string | null;
108
+ }
109
+ export interface SyncProjectResponse {
110
+ /** Portfolio project */
111
+ project?: SyncedProject;
112
+ }
113
+ export interface GetSyncStatusRequest {
114
+ /** Provider appDefId */
115
+ appDefId: string;
116
+ /** External Project ID */
117
+ externalId: string;
118
+ }
119
+ export interface GetSyncStatusResponse {
120
+ /** Provider appDefId */
121
+ appDefId?: string;
122
+ /** External Project ID */
123
+ externalId?: string;
124
+ /** Synced status */
125
+ status?: SyncStatus;
126
+ }
127
+ export interface StopSyncRequest {
128
+ /** Provider appDefId */
129
+ appDefId: string;
130
+ /** External Project ID */
131
+ externalId: string;
132
+ }
133
+ export interface StopSyncResponse {
134
+ /** Provider appDefId */
135
+ appDefId?: string;
136
+ /** External Project ID */
137
+ externalId?: string;
138
+ }
139
+ export interface GetLoginRedirectableUrlRequest {
140
+ /** Provider appDefId */
141
+ appDefId: string;
142
+ }
143
+ export interface GetLoginRedirectableUrlResponse {
144
+ /** Provider appDefId */
145
+ appDefId?: string;
146
+ /** Login url */
147
+ url?: string;
148
+ }
149
+ export interface DomainEvent extends DomainEventBodyOneOf {
150
+ createdEvent?: EntityCreatedEvent;
151
+ updatedEvent?: EntityUpdatedEvent;
152
+ deletedEvent?: EntityDeletedEvent;
153
+ actionEvent?: ActionEvent;
154
+ /**
155
+ * Unique event ID.
156
+ * Allows clients to ignore duplicate webhooks.
157
+ */
158
+ _id?: string;
159
+ /**
160
+ * Assumes actions are also always typed to an entity_type
161
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
162
+ */
163
+ entityFqdn?: string;
164
+ /**
165
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
166
+ * This is although the created/updated/deleted notion is duplication of the oneof types
167
+ * Example: created/updated/deleted/started/completed/email_opened
168
+ */
169
+ slug?: string;
170
+ /** ID of the entity associated with the event. */
171
+ entityId?: string;
172
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
173
+ eventTime?: Date | null;
174
+ /**
175
+ * Whether the event was triggered as a result of a privacy regulation application
176
+ * (for example, GDPR).
177
+ */
178
+ triggeredByAnonymizeRequest?: boolean | null;
179
+ /** If present, indicates the action that triggered the event. */
180
+ originatedFrom?: string | null;
181
+ /**
182
+ * A sequence number defining the order of updates to the underlying entity.
183
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
184
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
185
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
186
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
187
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
188
+ */
189
+ entityEventSequence?: string | null;
190
+ }
191
+ /** @oneof */
192
+ export interface DomainEventBodyOneOf {
193
+ createdEvent?: EntityCreatedEvent;
194
+ updatedEvent?: EntityUpdatedEvent;
195
+ deletedEvent?: EntityDeletedEvent;
196
+ actionEvent?: ActionEvent;
197
+ }
198
+ export interface EntityCreatedEvent {
199
+ entity?: string;
200
+ }
201
+ export interface RestoreInfo {
202
+ deletedDate?: Date | null;
203
+ }
204
+ export interface EntityUpdatedEvent {
205
+ /**
206
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
207
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
208
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
209
+ */
210
+ currentEntity?: string;
211
+ }
212
+ export interface EntityDeletedEvent {
213
+ /** Entity that was deleted */
214
+ deletedEntity?: string | null;
215
+ }
216
+ export interface ActionEvent {
217
+ body?: string;
218
+ }
219
+ export interface Empty {
220
+ }
221
+ export interface ItemCreatedMediaCallbackRequest {
222
+ appDefId?: string;
223
+ /** External Project ID */
224
+ projectExternalId?: string;
225
+ /** External Project ID */
226
+ itemExternalId?: string;
227
+ fileName?: string | null;
228
+ mediaType?: string | null;
229
+ opStatus?: string | null;
230
+ fileSize?: number | null;
231
+ width?: number | null;
232
+ height?: number | null;
233
+ fileOutput?: MediaFileOutput;
234
+ siteId?: string | null;
235
+ }
236
+ export interface MediaFileOutput {
237
+ video?: MediaVideoOutput[];
238
+ image?: MediaImageOutput[];
239
+ }
240
+ export interface MediaVideoOutput {
241
+ key?: string | null;
242
+ status?: string | null;
243
+ url?: string | null;
244
+ quality?: string | null;
245
+ duration?: number | null;
246
+ width?: number | null;
247
+ height?: number | null;
248
+ format?: string | null;
249
+ }
250
+ export interface MediaImageOutput {
251
+ key?: string | null;
252
+ status?: string | null;
253
+ url?: string | null;
254
+ width?: number | null;
255
+ height?: number | null;
256
+ format?: string | null;
257
+ }
258
+ export interface ItemCreatedMediaCallbackResponse {
259
+ }
260
+ export interface ProjectCoverImageCreatedMediaCallbackRequest {
261
+ appDefId?: string;
262
+ /** External Project ID */
263
+ projectExternalId?: string;
264
+ fileName?: string | null;
265
+ mediaType?: string | null;
266
+ opStatus?: string | null;
267
+ fileSize?: number | null;
268
+ width?: number | null;
269
+ height?: number | null;
270
+ fileOutput?: MediaFileOutput;
271
+ siteId?: string | null;
272
+ }
273
+ export interface ProjectCoverImageCreatedMediaCallbackResponse {
274
+ }
275
+ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
276
+ /** Emitted on a meta site creation. */
277
+ siteCreated?: SiteCreated;
278
+ /** Emitted on a meta site transfer completion. */
279
+ siteTransferred?: SiteTransferred;
280
+ /** Emitted on a meta site deletion. */
281
+ siteDeleted?: SiteDeleted;
282
+ /** Emitted on a meta site restoration. */
283
+ siteUndeleted?: SiteUndeleted;
284
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
285
+ sitePublished?: SitePublished;
286
+ /** Emitted on a meta site unpublish. */
287
+ siteUnpublished?: SiteUnpublished;
288
+ /** Emitted when meta site is marked as template. */
289
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
290
+ /** Emitted when meta site is marked as a WixSite. */
291
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
292
+ /** Emitted when an application is provisioned (installed). */
293
+ serviceProvisioned?: ServiceProvisioned;
294
+ /** Emitted when an application is removed (uninstalled). */
295
+ serviceRemoved?: ServiceRemoved;
296
+ /** Emitted when meta site name (URL slug) is changed. */
297
+ siteRenamedPayload?: SiteRenamed;
298
+ /** Emitted when meta site was permanently deleted. */
299
+ hardDeleted?: SiteHardDeleted;
300
+ /** Emitted on a namespace change. */
301
+ namespaceChanged?: NamespaceChanged;
302
+ /** Emitted when Studio is attached. */
303
+ studioAssigned?: StudioAssigned;
304
+ /** Emitted when Studio is detached. */
305
+ studioUnassigned?: StudioUnassigned;
306
+ /** A meta site id. */
307
+ metaSiteId?: string;
308
+ /** A meta site version. Monotonically increasing. */
309
+ version?: string;
310
+ /** A timestamp of the event. */
311
+ timestamp?: string;
312
+ /**
313
+ * TODO(meta-site): Change validation once validations are disabled for consumers
314
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
315
+ */
316
+ assets?: Asset[];
317
+ }
318
+ /** @oneof */
319
+ export interface MetaSiteSpecialEventPayloadOneOf {
320
+ /** Emitted on a meta site creation. */
321
+ siteCreated?: SiteCreated;
322
+ /** Emitted on a meta site transfer completion. */
323
+ siteTransferred?: SiteTransferred;
324
+ /** Emitted on a meta site deletion. */
325
+ siteDeleted?: SiteDeleted;
326
+ /** Emitted on a meta site restoration. */
327
+ siteUndeleted?: SiteUndeleted;
328
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
329
+ sitePublished?: SitePublished;
330
+ /** Emitted on a meta site unpublish. */
331
+ siteUnpublished?: SiteUnpublished;
332
+ /** Emitted when meta site is marked as template. */
333
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
334
+ /** Emitted when meta site is marked as a WixSite. */
335
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
336
+ /** Emitted when an application is provisioned (installed). */
337
+ serviceProvisioned?: ServiceProvisioned;
338
+ /** Emitted when an application is removed (uninstalled). */
339
+ serviceRemoved?: ServiceRemoved;
340
+ /** Emitted when meta site name (URL slug) is changed. */
341
+ siteRenamedPayload?: SiteRenamed;
342
+ /** Emitted when meta site was permanently deleted. */
343
+ hardDeleted?: SiteHardDeleted;
344
+ /** Emitted on a namespace change. */
345
+ namespaceChanged?: NamespaceChanged;
346
+ /** Emitted when Studio is attached. */
347
+ studioAssigned?: StudioAssigned;
348
+ /** Emitted when Studio is detached. */
349
+ studioUnassigned?: StudioUnassigned;
350
+ }
351
+ export interface Asset {
352
+ /** An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum). */
353
+ appDefId?: string;
354
+ /** An instance id. For legacy reasons may be UUID or a string. */
355
+ instanceId?: string;
356
+ /** An application state. */
357
+ state?: State;
358
+ }
359
+ export declare enum State {
360
+ UNKNOWN = "UNKNOWN",
361
+ ENABLED = "ENABLED",
362
+ DISABLED = "DISABLED",
363
+ PENDING = "PENDING",
364
+ DEMO = "DEMO"
365
+ }
366
+ export interface SiteCreated {
367
+ /** A template identifier (empty if not created from a template). */
368
+ originTemplateId?: string;
369
+ /** An account id of the owner. */
370
+ ownerId?: string;
371
+ /** A context in which meta site was created. */
372
+ context?: SiteCreatedContext;
373
+ /**
374
+ * A meta site id from which this site was created.
375
+ *
376
+ * In case of a creation from a template it's a template id.
377
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
378
+ */
379
+ originMetaSiteId?: string | null;
380
+ /** A meta site name (URL slug). */
381
+ siteName?: string;
382
+ /** A namespace. */
383
+ namespace?: Namespace;
384
+ }
385
+ export declare enum SiteCreatedContext {
386
+ /** A valid option, we don't expose all reasons why site might be created. */
387
+ OTHER = "OTHER",
388
+ /** A meta site was created from template. */
389
+ FROM_TEMPLATE = "FROM_TEMPLATE",
390
+ /** A meta site was created by copying of the transfferred meta site. */
391
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
392
+ /** A copy of existing meta site. */
393
+ DUPLICATE = "DUPLICATE",
394
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
395
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
396
+ /** deprecated A meta site was created for Flash editor. */
397
+ FLASH = "FLASH"
398
+ }
399
+ export declare enum Namespace {
400
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
401
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
402
+ WIX = "WIX",
403
+ /** 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. */
404
+ SHOUT_OUT = "SHOUT_OUT",
405
+ /** 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. */
406
+ ALBUMS = "ALBUMS",
407
+ /** 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. */
408
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
409
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
410
+ HOTELS = "HOTELS",
411
+ /** 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. */
412
+ CLUBS = "CLUBS",
413
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
414
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
415
+ /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
416
+ DEV_SITE = "DEV_SITE",
417
+ /** 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. */
418
+ LOGOS = "LOGOS",
419
+ /** 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. */
420
+ VIDEO_MAKER = "VIDEO_MAKER",
421
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
422
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
423
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
424
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
425
+ /**
426
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
427
+ *
428
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
429
+ */
430
+ HTML_DRAFT = "HTML_DRAFT",
431
+ /**
432
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
433
+ * Will be accessible from Site List and will not have a website app.
434
+ * Once the user attaches a site, the site will become a regular wixsite.
435
+ */
436
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
437
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
438
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
439
+ /** It is to be used in the Business First efforts. */
440
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
441
+ /** Bookings business flow with no site. */
442
+ ANYWHERE = "ANYWHERE",
443
+ /** Namespace for Headless Backoffice with no editor */
444
+ HEADLESS = "HEADLESS",
445
+ /**
446
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
447
+ * The site will be used for account level CSM feature for enterprise
448
+ */
449
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
450
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
451
+ RISE = "RISE",
452
+ /**
453
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
454
+ * There's a blank site behind the scene but it's blank).
455
+ * The Mobile company will be the owner of this namespace.
456
+ */
457
+ BRANDED_FIRST = "BRANDED_FIRST",
458
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
459
+ NOWNIA = "NOWNIA",
460
+ /**
461
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
462
+ * The Partners company owns this namespace.
463
+ */
464
+ UGC_TEMPLATE = "UGC_TEMPLATE",
465
+ /** Codux Headless Sites */
466
+ CODUX = "CODUX",
467
+ /** Bobb - AI Design Creator. */
468
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
469
+ /**
470
+ * Shared Blog Site is a unique single site across Enterprise account,
471
+ * This site will hold all Blog posts related to the Marketing product.
472
+ */
473
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE"
474
+ }
475
+ /** Site transferred to another user. */
476
+ export interface SiteTransferred {
477
+ /** A previous owner id (user that transfers meta site). */
478
+ oldOwnerId?: string;
479
+ /** A new owner id (user that accepts meta site). */
480
+ newOwnerId?: string;
481
+ }
482
+ /** Soft deletion of the meta site. Could be restored. */
483
+ export interface SiteDeleted {
484
+ /** A deletion context. */
485
+ deleteContext?: DeleteContext;
486
+ }
487
+ export interface DeleteContext {
488
+ /** When the meta site was deleted. */
489
+ dateDeleted?: Date | null;
490
+ /** A status. */
491
+ deleteStatus?: DeleteStatus;
492
+ /** A reason (flow). */
493
+ deleteOrigin?: string;
494
+ /** A service that deleted it. */
495
+ initiatorId?: string | null;
496
+ }
497
+ export declare enum DeleteStatus {
498
+ UNKNOWN = "UNKNOWN",
499
+ TRASH = "TRASH",
500
+ DELETED = "DELETED",
501
+ PENDING_PURGE = "PENDING_PURGE"
502
+ }
503
+ /** Restoration of the meta site. */
504
+ export interface SiteUndeleted {
505
+ }
506
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
507
+ export interface SitePublished {
508
+ }
509
+ export interface SiteUnpublished {
510
+ /** A list of URLs previously associated with the meta site. */
511
+ urls?: string[];
512
+ }
513
+ export interface SiteMarkedAsTemplate {
514
+ }
515
+ export interface SiteMarkedAsWixSite {
516
+ }
517
+ /**
518
+ * Represents a service provisioned a site.
519
+ *
520
+ * Note on `origin_instance_id`:
521
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
522
+ * This is because of the following scenario:
523
+ *
524
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
525
+ * such as a product catalog. When you create a site from this template, you inherit this
526
+ * default product catalog. However, if the template's product catalog is modified,
527
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
528
+ * your site remains consistent with what you initially received and does not include any
529
+ * changes made to the original template afterward.
530
+ * To ensure this, the TPA on the template gets a new instance_id.
531
+ */
532
+ export interface ServiceProvisioned {
533
+ /** Either UUID or EmbeddedServiceType. */
534
+ appDefId?: string;
535
+ /** Not only UUID. Something here could be something weird. */
536
+ instanceId?: string;
537
+ /** An instance id from which this instance is originated. */
538
+ originInstanceId?: string;
539
+ /** A version. */
540
+ version?: string | null;
541
+ /** The origin meta site id */
542
+ originMetaSiteId?: string | null;
543
+ }
544
+ export interface ServiceRemoved {
545
+ /** Either UUID or EmbeddedServiceType. */
546
+ appDefId?: string;
547
+ /** Not only UUID. Something here could be something weird. */
548
+ instanceId?: string;
549
+ /** A version. */
550
+ version?: string | null;
551
+ }
552
+ /** Rename of the site. Meaning, free public url has been changed as well. */
553
+ export interface SiteRenamed {
554
+ /** A new meta site name (URL slug). */
555
+ newSiteName?: string;
556
+ /** A previous meta site name (URL slug). */
557
+ oldSiteName?: string;
558
+ }
559
+ /**
560
+ * Hard deletion of the meta site.
561
+ *
562
+ * Could not be restored. Therefore it's desirable to cleanup data.
563
+ */
564
+ export interface SiteHardDeleted {
565
+ /** A deletion context. */
566
+ deleteContext?: DeleteContext;
567
+ }
568
+ export interface NamespaceChanged {
569
+ /** A previous namespace. */
570
+ oldNamespace?: Namespace;
571
+ /** A new namespace. */
572
+ newNamespace?: Namespace;
573
+ }
574
+ /** Assigned Studio editor */
575
+ export interface StudioAssigned {
576
+ }
577
+ /** Unassigned Studio editor */
578
+ export interface StudioUnassigned {
579
+ }
580
+ export interface SyncAllSitesEvent {
581
+ /** Paging */
582
+ paging?: CursorPaging;
583
+ }
584
+ export interface MessageEnvelope {
585
+ /** App instance ID. */
586
+ instanceId?: string | null;
587
+ /** Event type. */
588
+ eventType?: string;
589
+ /** The identification type and identity data. */
590
+ identity?: IdentificationData;
591
+ /** Stringify payload. */
592
+ data?: string;
593
+ }
594
+ export interface IdentificationData extends IdentificationDataIdOneOf {
595
+ /** ID of a site visitor that has not logged in to the site. */
596
+ anonymousVisitorId?: string;
597
+ /** ID of a site visitor that has logged in to the site. */
598
+ memberId?: string;
599
+ /** ID of a Wix user (site owner, contributor, etc.). */
600
+ wixUserId?: string;
601
+ /** ID of an app. */
602
+ appId?: string;
603
+ /** @readonly */
604
+ identityType?: WebhookIdentityType;
605
+ }
606
+ /** @oneof */
607
+ export interface IdentificationDataIdOneOf {
608
+ /** ID of a site visitor that has not logged in to the site. */
609
+ anonymousVisitorId?: string;
610
+ /** ID of a site visitor that has logged in to the site. */
611
+ memberId?: string;
612
+ /** ID of a Wix user (site owner, contributor, etc.). */
613
+ wixUserId?: string;
614
+ /** ID of an app. */
615
+ appId?: string;
616
+ }
617
+ export declare enum WebhookIdentityType {
618
+ UNKNOWN = "UNKNOWN",
619
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
620
+ MEMBER = "MEMBER",
621
+ WIX_USER = "WIX_USER",
622
+ APP = "APP"
623
+ }
624
+ interface SyncedProjectNonNullableFields {
625
+ externalId: string;
626
+ mediaCount: number;
627
+ status: SyncStatus;
628
+ }
629
+ export interface GetProjectsResponseNonNullableFields {
630
+ projects: SyncedProjectNonNullableFields[];
631
+ }
632
+ export interface SyncProjectResponseNonNullableFields {
633
+ project?: SyncedProjectNonNullableFields;
634
+ }
635
+ export interface GetSyncStatusResponseNonNullableFields {
636
+ appDefId: string;
637
+ externalId: string;
638
+ status: SyncStatus;
639
+ }
640
+ export interface StopSyncResponseNonNullableFields {
641
+ appDefId: string;
642
+ externalId: string;
643
+ }
644
+ export interface GetLoginRedirectableUrlResponseNonNullableFields {
645
+ appDefId: string;
646
+ url: string;
647
+ }
648
+ /**
649
+ * Get projects per app
650
+ * @param appDefId - Provider appDefId
651
+ * @public
652
+ * @documentationMaturity preview
653
+ * @requiredField appDefId
654
+ * @permissionId PORTFOLIO.SYNCED_PROJECTS_READ
655
+ * @permissionScope Manage Portfolio
656
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
657
+ * @applicableIdentity APP
658
+ * @fqn com.wixpress.portfolio.syncedprojects.spi_host.v1.SyncedProjectsService.GetProjects
659
+ */
660
+ export declare function getProjects(appDefId: string, options?: GetProjectsOptions): Promise<GetProjectsResponse & GetProjectsResponseNonNullableFields>;
661
+ export interface GetProjectsOptions {
662
+ /** Paging */
663
+ paging?: CursorPaging;
664
+ }
665
+ /**
666
+ * Async Sync project
667
+ * @public
668
+ * @documentationMaturity preview
669
+ * @requiredField identifiers
670
+ * @requiredField identifiers.appDefId
671
+ * @requiredField identifiers.externalId
672
+ * @permissionId PORTFOLIO.SYNCED_PROJECTS_SYNC
673
+ * @permissionScope Manage Portfolio
674
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
675
+ * @applicableIdentity APP
676
+ * @fqn com.wixpress.portfolio.syncedprojects.spi_host.v1.SyncedProjectsService.SyncProject
677
+ */
678
+ export declare function syncProject(identifiers: SyncProjectIdentifiers): Promise<SyncProjectResponse & SyncProjectResponseNonNullableFields>;
679
+ export interface SyncProjectIdentifiers {
680
+ /** Provider appDefId */
681
+ appDefId: string;
682
+ /** External Project ID */
683
+ externalId: string;
684
+ }
685
+ /**
686
+ * Get sync status (when was last synced and etc..)
687
+ * @public
688
+ * @documentationMaturity preview
689
+ * @requiredField identifiers
690
+ * @requiredField identifiers.appDefId
691
+ * @requiredField identifiers.externalId
692
+ * @permissionId PORTFOLIO.SYNCED_PROJECTS_READ
693
+ * @permissionScope Manage Portfolio
694
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
695
+ * @applicableIdentity APP
696
+ * @fqn com.wixpress.portfolio.syncedprojects.spi_host.v1.SyncedProjectsService.GetSyncStatus
697
+ */
698
+ export declare function getSyncStatus(identifiers: GetSyncStatusIdentifiers): Promise<GetSyncStatusResponse & GetSyncStatusResponseNonNullableFields>;
699
+ export interface GetSyncStatusIdentifiers {
700
+ /** Provider appDefId */
701
+ appDefId: string;
702
+ /** External Project ID */
703
+ externalId: string;
704
+ }
705
+ /**
706
+ * Stop sync project
707
+ * @public
708
+ * @documentationMaturity preview
709
+ * @requiredField identifiers
710
+ * @requiredField identifiers.appDefId
711
+ * @requiredField identifiers.externalId
712
+ * @permissionId PORTFOLIO.SYNCED_PROJECTS_STOP_SYNC
713
+ * @permissionScope Manage Portfolio
714
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
715
+ * @applicableIdentity APP
716
+ * @fqn com.wixpress.portfolio.syncedprojects.spi_host.v1.SyncedProjectsService.StopSync
717
+ */
718
+ export declare function stopSync(identifiers: StopSyncIdentifiers): Promise<StopSyncResponse & StopSyncResponseNonNullableFields>;
719
+ export interface StopSyncIdentifiers {
720
+ /** Provider appDefId */
721
+ appDefId: string;
722
+ /** External Project ID */
723
+ externalId: string;
724
+ }
725
+ /**
726
+ * Get login redirectable url
727
+ * @param appDefId - Provider appDefId
728
+ * @public
729
+ * @documentationMaturity preview
730
+ * @requiredField appDefId
731
+ * @permissionId PORTFOLIO.SYNCED_PROJECTS_READ
732
+ * @permissionScope Manage Portfolio
733
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
734
+ * @applicableIdentity APP
735
+ * @fqn com.wixpress.portfolio.syncedprojects.spi_host.v1.SyncedProjectsService.GetLoginRedirectableUrl
736
+ */
737
+ export declare function getLoginRedirectableUrl(appDefId: string): Promise<GetLoginRedirectableUrlResponse & GetLoginRedirectableUrlResponseNonNullableFields>;
738
+ export {};