import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types'; import { GetSeoPatternOptions, GetSeoPatternResponse, GetSeoPatternApplicationErrors, ListSeoPatternsResponse, ListSeoPatternVariablesResponse, ListSeoPatternVariablesApplicationErrors, SeoPattern, CreateSeoPatternApplicationErrors, SetSeoPatternOptions, SetSeoPatternResponse, SetSeoPatternApplicationErrors, ResetSeoPatternToDefaultOptions, ResetSeoPatternToDefaultResponse, ResetSeoPatternToDefaultApplicationErrors } from './index.typings.js'; export { AccountInfo, ActionEvent, CreateSeoPatternRequest, CreateSeoPatternResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, GetSeoPatternRequest, IdentificationData, IdentificationDataIdOneOf, ListSeoPatternVariablesRequest, ListSeoPatternsRequest, MessageEnvelope, Origin, OriginWithLiterals, PatternSource, PatternSourceWithLiterals, ResetSeoPatternToDefaultRequest, RestoreInfo, SeoPatternBlob, SeoPatternVariable, SetSeoPatternRequest, Tag, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js'; declare function getSeoPattern$1(httpClient: HttpClient): GetSeoPatternSignature; interface GetSeoPatternSignature { /** * Retrieves the SEO pattern in effect for a page type. * * The response contains the site's own pattern in `pattern`, and the pattern Wix * provides in `defaultPattern`. `source` reports which of the two is in effect. * `pattern` is empty when the site has no pattern of its own. * @param - Page type whose pattern to retrieve. Send a known page type name, such as * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`. * * An unknown name fails with `UNSUPPORTED_PAGE_TYPE`. A known page type whose Wix * business solution isn't installed on the site fails with `PAGE_TYPE_NOT_ON_SITE`. * * See the list of [common page * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types). */ (pageType: string, options?: GetSeoPatternOptions): Promise & { __applicationErrorsType?: GetSeoPatternApplicationErrors; }>; } declare function listSeoPatterns$1(httpClient: HttpClient): ListSeoPatternsSignature; interface ListSeoPatternsSignature { /** * Retrieves the patterns stored for a site, one per page type. * * Only returns page types that have had a pattern of the site's own stored, so a page * type that has never had one is absent. A page type that was reset to its default remains in the * list, with an empty `pattern` and `source` of `PATTERN_SOURCE_DEFAULT`. */ (): Promise>; } declare function listSeoPatternVariables$1(httpClient: HttpClient): ListSeoPatternVariablesSignature; interface ListSeoPatternVariablesSignature { /** * Retrieves the variables a pattern for a page type may reference. * * Call this method to retrieve the valid variables for a page type before writing a * pattern. * * Variables for the page's own tags and variables for its structured data are returned * in separate fields, and a pattern may use either. * @param - Page type whose variables to retrieve. Send a known page type name, such as * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`. * * An unknown name fails with `UNSUPPORTED_PAGE_TYPE`. A known page type whose Wix * business solution isn't installed on the site fails with `PAGE_TYPE_NOT_ON_SITE`. * * See the list of [common page * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types). */ (pageType: string): Promise & { __applicationErrorsType?: ListSeoPatternVariablesApplicationErrors; }>; } declare function createSeoPattern$1(httpClient: HttpClient): CreateSeoPatternSignature; interface CreateSeoPatternSignature { /** * Creates a pattern for a page type that's still on its Wix default. * * The pattern must contain at least one tag. To leave a page type on its Wix default, * create nothing for it. * * To change a pattern that already exists, call [Set SEO * Pattern](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/set-seo-pattern). * @param - Page type to create a pattern for. Send a known page type name, such as * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`. * * An unknown name fails with `UNSUPPORTED_PAGE_TYPE`. A known page type whose Wix * business solution isn't installed on the site fails with `PAGE_TYPE_NOT_ON_SITE`. * * See the list of [common page * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types). * @param - Pattern to create for the page type. * * `pattern` is the only field to send. The page type comes from the request path, and * every other field is read-only. To create a pattern for a single page built from a * Wix Data collection, set `pageId`. * @returns The created pattern, with `source` reporting that the site's own pattern is now in * effect. */ (pageType: string, seoPattern: SeoPattern): Promise & { __applicationErrorsType?: CreateSeoPatternApplicationErrors; }>; } declare function setSeoPattern$1(httpClient: HttpClient): SetSeoPatternSignature; interface SetSeoPatternSignature { /** * Changes the pattern a site has for a page type. * * Setting `pattern` replaces the page type's tag templates in full, so retrieve the * pattern first and send back the complete set you want it to have. Sending an empty * pattern clears it, which returns the page type to its Wix default. * * This method changes a pattern that already exists rather than creating one. For a page * type still on its Wix default, call [Create SEO * Pattern](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/create-seo-pattern) * instead. * * A pattern has no revision, and the site's SEO settings in the dashboard write to the * same pattern. The last write wins, so retrieve the pattern immediately before writing * it. * @param - Page type whose pattern to change. Send a known page type name, such as * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`. * * An unknown name fails with `UNSUPPORTED_PAGE_TYPE`. * * See the list of [common page * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types). * @param - Pattern to set for the page type. * * `pattern` is the only writable field, and setting it replaces the page type's tag * templates in full. Sending an empty pattern clears it, which returns the page type to * its Wix default. */ (pageType: string, seoPattern: SeoPattern, options?: NonNullablePaths): Promise & { __applicationErrorsType?: SetSeoPatternApplicationErrors; }>; } declare function resetSeoPatternToDefault$1(httpClient: HttpClient): ResetSeoPatternToDefaultSignature; interface ResetSeoPatternToDefaultSignature { /** * Removes the pattern a site has for a page type, so the Wix default applies again. * * The response reports the page type after the reset, with an empty `pattern` and * `source` of `PATTERN_SOURCE_DEFAULT`. * @param - Page type whose pattern to reset. Send a known page type name, such as * `STATIC_PAGE`, `BLOG_POST`, or `STORES_PRODUCT`. * * An unknown name fails with `UNSUPPORTED_PAGE_TYPE`. * * See the list of [common page * types](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/introduction#page-types). */ (pageType: string, options?: ResetSeoPatternToDefaultOptions): Promise & { __applicationErrorsType?: ResetSeoPatternToDefaultApplicationErrors; }>; } declare const getSeoPattern: MaybeContext & typeof getSeoPattern$1>; declare const listSeoPatterns: MaybeContext & typeof listSeoPatterns$1>; declare const listSeoPatternVariables: MaybeContext & typeof listSeoPatternVariables$1>; declare const createSeoPattern: MaybeContext & typeof createSeoPattern$1>; declare const setSeoPattern: MaybeContext & typeof setSeoPattern$1>; declare const resetSeoPatternToDefault: MaybeContext & typeof resetSeoPatternToDefault$1>; export { CreateSeoPatternApplicationErrors, GetSeoPatternApplicationErrors, GetSeoPatternOptions, GetSeoPatternResponse, ListSeoPatternVariablesApplicationErrors, ListSeoPatternVariablesResponse, ListSeoPatternsResponse, ResetSeoPatternToDefaultApplicationErrors, ResetSeoPatternToDefaultOptions, ResetSeoPatternToDefaultResponse, SeoPattern, SetSeoPatternApplicationErrors, SetSeoPatternOptions, SetSeoPatternResponse, createSeoPattern, getSeoPattern, listSeoPatternVariables, listSeoPatterns, resetSeoPatternToDefault, setSeoPattern };