@wix/auto_sdk_seo_page-optimization 1.0.0

package/build/internal/cjs/meta.d.ts

@@ -0,0 +1,224 @@
+import { TriggerPageOptimizationRequest as TriggerPageOptimizationRequest$1, TriggerPageOptimizationResponse as TriggerPageOptimizationResponse$1, TriggerHomePageOptimizationRequest as TriggerHomePageOptimizationRequest$1, TriggerHomePageOptimizationResponse as TriggerHomePageOptimizationResponse$1, GetPageOptimizationResultsRequest as GetPageOptimizationResultsRequest$1, GetPageOptimizationResultsResponse as GetPageOptimizationResultsResponse$1 } from './index.typings.js';
+import '@wix/sdk-types';
+
+/**
+ * A whole-page set of SEO optimization suggestions, generated for one page
+ * and focus keyword.
+ *
+ * Each suggestion is a before/after pair: `before` is the page's current
+ * text (empty when the page has none, such as a missing meta description),
+ * and `after` is the suggested replacement. Locate the element to change by
+ * its `before` text.
+ */
+interface PageOptimization {
+    /**
+     * ID of this suggestion set.
+     * @format GUID
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Suggested title tag.
+     * @readonly
+     */
+    metaTitle?: TextSuggestion;
+    /**
+     * Suggested description tag.
+     * @readonly
+     */
+    metaDescription?: TextSuggestion;
+    /**
+     * Suggested H1 heading.
+     * @readonly
+     */
+    h1?: TextSuggestion;
+    /**
+     * Suggested H2 or H3 heading.
+     * @readonly
+     */
+    h2OrH3?: TextSuggestion;
+    /**
+     * Suggested body text rewrites.
+     * @readonly
+     * @maxSize 100
+     */
+    content?: TextSuggestion[];
+}
+/** One suggested text change. */
+interface TextSuggestion {
+    /**
+     * The page's current text. Empty when the page has no text in this slot —
+     * for example, a missing meta description.
+     * @readonly
+     * @maxLength 1000
+     */
+    before?: string | null;
+    /**
+     * The suggested text.
+     * @readonly
+     * @maxLength 1000
+     */
+    after?: string;
+}
+interface TriggerPageOptimizationRequest {
+    /**
+     * ID of the site page to optimize.
+     * @maxLength 1000
+     * @minLength 1
+     */
+    pageId: string;
+    /**
+     * URL path of the page, relative to the site's domain. For example,
+     * `/about`.
+     * @maxLength 1000
+     * @minLength 1
+     */
+    pagePath: string;
+}
+interface TriggerPageOptimizationResponse {
+    /**
+     * ID of the generation job. Pass to Get Page Optimization Results.
+     * @readonly
+     * @maxLength 200
+     */
+    predictionId?: string;
+}
+interface TriggerHomePageOptimizationRequest {
+    /**
+     * ID of the site's homepage.
+     * @maxLength 1000
+     * @minLength 1
+     */
+    pageId: string;
+    /**
+     * URL path of the homepage. Usually `/`.
+     * @maxLength 1000
+     * @minLength 1
+     */
+    pagePath: string;
+}
+interface TriggerHomePageOptimizationResponse {
+    /**
+     * ID of the generation job. Pass to Get Page Optimization Results.
+     * @readonly
+     * @maxLength 200
+     */
+    predictionId?: string;
+}
+interface GetPageOptimizationResultsRequest {
+    /**
+     * ID of the generation job, from the trigger call.
+     * @maxLength 200
+     */
+    predictionId?: string | null;
+    /**
+     * ID of the page to retrieve suggestions for. An alternative to
+     * `predictionId` — returns the page's latest generation.
+     * @maxLength 1000
+     */
+    pageId?: string | null;
+}
+interface GetPageOptimizationResultsResponse {
+    /** The generated suggestions. Returned only when `status` is `COMPLETED`. */
+    pageOptimization?: PageOptimization;
+    /**
+     * Status of the generation job the lookup matched.
+     * @readonly
+     */
+    status?: OptimizationStatusWithLiterals;
+}
+/** Status of a page optimization generation job. */
+declare enum OptimizationStatus {
+    UNKNOWN_OPTIMIZATION_STATUS = "UNKNOWN_OPTIMIZATION_STATUS",
+    /**
+     * No generation job matches the lookup — it never existed, or a later
+     * trigger for the same page replaced it.
+     */
+    NOT_FOUND = "NOT_FOUND",
+    /** Generation is still running. Poll again. */
+    IN_PROGRESS = "IN_PROGRESS",
+    /** Generation finished; the response carries the suggestions. */
+    COMPLETED = "COMPLETED",
+    /** Generation failed. Trigger again to retry. */
+    FAILED = "FAILED"
+}
+/** @enumType */
+type OptimizationStatusWithLiterals = OptimizationStatus | 'UNKNOWN_OPTIMIZATION_STATUS' | 'NOT_FOUND' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
+/** @docsIgnore */
+type TriggerPageOptimizationApplicationErrors = {
+    code?: 'SITE_NOT_SUPPORTED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'FOCUS_KEYWORD_NOT_SET';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'CONTENT_TOO_SHORT';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'SUGGESTIONS_ALREADY_IN_PROGRESS';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'GENERATION_FAILED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'QUOTA_LIMIT_REACHED';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type TriggerHomePageOptimizationApplicationErrors = {
+    code?: 'SITE_NOT_SUPPORTED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'FOCUS_KEYWORD_NOT_SET';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'CONTENT_TOO_SHORT';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'SUGGESTIONS_ALREADY_IN_PROGRESS';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'GENERATION_FAILED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'QUOTA_LIMIT_REACHED';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type GetPageOptimizationResultsApplicationErrors = {
+    code?: 'GENERATION_FAILED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'QUOTA_LIMIT_REACHED';
+    description?: string;
+    data?: Record<string, any>;
+};
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function triggerPageOptimization(): __PublicMethodMetaInfo<'POST', {}, TriggerPageOptimizationRequest$1, TriggerPageOptimizationRequest, TriggerPageOptimizationResponse$1, TriggerPageOptimizationResponse>;
+declare function triggerHomePageOptimization(): __PublicMethodMetaInfo<'POST', {}, TriggerHomePageOptimizationRequest$1, TriggerHomePageOptimizationRequest, TriggerHomePageOptimizationResponse$1, TriggerHomePageOptimizationResponse>;
+declare function getPageOptimizationResults(): __PublicMethodMetaInfo<'GET', {}, GetPageOptimizationResultsRequest$1, GetPageOptimizationResultsRequest, GetPageOptimizationResultsResponse$1, GetPageOptimizationResultsResponse>;
+
+export { type GetPageOptimizationResultsApplicationErrors as GetPageOptimizationResultsApplicationErrorsOriginal, type GetPageOptimizationResultsRequest as GetPageOptimizationResultsRequestOriginal, type GetPageOptimizationResultsResponse as GetPageOptimizationResultsResponseOriginal, OptimizationStatus as OptimizationStatusOriginal, type OptimizationStatusWithLiterals as OptimizationStatusWithLiteralsOriginal, type PageOptimization as PageOptimizationOriginal, type TextSuggestion as TextSuggestionOriginal, type TriggerHomePageOptimizationApplicationErrors as TriggerHomePageOptimizationApplicationErrorsOriginal, type TriggerHomePageOptimizationRequest as TriggerHomePageOptimizationRequestOriginal, type TriggerHomePageOptimizationResponse as TriggerHomePageOptimizationResponseOriginal, type TriggerPageOptimizationApplicationErrors as TriggerPageOptimizationApplicationErrorsOriginal, type TriggerPageOptimizationRequest as TriggerPageOptimizationRequestOriginal, type TriggerPageOptimizationResponse as TriggerPageOptimizationResponseOriginal, type __PublicMethodMetaInfo, getPageOptimizationResults, triggerHomePageOptimization, triggerPageOptimization };

package/build/internal/es/index.d.mts

@@ -0,0 +1,65 @@
+import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { TriggerPageOptimizationOptions, TriggerPageOptimizationResponse, TriggerPageOptimizationApplicationErrors, TriggerHomePageOptimizationOptions, TriggerHomePageOptimizationResponse, TriggerHomePageOptimizationApplicationErrors, GetPageOptimizationResultsOptions, GetPageOptimizationResultsResponse, GetPageOptimizationResultsApplicationErrors } from './index.typings.mjs';
+export { GetPageOptimizationResultsRequest, OptimizationStatus, OptimizationStatusWithLiterals, PageOptimization, TextSuggestion, TriggerHomePageOptimizationRequest, TriggerPageOptimizationRequest } from './index.typings.mjs';
+
+declare function triggerPageOptimization$1(httpClient: HttpClient): TriggerPageOptimizationSignature;
+interface TriggerPageOptimizationSignature {
+    /**
+     * Starts generating optimization suggestions for a site page.
+     *
+     * The suggestions target the page's focus keyword, so set it first: run
+     * keyword research, set the chosen keyword as the page's focus keyword,
+     * then trigger. Returns a `predictionId` to poll Get Page Optimization
+     * Results with.
+     *
+     * Triggering is idempotent per page: while a generation for the page is in
+     * progress, calling again returns the same `predictionId` instead of
+     * starting a new job — unless the page's focus keyword changed since the
+     * job started, which returns a `SUGGESTIONS_ALREADY_IN_PROGRESS` error.
+     * @param - ID of the site page to optimize.
+     */
+    (pageId: string, options: NonNullablePaths<TriggerPageOptimizationOptions, `pagePath`, 2>): Promise<NonNullablePaths<TriggerPageOptimizationResponse, `predictionId`, 2> & {
+        __applicationErrorsType?: TriggerPageOptimizationApplicationErrors;
+    }>;
+}
+declare function triggerHomePageOptimization$1(httpClient: HttpClient): TriggerHomePageOptimizationSignature;
+interface TriggerHomePageOptimizationSignature {
+    /**
+     * Starts generating optimization suggestions for the site's homepage.
+     *
+     * The homepage gets its own method because its suggestions are generated
+     * with homepage-specific guidance — representing the whole site, not one
+     * topic. Same contract as Trigger Page Optimization: the homepage's focus
+     * keyword must be set first, the call returns a `predictionId` to poll,
+     * and triggering is idempotent per page while a job is in progress.
+     * @param - ID of the site's homepage.
+     */
+    (pageId: string, options: NonNullablePaths<TriggerHomePageOptimizationOptions, `pagePath`, 2>): Promise<NonNullablePaths<TriggerHomePageOptimizationResponse, `predictionId`, 2> & {
+        __applicationErrorsType?: TriggerHomePageOptimizationApplicationErrors;
+    }>;
+}
+declare function getPageOptimizationResults$1(httpClient: HttpClient): GetPageOptimizationResultsSignature;
+interface GetPageOptimizationResultsSignature {
+    /**
+     * Retrieves the optimization suggestions generated for a page.
+     *
+     * Poll this method after a trigger call. The response's `status` reports
+     * where the job stands: while generation is still in progress the
+     * suggestions are empty and `status` is `IN_PROGRESS`; when it completes,
+     * the response carries the full suggestion set with `status` `COMPLETED`.
+     * A job that failed reports `FAILED` — trigger again to retry. Suggestions
+     * are stored per page — a later trigger for the same page replaces them,
+     * and a replaced job's lookup reports `NOT_FOUND`.
+     *
+     * Look up by `predictionId` (from the trigger call), or by `pageId`.
+     */
+    (options?: GetPageOptimizationResultsOptions): Promise<NonNullablePaths<GetPageOptimizationResultsResponse, `pageOptimization.metaTitle.after` | `pageOptimization.content` | `status`, 4> & {
+        __applicationErrorsType?: GetPageOptimizationResultsApplicationErrors;
+    }>;
+}
+
+declare const triggerPageOptimization: MaybeContext<BuildRESTFunction<typeof triggerPageOptimization$1> & typeof triggerPageOptimization$1>;
+declare const triggerHomePageOptimization: MaybeContext<BuildRESTFunction<typeof triggerHomePageOptimization$1> & typeof triggerHomePageOptimization$1>;
+declare const getPageOptimizationResults: MaybeContext<BuildRESTFunction<typeof getPageOptimizationResults$1> & typeof getPageOptimizationResults$1>;
+
+export { GetPageOptimizationResultsApplicationErrors, GetPageOptimizationResultsOptions, GetPageOptimizationResultsResponse, TriggerHomePageOptimizationApplicationErrors, TriggerHomePageOptimizationOptions, TriggerHomePageOptimizationResponse, TriggerPageOptimizationApplicationErrors, TriggerPageOptimizationOptions, TriggerPageOptimizationResponse, getPageOptimizationResults, triggerHomePageOptimization, triggerPageOptimization };

package/build/internal/es/index.typings.d.mts

@@ -0,0 +1,306 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
+/**
+ * A whole-page set of SEO optimization suggestions, generated for one page
+ * and focus keyword.
+ *
+ * Each suggestion is a before/after pair: `before` is the page's current
+ * text (empty when the page has none, such as a missing meta description),
+ * and `after` is the suggested replacement. Locate the element to change by
+ * its `before` text.
+ */
+interface PageOptimization {
+    /**
+     * ID of this suggestion set.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Suggested title tag.
+     * @readonly
+     */
+    metaTitle?: TextSuggestion;
+    /**
+     * Suggested description tag.
+     * @readonly
+     */
+    metaDescription?: TextSuggestion;
+    /**
+     * Suggested H1 heading.
+     * @readonly
+     */
+    h1?: TextSuggestion;
+    /**
+     * Suggested H2 or H3 heading.
+     * @readonly
+     */
+    h2OrH3?: TextSuggestion;
+    /**
+     * Suggested body text rewrites.
+     * @readonly
+     * @maxSize 100
+     */
+    content?: TextSuggestion[];
+}
+/** One suggested text change. */
+interface TextSuggestion {
+    /**
+     * The page's current text. Empty when the page has no text in this slot —
+     * for example, a missing meta description.
+     * @readonly
+     * @maxLength 1000
+     */
+    before?: string | null;
+    /**
+     * The suggested text.
+     * @readonly
+     * @maxLength 1000
+     */
+    after?: string;
+}
+interface TriggerPageOptimizationRequest {
+    /**
+     * ID of the site page to optimize.
+     * @maxLength 1000
+     * @minLength 1
+     */
+    pageId: string;
+    /**
+     * URL path of the page, relative to the site's domain. For example,
+     * `/about`.
+     * @maxLength 1000
+     * @minLength 1
+     */
+    pagePath: string;
+}
+interface TriggerPageOptimizationResponse {
+    /**
+     * ID of the generation job. Pass to Get Page Optimization Results.
+     * @readonly
+     * @maxLength 200
+     */
+    predictionId?: string;
+}
+interface TriggerHomePageOptimizationRequest {
+    /**
+     * ID of the site's homepage.
+     * @maxLength 1000
+     * @minLength 1
+     */
+    pageId: string;
+    /**
+     * URL path of the homepage. Usually `/`.
+     * @maxLength 1000
+     * @minLength 1
+     */
+    pagePath: string;
+}
+interface TriggerHomePageOptimizationResponse {
+    /**
+     * ID of the generation job. Pass to Get Page Optimization Results.
+     * @readonly
+     * @maxLength 200
+     */
+    predictionId?: string;
+}
+interface GetPageOptimizationResultsRequest {
+    /**
+     * ID of the generation job, from the trigger call.
+     * @maxLength 200
+     */
+    predictionId?: string | null;
+    /**
+     * ID of the page to retrieve suggestions for. An alternative to
+     * `predictionId` — returns the page's latest generation.
+     * @maxLength 1000
+     */
+    pageId?: string | null;
+}
+interface GetPageOptimizationResultsResponse {
+    /** The generated suggestions. Returned only when `status` is `COMPLETED`. */
+    pageOptimization?: PageOptimization;
+    /**
+     * Status of the generation job the lookup matched.
+     * @readonly
+     */
+    status?: OptimizationStatusWithLiterals;
+}
+/** Status of a page optimization generation job. */
+declare enum OptimizationStatus {
+    UNKNOWN_OPTIMIZATION_STATUS = "UNKNOWN_OPTIMIZATION_STATUS",
+    /**
+     * No generation job matches the lookup — it never existed, or a later
+     * trigger for the same page replaced it.
+     */
+    NOT_FOUND = "NOT_FOUND",
+    /** Generation is still running. Poll again. */
+    IN_PROGRESS = "IN_PROGRESS",
+    /** Generation finished; the response carries the suggestions. */
+    COMPLETED = "COMPLETED",
+    /** Generation failed. Trigger again to retry. */
+    FAILED = "FAILED"
+}
+/** @enumType */
+type OptimizationStatusWithLiterals = OptimizationStatus | 'UNKNOWN_OPTIMIZATION_STATUS' | 'NOT_FOUND' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
+/** @docsIgnore */
+type TriggerPageOptimizationApplicationErrors = {
+    code?: 'SITE_NOT_SUPPORTED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'FOCUS_KEYWORD_NOT_SET';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'CONTENT_TOO_SHORT';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'SUGGESTIONS_ALREADY_IN_PROGRESS';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'GENERATION_FAILED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'QUOTA_LIMIT_REACHED';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type TriggerHomePageOptimizationApplicationErrors = {
+    code?: 'SITE_NOT_SUPPORTED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'FOCUS_KEYWORD_NOT_SET';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'CONTENT_TOO_SHORT';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'SUGGESTIONS_ALREADY_IN_PROGRESS';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'GENERATION_FAILED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'QUOTA_LIMIT_REACHED';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type GetPageOptimizationResultsApplicationErrors = {
+    code?: 'GENERATION_FAILED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'QUOTA_LIMIT_REACHED';
+    description?: string;
+    data?: Record<string, any>;
+};
+/**
+ * Starts generating optimization suggestions for a site page.
+ *
+ * The suggestions target the page's focus keyword, so set it first: run
+ * keyword research, set the chosen keyword as the page's focus keyword,
+ * then trigger. Returns a `predictionId` to poll Get Page Optimization
+ * Results with.
+ *
+ * Triggering is idempotent per page: while a generation for the page is in
+ * progress, calling again returns the same `predictionId` instead of
+ * starting a new job — unless the page's focus keyword changed since the
+ * job started, which returns a `SUGGESTIONS_ALREADY_IN_PROGRESS` error.
+ * @param pageId - ID of the site page to optimize.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options
+ * @requiredField options.pagePath
+ * @requiredField pageId
+ * @permissionId seo:suggestions:v1:page_optimization:trigger_page_optimization
+ * @applicableIdentity APP
+ * @fqn wix.seo.suggestions.v1.PageOptimizationService.TriggerPageOptimization
+ */
+declare function triggerPageOptimization(pageId: string, options: NonNullablePaths<TriggerPageOptimizationOptions, `pagePath`, 2>): Promise<NonNullablePaths<TriggerPageOptimizationResponse, `predictionId`, 2> & {
+    __applicationErrorsType?: TriggerPageOptimizationApplicationErrors;
+}>;
+interface TriggerPageOptimizationOptions {
+    /**
+     * URL path of the page, relative to the site's domain. For example,
+     * `/about`.
+     * @maxLength 1000
+     * @minLength 1
+     */
+    pagePath: string;
+}
+/**
+ * Starts generating optimization suggestions for the site's homepage.
+ *
+ * The homepage gets its own method because its suggestions are generated
+ * with homepage-specific guidance — representing the whole site, not one
+ * topic. Same contract as Trigger Page Optimization: the homepage's focus
+ * keyword must be set first, the call returns a `predictionId` to poll,
+ * and triggering is idempotent per page while a job is in progress.
+ * @param pageId - ID of the site's homepage.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options
+ * @requiredField options.pagePath
+ * @requiredField pageId
+ * @permissionId seo:suggestions:v1:page_optimization:trigger_home_page_optimization
+ * @applicableIdentity APP
+ * @fqn wix.seo.suggestions.v1.PageOptimizationService.TriggerHomePageOptimization
+ */
+declare function triggerHomePageOptimization(pageId: string, options: NonNullablePaths<TriggerHomePageOptimizationOptions, `pagePath`, 2>): Promise<NonNullablePaths<TriggerHomePageOptimizationResponse, `predictionId`, 2> & {
+    __applicationErrorsType?: TriggerHomePageOptimizationApplicationErrors;
+}>;
+interface TriggerHomePageOptimizationOptions {
+    /**
+     * URL path of the homepage. Usually `/`.
+     * @maxLength 1000
+     * @minLength 1
+     */
+    pagePath: string;
+}
+/**
+ * Retrieves the optimization suggestions generated for a page.
+ *
+ * Poll this method after a trigger call. The response's `status` reports
+ * where the job stands: while generation is still in progress the
+ * suggestions are empty and `status` is `IN_PROGRESS`; when it completes,
+ * the response carries the full suggestion set with `status` `COMPLETED`.
+ * A job that failed reports `FAILED` — trigger again to retry. Suggestions
+ * are stored per page — a later trigger for the same page replaces them,
+ * and a replaced job's lookup reports `NOT_FOUND`.
+ *
+ * Look up by `predictionId` (from the trigger call), or by `pageId`.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId seo:suggestions:v1:page_optimization:get_page_optimization_results
+ * @applicableIdentity APP
+ * @fqn wix.seo.suggestions.v1.PageOptimizationService.GetPageOptimizationResults
+ */
+declare function getPageOptimizationResults(options?: GetPageOptimizationResultsOptions): Promise<NonNullablePaths<GetPageOptimizationResultsResponse, `pageOptimization.metaTitle.after` | `pageOptimization.content` | `status`, 4> & {
+    __applicationErrorsType?: GetPageOptimizationResultsApplicationErrors;
+}>;
+interface GetPageOptimizationResultsOptions {
+    /**
+     * ID of the generation job, from the trigger call.
+     * @maxLength 200
+     */
+    predictionId?: string | null;
+    /**
+     * ID of the page to retrieve suggestions for. An alternative to
+     * `predictionId` — returns the page's latest generation.
+     * @maxLength 1000
+     */
+    pageId?: string | null;
+}
+
+export { type GetPageOptimizationResultsApplicationErrors, type GetPageOptimizationResultsOptions, type GetPageOptimizationResultsRequest, type GetPageOptimizationResultsResponse, OptimizationStatus, type OptimizationStatusWithLiterals, type PageOptimization, type TextSuggestion, type TriggerHomePageOptimizationApplicationErrors, type TriggerHomePageOptimizationOptions, type TriggerHomePageOptimizationRequest, type TriggerHomePageOptimizationResponse, type TriggerPageOptimizationApplicationErrors, type TriggerPageOptimizationOptions, type TriggerPageOptimizationRequest, type TriggerPageOptimizationResponse, getPageOptimizationResults, triggerHomePageOptimization, triggerPageOptimization };