@wix/auto_sdk_containers_plans 1.0.4 → 1.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +152 -1
- package/build/cjs/index.js +81 -0
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +1 -1
- package/build/cjs/index.typings.js +74 -0
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +154 -2
- package/build/cjs/meta.js +69 -0
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +152 -1
- package/build/es/index.mjs +77 -0
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +1 -1
- package/build/es/index.typings.mjs +70 -0
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +154 -2
- package/build/es/meta.mjs +65 -0
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +26 -11
- package/build/internal/cjs/index.typings.d.ts +173 -9
- package/build/internal/cjs/meta.d.ts +154 -2
- package/build/internal/es/index.d.mts +26 -11
- package/build/internal/es/index.typings.d.mts +173 -9
- package/build/internal/es/meta.d.mts +154 -2
- package/package.json +2 -2
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
|
|
2
|
-
import { Plan, CreateAndGeneratePlanResponse, GetPlanByProjectIdResponse, UpdatePlan, GeneratePlanResponse, ModifyPlanOptions, ModifyPlanResponse, RegenerateIconResponse, FinalizePlanResponse } from './index.typings.mjs';
|
|
3
|
-
export { AccountInfo, ActionEvent, AnsweredQuestion, AppSpec, BrandIdentity, BusinessContext, CreateAndGeneratePlanRequest, CreatePlanRequest, CreatePlanResponse, DeletePlanRequest, DeletePlanResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, Feature, FinalizePlanRequest, FollowUpQuestion, GeneratePlanRequest, GetPlanByProjectIdRequest, GetPlanRequest, GetPlanResponse, IdentificationData, IdentificationDataIdOneOf, Integration, MessageEnvelope, ModifyPlanRequest, PlanEditContext, PlanFinalized, PlanPartType, PlanPartTypeWithLiterals, PlanStatus, PlanStatusWithLiterals, Platform, PlatformWithLiterals, RegenerateIconRequest, RestoreInfo, UpdatePlanRequest, UpdatePlanResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.mjs';
|
|
2
|
+
import { Plan, CreateAndGeneratePlanResponse, GetPlanByProjectIdResponse, UpdatePlan, GeneratePlanResponse, ModifyPlanOptions, ModifyPlanResponse, RegenerateIconResponse, FinalizePlanResponse, GetPromptSuggestionsResponse } from './index.typings.mjs';
|
|
3
|
+
export { AccountInfo, ActionEvent, AnsweredQuestion, AppSpec, BrandIdentity, BusinessAnalysis, BusinessContext, BusinessGoalConfidence, BusinessGoalConfidenceWithLiterals, ContentSource, ContentSourceWithLiterals, CreateAndGeneratePlanRequest, CreatePlanRequest, CreatePlanResponse, DeletePlanRequest, DeletePlanResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, Feature, FinalizePlanRequest, FollowUpQuestion, GeneratePlanRequest, GetPlanByProjectIdRequest, GetPlanRequest, GetPlanResponse, GetPromptSuggestionsRequest, IdentificationData, IdentificationDataIdOneOf, Integration, MessageEnvelope, ModifyPlanRequest, PlanEditContext, PlanFinalized, PlanPartType, PlanPartTypeWithLiterals, PlanStatus, PlanStatusWithLiterals, Platform, PlatformWithLiterals, PromptSuggestion, PromptSuggestionsSource, PromptSuggestionsSourceWithLiterals, RegenerateIconRequest, RestoreInfo, UpdatePlanRequest, UpdatePlanResponse, UsableContent, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.mjs';
|
|
4
4
|
|
|
5
5
|
/** @internal */
|
|
6
6
|
declare function createPlan$1(httpClient: HttpClient): CreatePlanSignature;
|
|
@@ -10,7 +10,7 @@ interface CreatePlanSignature {
|
|
|
10
10
|
* @param - Plan to be created.
|
|
11
11
|
* @returns The created Plan.
|
|
12
12
|
*/
|
|
13
|
-
(plan: NonNullablePaths<Plan, `initialPrompt` | `platform` | `projectId` | `selectedTemplateId`, 0>): Promise<NonNullablePaths<Plan, `initialPrompt` | `platform` | `status` | `businessContext.businessName` | `businessContext.businessLogoUrl` | `businessContext.businessDescription` | `businessContext.language` | `businessContext.country` | `businessContext.wixIntegrations` | `brandIdentity.primaryColor` | `brandIdentity.backgroundColor` | `brandIdentity.contentColor` | `brandIdentity.headingFont` | `brandIdentity.bodyFont` | `appSpec.appName` | `appSpec.appDescription` | `appSpec.businessGoal` | `appSpec.audience` | `appSpec.wixIntegrations` | `appSpec.wixIntegrations.${number}.displayName` | `appSpec.wixIntegrations.${number}.description` | `appSpec.wixIntegrations.${number}._id` | `appSpec.thirdPartyIntegrations` | `appSpec.features` | `appSpec.features.${number}.title` | `appSpec.features.${number}.description` | `appSpec.navigation` | `appSpec.appIconUrl`,
|
|
13
|
+
(plan: NonNullablePaths<Plan, `initialPrompt` | `platform` | `projectId` | `selectedTemplateId`, 0>): Promise<NonNullablePaths<Plan, `initialPrompt` | `platform` | `status` | `businessContext.businessName` | `businessContext.businessLogoUrl` | `businessContext.businessDescription` | `businessContext.language` | `businessContext.country` | `businessContext.wixIntegrations` | `businessContext.analysis.industry` | `businessContext.analysis.summary` | `businessContext.analysis.businessGoal` | `businessContext.analysis.businessGoalConfidence` | `businessContext.analysis.audience` | `businessContext.analysis.keyOfferings` | `businessContext.analysis.usableContent` | `businessContext.analysis.usableContent.${number}.source` | `businessContext.analysis.usableContent.${number}.description` | `businessContext.analysis.installedVerticals` | `businessContext.analysis.appFocus` | `businessContext.analysis.toneOfVoice` | `businessContext.analysis.toneExamples` | `brandIdentity.primaryColor` | `brandIdentity.backgroundColor` | `brandIdentity.contentColor` | `brandIdentity.headingFont` | `brandIdentity.bodyFont` | `appSpec.appName` | `appSpec.appDescription` | `appSpec.businessGoal` | `appSpec.audience` | `appSpec.wixIntegrations` | `appSpec.wixIntegrations.${number}.displayName` | `appSpec.wixIntegrations.${number}.description` | `appSpec.wixIntegrations.${number}._id` | `appSpec.thirdPartyIntegrations` | `appSpec.features` | `appSpec.features.${number}.title` | `appSpec.features.${number}.description` | `appSpec.navigation` | `appSpec.appIconUrl`, 4>>;
|
|
14
14
|
}
|
|
15
15
|
/** @internal */
|
|
16
16
|
declare function createAndGeneratePlan$1(httpClient: HttpClient): CreateAndGeneratePlanSignature;
|
|
@@ -19,7 +19,7 @@ interface CreateAndGeneratePlanSignature {
|
|
|
19
19
|
* Creates a new Plan and immediately generates it using the planning agent.
|
|
20
20
|
* @param - Plan to be created and generated.
|
|
21
21
|
*/
|
|
22
|
-
(plan: NonNullablePaths<Plan, `initialPrompt` | `platform` | `projectId` | `selectedTemplateId`, 0>): Promise<NonNullablePaths<CreateAndGeneratePlanResponse, `plan.initialPrompt` | `plan.platform` | `plan.status` | `plan.businessContext.businessName` | `plan.businessContext.businessLogoUrl` | `plan.businessContext.businessDescription` | `plan.businessContext.language` | `plan.businessContext.country` | `plan.businessContext.wixIntegrations` | `plan.brandIdentity.primaryColor` | `plan.brandIdentity.backgroundColor` | `plan.brandIdentity.contentColor` | `plan.brandIdentity.headingFont` | `plan.brandIdentity.bodyFont` | `plan.appSpec.appName` | `plan.appSpec.appDescription` | `plan.appSpec.businessGoal` | `plan.appSpec.audience` | `plan.appSpec.wixIntegrations` | `plan.appSpec.wixIntegrations.${number}.displayName` | `plan.appSpec.wixIntegrations.${number}.description` | `plan.appSpec.wixIntegrations.${number}._id` | `plan.appSpec.thirdPartyIntegrations` | `plan.appSpec.features` | `plan.appSpec.features.${number}.title` | `plan.appSpec.features.${number}.description` | `plan.appSpec.navigation` | `plan.appSpec.appIconUrl` | `followUpQuestions` | `followUpQuestionOptions` | `followUpQuestionOptions.${number}.question`,
|
|
22
|
+
(plan: NonNullablePaths<Plan, `initialPrompt` | `platform` | `projectId` | `selectedTemplateId`, 0>): Promise<NonNullablePaths<CreateAndGeneratePlanResponse, `plan.initialPrompt` | `plan.platform` | `plan.status` | `plan.businessContext.businessName` | `plan.businessContext.businessLogoUrl` | `plan.businessContext.businessDescription` | `plan.businessContext.language` | `plan.businessContext.country` | `plan.businessContext.wixIntegrations` | `plan.businessContext.analysis.industry` | `plan.businessContext.analysis.summary` | `plan.businessContext.analysis.businessGoal` | `plan.businessContext.analysis.businessGoalConfidence` | `plan.businessContext.analysis.audience` | `plan.businessContext.analysis.keyOfferings` | `plan.businessContext.analysis.usableContent` | `plan.businessContext.analysis.usableContent.${number}.source` | `plan.businessContext.analysis.usableContent.${number}.description` | `plan.businessContext.analysis.installedVerticals` | `plan.businessContext.analysis.appFocus` | `plan.businessContext.analysis.toneOfVoice` | `plan.businessContext.analysis.toneExamples` | `plan.brandIdentity.primaryColor` | `plan.brandIdentity.backgroundColor` | `plan.brandIdentity.contentColor` | `plan.brandIdentity.headingFont` | `plan.brandIdentity.bodyFont` | `plan.appSpec.appName` | `plan.appSpec.appDescription` | `plan.appSpec.businessGoal` | `plan.appSpec.audience` | `plan.appSpec.wixIntegrations` | `plan.appSpec.wixIntegrations.${number}.displayName` | `plan.appSpec.wixIntegrations.${number}.description` | `plan.appSpec.wixIntegrations.${number}._id` | `plan.appSpec.thirdPartyIntegrations` | `plan.appSpec.features` | `plan.appSpec.features.${number}.title` | `plan.appSpec.features.${number}.description` | `plan.appSpec.navigation` | `plan.appSpec.appIconUrl` | `followUpQuestions` | `followUpQuestionOptions` | `followUpQuestionOptions.${number}.question`, 5>>;
|
|
23
23
|
}
|
|
24
24
|
/** @internal */
|
|
25
25
|
declare function getPlan$1(httpClient: HttpClient): GetPlanSignature;
|
|
@@ -29,7 +29,7 @@ interface GetPlanSignature {
|
|
|
29
29
|
* @param - ID of the Plan to retrieve.
|
|
30
30
|
* @returns The requested Plan.
|
|
31
31
|
*/
|
|
32
|
-
(planId: string): Promise<NonNullablePaths<Plan, `initialPrompt` | `platform` | `status` | `businessContext.businessName` | `businessContext.businessLogoUrl` | `businessContext.businessDescription` | `businessContext.language` | `businessContext.country` | `businessContext.wixIntegrations` | `brandIdentity.primaryColor` | `brandIdentity.backgroundColor` | `brandIdentity.contentColor` | `brandIdentity.headingFont` | `brandIdentity.bodyFont` | `appSpec.appName` | `appSpec.appDescription` | `appSpec.businessGoal` | `appSpec.audience` | `appSpec.wixIntegrations` | `appSpec.wixIntegrations.${number}.displayName` | `appSpec.wixIntegrations.${number}.description` | `appSpec.wixIntegrations.${number}._id` | `appSpec.thirdPartyIntegrations` | `appSpec.features` | `appSpec.features.${number}.title` | `appSpec.features.${number}.description` | `appSpec.navigation` | `appSpec.appIconUrl`,
|
|
32
|
+
(planId: string): Promise<NonNullablePaths<Plan, `initialPrompt` | `platform` | `status` | `businessContext.businessName` | `businessContext.businessLogoUrl` | `businessContext.businessDescription` | `businessContext.language` | `businessContext.country` | `businessContext.wixIntegrations` | `businessContext.analysis.industry` | `businessContext.analysis.summary` | `businessContext.analysis.businessGoal` | `businessContext.analysis.businessGoalConfidence` | `businessContext.analysis.audience` | `businessContext.analysis.keyOfferings` | `businessContext.analysis.usableContent` | `businessContext.analysis.usableContent.${number}.source` | `businessContext.analysis.usableContent.${number}.description` | `businessContext.analysis.installedVerticals` | `businessContext.analysis.appFocus` | `businessContext.analysis.toneOfVoice` | `businessContext.analysis.toneExamples` | `brandIdentity.primaryColor` | `brandIdentity.backgroundColor` | `brandIdentity.contentColor` | `brandIdentity.headingFont` | `brandIdentity.bodyFont` | `appSpec.appName` | `appSpec.appDescription` | `appSpec.businessGoal` | `appSpec.audience` | `appSpec.wixIntegrations` | `appSpec.wixIntegrations.${number}.displayName` | `appSpec.wixIntegrations.${number}.description` | `appSpec.wixIntegrations.${number}._id` | `appSpec.thirdPartyIntegrations` | `appSpec.features` | `appSpec.features.${number}.title` | `appSpec.features.${number}.description` | `appSpec.navigation` | `appSpec.appIconUrl`, 4>>;
|
|
33
33
|
}
|
|
34
34
|
/** @internal */
|
|
35
35
|
declare function getPlanByProjectId$1(httpClient: HttpClient): GetPlanByProjectIdSignature;
|
|
@@ -39,7 +39,7 @@ interface GetPlanByProjectIdSignature {
|
|
|
39
39
|
* read the finalized plan when creating the initial generation job.
|
|
40
40
|
* @param - ID of the project whose Plan to retrieve.
|
|
41
41
|
*/
|
|
42
|
-
(projectId: string): Promise<NonNullablePaths<GetPlanByProjectIdResponse, `plan.initialPrompt` | `plan.platform` | `plan.status` | `plan.businessContext.businessName` | `plan.businessContext.businessLogoUrl` | `plan.businessContext.businessDescription` | `plan.businessContext.language` | `plan.businessContext.country` | `plan.businessContext.wixIntegrations` | `plan.brandIdentity.primaryColor` | `plan.brandIdentity.backgroundColor` | `plan.brandIdentity.contentColor` | `plan.brandIdentity.headingFont` | `plan.brandIdentity.bodyFont` | `plan.appSpec.appName` | `plan.appSpec.appDescription` | `plan.appSpec.businessGoal` | `plan.appSpec.audience` | `plan.appSpec.wixIntegrations` | `plan.appSpec.wixIntegrations.${number}.displayName` | `plan.appSpec.wixIntegrations.${number}.description` | `plan.appSpec.wixIntegrations.${number}._id` | `plan.appSpec.thirdPartyIntegrations` | `plan.appSpec.features` | `plan.appSpec.features.${number}.title` | `plan.appSpec.features.${number}.description` | `plan.appSpec.navigation` | `plan.appSpec.appIconUrl`,
|
|
42
|
+
(projectId: string): Promise<NonNullablePaths<GetPlanByProjectIdResponse, `plan.initialPrompt` | `plan.platform` | `plan.status` | `plan.businessContext.businessName` | `plan.businessContext.businessLogoUrl` | `plan.businessContext.businessDescription` | `plan.businessContext.language` | `plan.businessContext.country` | `plan.businessContext.wixIntegrations` | `plan.businessContext.analysis.industry` | `plan.businessContext.analysis.summary` | `plan.businessContext.analysis.businessGoal` | `plan.businessContext.analysis.businessGoalConfidence` | `plan.businessContext.analysis.audience` | `plan.businessContext.analysis.keyOfferings` | `plan.businessContext.analysis.usableContent` | `plan.businessContext.analysis.usableContent.${number}.source` | `plan.businessContext.analysis.usableContent.${number}.description` | `plan.businessContext.analysis.installedVerticals` | `plan.businessContext.analysis.appFocus` | `plan.businessContext.analysis.toneOfVoice` | `plan.businessContext.analysis.toneExamples` | `plan.brandIdentity.primaryColor` | `plan.brandIdentity.backgroundColor` | `plan.brandIdentity.contentColor` | `plan.brandIdentity.headingFont` | `plan.brandIdentity.bodyFont` | `plan.appSpec.appName` | `plan.appSpec.appDescription` | `plan.appSpec.businessGoal` | `plan.appSpec.audience` | `plan.appSpec.wixIntegrations` | `plan.appSpec.wixIntegrations.${number}.displayName` | `plan.appSpec.wixIntegrations.${number}.description` | `plan.appSpec.wixIntegrations.${number}._id` | `plan.appSpec.thirdPartyIntegrations` | `plan.appSpec.features` | `plan.appSpec.features.${number}.title` | `plan.appSpec.features.${number}.description` | `plan.appSpec.navigation` | `plan.appSpec.appIconUrl`, 5>>;
|
|
43
43
|
}
|
|
44
44
|
/** @internal */
|
|
45
45
|
declare function updatePlan$1(httpClient: HttpClient): UpdatePlanSignature;
|
|
@@ -49,7 +49,7 @@ interface UpdatePlanSignature {
|
|
|
49
49
|
* @param - Plan ID.
|
|
50
50
|
* @returns The updated Plan.
|
|
51
51
|
*/
|
|
52
|
-
(_id: string, plan: NonNullablePaths<UpdatePlan, `revision`, 0>): Promise<NonNullablePaths<Plan, `initialPrompt` | `platform` | `status` | `businessContext.businessName` | `businessContext.businessLogoUrl` | `businessContext.businessDescription` | `businessContext.language` | `businessContext.country` | `businessContext.wixIntegrations` | `brandIdentity.primaryColor` | `brandIdentity.backgroundColor` | `brandIdentity.contentColor` | `brandIdentity.headingFont` | `brandIdentity.bodyFont` | `appSpec.appName` | `appSpec.appDescription` | `appSpec.businessGoal` | `appSpec.audience` | `appSpec.wixIntegrations` | `appSpec.wixIntegrations.${number}.displayName` | `appSpec.wixIntegrations.${number}.description` | `appSpec.wixIntegrations.${number}._id` | `appSpec.thirdPartyIntegrations` | `appSpec.features` | `appSpec.features.${number}.title` | `appSpec.features.${number}.description` | `appSpec.navigation` | `appSpec.appIconUrl`,
|
|
52
|
+
(_id: string, plan: NonNullablePaths<UpdatePlan, `revision`, 0>): Promise<NonNullablePaths<Plan, `initialPrompt` | `platform` | `status` | `businessContext.businessName` | `businessContext.businessLogoUrl` | `businessContext.businessDescription` | `businessContext.language` | `businessContext.country` | `businessContext.wixIntegrations` | `businessContext.analysis.industry` | `businessContext.analysis.summary` | `businessContext.analysis.businessGoal` | `businessContext.analysis.businessGoalConfidence` | `businessContext.analysis.audience` | `businessContext.analysis.keyOfferings` | `businessContext.analysis.usableContent` | `businessContext.analysis.usableContent.${number}.source` | `businessContext.analysis.usableContent.${number}.description` | `businessContext.analysis.installedVerticals` | `businessContext.analysis.appFocus` | `businessContext.analysis.toneOfVoice` | `businessContext.analysis.toneExamples` | `brandIdentity.primaryColor` | `brandIdentity.backgroundColor` | `brandIdentity.contentColor` | `brandIdentity.headingFont` | `brandIdentity.bodyFont` | `appSpec.appName` | `appSpec.appDescription` | `appSpec.businessGoal` | `appSpec.audience` | `appSpec.wixIntegrations` | `appSpec.wixIntegrations.${number}.displayName` | `appSpec.wixIntegrations.${number}.description` | `appSpec.wixIntegrations.${number}._id` | `appSpec.thirdPartyIntegrations` | `appSpec.features` | `appSpec.features.${number}.title` | `appSpec.features.${number}.description` | `appSpec.navigation` | `appSpec.appIconUrl`, 4>>;
|
|
53
53
|
}
|
|
54
54
|
/** @internal */
|
|
55
55
|
declare function deletePlan$1(httpClient: HttpClient): DeletePlanSignature;
|
|
@@ -69,7 +69,7 @@ interface GeneratePlanSignature {
|
|
|
69
69
|
* selected template. Populates app_spec (and brand_identity) and returns follow-up questions.
|
|
70
70
|
* @param - ID of the Plan to generate.
|
|
71
71
|
*/
|
|
72
|
-
(planId: string): Promise<NonNullablePaths<GeneratePlanResponse, `plan.initialPrompt` | `plan.platform` | `plan.status` | `plan.businessContext.businessName` | `plan.businessContext.businessLogoUrl` | `plan.businessContext.businessDescription` | `plan.businessContext.language` | `plan.businessContext.country` | `plan.businessContext.wixIntegrations` | `plan.brandIdentity.primaryColor` | `plan.brandIdentity.backgroundColor` | `plan.brandIdentity.contentColor` | `plan.brandIdentity.headingFont` | `plan.brandIdentity.bodyFont` | `plan.appSpec.appName` | `plan.appSpec.appDescription` | `plan.appSpec.businessGoal` | `plan.appSpec.audience` | `plan.appSpec.wixIntegrations` | `plan.appSpec.wixIntegrations.${number}.displayName` | `plan.appSpec.wixIntegrations.${number}.description` | `plan.appSpec.wixIntegrations.${number}._id` | `plan.appSpec.thirdPartyIntegrations` | `plan.appSpec.features` | `plan.appSpec.features.${number}.title` | `plan.appSpec.features.${number}.description` | `plan.appSpec.navigation` | `plan.appSpec.appIconUrl` | `followUpQuestions` | `followUpQuestionOptions` | `followUpQuestionOptions.${number}.question`,
|
|
72
|
+
(planId: string): Promise<NonNullablePaths<GeneratePlanResponse, `plan.initialPrompt` | `plan.platform` | `plan.status` | `plan.businessContext.businessName` | `plan.businessContext.businessLogoUrl` | `plan.businessContext.businessDescription` | `plan.businessContext.language` | `plan.businessContext.country` | `plan.businessContext.wixIntegrations` | `plan.businessContext.analysis.industry` | `plan.businessContext.analysis.summary` | `plan.businessContext.analysis.businessGoal` | `plan.businessContext.analysis.businessGoalConfidence` | `plan.businessContext.analysis.audience` | `plan.businessContext.analysis.keyOfferings` | `plan.businessContext.analysis.usableContent` | `plan.businessContext.analysis.usableContent.${number}.source` | `plan.businessContext.analysis.usableContent.${number}.description` | `plan.businessContext.analysis.installedVerticals` | `plan.businessContext.analysis.appFocus` | `plan.businessContext.analysis.toneOfVoice` | `plan.businessContext.analysis.toneExamples` | `plan.brandIdentity.primaryColor` | `plan.brandIdentity.backgroundColor` | `plan.brandIdentity.contentColor` | `plan.brandIdentity.headingFont` | `plan.brandIdentity.bodyFont` | `plan.appSpec.appName` | `plan.appSpec.appDescription` | `plan.appSpec.businessGoal` | `plan.appSpec.audience` | `plan.appSpec.wixIntegrations` | `plan.appSpec.wixIntegrations.${number}.displayName` | `plan.appSpec.wixIntegrations.${number}.description` | `plan.appSpec.wixIntegrations.${number}._id` | `plan.appSpec.thirdPartyIntegrations` | `plan.appSpec.features` | `plan.appSpec.features.${number}.title` | `plan.appSpec.features.${number}.description` | `plan.appSpec.navigation` | `plan.appSpec.appIconUrl` | `followUpQuestions` | `followUpQuestionOptions` | `followUpQuestionOptions.${number}.question`, 5>>;
|
|
73
73
|
}
|
|
74
74
|
/** @internal */
|
|
75
75
|
declare function modifyPlan$1(httpClient: HttpClient): ModifyPlanSignature;
|
|
@@ -80,7 +80,7 @@ interface ModifyPlanSignature {
|
|
|
80
80
|
* any new follow-up questions.
|
|
81
81
|
* @param - ID of the Plan to modify.
|
|
82
82
|
*/
|
|
83
|
-
(planId: string, options?: ModifyPlanOptions): Promise<NonNullablePaths<ModifyPlanResponse, `plan.initialPrompt` | `plan.platform` | `plan.status` | `plan.businessContext.businessName` | `plan.businessContext.businessLogoUrl` | `plan.businessContext.businessDescription` | `plan.businessContext.language` | `plan.businessContext.country` | `plan.businessContext.wixIntegrations` | `plan.brandIdentity.primaryColor` | `plan.brandIdentity.backgroundColor` | `plan.brandIdentity.contentColor` | `plan.brandIdentity.headingFont` | `plan.brandIdentity.bodyFont` | `plan.appSpec.appName` | `plan.appSpec.appDescription` | `plan.appSpec.businessGoal` | `plan.appSpec.audience` | `plan.appSpec.wixIntegrations` | `plan.appSpec.wixIntegrations.${number}.displayName` | `plan.appSpec.wixIntegrations.${number}.description` | `plan.appSpec.wixIntegrations.${number}._id` | `plan.appSpec.thirdPartyIntegrations` | `plan.appSpec.features` | `plan.appSpec.features.${number}.title` | `plan.appSpec.features.${number}.description` | `plan.appSpec.navigation` | `plan.appSpec.appIconUrl` | `followUpQuestions` | `followUpQuestionOptions` | `followUpQuestionOptions.${number}.question`,
|
|
83
|
+
(planId: string, options?: ModifyPlanOptions): Promise<NonNullablePaths<ModifyPlanResponse, `plan.initialPrompt` | `plan.platform` | `plan.status` | `plan.businessContext.businessName` | `plan.businessContext.businessLogoUrl` | `plan.businessContext.businessDescription` | `plan.businessContext.language` | `plan.businessContext.country` | `plan.businessContext.wixIntegrations` | `plan.businessContext.analysis.industry` | `plan.businessContext.analysis.summary` | `plan.businessContext.analysis.businessGoal` | `plan.businessContext.analysis.businessGoalConfidence` | `plan.businessContext.analysis.audience` | `plan.businessContext.analysis.keyOfferings` | `plan.businessContext.analysis.usableContent` | `plan.businessContext.analysis.usableContent.${number}.source` | `plan.businessContext.analysis.usableContent.${number}.description` | `plan.businessContext.analysis.installedVerticals` | `plan.businessContext.analysis.appFocus` | `plan.businessContext.analysis.toneOfVoice` | `plan.businessContext.analysis.toneExamples` | `plan.brandIdentity.primaryColor` | `plan.brandIdentity.backgroundColor` | `plan.brandIdentity.contentColor` | `plan.brandIdentity.headingFont` | `plan.brandIdentity.bodyFont` | `plan.appSpec.appName` | `plan.appSpec.appDescription` | `plan.appSpec.businessGoal` | `plan.appSpec.audience` | `plan.appSpec.wixIntegrations` | `plan.appSpec.wixIntegrations.${number}.displayName` | `plan.appSpec.wixIntegrations.${number}.description` | `plan.appSpec.wixIntegrations.${number}._id` | `plan.appSpec.thirdPartyIntegrations` | `plan.appSpec.features` | `plan.appSpec.features.${number}.title` | `plan.appSpec.features.${number}.description` | `plan.appSpec.navigation` | `plan.appSpec.appIconUrl` | `followUpQuestions` | `followUpQuestionOptions` | `followUpQuestionOptions.${number}.question`, 5>>;
|
|
84
84
|
}
|
|
85
85
|
/** @internal */
|
|
86
86
|
declare function regenerateIcon$1(httpClient: HttpClient): RegenerateIconSignature;
|
|
@@ -107,7 +107,20 @@ interface FinalizePlanSignature {
|
|
|
107
107
|
* are used to drive generation.
|
|
108
108
|
* @param - ID of the conversation that led to this plan being finalized.
|
|
109
109
|
*/
|
|
110
|
-
(planId: string, conversationId: string): Promise<NonNullablePaths<FinalizePlanResponse, `plan.initialPrompt` | `plan.platform` | `plan.status` | `plan.businessContext.businessName` | `plan.businessContext.businessLogoUrl` | `plan.businessContext.businessDescription` | `plan.businessContext.language` | `plan.businessContext.country` | `plan.businessContext.wixIntegrations` | `plan.brandIdentity.primaryColor` | `plan.brandIdentity.backgroundColor` | `plan.brandIdentity.contentColor` | `plan.brandIdentity.headingFont` | `plan.brandIdentity.bodyFont` | `plan.appSpec.appName` | `plan.appSpec.appDescription` | `plan.appSpec.businessGoal` | `plan.appSpec.audience` | `plan.appSpec.wixIntegrations` | `plan.appSpec.wixIntegrations.${number}.displayName` | `plan.appSpec.wixIntegrations.${number}.description` | `plan.appSpec.wixIntegrations.${number}._id` | `plan.appSpec.thirdPartyIntegrations` | `plan.appSpec.features` | `plan.appSpec.features.${number}.title` | `plan.appSpec.features.${number}.description` | `plan.appSpec.navigation` | `plan.appSpec.appIconUrl`,
|
|
110
|
+
(planId: string, conversationId: string): Promise<NonNullablePaths<FinalizePlanResponse, `plan.initialPrompt` | `plan.platform` | `plan.status` | `plan.businessContext.businessName` | `plan.businessContext.businessLogoUrl` | `plan.businessContext.businessDescription` | `plan.businessContext.language` | `plan.businessContext.country` | `plan.businessContext.wixIntegrations` | `plan.businessContext.analysis.industry` | `plan.businessContext.analysis.summary` | `plan.businessContext.analysis.businessGoal` | `plan.businessContext.analysis.businessGoalConfidence` | `plan.businessContext.analysis.audience` | `plan.businessContext.analysis.keyOfferings` | `plan.businessContext.analysis.usableContent` | `plan.businessContext.analysis.usableContent.${number}.source` | `plan.businessContext.analysis.usableContent.${number}.description` | `plan.businessContext.analysis.installedVerticals` | `plan.businessContext.analysis.appFocus` | `plan.businessContext.analysis.toneOfVoice` | `plan.businessContext.analysis.toneExamples` | `plan.brandIdentity.primaryColor` | `plan.brandIdentity.backgroundColor` | `plan.brandIdentity.contentColor` | `plan.brandIdentity.headingFont` | `plan.brandIdentity.bodyFont` | `plan.appSpec.appName` | `plan.appSpec.appDescription` | `plan.appSpec.businessGoal` | `plan.appSpec.audience` | `plan.appSpec.wixIntegrations` | `plan.appSpec.wixIntegrations.${number}.displayName` | `plan.appSpec.wixIntegrations.${number}.description` | `plan.appSpec.wixIntegrations.${number}._id` | `plan.appSpec.thirdPartyIntegrations` | `plan.appSpec.features` | `plan.appSpec.features.${number}.title` | `plan.appSpec.features.${number}.description` | `plan.appSpec.navigation` | `plan.appSpec.appIconUrl`, 5>>;
|
|
111
|
+
}
|
|
112
|
+
/** @internal */
|
|
113
|
+
declare function getPromptSuggestions$1(httpClient: HttpClient): GetPromptSuggestionsSignature;
|
|
114
|
+
interface GetPromptSuggestionsSignature {
|
|
115
|
+
/**
|
|
116
|
+
* Returns a first request and suggestion chips for the site in the call scope, made from the
|
|
117
|
+
* site's business: its content, business goal and tone. The server keeps one business profile per
|
|
118
|
+
* site, checks the site for changes at most every 30 days, and runs the analysis again only when
|
|
119
|
+
* the site changed or once a year. Empty, with source NO_SUGGESTIONS, when the feature is off for
|
|
120
|
+
* the site, the site gives nothing to use, or the first profile is not ready yet; then show the
|
|
121
|
+
* static first prompt.
|
|
122
|
+
*/
|
|
123
|
+
(): Promise<NonNullablePaths<GetPromptSuggestionsResponse, `businessName` | `defaultPrompt` | `suggestions` | `suggestions.${number}.label` | `suggestions.${number}.prompt` | `source`, 2>>;
|
|
111
124
|
}
|
|
112
125
|
|
|
113
126
|
/** @internal */
|
|
@@ -130,5 +143,7 @@ declare const modifyPlan: MaybeContext<BuildRESTFunction<typeof modifyPlan$1> &
|
|
|
130
143
|
declare const regenerateIcon: MaybeContext<BuildRESTFunction<typeof regenerateIcon$1> & typeof regenerateIcon$1>;
|
|
131
144
|
/** @internal */
|
|
132
145
|
declare const finalizePlan: MaybeContext<BuildRESTFunction<typeof finalizePlan$1> & typeof finalizePlan$1>;
|
|
146
|
+
/** @internal */
|
|
147
|
+
declare const getPromptSuggestions: MaybeContext<BuildRESTFunction<typeof getPromptSuggestions$1> & typeof getPromptSuggestions$1>;
|
|
133
148
|
|
|
134
|
-
export { CreateAndGeneratePlanResponse, FinalizePlanResponse, GeneratePlanResponse, GetPlanByProjectIdResponse, ModifyPlanOptions, ModifyPlanResponse, Plan, RegenerateIconResponse, UpdatePlan, createAndGeneratePlan, createPlan, deletePlan, finalizePlan, generatePlan, getPlan, getPlanByProjectId, modifyPlan, regenerateIcon, updatePlan };
|
|
149
|
+
export { CreateAndGeneratePlanResponse, FinalizePlanResponse, GeneratePlanResponse, GetPlanByProjectIdResponse, GetPromptSuggestionsResponse, ModifyPlanOptions, ModifyPlanResponse, Plan, RegenerateIconResponse, UpdatePlan, createAndGeneratePlan, createPlan, deletePlan, finalizePlan, generatePlan, getPlan, getPlanByProjectId, getPromptSuggestions, modifyPlan, regenerateIcon, updatePlan };
|
|
@@ -115,7 +115,116 @@ interface BusinessContext {
|
|
|
115
115
|
* @format WEB_URL
|
|
116
116
|
*/
|
|
117
117
|
publicSiteUrl?: string | null;
|
|
118
|
+
/**
|
|
119
|
+
* What the server learned from the site's content before the first plan was generated: the
|
|
120
|
+
* business, its goal and the content an app can show. Absent for older plans, when the analysis
|
|
121
|
+
* is off for the site, or when it did not finish.
|
|
122
|
+
* @readonly
|
|
123
|
+
*/
|
|
124
|
+
analysis?: BusinessAnalysis;
|
|
125
|
+
}
|
|
126
|
+
/** A short analysis of the business, made from the site's content for the planning agent. */
|
|
127
|
+
interface BusinessAnalysis {
|
|
128
|
+
/**
|
|
129
|
+
* Industry of the business, for example "yoga studio".
|
|
130
|
+
* @maxLength 200
|
|
131
|
+
*/
|
|
132
|
+
industry?: string;
|
|
133
|
+
/**
|
|
134
|
+
* Short factual summary of the business and what its site offers.
|
|
135
|
+
* @maxLength 2000
|
|
136
|
+
*/
|
|
137
|
+
summary?: string;
|
|
138
|
+
/**
|
|
139
|
+
* The main outcome the business wants from its customers, for example "Get more class bookings".
|
|
140
|
+
* @maxLength 500
|
|
141
|
+
*/
|
|
142
|
+
businessGoal?: string;
|
|
143
|
+
/** How strongly the site's content supports business_goal. */
|
|
144
|
+
businessGoalConfidence?: BusinessGoalConfidenceWithLiterals;
|
|
145
|
+
/**
|
|
146
|
+
* Who the business's customers are.
|
|
147
|
+
* @maxLength 500
|
|
148
|
+
*/
|
|
149
|
+
audience?: string;
|
|
150
|
+
/**
|
|
151
|
+
* Main products or services the business offers, as named on the site.
|
|
152
|
+
* @maxSize 6
|
|
153
|
+
* @maxLength 200
|
|
154
|
+
*/
|
|
155
|
+
keyOfferings?: string[];
|
|
156
|
+
/**
|
|
157
|
+
* Site content of each kind that the generated app can show.
|
|
158
|
+
* @maxSize 10
|
|
159
|
+
*/
|
|
160
|
+
usableContent?: UsableContent[];
|
|
161
|
+
/**
|
|
162
|
+
* Names of the Wix business apps installed on the site, for example "Wix Bookings".
|
|
163
|
+
* @maxSize 30
|
|
164
|
+
* @maxLength 100
|
|
165
|
+
*/
|
|
166
|
+
installedVerticals?: string[];
|
|
167
|
+
/**
|
|
168
|
+
* Short points the app should focus on to serve business_goal.
|
|
169
|
+
* @maxSize 3
|
|
170
|
+
* @maxLength 300
|
|
171
|
+
*/
|
|
172
|
+
appFocus?: string[];
|
|
173
|
+
/**
|
|
174
|
+
* How the site's own text sounds to its customers, so the app's text can sound the same, for
|
|
175
|
+
* example "Warm and homely; short sentences; speaks to the customer as 'you'".
|
|
176
|
+
* @maxLength 500
|
|
177
|
+
*/
|
|
178
|
+
toneOfVoice?: string;
|
|
179
|
+
/**
|
|
180
|
+
* Up to three short phrases quoted from the site that show its tone of voice.
|
|
181
|
+
* @maxSize 3
|
|
182
|
+
* @maxLength 200
|
|
183
|
+
*/
|
|
184
|
+
toneExamples?: string[];
|
|
185
|
+
}
|
|
186
|
+
declare enum BusinessGoalConfidence {
|
|
187
|
+
/** The site gives little or conflicting evidence for the goal. */
|
|
188
|
+
LOW = "LOW",
|
|
189
|
+
/** The goal is a reasonable inference from the site. */
|
|
190
|
+
MEDIUM = "MEDIUM",
|
|
191
|
+
/** The goal follows directly from strong evidence, such as a booking app with services. */
|
|
192
|
+
HIGH = "HIGH"
|
|
193
|
+
}
|
|
194
|
+
/** @enumType */
|
|
195
|
+
type BusinessGoalConfidenceWithLiterals = BusinessGoalConfidence | 'LOW' | 'MEDIUM' | 'HIGH';
|
|
196
|
+
/** Site content of one kind that the generated app can show. */
|
|
197
|
+
interface UsableContent {
|
|
198
|
+
/** Where the content comes from. */
|
|
199
|
+
source?: ContentSourceWithLiterals;
|
|
200
|
+
/**
|
|
201
|
+
* What the content is, for example "12 yoga and pilates classes with prices".
|
|
202
|
+
* @maxLength 500
|
|
203
|
+
*/
|
|
204
|
+
description?: string;
|
|
205
|
+
/** Number of items found, when known. */
|
|
206
|
+
itemCount?: number | null;
|
|
207
|
+
}
|
|
208
|
+
declare enum ContentSource {
|
|
209
|
+
/** Wix Stores products. */
|
|
210
|
+
STORES = "STORES",
|
|
211
|
+
/** Wix Bookings services. */
|
|
212
|
+
BOOKINGS = "BOOKINGS",
|
|
213
|
+
/** Wix Events events. */
|
|
214
|
+
EVENTS = "EVENTS",
|
|
215
|
+
/** Wix Blog posts. */
|
|
216
|
+
BLOG = "BLOG",
|
|
217
|
+
/** Wix Pricing Plans plans. */
|
|
218
|
+
PRICING_PLANS = "PRICING_PLANS",
|
|
219
|
+
/** Wix Restaurants menu items. */
|
|
220
|
+
RESTAURANTS = "RESTAURANTS",
|
|
221
|
+
/** Wix CMS (Wix Data) collections. */
|
|
222
|
+
CMS = "CMS",
|
|
223
|
+
/** Text of the published site's home page. */
|
|
224
|
+
SITE_TEXT = "SITE_TEXT"
|
|
118
225
|
}
|
|
226
|
+
/** @enumType */
|
|
227
|
+
type ContentSourceWithLiterals = ContentSource | 'STORES' | 'BOOKINGS' | 'EVENTS' | 'BLOG' | 'PRICING_PLANS' | 'RESTAURANTS' | 'CMS' | 'SITE_TEXT';
|
|
119
228
|
/**
|
|
120
229
|
* Visual identity extracted from the user's existing website. Serves as an editable
|
|
121
230
|
* starting point for the generated app.
|
|
@@ -502,6 +611,48 @@ interface FinalizePlanResponse {
|
|
|
502
611
|
/** The finalized Plan. */
|
|
503
612
|
plan?: Plan;
|
|
504
613
|
}
|
|
614
|
+
interface GetPromptSuggestionsRequest {
|
|
615
|
+
}
|
|
616
|
+
interface GetPromptSuggestionsResponse {
|
|
617
|
+
/**
|
|
618
|
+
* Name of the business the suggestions are for. Empty when unknown.
|
|
619
|
+
* @maxLength 200
|
|
620
|
+
*/
|
|
621
|
+
businessName?: string;
|
|
622
|
+
/**
|
|
623
|
+
* The owner's first request, ready to send or to edit. Empty when there are no suggestions.
|
|
624
|
+
* @maxLength 500
|
|
625
|
+
*/
|
|
626
|
+
defaultPrompt?: string;
|
|
627
|
+
/**
|
|
628
|
+
* App ideas for this business, strongest first: none, or 3 to 5.
|
|
629
|
+
* @maxSize 5
|
|
630
|
+
*/
|
|
631
|
+
suggestions?: PromptSuggestion[];
|
|
632
|
+
/** Where the suggestions come from. */
|
|
633
|
+
source?: PromptSuggestionsSourceWithLiterals;
|
|
634
|
+
}
|
|
635
|
+
/** One suggestion chip. */
|
|
636
|
+
interface PromptSuggestion {
|
|
637
|
+
/**
|
|
638
|
+
* Short chip text, one line on a phone, for example "Workshop booking app".
|
|
639
|
+
* @maxLength 42
|
|
640
|
+
*/
|
|
641
|
+
label?: string;
|
|
642
|
+
/**
|
|
643
|
+
* The owner's full request that the chip puts in the prompt box.
|
|
644
|
+
* @maxLength 400
|
|
645
|
+
*/
|
|
646
|
+
prompt?: string;
|
|
647
|
+
}
|
|
648
|
+
declare enum PromptSuggestionsSource {
|
|
649
|
+
/** Made from the site's business profile. */
|
|
650
|
+
BUSINESS_PROFILE = "BUSINESS_PROFILE",
|
|
651
|
+
/** No suggestions: show the static first prompt. */
|
|
652
|
+
NO_SUGGESTIONS = "NO_SUGGESTIONS"
|
|
653
|
+
}
|
|
654
|
+
/** @enumType */
|
|
655
|
+
type PromptSuggestionsSourceWithLiterals = PromptSuggestionsSource | 'BUSINESS_PROFILE' | 'NO_SUGGESTIONS';
|
|
505
656
|
interface DomainEvent extends DomainEventBodyOneOf {
|
|
506
657
|
createdEvent?: EntityCreatedEvent;
|
|
507
658
|
updatedEvent?: EntityUpdatedEvent;
|
|
@@ -669,7 +820,7 @@ interface AccountInfo {
|
|
|
669
820
|
* @returns The created Plan.
|
|
670
821
|
* @fqn wix.containers.plans.v1.ContainersPlans.CreatePlan
|
|
671
822
|
*/
|
|
672
|
-
declare function createPlan(plan: NonNullablePaths<Plan, `initialPrompt` | `platform` | `projectId` | `selectedTemplateId`, 0>): Promise<NonNullablePaths<Plan, `initialPrompt` | `platform` | `status` | `businessContext.businessName` | `businessContext.businessLogoUrl` | `businessContext.businessDescription` | `businessContext.language` | `businessContext.country` | `businessContext.wixIntegrations` | `brandIdentity.primaryColor` | `brandIdentity.backgroundColor` | `brandIdentity.contentColor` | `brandIdentity.headingFont` | `brandIdentity.bodyFont` | `appSpec.appName` | `appSpec.appDescription` | `appSpec.businessGoal` | `appSpec.audience` | `appSpec.wixIntegrations` | `appSpec.wixIntegrations.${number}.displayName` | `appSpec.wixIntegrations.${number}.description` | `appSpec.wixIntegrations.${number}._id` | `appSpec.thirdPartyIntegrations` | `appSpec.features` | `appSpec.features.${number}.title` | `appSpec.features.${number}.description` | `appSpec.navigation` | `appSpec.appIconUrl`,
|
|
823
|
+
declare function createPlan(plan: NonNullablePaths<Plan, `initialPrompt` | `platform` | `projectId` | `selectedTemplateId`, 0>): Promise<NonNullablePaths<Plan, `initialPrompt` | `platform` | `status` | `businessContext.businessName` | `businessContext.businessLogoUrl` | `businessContext.businessDescription` | `businessContext.language` | `businessContext.country` | `businessContext.wixIntegrations` | `businessContext.analysis.industry` | `businessContext.analysis.summary` | `businessContext.analysis.businessGoal` | `businessContext.analysis.businessGoalConfidence` | `businessContext.analysis.audience` | `businessContext.analysis.keyOfferings` | `businessContext.analysis.usableContent` | `businessContext.analysis.usableContent.${number}.source` | `businessContext.analysis.usableContent.${number}.description` | `businessContext.analysis.installedVerticals` | `businessContext.analysis.appFocus` | `businessContext.analysis.toneOfVoice` | `businessContext.analysis.toneExamples` | `brandIdentity.primaryColor` | `brandIdentity.backgroundColor` | `brandIdentity.contentColor` | `brandIdentity.headingFont` | `brandIdentity.bodyFont` | `appSpec.appName` | `appSpec.appDescription` | `appSpec.businessGoal` | `appSpec.audience` | `appSpec.wixIntegrations` | `appSpec.wixIntegrations.${number}.displayName` | `appSpec.wixIntegrations.${number}.description` | `appSpec.wixIntegrations.${number}._id` | `appSpec.thirdPartyIntegrations` | `appSpec.features` | `appSpec.features.${number}.title` | `appSpec.features.${number}.description` | `appSpec.navigation` | `appSpec.appIconUrl`, 4>>;
|
|
673
824
|
/**
|
|
674
825
|
* Creates a new Plan and immediately generates it using the planning agent.
|
|
675
826
|
* @param plan - Plan to be created and generated.
|
|
@@ -683,7 +834,7 @@ declare function createPlan(plan: NonNullablePaths<Plan, `initialPrompt` | `plat
|
|
|
683
834
|
* @permissionId containers:plans:v1:plan:create_and_generate_plan
|
|
684
835
|
* @fqn wix.containers.plans.v1.ContainersPlans.CreateAndGeneratePlan
|
|
685
836
|
*/
|
|
686
|
-
declare function createAndGeneratePlan(plan: NonNullablePaths<Plan, `initialPrompt` | `platform` | `projectId` | `selectedTemplateId`, 0>): Promise<NonNullablePaths<CreateAndGeneratePlanResponse, `plan.initialPrompt` | `plan.platform` | `plan.status` | `plan.businessContext.businessName` | `plan.businessContext.businessLogoUrl` | `plan.businessContext.businessDescription` | `plan.businessContext.language` | `plan.businessContext.country` | `plan.businessContext.wixIntegrations` | `plan.brandIdentity.primaryColor` | `plan.brandIdentity.backgroundColor` | `plan.brandIdentity.contentColor` | `plan.brandIdentity.headingFont` | `plan.brandIdentity.bodyFont` | `plan.appSpec.appName` | `plan.appSpec.appDescription` | `plan.appSpec.businessGoal` | `plan.appSpec.audience` | `plan.appSpec.wixIntegrations` | `plan.appSpec.wixIntegrations.${number}.displayName` | `plan.appSpec.wixIntegrations.${number}.description` | `plan.appSpec.wixIntegrations.${number}._id` | `plan.appSpec.thirdPartyIntegrations` | `plan.appSpec.features` | `plan.appSpec.features.${number}.title` | `plan.appSpec.features.${number}.description` | `plan.appSpec.navigation` | `plan.appSpec.appIconUrl` | `followUpQuestions` | `followUpQuestionOptions` | `followUpQuestionOptions.${number}.question`,
|
|
837
|
+
declare function createAndGeneratePlan(plan: NonNullablePaths<Plan, `initialPrompt` | `platform` | `projectId` | `selectedTemplateId`, 0>): Promise<NonNullablePaths<CreateAndGeneratePlanResponse, `plan.initialPrompt` | `plan.platform` | `plan.status` | `plan.businessContext.businessName` | `plan.businessContext.businessLogoUrl` | `plan.businessContext.businessDescription` | `plan.businessContext.language` | `plan.businessContext.country` | `plan.businessContext.wixIntegrations` | `plan.businessContext.analysis.industry` | `plan.businessContext.analysis.summary` | `plan.businessContext.analysis.businessGoal` | `plan.businessContext.analysis.businessGoalConfidence` | `plan.businessContext.analysis.audience` | `plan.businessContext.analysis.keyOfferings` | `plan.businessContext.analysis.usableContent` | `plan.businessContext.analysis.usableContent.${number}.source` | `plan.businessContext.analysis.usableContent.${number}.description` | `plan.businessContext.analysis.installedVerticals` | `plan.businessContext.analysis.appFocus` | `plan.businessContext.analysis.toneOfVoice` | `plan.businessContext.analysis.toneExamples` | `plan.brandIdentity.primaryColor` | `plan.brandIdentity.backgroundColor` | `plan.brandIdentity.contentColor` | `plan.brandIdentity.headingFont` | `plan.brandIdentity.bodyFont` | `plan.appSpec.appName` | `plan.appSpec.appDescription` | `plan.appSpec.businessGoal` | `plan.appSpec.audience` | `plan.appSpec.wixIntegrations` | `plan.appSpec.wixIntegrations.${number}.displayName` | `plan.appSpec.wixIntegrations.${number}.description` | `plan.appSpec.wixIntegrations.${number}._id` | `plan.appSpec.thirdPartyIntegrations` | `plan.appSpec.features` | `plan.appSpec.features.${number}.title` | `plan.appSpec.features.${number}.description` | `plan.appSpec.navigation` | `plan.appSpec.appIconUrl` | `followUpQuestions` | `followUpQuestionOptions` | `followUpQuestionOptions.${number}.question`, 5>>;
|
|
687
838
|
/**
|
|
688
839
|
* Retrieves a Plan by its ID.
|
|
689
840
|
* @param planId - ID of the Plan to retrieve.
|
|
@@ -694,7 +845,7 @@ declare function createAndGeneratePlan(plan: NonNullablePaths<Plan, `initialProm
|
|
|
694
845
|
* @returns The requested Plan.
|
|
695
846
|
* @fqn wix.containers.plans.v1.ContainersPlans.GetPlan
|
|
696
847
|
*/
|
|
697
|
-
declare function getPlan(planId: string): Promise<NonNullablePaths<Plan, `initialPrompt` | `platform` | `status` | `businessContext.businessName` | `businessContext.businessLogoUrl` | `businessContext.businessDescription` | `businessContext.language` | `businessContext.country` | `businessContext.wixIntegrations` | `brandIdentity.primaryColor` | `brandIdentity.backgroundColor` | `brandIdentity.contentColor` | `brandIdentity.headingFont` | `brandIdentity.bodyFont` | `appSpec.appName` | `appSpec.appDescription` | `appSpec.businessGoal` | `appSpec.audience` | `appSpec.wixIntegrations` | `appSpec.wixIntegrations.${number}.displayName` | `appSpec.wixIntegrations.${number}.description` | `appSpec.wixIntegrations.${number}._id` | `appSpec.thirdPartyIntegrations` | `appSpec.features` | `appSpec.features.${number}.title` | `appSpec.features.${number}.description` | `appSpec.navigation` | `appSpec.appIconUrl`,
|
|
848
|
+
declare function getPlan(planId: string): Promise<NonNullablePaths<Plan, `initialPrompt` | `platform` | `status` | `businessContext.businessName` | `businessContext.businessLogoUrl` | `businessContext.businessDescription` | `businessContext.language` | `businessContext.country` | `businessContext.wixIntegrations` | `businessContext.analysis.industry` | `businessContext.analysis.summary` | `businessContext.analysis.businessGoal` | `businessContext.analysis.businessGoalConfidence` | `businessContext.analysis.audience` | `businessContext.analysis.keyOfferings` | `businessContext.analysis.usableContent` | `businessContext.analysis.usableContent.${number}.source` | `businessContext.analysis.usableContent.${number}.description` | `businessContext.analysis.installedVerticals` | `businessContext.analysis.appFocus` | `businessContext.analysis.toneOfVoice` | `businessContext.analysis.toneExamples` | `brandIdentity.primaryColor` | `brandIdentity.backgroundColor` | `brandIdentity.contentColor` | `brandIdentity.headingFont` | `brandIdentity.bodyFont` | `appSpec.appName` | `appSpec.appDescription` | `appSpec.businessGoal` | `appSpec.audience` | `appSpec.wixIntegrations` | `appSpec.wixIntegrations.${number}.displayName` | `appSpec.wixIntegrations.${number}.description` | `appSpec.wixIntegrations.${number}._id` | `appSpec.thirdPartyIntegrations` | `appSpec.features` | `appSpec.features.${number}.title` | `appSpec.features.${number}.description` | `appSpec.navigation` | `appSpec.appIconUrl`, 4>>;
|
|
698
849
|
/**
|
|
699
850
|
* Retrieves the (single) Plan for a project. Server-to-server: containers-projects uses this to
|
|
700
851
|
* read the finalized plan when creating the initial generation job.
|
|
@@ -705,7 +856,7 @@ declare function getPlan(planId: string): Promise<NonNullablePaths<Plan, `initia
|
|
|
705
856
|
* @permissionId containers:plans:v1:plan:get_plan_by_project_id
|
|
706
857
|
* @fqn wix.containers.plans.v1.ContainersPlans.GetPlanByProjectId
|
|
707
858
|
*/
|
|
708
|
-
declare function getPlanByProjectId(projectId: string): Promise<NonNullablePaths<GetPlanByProjectIdResponse, `plan.initialPrompt` | `plan.platform` | `plan.status` | `plan.businessContext.businessName` | `plan.businessContext.businessLogoUrl` | `plan.businessContext.businessDescription` | `plan.businessContext.language` | `plan.businessContext.country` | `plan.businessContext.wixIntegrations` | `plan.brandIdentity.primaryColor` | `plan.brandIdentity.backgroundColor` | `plan.brandIdentity.contentColor` | `plan.brandIdentity.headingFont` | `plan.brandIdentity.bodyFont` | `plan.appSpec.appName` | `plan.appSpec.appDescription` | `plan.appSpec.businessGoal` | `plan.appSpec.audience` | `plan.appSpec.wixIntegrations` | `plan.appSpec.wixIntegrations.${number}.displayName` | `plan.appSpec.wixIntegrations.${number}.description` | `plan.appSpec.wixIntegrations.${number}._id` | `plan.appSpec.thirdPartyIntegrations` | `plan.appSpec.features` | `plan.appSpec.features.${number}.title` | `plan.appSpec.features.${number}.description` | `plan.appSpec.navigation` | `plan.appSpec.appIconUrl`,
|
|
859
|
+
declare function getPlanByProjectId(projectId: string): Promise<NonNullablePaths<GetPlanByProjectIdResponse, `plan.initialPrompt` | `plan.platform` | `plan.status` | `plan.businessContext.businessName` | `plan.businessContext.businessLogoUrl` | `plan.businessContext.businessDescription` | `plan.businessContext.language` | `plan.businessContext.country` | `plan.businessContext.wixIntegrations` | `plan.businessContext.analysis.industry` | `plan.businessContext.analysis.summary` | `plan.businessContext.analysis.businessGoal` | `plan.businessContext.analysis.businessGoalConfidence` | `plan.businessContext.analysis.audience` | `plan.businessContext.analysis.keyOfferings` | `plan.businessContext.analysis.usableContent` | `plan.businessContext.analysis.usableContent.${number}.source` | `plan.businessContext.analysis.usableContent.${number}.description` | `plan.businessContext.analysis.installedVerticals` | `plan.businessContext.analysis.appFocus` | `plan.businessContext.analysis.toneOfVoice` | `plan.businessContext.analysis.toneExamples` | `plan.brandIdentity.primaryColor` | `plan.brandIdentity.backgroundColor` | `plan.brandIdentity.contentColor` | `plan.brandIdentity.headingFont` | `plan.brandIdentity.bodyFont` | `plan.appSpec.appName` | `plan.appSpec.appDescription` | `plan.appSpec.businessGoal` | `plan.appSpec.audience` | `plan.appSpec.wixIntegrations` | `plan.appSpec.wixIntegrations.${number}.displayName` | `plan.appSpec.wixIntegrations.${number}.description` | `plan.appSpec.wixIntegrations.${number}._id` | `plan.appSpec.thirdPartyIntegrations` | `plan.appSpec.features` | `plan.appSpec.features.${number}.title` | `plan.appSpec.features.${number}.description` | `plan.appSpec.navigation` | `plan.appSpec.appIconUrl`, 5>>;
|
|
709
860
|
/**
|
|
710
861
|
* Updates a Plan. The current revision must be passed for optimistic locking.
|
|
711
862
|
* @param _id - Plan ID.
|
|
@@ -718,7 +869,7 @@ declare function getPlanByProjectId(projectId: string): Promise<NonNullablePaths
|
|
|
718
869
|
* @returns The updated Plan.
|
|
719
870
|
* @fqn wix.containers.plans.v1.ContainersPlans.UpdatePlan
|
|
720
871
|
*/
|
|
721
|
-
declare function updatePlan(_id: string, plan: NonNullablePaths<UpdatePlan, `revision`, 0>): Promise<NonNullablePaths<Plan, `initialPrompt` | `platform` | `status` | `businessContext.businessName` | `businessContext.businessLogoUrl` | `businessContext.businessDescription` | `businessContext.language` | `businessContext.country` | `businessContext.wixIntegrations` | `brandIdentity.primaryColor` | `brandIdentity.backgroundColor` | `brandIdentity.contentColor` | `brandIdentity.headingFont` | `brandIdentity.bodyFont` | `appSpec.appName` | `appSpec.appDescription` | `appSpec.businessGoal` | `appSpec.audience` | `appSpec.wixIntegrations` | `appSpec.wixIntegrations.${number}.displayName` | `appSpec.wixIntegrations.${number}.description` | `appSpec.wixIntegrations.${number}._id` | `appSpec.thirdPartyIntegrations` | `appSpec.features` | `appSpec.features.${number}.title` | `appSpec.features.${number}.description` | `appSpec.navigation` | `appSpec.appIconUrl`,
|
|
872
|
+
declare function updatePlan(_id: string, plan: NonNullablePaths<UpdatePlan, `revision`, 0>): Promise<NonNullablePaths<Plan, `initialPrompt` | `platform` | `status` | `businessContext.businessName` | `businessContext.businessLogoUrl` | `businessContext.businessDescription` | `businessContext.language` | `businessContext.country` | `businessContext.wixIntegrations` | `businessContext.analysis.industry` | `businessContext.analysis.summary` | `businessContext.analysis.businessGoal` | `businessContext.analysis.businessGoalConfidence` | `businessContext.analysis.audience` | `businessContext.analysis.keyOfferings` | `businessContext.analysis.usableContent` | `businessContext.analysis.usableContent.${number}.source` | `businessContext.analysis.usableContent.${number}.description` | `businessContext.analysis.installedVerticals` | `businessContext.analysis.appFocus` | `businessContext.analysis.toneOfVoice` | `businessContext.analysis.toneExamples` | `brandIdentity.primaryColor` | `brandIdentity.backgroundColor` | `brandIdentity.contentColor` | `brandIdentity.headingFont` | `brandIdentity.bodyFont` | `appSpec.appName` | `appSpec.appDescription` | `appSpec.businessGoal` | `appSpec.audience` | `appSpec.wixIntegrations` | `appSpec.wixIntegrations.${number}.displayName` | `appSpec.wixIntegrations.${number}.description` | `appSpec.wixIntegrations.${number}._id` | `appSpec.thirdPartyIntegrations` | `appSpec.features` | `appSpec.features.${number}.title` | `appSpec.features.${number}.description` | `appSpec.navigation` | `appSpec.appIconUrl`, 4>>;
|
|
722
873
|
interface UpdatePlan {
|
|
723
874
|
/**
|
|
724
875
|
* Plan ID.
|
|
@@ -794,7 +945,7 @@ declare function deletePlan(planId: string): Promise<void>;
|
|
|
794
945
|
* @permissionId containers:plans:v1:plan:generate_plan
|
|
795
946
|
* @fqn wix.containers.plans.v1.ContainersPlans.GeneratePlan
|
|
796
947
|
*/
|
|
797
|
-
declare function generatePlan(planId: string): Promise<NonNullablePaths<GeneratePlanResponse, `plan.initialPrompt` | `plan.platform` | `plan.status` | `plan.businessContext.businessName` | `plan.businessContext.businessLogoUrl` | `plan.businessContext.businessDescription` | `plan.businessContext.language` | `plan.businessContext.country` | `plan.businessContext.wixIntegrations` | `plan.brandIdentity.primaryColor` | `plan.brandIdentity.backgroundColor` | `plan.brandIdentity.contentColor` | `plan.brandIdentity.headingFont` | `plan.brandIdentity.bodyFont` | `plan.appSpec.appName` | `plan.appSpec.appDescription` | `plan.appSpec.businessGoal` | `plan.appSpec.audience` | `plan.appSpec.wixIntegrations` | `plan.appSpec.wixIntegrations.${number}.displayName` | `plan.appSpec.wixIntegrations.${number}.description` | `plan.appSpec.wixIntegrations.${number}._id` | `plan.appSpec.thirdPartyIntegrations` | `plan.appSpec.features` | `plan.appSpec.features.${number}.title` | `plan.appSpec.features.${number}.description` | `plan.appSpec.navigation` | `plan.appSpec.appIconUrl` | `followUpQuestions` | `followUpQuestionOptions` | `followUpQuestionOptions.${number}.question`,
|
|
948
|
+
declare function generatePlan(planId: string): Promise<NonNullablePaths<GeneratePlanResponse, `plan.initialPrompt` | `plan.platform` | `plan.status` | `plan.businessContext.businessName` | `plan.businessContext.businessLogoUrl` | `plan.businessContext.businessDescription` | `plan.businessContext.language` | `plan.businessContext.country` | `plan.businessContext.wixIntegrations` | `plan.businessContext.analysis.industry` | `plan.businessContext.analysis.summary` | `plan.businessContext.analysis.businessGoal` | `plan.businessContext.analysis.businessGoalConfidence` | `plan.businessContext.analysis.audience` | `plan.businessContext.analysis.keyOfferings` | `plan.businessContext.analysis.usableContent` | `plan.businessContext.analysis.usableContent.${number}.source` | `plan.businessContext.analysis.usableContent.${number}.description` | `plan.businessContext.analysis.installedVerticals` | `plan.businessContext.analysis.appFocus` | `plan.businessContext.analysis.toneOfVoice` | `plan.businessContext.analysis.toneExamples` | `plan.brandIdentity.primaryColor` | `plan.brandIdentity.backgroundColor` | `plan.brandIdentity.contentColor` | `plan.brandIdentity.headingFont` | `plan.brandIdentity.bodyFont` | `plan.appSpec.appName` | `plan.appSpec.appDescription` | `plan.appSpec.businessGoal` | `plan.appSpec.audience` | `plan.appSpec.wixIntegrations` | `plan.appSpec.wixIntegrations.${number}.displayName` | `plan.appSpec.wixIntegrations.${number}.description` | `plan.appSpec.wixIntegrations.${number}._id` | `plan.appSpec.thirdPartyIntegrations` | `plan.appSpec.features` | `plan.appSpec.features.${number}.title` | `plan.appSpec.features.${number}.description` | `plan.appSpec.navigation` | `plan.appSpec.appIconUrl` | `followUpQuestions` | `followUpQuestionOptions` | `followUpQuestionOptions.${number}.question`, 5>>;
|
|
798
949
|
/**
|
|
799
950
|
* Modifies an existing Plan based on the user's answers to the previous iteration's
|
|
800
951
|
* follow-up questions plus an optional additional prompt. Returns the updated plan and
|
|
@@ -806,7 +957,7 @@ declare function generatePlan(planId: string): Promise<NonNullablePaths<Generate
|
|
|
806
957
|
* @permissionId containers:plans:v1:plan:modify_plan
|
|
807
958
|
* @fqn wix.containers.plans.v1.ContainersPlans.ModifyPlan
|
|
808
959
|
*/
|
|
809
|
-
declare function modifyPlan(planId: string, options?: ModifyPlanOptions): Promise<NonNullablePaths<ModifyPlanResponse, `plan.initialPrompt` | `plan.platform` | `plan.status` | `plan.businessContext.businessName` | `plan.businessContext.businessLogoUrl` | `plan.businessContext.businessDescription` | `plan.businessContext.language` | `plan.businessContext.country` | `plan.businessContext.wixIntegrations` | `plan.brandIdentity.primaryColor` | `plan.brandIdentity.backgroundColor` | `plan.brandIdentity.contentColor` | `plan.brandIdentity.headingFont` | `plan.brandIdentity.bodyFont` | `plan.appSpec.appName` | `plan.appSpec.appDescription` | `plan.appSpec.businessGoal` | `plan.appSpec.audience` | `plan.appSpec.wixIntegrations` | `plan.appSpec.wixIntegrations.${number}.displayName` | `plan.appSpec.wixIntegrations.${number}.description` | `plan.appSpec.wixIntegrations.${number}._id` | `plan.appSpec.thirdPartyIntegrations` | `plan.appSpec.features` | `plan.appSpec.features.${number}.title` | `plan.appSpec.features.${number}.description` | `plan.appSpec.navigation` | `plan.appSpec.appIconUrl` | `followUpQuestions` | `followUpQuestionOptions` | `followUpQuestionOptions.${number}.question`,
|
|
960
|
+
declare function modifyPlan(planId: string, options?: ModifyPlanOptions): Promise<NonNullablePaths<ModifyPlanResponse, `plan.initialPrompt` | `plan.platform` | `plan.status` | `plan.businessContext.businessName` | `plan.businessContext.businessLogoUrl` | `plan.businessContext.businessDescription` | `plan.businessContext.language` | `plan.businessContext.country` | `plan.businessContext.wixIntegrations` | `plan.businessContext.analysis.industry` | `plan.businessContext.analysis.summary` | `plan.businessContext.analysis.businessGoal` | `plan.businessContext.analysis.businessGoalConfidence` | `plan.businessContext.analysis.audience` | `plan.businessContext.analysis.keyOfferings` | `plan.businessContext.analysis.usableContent` | `plan.businessContext.analysis.usableContent.${number}.source` | `plan.businessContext.analysis.usableContent.${number}.description` | `plan.businessContext.analysis.installedVerticals` | `plan.businessContext.analysis.appFocus` | `plan.businessContext.analysis.toneOfVoice` | `plan.businessContext.analysis.toneExamples` | `plan.brandIdentity.primaryColor` | `plan.brandIdentity.backgroundColor` | `plan.brandIdentity.contentColor` | `plan.brandIdentity.headingFont` | `plan.brandIdentity.bodyFont` | `plan.appSpec.appName` | `plan.appSpec.appDescription` | `plan.appSpec.businessGoal` | `plan.appSpec.audience` | `plan.appSpec.wixIntegrations` | `plan.appSpec.wixIntegrations.${number}.displayName` | `plan.appSpec.wixIntegrations.${number}.description` | `plan.appSpec.wixIntegrations.${number}._id` | `plan.appSpec.thirdPartyIntegrations` | `plan.appSpec.features` | `plan.appSpec.features.${number}.title` | `plan.appSpec.features.${number}.description` | `plan.appSpec.navigation` | `plan.appSpec.appIconUrl` | `followUpQuestions` | `followUpQuestionOptions` | `followUpQuestionOptions.${number}.question`, 5>>;
|
|
810
961
|
interface ModifyPlanOptions {
|
|
811
962
|
/**
|
|
812
963
|
* The user's answers to the previous iteration's follow-up questions.
|
|
@@ -854,6 +1005,19 @@ declare function regenerateIcon(planId: string, prompt: string): Promise<NonNull
|
|
|
854
1005
|
* @permissionId containers:plans:v1:plan:finalize_plan
|
|
855
1006
|
* @fqn wix.containers.plans.v1.ContainersPlans.FinalizePlan
|
|
856
1007
|
*/
|
|
857
|
-
declare function finalizePlan(planId: string, conversationId: string): Promise<NonNullablePaths<FinalizePlanResponse, `plan.initialPrompt` | `plan.platform` | `plan.status` | `plan.businessContext.businessName` | `plan.businessContext.businessLogoUrl` | `plan.businessContext.businessDescription` | `plan.businessContext.language` | `plan.businessContext.country` | `plan.businessContext.wixIntegrations` | `plan.brandIdentity.primaryColor` | `plan.brandIdentity.backgroundColor` | `plan.brandIdentity.contentColor` | `plan.brandIdentity.headingFont` | `plan.brandIdentity.bodyFont` | `plan.appSpec.appName` | `plan.appSpec.appDescription` | `plan.appSpec.businessGoal` | `plan.appSpec.audience` | `plan.appSpec.wixIntegrations` | `plan.appSpec.wixIntegrations.${number}.displayName` | `plan.appSpec.wixIntegrations.${number}.description` | `plan.appSpec.wixIntegrations.${number}._id` | `plan.appSpec.thirdPartyIntegrations` | `plan.appSpec.features` | `plan.appSpec.features.${number}.title` | `plan.appSpec.features.${number}.description` | `plan.appSpec.navigation` | `plan.appSpec.appIconUrl`,
|
|
1008
|
+
declare function finalizePlan(planId: string, conversationId: string): Promise<NonNullablePaths<FinalizePlanResponse, `plan.initialPrompt` | `plan.platform` | `plan.status` | `plan.businessContext.businessName` | `plan.businessContext.businessLogoUrl` | `plan.businessContext.businessDescription` | `plan.businessContext.language` | `plan.businessContext.country` | `plan.businessContext.wixIntegrations` | `plan.businessContext.analysis.industry` | `plan.businessContext.analysis.summary` | `plan.businessContext.analysis.businessGoal` | `plan.businessContext.analysis.businessGoalConfidence` | `plan.businessContext.analysis.audience` | `plan.businessContext.analysis.keyOfferings` | `plan.businessContext.analysis.usableContent` | `plan.businessContext.analysis.usableContent.${number}.source` | `plan.businessContext.analysis.usableContent.${number}.description` | `plan.businessContext.analysis.installedVerticals` | `plan.businessContext.analysis.appFocus` | `plan.businessContext.analysis.toneOfVoice` | `plan.businessContext.analysis.toneExamples` | `plan.brandIdentity.primaryColor` | `plan.brandIdentity.backgroundColor` | `plan.brandIdentity.contentColor` | `plan.brandIdentity.headingFont` | `plan.brandIdentity.bodyFont` | `plan.appSpec.appName` | `plan.appSpec.appDescription` | `plan.appSpec.businessGoal` | `plan.appSpec.audience` | `plan.appSpec.wixIntegrations` | `plan.appSpec.wixIntegrations.${number}.displayName` | `plan.appSpec.wixIntegrations.${number}.description` | `plan.appSpec.wixIntegrations.${number}._id` | `plan.appSpec.thirdPartyIntegrations` | `plan.appSpec.features` | `plan.appSpec.features.${number}.title` | `plan.appSpec.features.${number}.description` | `plan.appSpec.navigation` | `plan.appSpec.appIconUrl`, 5>>;
|
|
1009
|
+
/**
|
|
1010
|
+
* Returns a first request and suggestion chips for the site in the call scope, made from the
|
|
1011
|
+
* site's business: its content, business goal and tone. The server keeps one business profile per
|
|
1012
|
+
* site, checks the site for changes at most every 30 days, and runs the analysis again only when
|
|
1013
|
+
* the site changed or once a year. Empty, with source NO_SUGGESTIONS, when the feature is off for
|
|
1014
|
+
* the site, the site gives nothing to use, or the first profile is not ready yet; then show the
|
|
1015
|
+
* static first prompt.
|
|
1016
|
+
* @internal
|
|
1017
|
+
* @documentationMaturity preview
|
|
1018
|
+
* @permissionId containers:plans:v1:plan:get_prompt_suggestions
|
|
1019
|
+
* @fqn wix.containers.plans.v1.ContainersPlans.GetPromptSuggestions
|
|
1020
|
+
*/
|
|
1021
|
+
declare function getPromptSuggestions(): Promise<NonNullablePaths<GetPromptSuggestionsResponse, `businessName` | `defaultPrompt` | `suggestions` | `suggestions.${number}.label` | `suggestions.${number}.prompt` | `source`, 2>>;
|
|
858
1022
|
|
|
859
|
-
export { type AccountInfo, type ActionEvent, type AnsweredQuestion, type AppSpec, type BrandIdentity, type BusinessContext, type CreateAndGeneratePlanRequest, type CreateAndGeneratePlanResponse, type CreatePlanRequest, type CreatePlanResponse, type DeletePlanRequest, type DeletePlanResponse, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type Feature, type FinalizePlanRequest, type FinalizePlanResponse, type FollowUpQuestion, type GeneratePlanRequest, type GeneratePlanResponse, type GetPlanByProjectIdRequest, type GetPlanByProjectIdResponse, type GetPlanRequest, type GetPlanResponse, type IdentificationData, type IdentificationDataIdOneOf, type Integration, type MessageEnvelope, type ModifyPlanOptions, type ModifyPlanRequest, type ModifyPlanResponse, type Plan, type PlanEditContext, type PlanFinalized, PlanPartType, type PlanPartTypeWithLiterals, PlanStatus, type PlanStatusWithLiterals, Platform, type PlatformWithLiterals, type RegenerateIconRequest, type RegenerateIconResponse, type RestoreInfo, type UpdatePlan, type UpdatePlanRequest, type UpdatePlanResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createAndGeneratePlan, createPlan, deletePlan, finalizePlan, generatePlan, getPlan, getPlanByProjectId, modifyPlan, regenerateIcon, updatePlan };
|
|
1023
|
+
export { type AccountInfo, type ActionEvent, type AnsweredQuestion, type AppSpec, type BrandIdentity, type BusinessAnalysis, type BusinessContext, BusinessGoalConfidence, type BusinessGoalConfidenceWithLiterals, ContentSource, type ContentSourceWithLiterals, type CreateAndGeneratePlanRequest, type CreateAndGeneratePlanResponse, type CreatePlanRequest, type CreatePlanResponse, type DeletePlanRequest, type DeletePlanResponse, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type Feature, type FinalizePlanRequest, type FinalizePlanResponse, type FollowUpQuestion, type GeneratePlanRequest, type GeneratePlanResponse, type GetPlanByProjectIdRequest, type GetPlanByProjectIdResponse, type GetPlanRequest, type GetPlanResponse, type GetPromptSuggestionsRequest, type GetPromptSuggestionsResponse, type IdentificationData, type IdentificationDataIdOneOf, type Integration, type MessageEnvelope, type ModifyPlanOptions, type ModifyPlanRequest, type ModifyPlanResponse, type Plan, type PlanEditContext, type PlanFinalized, PlanPartType, type PlanPartTypeWithLiterals, PlanStatus, type PlanStatusWithLiterals, Platform, type PlatformWithLiterals, type PromptSuggestion, PromptSuggestionsSource, type PromptSuggestionsSourceWithLiterals, type RegenerateIconRequest, type RegenerateIconResponse, type RestoreInfo, type UpdatePlan, type UpdatePlanRequest, type UpdatePlanResponse, type UsableContent, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createAndGeneratePlan, createPlan, deletePlan, finalizePlan, generatePlan, getPlan, getPlanByProjectId, getPromptSuggestions, modifyPlan, regenerateIcon, updatePlan };
|
|
@@ -1,4 +1,4 @@
|
|
|
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.mjs';
|
|
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, GetPromptSuggestionsRequest as GetPromptSuggestionsRequest$1, GetPromptSuggestionsResponse as GetPromptSuggestionsResponse$1 } from './index.typings.mjs';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
interface Plan {
|
|
@@ -116,7 +116,116 @@ interface BusinessContext {
|
|
|
116
116
|
* @format WEB_URL
|
|
117
117
|
*/
|
|
118
118
|
publicSiteUrl?: string | null;
|
|
119
|
+
/**
|
|
120
|
+
* What the server learned from the site's content before the first plan was generated: the
|
|
121
|
+
* business, its goal and the content an app can show. Absent for older plans, when the analysis
|
|
122
|
+
* is off for the site, or when it did not finish.
|
|
123
|
+
* @readonly
|
|
124
|
+
*/
|
|
125
|
+
analysis?: BusinessAnalysis;
|
|
126
|
+
}
|
|
127
|
+
/** A short analysis of the business, made from the site's content for the planning agent. */
|
|
128
|
+
interface BusinessAnalysis {
|
|
129
|
+
/**
|
|
130
|
+
* Industry of the business, for example "yoga studio".
|
|
131
|
+
* @maxLength 200
|
|
132
|
+
*/
|
|
133
|
+
industry?: string;
|
|
134
|
+
/**
|
|
135
|
+
* Short factual summary of the business and what its site offers.
|
|
136
|
+
* @maxLength 2000
|
|
137
|
+
*/
|
|
138
|
+
summary?: string;
|
|
139
|
+
/**
|
|
140
|
+
* The main outcome the business wants from its customers, for example "Get more class bookings".
|
|
141
|
+
* @maxLength 500
|
|
142
|
+
*/
|
|
143
|
+
businessGoal?: string;
|
|
144
|
+
/** How strongly the site's content supports business_goal. */
|
|
145
|
+
businessGoalConfidence?: BusinessGoalConfidenceWithLiterals;
|
|
146
|
+
/**
|
|
147
|
+
* Who the business's customers are.
|
|
148
|
+
* @maxLength 500
|
|
149
|
+
*/
|
|
150
|
+
audience?: string;
|
|
151
|
+
/**
|
|
152
|
+
* Main products or services the business offers, as named on the site.
|
|
153
|
+
* @maxSize 6
|
|
154
|
+
* @maxLength 200
|
|
155
|
+
*/
|
|
156
|
+
keyOfferings?: string[];
|
|
157
|
+
/**
|
|
158
|
+
* Site content of each kind that the generated app can show.
|
|
159
|
+
* @maxSize 10
|
|
160
|
+
*/
|
|
161
|
+
usableContent?: UsableContent[];
|
|
162
|
+
/**
|
|
163
|
+
* Names of the Wix business apps installed on the site, for example "Wix Bookings".
|
|
164
|
+
* @maxSize 30
|
|
165
|
+
* @maxLength 100
|
|
166
|
+
*/
|
|
167
|
+
installedVerticals?: string[];
|
|
168
|
+
/**
|
|
169
|
+
* Short points the app should focus on to serve business_goal.
|
|
170
|
+
* @maxSize 3
|
|
171
|
+
* @maxLength 300
|
|
172
|
+
*/
|
|
173
|
+
appFocus?: string[];
|
|
174
|
+
/**
|
|
175
|
+
* How the site's own text sounds to its customers, so the app's text can sound the same, for
|
|
176
|
+
* example "Warm and homely; short sentences; speaks to the customer as 'you'".
|
|
177
|
+
* @maxLength 500
|
|
178
|
+
*/
|
|
179
|
+
toneOfVoice?: string;
|
|
180
|
+
/**
|
|
181
|
+
* Up to three short phrases quoted from the site that show its tone of voice.
|
|
182
|
+
* @maxSize 3
|
|
183
|
+
* @maxLength 200
|
|
184
|
+
*/
|
|
185
|
+
toneExamples?: string[];
|
|
186
|
+
}
|
|
187
|
+
declare enum BusinessGoalConfidence {
|
|
188
|
+
/** The site gives little or conflicting evidence for the goal. */
|
|
189
|
+
LOW = "LOW",
|
|
190
|
+
/** The goal is a reasonable inference from the site. */
|
|
191
|
+
MEDIUM = "MEDIUM",
|
|
192
|
+
/** The goal follows directly from strong evidence, such as a booking app with services. */
|
|
193
|
+
HIGH = "HIGH"
|
|
194
|
+
}
|
|
195
|
+
/** @enumType */
|
|
196
|
+
type BusinessGoalConfidenceWithLiterals = BusinessGoalConfidence | 'LOW' | 'MEDIUM' | 'HIGH';
|
|
197
|
+
/** Site content of one kind that the generated app can show. */
|
|
198
|
+
interface UsableContent {
|
|
199
|
+
/** Where the content comes from. */
|
|
200
|
+
source?: ContentSourceWithLiterals;
|
|
201
|
+
/**
|
|
202
|
+
* What the content is, for example "12 yoga and pilates classes with prices".
|
|
203
|
+
* @maxLength 500
|
|
204
|
+
*/
|
|
205
|
+
description?: string;
|
|
206
|
+
/** Number of items found, when known. */
|
|
207
|
+
itemCount?: number | null;
|
|
208
|
+
}
|
|
209
|
+
declare enum ContentSource {
|
|
210
|
+
/** Wix Stores products. */
|
|
211
|
+
STORES = "STORES",
|
|
212
|
+
/** Wix Bookings services. */
|
|
213
|
+
BOOKINGS = "BOOKINGS",
|
|
214
|
+
/** Wix Events events. */
|
|
215
|
+
EVENTS = "EVENTS",
|
|
216
|
+
/** Wix Blog posts. */
|
|
217
|
+
BLOG = "BLOG",
|
|
218
|
+
/** Wix Pricing Plans plans. */
|
|
219
|
+
PRICING_PLANS = "PRICING_PLANS",
|
|
220
|
+
/** Wix Restaurants menu items. */
|
|
221
|
+
RESTAURANTS = "RESTAURANTS",
|
|
222
|
+
/** Wix CMS (Wix Data) collections. */
|
|
223
|
+
CMS = "CMS",
|
|
224
|
+
/** Text of the published site's home page. */
|
|
225
|
+
SITE_TEXT = "SITE_TEXT"
|
|
119
226
|
}
|
|
227
|
+
/** @enumType */
|
|
228
|
+
type ContentSourceWithLiterals = ContentSource | 'STORES' | 'BOOKINGS' | 'EVENTS' | 'BLOG' | 'PRICING_PLANS' | 'RESTAURANTS' | 'CMS' | 'SITE_TEXT';
|
|
120
229
|
/**
|
|
121
230
|
* Visual identity extracted from the user's existing website. Serves as an editable
|
|
122
231
|
* starting point for the generated app.
|
|
@@ -503,6 +612,48 @@ interface FinalizePlanResponse {
|
|
|
503
612
|
/** The finalized Plan. */
|
|
504
613
|
plan?: Plan;
|
|
505
614
|
}
|
|
615
|
+
interface GetPromptSuggestionsRequest {
|
|
616
|
+
}
|
|
617
|
+
interface GetPromptSuggestionsResponse {
|
|
618
|
+
/**
|
|
619
|
+
* Name of the business the suggestions are for. Empty when unknown.
|
|
620
|
+
* @maxLength 200
|
|
621
|
+
*/
|
|
622
|
+
businessName?: string;
|
|
623
|
+
/**
|
|
624
|
+
* The owner's first request, ready to send or to edit. Empty when there are no suggestions.
|
|
625
|
+
* @maxLength 500
|
|
626
|
+
*/
|
|
627
|
+
defaultPrompt?: string;
|
|
628
|
+
/**
|
|
629
|
+
* App ideas for this business, strongest first: none, or 3 to 5.
|
|
630
|
+
* @maxSize 5
|
|
631
|
+
*/
|
|
632
|
+
suggestions?: PromptSuggestion[];
|
|
633
|
+
/** Where the suggestions come from. */
|
|
634
|
+
source?: PromptSuggestionsSourceWithLiterals;
|
|
635
|
+
}
|
|
636
|
+
/** One suggestion chip. */
|
|
637
|
+
interface PromptSuggestion {
|
|
638
|
+
/**
|
|
639
|
+
* Short chip text, one line on a phone, for example "Workshop booking app".
|
|
640
|
+
* @maxLength 42
|
|
641
|
+
*/
|
|
642
|
+
label?: string;
|
|
643
|
+
/**
|
|
644
|
+
* The owner's full request that the chip puts in the prompt box.
|
|
645
|
+
* @maxLength 400
|
|
646
|
+
*/
|
|
647
|
+
prompt?: string;
|
|
648
|
+
}
|
|
649
|
+
declare enum PromptSuggestionsSource {
|
|
650
|
+
/** Made from the site's business profile. */
|
|
651
|
+
BUSINESS_PROFILE = "BUSINESS_PROFILE",
|
|
652
|
+
/** No suggestions: show the static first prompt. */
|
|
653
|
+
NO_SUGGESTIONS = "NO_SUGGESTIONS"
|
|
654
|
+
}
|
|
655
|
+
/** @enumType */
|
|
656
|
+
type PromptSuggestionsSourceWithLiterals = PromptSuggestionsSource | 'BUSINESS_PROFILE' | 'NO_SUGGESTIONS';
|
|
506
657
|
interface DomainEvent extends DomainEventBodyOneOf {
|
|
507
658
|
createdEvent?: EntityCreatedEvent;
|
|
508
659
|
updatedEvent?: EntityUpdatedEvent;
|
|
@@ -737,5 +888,6 @@ declare function regenerateIcon(): __PublicMethodMetaInfo<'POST', {
|
|
|
737
888
|
declare function finalizePlan(): __PublicMethodMetaInfo<'POST', {
|
|
738
889
|
planId: string;
|
|
739
890
|
}, FinalizePlanRequest$1, FinalizePlanRequest, FinalizePlanResponse$1, FinalizePlanResponse>;
|
|
891
|
+
declare function getPromptSuggestions(): __PublicMethodMetaInfo<'GET', {}, GetPromptSuggestionsRequest$1, GetPromptSuggestionsRequest, GetPromptSuggestionsResponse$1, GetPromptSuggestionsResponse>;
|
|
740
892
|
|
|
741
|
-
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 };
|
|
893
|
+
export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AnsweredQuestion as AnsweredQuestionOriginal, type AppSpec as AppSpecOriginal, type BrandIdentity as BrandIdentityOriginal, type BusinessAnalysis as BusinessAnalysisOriginal, type BusinessContext as BusinessContextOriginal, BusinessGoalConfidence as BusinessGoalConfidenceOriginal, type BusinessGoalConfidenceWithLiterals as BusinessGoalConfidenceWithLiteralsOriginal, ContentSource as ContentSourceOriginal, type ContentSourceWithLiterals as ContentSourceWithLiteralsOriginal, 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 GetPromptSuggestionsRequest as GetPromptSuggestionsRequestOriginal, type GetPromptSuggestionsResponse as GetPromptSuggestionsResponseOriginal, 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 PromptSuggestion as PromptSuggestionOriginal, PromptSuggestionsSource as PromptSuggestionsSourceOriginal, type PromptSuggestionsSourceWithLiterals as PromptSuggestionsSourceWithLiteralsOriginal, type RegenerateIconRequest as RegenerateIconRequestOriginal, type RegenerateIconResponse as RegenerateIconResponseOriginal, type RestoreInfo as RestoreInfoOriginal, type UpdatePlanRequest as UpdatePlanRequestOriginal, type UpdatePlanResponse as UpdatePlanResponseOriginal, type UsableContent as UsableContentOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, createAndGeneratePlan, createPlan, deletePlan, finalizePlan, generatePlan, getPlan, getPlanByProjectId, getPromptSuggestions, modifyPlan, regenerateIcon, updatePlan };
|