@wix/auto_sdk_containers_plans 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.
@@ -0,0 +1,726 @@
1
+ import { CreatePlanRequest as CreatePlanRequest$1, CreatePlanResponse as CreatePlanResponse$1, CreateAndGeneratePlanRequest as CreateAndGeneratePlanRequest$1, CreateAndGeneratePlanResponse as CreateAndGeneratePlanResponse$1, GetPlanRequest as GetPlanRequest$1, GetPlanResponse as GetPlanResponse$1, GetPlanByProjectIdRequest as GetPlanByProjectIdRequest$1, GetPlanByProjectIdResponse as GetPlanByProjectIdResponse$1, UpdatePlanRequest as UpdatePlanRequest$1, UpdatePlanResponse as UpdatePlanResponse$1, DeletePlanRequest as DeletePlanRequest$1, DeletePlanResponse as DeletePlanResponse$1, GeneratePlanRequest as GeneratePlanRequest$1, GeneratePlanResponse as GeneratePlanResponse$1, ModifyPlanRequest as ModifyPlanRequest$1, ModifyPlanResponse as ModifyPlanResponse$1, RegenerateIconRequest as RegenerateIconRequest$1, RegenerateIconResponse as RegenerateIconResponse$1, FinalizePlanRequest as FinalizePlanRequest$1, FinalizePlanResponse as FinalizePlanResponse$1 } from './index.typings.js';
2
+ import '@wix/sdk-types';
3
+
4
+ interface Plan {
5
+ /**
6
+ * Plan ID.
7
+ * @format GUID
8
+ * @readonly
9
+ */
10
+ id?: string | null;
11
+ /**
12
+ * Revision number, which increments by 1 each time the Plan is updated.
13
+ * @readonly
14
+ */
15
+ revision?: string | null;
16
+ /**
17
+ * Date and time the Plan was created.
18
+ * @readonly
19
+ */
20
+ createdDate?: Date | null;
21
+ /**
22
+ * Date and time the Plan was last updated.
23
+ * @readonly
24
+ */
25
+ updatedDate?: Date | null;
26
+ /**
27
+ * The user's initial free-text prompt that started the plan.
28
+ * @maxLength 10000
29
+ */
30
+ initialPrompt?: string;
31
+ /** Generation platform for the app. */
32
+ platform?: PlatformWithLiterals;
33
+ /** Lifecycle status of the Plan. */
34
+ status?: PlanStatusWithLiterals;
35
+ /**
36
+ * Template chosen for generation. A Code Store `containers-templates` catalog GUID, or (for
37
+ * HIMALAYA_MOBILE) a himi starter template name (e.g. "branded-lite") that does not resolve to
38
+ * a catalog entry — see `PlansService.resolveTemplate`/`validateTemplatePlatform`, which treat a
39
+ * non-GUID value as an opaque template name rather than a catalog reference.
40
+ * @maxLength 200
41
+ */
42
+ selectedTemplateId?: string | null;
43
+ /**
44
+ * The project this plan belongs to. Supplied by the client at creation.
45
+ * @format GUID
46
+ */
47
+ projectId?: string | null;
48
+ /**
49
+ * Facts extracted from the existing business/site. Derived server-side and read-only to clients.
50
+ * @readonly
51
+ */
52
+ businessContext?: BusinessContext;
53
+ /** Visual identity extracted from the user's website. A starting point the user can edit. */
54
+ brandIdentity?: BrandIdentity;
55
+ /** The specification of the app to generate, produced from the plan prompt. */
56
+ appSpec?: AppSpec;
57
+ }
58
+ declare enum Platform {
59
+ /**
60
+ * Himalaya Mobile (Wix SDUI/OTA content package): mobile apps built headlessly on the
61
+ * on-demand remote machine via the himi CLI, instead of native iOS/Android pods.
62
+ */
63
+ HIMALAYA_MOBILE = "HIMALAYA_MOBILE"
64
+ }
65
+ /** @enumType */
66
+ type PlatformWithLiterals = Platform | 'HIMALAYA_MOBILE';
67
+ declare enum PlanStatus {
68
+ /** Plan is being assembled by the planning agent and the user. */
69
+ DRAFT = "DRAFT",
70
+ /** Plan is complete and approved; ready for the generation pipeline. */
71
+ FINALIZED = "FINALIZED"
72
+ }
73
+ /** @enumType */
74
+ type PlanStatusWithLiterals = PlanStatus | 'DRAFT' | 'FINALIZED';
75
+ /**
76
+ * Facts the server extracts about the existing business/site. The client reads these
77
+ * to inform the app spec, but does not write them.
78
+ */
79
+ interface BusinessContext {
80
+ /**
81
+ * Business name as configured on the site.
82
+ * @maxLength 200
83
+ */
84
+ businessName?: string;
85
+ /**
86
+ * Business logo image URL, extracted from the site (empty if it has none). Used as a reference
87
+ * image when generating the app icon (see AppSpec.app_icon_url).
88
+ * @maxLength 2000
89
+ */
90
+ businessLogoUrl?: string;
91
+ /**
92
+ * Business description as configured on the site.
93
+ * @maxLength 5000
94
+ */
95
+ businessDescription?: string;
96
+ /**
97
+ * Primary language code of the site (for example "en").
98
+ * @maxLength 20
99
+ */
100
+ language?: string;
101
+ /**
102
+ * Country code of the site (for example "IE").
103
+ * @maxLength 20
104
+ */
105
+ country?: string;
106
+ /**
107
+ * App definition IDs of Wix apps installed on the site (for example Bookings, eCommerce).
108
+ * @maxSize 100
109
+ * @maxLength 200
110
+ */
111
+ wixIntegrations?: string[];
112
+ }
113
+ /**
114
+ * Visual identity extracted from the user's existing website. Serves as an editable
115
+ * starting point for the generated app.
116
+ */
117
+ interface BrandIdentity {
118
+ /**
119
+ * Primary brand color.
120
+ * @maxLength 100
121
+ */
122
+ primaryColor?: string;
123
+ /**
124
+ * Background color.
125
+ * @maxLength 100
126
+ */
127
+ backgroundColor?: string;
128
+ /**
129
+ * Content (foreground) color.
130
+ * @maxLength 100
131
+ */
132
+ contentColor?: string;
133
+ /**
134
+ * Heading typography / font.
135
+ * @maxLength 100
136
+ */
137
+ headingFont?: string;
138
+ /**
139
+ * Body typography / font.
140
+ * @maxLength 100
141
+ */
142
+ bodyFont?: string;
143
+ }
144
+ /**
145
+ * The specification of the app to generate, produced from the plan prompt and confirmed
146
+ * by the user.
147
+ */
148
+ interface AppSpec {
149
+ /**
150
+ * Display name of the app to generate.
151
+ * @maxLength 200
152
+ */
153
+ appName?: string;
154
+ /**
155
+ * Description of the app to generate.
156
+ * @maxLength 5000
157
+ */
158
+ appDescription?: string;
159
+ /**
160
+ * The business goal the app should serve.
161
+ * @maxLength 2000
162
+ */
163
+ businessGoal?: string;
164
+ /**
165
+ * The target audience for the app.
166
+ * @maxLength 2000
167
+ */
168
+ audience?: string;
169
+ /**
170
+ * Wix integrations to include, each with a display name, description, and capability tags.
171
+ * @maxSize 100
172
+ */
173
+ wixIntegrations?: Integration[];
174
+ /**
175
+ * Third-party integrations to include, each with a display name, description, and capability tags.
176
+ * @maxSize 100
177
+ */
178
+ thirdPartyIntegrations?: Integration[];
179
+ /**
180
+ * Features the app should provide, each with a title and description.
181
+ * @maxSize 200
182
+ */
183
+ features?: Feature[];
184
+ /**
185
+ * Navigation screens for the app.
186
+ * @maxSize 100
187
+ * @maxLength 200
188
+ */
189
+ navigation?: string[];
190
+ /**
191
+ * Icon URL for the app to generate. Seeded at plan creation from the business's real logo, or
192
+ * a best-effort generated placeholder if it has none. The client can replace it later with a
193
+ * RegenerateIcon result they've accepted, via UpdatePlan.
194
+ * @format WEB_URL
195
+ * @maxLength 2000
196
+ */
197
+ appIconUrl?: string;
198
+ }
199
+ /**
200
+ * An integration (Wix or third-party) the generated app should include, produced by the
201
+ * planning agent from the prompt.
202
+ */
203
+ interface Integration {
204
+ /**
205
+ * Display name, for example "Wix Stores".
206
+ * @maxLength 200
207
+ */
208
+ displayName?: string;
209
+ /**
210
+ * What the integration provides / why it is included.
211
+ * @maxLength 2000
212
+ */
213
+ description?: string;
214
+ /**
215
+ * Sub-capabilities the integration includes, rendered as tags (for example "Storefront",
216
+ * "Cart & Checkout").
217
+ * @maxSize 50
218
+ * @maxLength 100
219
+ */
220
+ tags?: string[];
221
+ /**
222
+ * Stable integration id / slug (for example "wix-stores"). For Wix integrations this is chosen
223
+ * by the planning agent from the server-provided catalog of supported Wix integrations; empty
224
+ * for free-form third-party integrations. The client keys the integration's icon off this id.
225
+ * @maxLength 200
226
+ */
227
+ id?: string;
228
+ }
229
+ /** A capability the app should provide, produced by the planning agent from the prompt. */
230
+ interface Feature {
231
+ /**
232
+ * Short feature title.
233
+ * @maxLength 200
234
+ */
235
+ title?: string;
236
+ /**
237
+ * What the feature does, shown under the title.
238
+ * @maxLength 2000
239
+ */
240
+ description?: string;
241
+ }
242
+ interface PlanFinalized {
243
+ /**
244
+ * ID of the Plan that was finalized.
245
+ * @format GUID
246
+ */
247
+ planId?: string;
248
+ /**
249
+ * ID of the Project this plan belongs to. containers-projects reads the finalized plan back by
250
+ * this id (one plan per project) when creating the initial generation job.
251
+ * @format GUID
252
+ */
253
+ projectId?: string;
254
+ /**
255
+ * ID of the conversation that led to this plan being finalized.
256
+ * @format GUID
257
+ */
258
+ conversationId?: string;
259
+ }
260
+ interface CreatePlanRequest {
261
+ /** Plan to be created. */
262
+ plan: Plan;
263
+ }
264
+ interface CreatePlanResponse {
265
+ /** The created Plan. */
266
+ plan?: Plan;
267
+ }
268
+ interface CreateAndGeneratePlanRequest {
269
+ /** Plan to be created and generated. */
270
+ plan: Plan;
271
+ }
272
+ interface CreateAndGeneratePlanResponse {
273
+ /** The generated Plan. */
274
+ plan?: Plan;
275
+ /**
276
+ * Follow-up questions from the planning agent to further build the plan.
277
+ * @maxSize 50
278
+ * @maxLength 4000
279
+ */
280
+ followUpQuestions?: string[];
281
+ /**
282
+ * Structured follow-up questions with selectable answer options. Superseding follow_up_questions;
283
+ * that field is kept and populated in parallel for callers that have not migrated to this one.
284
+ * @maxSize 4
285
+ */
286
+ followUpQuestionOptions?: FollowUpQuestion[];
287
+ }
288
+ /** A follow-up question paired with selectable answer options, shown as quick-reply choices. */
289
+ interface FollowUpQuestion {
290
+ /**
291
+ * The question text.
292
+ * @maxLength 4000
293
+ */
294
+ question?: string;
295
+ /**
296
+ * Selectable answer options for this question.
297
+ * @maxSize 10
298
+ * @maxLength 200
299
+ */
300
+ options?: string[];
301
+ }
302
+ interface GetPlanRequest {
303
+ /**
304
+ * ID of the Plan to retrieve.
305
+ * @format GUID
306
+ */
307
+ planId: string;
308
+ }
309
+ interface GetPlanResponse {
310
+ /** The requested Plan. */
311
+ plan?: Plan;
312
+ }
313
+ interface GetPlanByProjectIdRequest {
314
+ /**
315
+ * ID of the project whose Plan to retrieve.
316
+ * @format GUID
317
+ */
318
+ projectId: string;
319
+ }
320
+ interface GetPlanByProjectIdResponse {
321
+ /** The project's Plan. */
322
+ plan?: Plan;
323
+ }
324
+ interface UpdatePlanRequest {
325
+ /** Plan to be updated, may be partial. */
326
+ plan: Plan;
327
+ /**
328
+ * Set of fields to update. Fields not in the mask are ignored.
329
+ * @internal
330
+ */
331
+ fieldMask?: string[];
332
+ }
333
+ interface UpdatePlanResponse {
334
+ /** The updated Plan. */
335
+ plan?: Plan;
336
+ }
337
+ interface DeletePlanRequest {
338
+ /**
339
+ * ID of the Plan to delete.
340
+ * @format GUID
341
+ */
342
+ planId: string;
343
+ }
344
+ interface DeletePlanResponse {
345
+ }
346
+ interface GeneratePlanRequest {
347
+ /**
348
+ * ID of the Plan to generate.
349
+ * @format GUID
350
+ */
351
+ planId: string;
352
+ }
353
+ interface GeneratePlanResponse {
354
+ /** The generated Plan. */
355
+ plan?: Plan;
356
+ /**
357
+ * Follow-up questions from the planning agent to further build the plan.
358
+ * @maxSize 50
359
+ * @maxLength 4000
360
+ */
361
+ followUpQuestions?: string[];
362
+ /**
363
+ * Structured follow-up questions with selectable answer options. Superseding follow_up_questions;
364
+ * that field is kept and populated in parallel for callers that have not migrated to this one.
365
+ * @maxSize 4
366
+ */
367
+ followUpQuestionOptions?: FollowUpQuestion[];
368
+ }
369
+ interface ModifyPlanRequest {
370
+ /**
371
+ * ID of the Plan to modify.
372
+ * @format GUID
373
+ */
374
+ planId: string;
375
+ /**
376
+ * The user's answers to the previous iteration's follow-up questions.
377
+ * @maxSize 50
378
+ */
379
+ answeredQuestions?: AnsweredQuestion[];
380
+ /**
381
+ * Optional additional request from the user to further shape the plan.
382
+ * @maxLength 10000
383
+ */
384
+ userPrompt?: string | null;
385
+ /**
386
+ * Optional selected plan part. When present, only this boundary may change.
387
+ * When absent, ModifyPlan keeps its existing whole-plan behavior.
388
+ */
389
+ planEditContext?: PlanEditContext;
390
+ }
391
+ /** A follow-up question from a previous iteration paired with the user's answer. */
392
+ interface AnsweredQuestion {
393
+ /**
394
+ * The follow-up question that was asked.
395
+ * @maxLength 4000
396
+ */
397
+ question?: string;
398
+ /**
399
+ * The user's answer to the question.
400
+ * @maxLength 10000
401
+ */
402
+ answer?: string;
403
+ }
404
+ /**
405
+ * Identifies one editable part of a plan. Optional on chat and plan-edit requests; when absent,
406
+ * plan editing keeps its existing whole-plan behavior.
407
+ */
408
+ interface PlanEditContext {
409
+ /** Kind of plan part selected by the user. */
410
+ type?: PlanPartTypeWithLiterals;
411
+ /**
412
+ * Zero-based item index. Set only for repeated parts such as features, screens, or integrations.
413
+ * @max 199
414
+ */
415
+ index?: number | null;
416
+ /**
417
+ * Plan revision shown when the user selected the part. Used to reject stale edits.
418
+ * @min 1
419
+ */
420
+ planRevision?: string | null;
421
+ }
422
+ declare enum PlanPartType {
423
+ APP_NAME = "APP_NAME",
424
+ APP_DESCRIPTION = "APP_DESCRIPTION",
425
+ BUSINESS_GOAL = "BUSINESS_GOAL",
426
+ AUDIENCE = "AUDIENCE",
427
+ FEATURE = "FEATURE",
428
+ SCREEN = "SCREEN",
429
+ WIX_INTEGRATION = "WIX_INTEGRATION",
430
+ THIRD_PARTY_INTEGRATION = "THIRD_PARTY_INTEGRATION",
431
+ BRAND_IDENTITY = "BRAND_IDENTITY",
432
+ /** Color fields within brand_identity; fonts are preserved by the service. */
433
+ COLOR_THEME = "COLOR_THEME",
434
+ /** Font fields within brand_identity; colors are preserved by the service. */
435
+ TEXT_THEME = "TEXT_THEME"
436
+ }
437
+ /** @enumType */
438
+ type PlanPartTypeWithLiterals = PlanPartType | 'APP_NAME' | 'APP_DESCRIPTION' | 'BUSINESS_GOAL' | 'AUDIENCE' | 'FEATURE' | 'SCREEN' | 'WIX_INTEGRATION' | 'THIRD_PARTY_INTEGRATION' | 'BRAND_IDENTITY' | 'COLOR_THEME' | 'TEXT_THEME';
439
+ interface ModifyPlanResponse {
440
+ /** The modified Plan. */
441
+ plan?: Plan;
442
+ /**
443
+ * Follow-up questions the agent wants to ask to further refine the plan.
444
+ * @maxSize 50
445
+ * @maxLength 4000
446
+ */
447
+ followUpQuestions?: string[];
448
+ /**
449
+ * Structured follow-up questions with selectable answer options. Superseding follow_up_questions;
450
+ * that field is kept and populated in parallel for callers that have not migrated to this one.
451
+ * @maxSize 4
452
+ */
453
+ followUpQuestionOptions?: FollowUpQuestion[];
454
+ }
455
+ interface RegenerateIconRequest {
456
+ /**
457
+ * ID of the Plan whose icon to regenerate.
458
+ * @format GUID
459
+ */
460
+ planId: string;
461
+ /**
462
+ * Free-text description of the desired icon, passed to the icon-generation prompt.
463
+ * @maxLength 4000
464
+ */
465
+ prompt: string;
466
+ }
467
+ interface RegenerateIconResponse {
468
+ /**
469
+ * The generated icon URL. Not persisted — apply via UpdatePlan (app_spec.app_icon_url).
470
+ * @maxLength 2000
471
+ */
472
+ iconUrl?: string;
473
+ }
474
+ interface FinalizePlanRequest {
475
+ /**
476
+ * ID of the Plan to finalize. Its project_id and selected_template_id (set at creation)
477
+ * are used to drive generation.
478
+ * @format GUID
479
+ */
480
+ planId: string;
481
+ /**
482
+ * ID of the conversation that led to this plan being finalized.
483
+ * @format GUID
484
+ */
485
+ conversationId: string;
486
+ }
487
+ interface FinalizePlanResponse {
488
+ /** The finalized Plan. */
489
+ plan?: Plan;
490
+ }
491
+ interface DomainEvent extends DomainEventBodyOneOf {
492
+ createdEvent?: EntityCreatedEvent;
493
+ updatedEvent?: EntityUpdatedEvent;
494
+ deletedEvent?: EntityDeletedEvent;
495
+ actionEvent?: ActionEvent;
496
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
497
+ id?: string;
498
+ /**
499
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
500
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
501
+ */
502
+ entityFqdn?: string;
503
+ /**
504
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
505
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
506
+ */
507
+ slug?: string;
508
+ /** ID of the entity associated with the event. */
509
+ entityId?: string;
510
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
511
+ eventTime?: Date | null;
512
+ /**
513
+ * Whether the event was triggered as a result of a privacy regulation application
514
+ * (for example, GDPR).
515
+ */
516
+ triggeredByAnonymizeRequest?: boolean | null;
517
+ /** If present, indicates the action that triggered the event. */
518
+ originatedFrom?: string | null;
519
+ /**
520
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
521
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
522
+ */
523
+ entityEventSequence?: string | null;
524
+ }
525
+ /** @oneof */
526
+ interface DomainEventBodyOneOf {
527
+ createdEvent?: EntityCreatedEvent;
528
+ updatedEvent?: EntityUpdatedEvent;
529
+ deletedEvent?: EntityDeletedEvent;
530
+ actionEvent?: ActionEvent;
531
+ }
532
+ interface EntityCreatedEvent {
533
+ entityAsJson?: string;
534
+ /**
535
+ * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
536
+ * @internal
537
+ */
538
+ triggeredByUndelete?: boolean | null;
539
+ /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
540
+ restoreInfo?: RestoreInfo;
541
+ /**
542
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
543
+ * @internal
544
+ */
545
+ additionalMetadataAsJson?: string | null;
546
+ }
547
+ interface RestoreInfo {
548
+ deletedDate?: Date | null;
549
+ }
550
+ interface EntityUpdatedEvent {
551
+ /**
552
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
553
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
554
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
555
+ */
556
+ currentEntityAsJson?: string;
557
+ /**
558
+ * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
559
+ * wont populate it / have any reference to it in the API.
560
+ * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
561
+ * the developer should send only the new (current) entity.
562
+ * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
563
+ * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
564
+ * @internal
565
+ * @deprecated
566
+ */
567
+ previousEntityAsJson?: string | null;
568
+ /**
569
+ * Map of fully qualified field paths to their previous values for fields that changed.
570
+ * For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format)
571
+ * @internal
572
+ */
573
+ modifiedFields?: Record<string, any>;
574
+ /**
575
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
576
+ * @internal
577
+ */
578
+ additionalMetadataAsJson?: string | null;
579
+ }
580
+ interface EntityDeletedEvent {
581
+ /**
582
+ * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
583
+ * @internal
584
+ */
585
+ movedToTrash?: boolean | null;
586
+ /** Entity that was deleted. */
587
+ deletedEntityAsJson?: string | null;
588
+ /**
589
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
590
+ * @internal
591
+ */
592
+ additionalMetadataAsJson?: string | null;
593
+ }
594
+ interface ActionEvent {
595
+ bodyAsJson?: string;
596
+ }
597
+ interface MessageEnvelope {
598
+ /**
599
+ * App instance ID.
600
+ * @format GUID
601
+ */
602
+ instanceId?: string | null;
603
+ /**
604
+ * Event type.
605
+ * @maxLength 150
606
+ */
607
+ eventType?: string;
608
+ /** The identification type and identity data. */
609
+ identity?: IdentificationData;
610
+ /** Stringify payload. */
611
+ data?: string;
612
+ /** Details related to the account */
613
+ accountInfo?: AccountInfo;
614
+ }
615
+ interface IdentificationData extends IdentificationDataIdOneOf {
616
+ /**
617
+ * ID of a site visitor that has not logged in to the site.
618
+ * @format GUID
619
+ */
620
+ anonymousVisitorId?: string;
621
+ /**
622
+ * ID of a site visitor that has logged in to the site.
623
+ * @format GUID
624
+ */
625
+ memberId?: string;
626
+ /**
627
+ * ID of a Wix user (site owner, contributor, etc.).
628
+ * @format GUID
629
+ */
630
+ wixUserId?: string;
631
+ /**
632
+ * ID of an app.
633
+ * @format GUID
634
+ */
635
+ appId?: string;
636
+ /** @readonly */
637
+ identityType?: WebhookIdentityTypeWithLiterals;
638
+ }
639
+ /** @oneof */
640
+ interface IdentificationDataIdOneOf {
641
+ /**
642
+ * ID of a site visitor that has not logged in to the site.
643
+ * @format GUID
644
+ */
645
+ anonymousVisitorId?: string;
646
+ /**
647
+ * ID of a site visitor that has logged in to the site.
648
+ * @format GUID
649
+ */
650
+ memberId?: string;
651
+ /**
652
+ * ID of a Wix user (site owner, contributor, etc.).
653
+ * @format GUID
654
+ */
655
+ wixUserId?: string;
656
+ /**
657
+ * ID of an app.
658
+ * @format GUID
659
+ */
660
+ appId?: string;
661
+ }
662
+ declare enum WebhookIdentityType {
663
+ UNKNOWN = "UNKNOWN",
664
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
665
+ MEMBER = "MEMBER",
666
+ WIX_USER = "WIX_USER",
667
+ APP = "APP"
668
+ }
669
+ /** @enumType */
670
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
671
+ interface AccountInfo {
672
+ /**
673
+ * ID of the Wix account associated with the event.
674
+ * @format GUID
675
+ */
676
+ accountId?: string | null;
677
+ /**
678
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
679
+ * @format GUID
680
+ */
681
+ parentAccountId?: string | null;
682
+ /**
683
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
684
+ * @format GUID
685
+ */
686
+ siteId?: string | null;
687
+ }
688
+
689
+ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
690
+ getUrl: (context: any) => string;
691
+ httpMethod: K;
692
+ path: string;
693
+ pathParams: M;
694
+ __requestType: T;
695
+ __originalRequestType: S;
696
+ __responseType: Q;
697
+ __originalResponseType: R;
698
+ };
699
+ declare function createPlan(): __PublicMethodMetaInfo<'POST', {}, CreatePlanRequest$1, CreatePlanRequest, CreatePlanResponse$1, CreatePlanResponse>;
700
+ declare function createAndGeneratePlan(): __PublicMethodMetaInfo<'POST', {}, CreateAndGeneratePlanRequest$1, CreateAndGeneratePlanRequest, CreateAndGeneratePlanResponse$1, CreateAndGeneratePlanResponse>;
701
+ declare function getPlan(): __PublicMethodMetaInfo<'GET', {
702
+ planId: string;
703
+ }, GetPlanRequest$1, GetPlanRequest, GetPlanResponse$1, GetPlanResponse>;
704
+ declare function getPlanByProjectId(): __PublicMethodMetaInfo<'GET', {
705
+ projectId: string;
706
+ }, GetPlanByProjectIdRequest$1, GetPlanByProjectIdRequest, GetPlanByProjectIdResponse$1, GetPlanByProjectIdResponse>;
707
+ declare function updatePlan(): __PublicMethodMetaInfo<'PATCH', {
708
+ planId: string;
709
+ }, UpdatePlanRequest$1, UpdatePlanRequest, UpdatePlanResponse$1, UpdatePlanResponse>;
710
+ declare function deletePlan(): __PublicMethodMetaInfo<'DELETE', {
711
+ planId: string;
712
+ }, DeletePlanRequest$1, DeletePlanRequest, DeletePlanResponse$1, DeletePlanResponse>;
713
+ declare function generatePlan(): __PublicMethodMetaInfo<'POST', {
714
+ planId: string;
715
+ }, GeneratePlanRequest$1, GeneratePlanRequest, GeneratePlanResponse$1, GeneratePlanResponse>;
716
+ declare function modifyPlan(): __PublicMethodMetaInfo<'POST', {
717
+ planId: string;
718
+ }, ModifyPlanRequest$1, ModifyPlanRequest, ModifyPlanResponse$1, ModifyPlanResponse>;
719
+ declare function regenerateIcon(): __PublicMethodMetaInfo<'POST', {
720
+ planId: string;
721
+ }, RegenerateIconRequest$1, RegenerateIconRequest, RegenerateIconResponse$1, RegenerateIconResponse>;
722
+ declare function finalizePlan(): __PublicMethodMetaInfo<'POST', {
723
+ planId: string;
724
+ }, FinalizePlanRequest$1, FinalizePlanRequest, FinalizePlanResponse$1, FinalizePlanResponse>;
725
+
726
+ export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AnsweredQuestion as AnsweredQuestionOriginal, type AppSpec as AppSpecOriginal, type BrandIdentity as BrandIdentityOriginal, type BusinessContext as BusinessContextOriginal, type CreateAndGeneratePlanRequest as CreateAndGeneratePlanRequestOriginal, type CreateAndGeneratePlanResponse as CreateAndGeneratePlanResponseOriginal, type CreatePlanRequest as CreatePlanRequestOriginal, type CreatePlanResponse as CreatePlanResponseOriginal, type DeletePlanRequest as DeletePlanRequestOriginal, type DeletePlanResponse as DeletePlanResponseOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type Feature as FeatureOriginal, type FinalizePlanRequest as FinalizePlanRequestOriginal, type FinalizePlanResponse as FinalizePlanResponseOriginal, type FollowUpQuestion as FollowUpQuestionOriginal, type GeneratePlanRequest as GeneratePlanRequestOriginal, type GeneratePlanResponse as GeneratePlanResponseOriginal, type GetPlanByProjectIdRequest as GetPlanByProjectIdRequestOriginal, type GetPlanByProjectIdResponse as GetPlanByProjectIdResponseOriginal, type GetPlanRequest as GetPlanRequestOriginal, type GetPlanResponse as GetPlanResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Integration as IntegrationOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type ModifyPlanRequest as ModifyPlanRequestOriginal, type ModifyPlanResponse as ModifyPlanResponseOriginal, type PlanEditContext as PlanEditContextOriginal, type PlanFinalized as PlanFinalizedOriginal, type Plan as PlanOriginal, PlanPartType as PlanPartTypeOriginal, type PlanPartTypeWithLiterals as PlanPartTypeWithLiteralsOriginal, PlanStatus as PlanStatusOriginal, type PlanStatusWithLiterals as PlanStatusWithLiteralsOriginal, Platform as PlatformOriginal, type PlatformWithLiterals as PlatformWithLiteralsOriginal, type RegenerateIconRequest as RegenerateIconRequestOriginal, type RegenerateIconResponse as RegenerateIconResponseOriginal, type RestoreInfo as RestoreInfoOriginal, type UpdatePlanRequest as UpdatePlanRequestOriginal, type UpdatePlanResponse as UpdatePlanResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, createAndGeneratePlan, createPlan, deletePlan, finalizePlan, generatePlan, getPlan, getPlanByProjectId, modifyPlan, regenerateIcon, updatePlan };