@wix/auto_sdk_seo_blog-post-candidates 1.0.0

package/build/cjs/index.typings.d.ts

@@ -0,0 +1,795 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
+/**
+ * A blog post candidate is a single blog post brief in a site's content plan.
+ *
+ * Each candidate pairs a target keyword with a suggested title, the search
+ * data behind that keyword, and the site page the post should support. A site
+ * owner uses a candidate as the starting point for writing a post.
+ *
+ * Candidates are generated by the content plan pipeline and are read-only.
+ * Call Create Content Plan to generate them, and List Blog Post Candidates to
+ * read them.
+ */
+interface BlogPostCandidate {
+    /**
+     * Blog post candidate ID.
+     *
+     * Treat this value as opaque. Don't parse it or build it yourself, and
+     * pass it back exactly as received. The individual IDs it's built from are
+     * available on `candidateData`.
+     * @maxLength 100
+     * @readonly
+     */
+    _id?: string | null;
+    /** IDs that identify the candidate and the flow that generated it. */
+    candidateData?: CandidateData;
+    /**
+     * The blog post brief itself: the suggested title, the target keywords,
+     * and the search data behind them.
+     */
+    briefData?: BriefData;
+    /**
+     * SEO tags suggested for the blog post, such as its title tag and meta
+     * description.
+     */
+    seoData?: SeoSchema;
+}
+interface CandidateData {
+    /**
+     * ID of the blog post candidate within its content plan flow.
+     * @format GUID
+     * @readonly
+     */
+    blogPostCandidateId?: string | null;
+    /**
+     * ID of the content plan flow that generated this candidate.
+     * @format GUID
+     * @readonly
+     */
+    contentPlanFlowId?: string | null;
+}
+interface BriefData {
+    /**
+     * Suggested title for the blog post.
+     * @maxLength 1000
+     */
+    h1Title?: string | null;
+    /**
+     * Keyword the blog post targets.
+     * @maxLength 1000
+     */
+    keyword?: string | null;
+    /**
+     * Primary keyword for the page the blog post supports.
+     *
+     * A page has a single main keyword, and several blog posts can support the
+     * same one.
+     * @maxLength 1000
+     */
+    mainKeyword?: string | null;
+    /**
+     * Search engine results data for `mainKeyword`, such as its search volume
+     * and how hard it is to rank for.
+     *
+     * List Blog Post Candidates doesn't currently return this field.
+     */
+    serpData?: SerpData;
+    /**
+     * URL of the site page the blog post is meant to support.
+     * @maxLength 1000
+     */
+    pageUrl?: string | null;
+}
+interface SerpData {
+    /**
+     * SerpDataResult ID
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * list of people also ask questions
+     * @maxSize 4
+     */
+    peopleAlsoAskSuggestions?: PeopleAlsoAskQuestion[];
+    /**
+     * list of related searches
+     * @maxSize 10
+     * @maxLength 10000
+     */
+    peopleAlsoSearchSuggestions?: string[] | null;
+    /**
+     * list of autocomplete suggestions
+     * @maxSize 15
+     * @maxLength 10000
+     */
+    autocompleteSuggestions?: string[] | null;
+}
+interface PeopleAlsoAskQuestion {
+    /**
+     * people also ask question title
+     * @maxLength 10000
+     */
+    question?: string | null;
+    /**
+     * answers to the question
+     * @maxSize 2
+     */
+    answers?: PeopleAlsoAskAnswer[];
+}
+interface PeopleAlsoAskAnswer {
+    /**
+     * people also ask answer title
+     * @maxLength 10000
+     */
+    title?: string | null;
+    /**
+     * description of the answer
+     * @maxLength 10000
+     */
+    description?: string | null;
+}
+/**
+ * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
+ * The search engines use this information for ranking purposes, or to display snippets in the search results.
+ * This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
+ */
+interface SeoSchema {
+    /** SEO tag information. */
+    tags?: Tag[];
+    /** SEO general settings. */
+    settings?: Settings;
+}
+interface Keyword {
+    /** Keyword value. */
+    term?: string;
+    /** Whether the keyword is the main focus keyword. */
+    isMain?: boolean;
+    /**
+     * The source that added the keyword terms to the SEO settings.
+     * @maxLength 1000
+     */
+    origin?: string | null;
+}
+interface Tag {
+    /**
+     * SEO tag type.
+     *
+     *
+     * Supported values: `title`, `meta`, `script`, `link`.
+     *
+     * Which of these an API actually accepts depends on where the tag is being set: this
+     * list is not a blanket guarantee across every API that reuses this message. Site SEO
+     * Tags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects
+     * `title`/`script`/`link` with a validation error even though they appear here —
+     * check the field description of the specific `tags`-typed field you're writing to
+     * for the types it actually supports and the error it returns.
+     *
+     * Limitation: `title` and `script` (e.g. a `script` tag with `props.type`
+     * `"application/ld+json"` carrying structured data) are supported only when
+     * `custom` is unset or `false`. Setting `custom: true` on a `title` or `script`
+     * tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the
+     * write through the site's Advanced/Custom Tags list. To write structured data,
+     * omit `custom` (or set it to `false`).
+     */
+    type?: string;
+    /**
+     * A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.
+     * For example: `{"name": "description", "content": "the description itself"}`.
+     */
+    props?: Record<string, any> | null;
+    /** SEO tag metadata. For example, `{"height": 300, "width": 240}`. */
+    meta?: Record<string, any> | null;
+    /** SEO tag inner content. For example, `<title> inner content </title>`. */
+    children?: string;
+    /**
+     * Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) —
+     * i.e. an entry from the site's Advanced/Custom Tags list.
+     *
+     * Setting this to `true` on a write restricts which `type` values are accepted
+     * — the same restriction the Advanced/Custom Tags UI enforces. `title` and
+     * `script` tags (including JSON-LD structured data) must be sent with `custom`
+     * omitted or `false`; sending them with `custom: true` is rejected with
+     * `TAG_TYPE_NOT_ALLOWED`.
+     *
+     * Note this is a separate restriction from Site SEO Tags' own type restriction on
+     * `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.
+     * for site-wide structured data) unconditionally. There is currently no way to set
+     * site-wide, every-page structured data through any of these APIs — write a per-page
+     * `script` tag through the Item SEO Tags API instead.
+     *
+     * This flag is scoped to that feature only. It is NOT an indicator of whether a standard tag
+     * (`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed
+     * default/pattern — standard tags always resolve with `custom: false`, even when their content comes
+     * from a page's manually saved SEO title/description override. Don't use this field to verify whether
+     * a live page reflects a manual per-page SEO edit.
+     *
+     * Limitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read
+     * only from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor
+     * or Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the
+     * response entirely — there, `false` means this API could not tell, not that no custom tag exists.
+     * Pass `seoData` explicitly to resolve against a known set of tags.
+     */
+    custom?: boolean;
+    /** Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. */
+    disabled?: boolean;
+}
+interface Settings {
+    /**
+     * Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.
+     *
+     *
+     * Default: `false` (automatical redirect is enabled).
+     */
+    preventAutoRedirect?: boolean;
+    /**
+     * User-selected keyword terms for a specific page.
+     * @maxSize 5
+     */
+    keywords?: Keyword[];
+}
+interface GetBlogPostCandidateRequest {
+    /**
+     * id of the content plan flow this blog post candidate belongs to
+     * @format GUID
+     */
+    contentPlanFlowId?: string | null;
+}
+interface GetBlogPostCandidateResponse {
+    /** blog post candidate */
+    blogPostCandidate?: BlogPostCandidate;
+}
+interface GetBlogPostCandidateByIdRequest {
+    /**
+     * id of the blog post candidate
+     * @minLength 1
+     * @maxLength 100
+     */
+    blogPostCandidateId?: string | null;
+}
+interface GetBlogPostCandidateByIdResponse {
+    /** blog post candidate */
+    blogPostCandidate?: BlogPostCandidate;
+}
+interface MarkBlogPostCandidateRequest {
+    /** ids of the blog post candidate */
+    candidateData?: CandidateData;
+    /**
+     * ID of the blog post that was created from this candidate.
+     * @format GUID
+     */
+    blogPostId?: string | null;
+}
+interface MarkBlogPostCandidateResponse {
+}
+interface BulkMarkBlogPostCandidatesRequest {
+    /**
+     * id of the content plan flow these blog post candidates belong to
+     * @format GUID
+     */
+    contentPlanFlowId?: string | null;
+    /**
+     * List of blog post candidates to mark
+     * @maxSize 1000
+     */
+    items?: BulkMarkBlogPostCandidateItem[];
+}
+interface BulkMarkBlogPostCandidateItem {
+    /**
+     * id of the blog post candidate
+     * @format GUID
+     */
+    blogPostCandidateId?: string | null;
+    /**
+     * generated blog post id
+     * @format GUID
+     */
+    blogPostId?: string | null;
+}
+interface BulkMarkBlogPostCandidatesResponse {
+    /**
+     * Per-entry results, correlated by `itemMetadata.originalIndex`.
+     * @maxSize 1000
+     */
+    results?: BulkMarkBlogPostCandidateResult[];
+    /** How many entries succeeded and how many failed. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface ItemMetadata {
+    /**
+     * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
+     * @maxLength 100
+     */
+    _id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+/** Result of marking one blog post candidate in a bulk request. */
+interface BulkMarkBlogPostCandidateResult {
+    /** Success/failure and error detail for this entry. */
+    itemMetadata?: ItemMetadata;
+}
+interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+interface ListBlogPostCandidatesRequest {
+    /**
+     * ID of the content plan flow to retrieve candidates for.
+     *
+     * Omit to read the site's most recent successful flow.
+     * @format GUID
+     */
+    contentPlanFlowId: string | null;
+    /**
+     * Whether to return only candidates that haven't been used for a blog post
+     * yet.
+     *
+     * A candidate is marked as used when a blog post is created from it in the
+     * Wix Blog product. An app can read this flag but can't set it, so track
+     * the posts you've written on your own side as well.
+     *
+     * Default: `false`, which returns every candidate.
+     */
+    includeOnlyUnmarked?: boolean | null;
+    /**
+     * Cursor paging. Omit for the first page.
+     *
+     * Omit this object entirely to return every candidate in a single response.
+     */
+    paging?: CursorPaging;
+}
+interface CursorPaging {
+    /**
+     * Max items per page. Default 50, max 100.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Cursor from a previous response. Omit for the first page.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+interface ListBlogPostCandidatesResponse {
+    /**
+     * Retrieved blog post candidates.
+     * @maxSize 1000
+     */
+    blogPostCandidates?: BlogPostCandidate[];
+    /** Paging metadata. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Items returned in this page. */
+    count?: number | null;
+    /** Cursors for next/previous page. */
+    cursors?: Cursors;
+    /** Whether there are more pages. */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /**
+     * Cursor for the next page.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor for the previous page.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+/** Deprecated alias request. Same fields as ListBlogPostCandidatesRequest. */
+interface QueryBlogPostCandidatesRequest {
+    /**
+     * Content plan flow ID.
+     * @format GUID
+     */
+    contentPlanFlowId?: string | null;
+    /** Whether to return only unmarked candidates. */
+    includeOnlyUnmarked?: boolean | null;
+    /** Cursor paging. */
+    paging?: CursorPaging;
+}
+/** Deprecated alias response. Same fields as ListBlogPostCandidatesResponse. */
+interface QueryBlogPostCandidatesResponse {
+    /**
+     * Blog post candidates.
+     * @maxSize 1000
+     */
+    blogPostCandidates?: BlogPostCandidate[];
+    /** Paging metadata. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface GetContentPlanRequest {
+    /** requested start date */
+    startDate?: Date | null;
+    /** requested end date */
+    endDate?: Date | null;
+}
+interface GetContentPlanResponse {
+    /** content plan */
+    contentPlan?: ContentPlan;
+}
+interface ContentPlan {
+    /**
+     * content plan columns
+     * @maxSize 10
+     */
+    columns?: Column[];
+    /**
+     * content plan rows
+     * @maxSize 1000
+     */
+    rows?: Row[];
+    /**
+     * description to show the user
+     * @maxLength 1000
+     */
+    description?: string | null;
+}
+interface Column {
+    /**
+     * key is the column identifier (e.g. "date", "post-h1", "tags")
+     * @maxLength 100
+     */
+    key?: string | null;
+    /** type of the column */
+    type?: ColumnTypeWithLiterals;
+    /** editable flag */
+    editable?: boolean;
+    /** limit of characters for the column */
+    limit?: number | null;
+    /**
+     * width of the column
+     * @maxLength 100
+     */
+    width?: string | null;
+}
+declare enum ColumnType {
+    TEXT = "TEXT",
+    DATE = "DATE",
+    TEXT_LONG = "TEXT_LONG"
+}
+/** @enumType */
+type ColumnTypeWithLiterals = ColumnType | 'TEXT' | 'DATE' | 'TEXT_LONG';
+interface Row {
+    /**
+     * id of the row
+     * @readonly
+     * @format GUID
+     */
+    _id?: string | null;
+    /** order of the row */
+    order?: number | null;
+    /** data of the row (key = column key, value = cell value) */
+    data?: Record<string, any> | null;
+    /** status */
+    status?: RowStatusWithLiterals;
+}
+declare enum RowStatus {
+    DRAFT = "DRAFT",
+    PUBLISHED = "PUBLISHED"
+}
+/** @enumType */
+type RowStatusWithLiterals = RowStatus | 'DRAFT' | 'PUBLISHED';
+interface UpdateContentPlanRequest {
+    /**
+     * updated content plan rows
+     * @maxSize 100
+     */
+    updatedRows?: Row[];
+    /**
+     * deleted content plan rows
+     * @maxSize 1000
+     * @maxLength 1000
+     */
+    deletedRows?: string[] | null;
+}
+interface UpdateContentPlanResponse {
+    /** updated content plan */
+    contentPlan?: ContentPlan;
+}
+interface CreateContentPlanRequest {
+    /**
+     * ID of the content plan flow to generate the blog post briefs for.
+     *
+     * Omit to use the site's most recent eligible flow.
+     * Do not remove the fallback — existing callers depend on it.
+     * @format GUID
+     */
+    contentPlanFlowId?: string | null;
+}
+interface CreateContentPlanResponse {
+    /**
+     * Whether the blog post briefs were generated.
+     *
+     * Check this field as well as the HTTP status. Some failures return `false`
+     * here rather than an error.
+     */
+    success?: boolean | null;
+    /**
+     * Reason the generation failed.
+     *
+     * Returned only when `success` is `false`.
+     * @maxLength 1000
+     */
+    message?: string | null;
+    /**
+     * ID of the content plan flow the briefs were generated under.
+     *
+     * When this method regenerates a plan for a flow that already succeeded,
+     * this is a new ID. Poll this ID rather than the one you sent.
+     * @format GUID
+     */
+    contentPlanFlowId?: string | null;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface AccountInfo {
+    /**
+     * ID of the Wix account associated with the event.
+     * @format GUID
+     */
+    accountId?: string | null;
+    /**
+     * ID of the parent Wix account. Only included when accountId belongs to a child account.
+     * @format GUID
+     */
+    parentAccountId?: string | null;
+    /**
+     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
+     * @format GUID
+     */
+    siteId?: string | null;
+}
+/** @docsIgnore */
+type CreateContentPlanApplicationErrors = {
+    code?: 'FLOW_NOT_READY_FOR_CONTENT_PLAN';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'CONTENT_PLAN_FLOW_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'CONTENT_PLAN_FLOW_CANCELED';
+    description?: string;
+    data?: Record<string, any>;
+};
+/**
+ * Retrieves a list of blog post candidates for a content plan flow.
+ *
+ * Omit `contentPlanFlowId` to read the site's most recent successful flow.
+ * A site whose flows are all still running, failed, or canceled returns a
+ * not found error.
+ *
+ * Omit `paging` to return every candidate in a single response. When
+ * `paging` is present, `limit` accepts 1 to 100 and defaults to 50.
+ *
+ * Results are sorted by the order the content plan assigns them, then by
+ * descending keyword score. The sort isn't configurable.
+ * @param contentPlanFlowId - ID of the content plan flow to retrieve candidates for.
+ *
+ * Omit to read the site's most recent successful flow.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField contentPlanFlowId
+ * @permissionId promote:seo:v1:content_plan_blog_post_candidate:list_blog_post_candidates
+ * @applicableIdentity APP
+ * @fqn wix.promote.seo.content.plan.v1.SeoBlogPostCandidateServiceV1.ListBlogPostCandidates
+ */
+declare function listBlogPostCandidates(contentPlanFlowId: string, options?: ListBlogPostCandidatesOptions): Promise<NonNullablePaths<ListBlogPostCandidatesResponse, `blogPostCandidates` | `blogPostCandidates.${number}.seoData.settings.preventAutoRedirect`, 6>>;
+interface ListBlogPostCandidatesOptions {
+    /**
+     * Whether to return only candidates that haven't been used for a blog post
+     * yet.
+     *
+     * A candidate is marked as used when a blog post is created from it in the
+     * Wix Blog product. An app can read this flag but can't set it, so track
+     * the posts you've written on your own side as well.
+     *
+     * Default: `false`, which returns every candidate.
+     */
+    includeOnlyUnmarked?: boolean | null;
+    /**
+     * Cursor paging. Omit for the first page.
+     *
+     * Omit this object entirely to return every candidate in a single response.
+     */
+    paging?: CursorPaging;
+}
+/**
+ * Generates the blog post briefs for a content plan flow.
+ *
+ * A content plan flow stops at `KEYWORD_RESEARCH` and waits. Call this
+ * method to generate the briefs and let the flow continue to `SUCCESS`,
+ * then poll Get Content Plan Flow to follow it. A flow that's only polled
+ * never completes.
+ *
+ * Called on a flow that already reached `SUCCESS`, this method regenerates
+ * the plan under a separate content plan flow. The response carries the new
+ * `contentPlanFlowId`, and you poll that ID rather than the original. The
+ * original flow keeps its own candidates.
+ *
+ * Check `success` in the response as well as the HTTP status. A request
+ * that omits `contentPlanFlowId` reports every failure that way, with
+ * `success` set to `false` and the reason in `message` rather than an
+ * error. A generation failure reports that way even when you do send the
+ * ID.
+ *
+ * Call this method once for a flow and wait for it to return. Concurrent
+ * calls for the same site can produce duplicate content plans.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId promote:seo:v1:content_plan_blog_post_candidate:create_content_plan
+ * @applicableIdentity APP
+ * @fqn wix.promote.seo.content.plan.v1.SeoBlogPostCandidateServiceV1.CreateContentPlan
+ */
+declare function createContentPlan(options?: CreateContentPlanOptions): Promise<CreateContentPlanResponse & {
+    __applicationErrorsType?: CreateContentPlanApplicationErrors;
+}>;
+interface CreateContentPlanOptions {
+    /**
+     * ID of the content plan flow to generate the blog post briefs for.
+     *
+     * Omit to use the site's most recent eligible flow.
+     * Do not remove the fallback — existing callers depend on it.
+     * @format GUID
+     */
+    contentPlanFlowId?: string | null;
+}
+
+export { type AccountInfo, type ActionEvent, type ApplicationError, type BlogPostCandidate, type BriefData, type BulkActionMetadata, type BulkMarkBlogPostCandidateItem, type BulkMarkBlogPostCandidateResult, type BulkMarkBlogPostCandidatesRequest, type BulkMarkBlogPostCandidatesResponse, type CandidateData, type Column, ColumnType, type ColumnTypeWithLiterals, type ContentPlan, type CreateContentPlanApplicationErrors, type CreateContentPlanOptions, type CreateContentPlanRequest, type CreateContentPlanResponse, type CursorPaging, type CursorPagingMetadata, type Cursors, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type GetBlogPostCandidateByIdRequest, type GetBlogPostCandidateByIdResponse, type GetBlogPostCandidateRequest, type GetBlogPostCandidateResponse, type GetContentPlanRequest, type GetContentPlanResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type Keyword, type ListBlogPostCandidatesOptions, type ListBlogPostCandidatesRequest, type ListBlogPostCandidatesResponse, type MarkBlogPostCandidateRequest, type MarkBlogPostCandidateResponse, type MessageEnvelope, type PeopleAlsoAskAnswer, type PeopleAlsoAskQuestion, type QueryBlogPostCandidatesRequest, type QueryBlogPostCandidatesResponse, type RestoreInfo, type Row, RowStatus, type RowStatusWithLiterals, type SeoSchema, type SerpData, type Settings, type Tag, type UpdateContentPlanRequest, type UpdateContentPlanResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createContentPlan, listBlogPostCandidates };