@wix/auto_sdk_seo_redirects 1.0.0

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

@@ -0,0 +1,787 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
+/**
+ * Represent redirect entity
+ *
+ * This service is a proxy in front of the Redirector
+ * (com.wixpress.redirector.api.v1.RedirectsApi), which owns the storage. Two platform entity
+ * fields are therefore deliberately absent, and the matching rules are disabled below:
+ *
+ * - `revision`: the Redirector has no revision column and no optimistic concurrency. Writes are
+ * last-write-wins. Synthesising a revision we cannot enforce would be worse than omitting it.
+ * - `updated_date`: the Redirector tracks creation only (its `date_created`), so there is no
+ * source for a modification timestamp.
+ *
+ * `id` is present but client-assignable (a StringValue, not a server-assigned `string`), because
+ * the Redirector's Upsert accepts a caller-supplied id and CreateRedirect/AddRedirects/
+ * AddGroupRedirects have always passed one through. Changing it would break both the wire and
+ * existing callers.
+ *
+ * `Source`'s zero value carries no enum_maturity because the enum is defined in the Redirector's
+ * proto (com/wixpress/redirector/api/v1/redirects.proto), not here. Redirects are not user-taggable.
+ */
+interface Redirect {
+    /**
+     * The path that is intercepted from. Accepts only an encoded string.
+     *
+     * Capped at 950 to match the Redirector's own `from_path`, which is where this ends up. Without
+     * the cap an over-long path is accepted here and only rejected downstream, after this service has
+     * already begun writing.
+     *
+     * No `minLength`: the service rejects an empty path itself, and adding one here would move that
+     * rejection into the gateway and change the error payload of the deprecated Add* endpoints.
+     * @maxLength 950
+     */
+    from?: string;
+    /**
+     * The path that is going to be resolved to. Either a path on the site or a full URL, encoded.
+     *
+     * Capped at 4096 to match the Redirector's own `target`.
+     * @maxLength 4096
+     */
+    to?: string;
+    /** additional options for the redirect */
+    options?: RedirectOptions;
+    /**
+     * When provided, defines a language specific redirect. Otherwise, defines a general redirect.
+     * @minLength 2
+     * @maxLength 5
+     */
+    language?: string | null;
+    /**
+     * Unique identifier for the redirect
+     * @format GUID
+     */
+    _id?: string | null;
+    /**
+     * Date the redirect was created. Sourced from the Redirector's `date_created`.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+}
+/** options and configurations specific for the redirect */
+interface RedirectOptions {
+    /** set to true for group redirects */
+    groupRedirect?: boolean;
+}
+declare enum Source {
+    /** Unknown. */
+    UNKNOWN_SOURCE = "UNKNOWN_SOURCE",
+    /** A route is created by user in SEO tab. */
+    REDIRECTOR = "REDIRECTOR",
+    /** A route is created via offline process (e.g., blogs migration). */
+    REDIRECTOR_NON_USER_FACING = "REDIRECTOR_NON_USER_FACING",
+    /** A route is created on page slug rename. */
+    PAGE_SLUG_RENAME = "PAGE_SLUG_RENAME"
+}
+/** @enumType */
+type SourceWithLiterals = Source | 'UNKNOWN_SOURCE' | 'REDIRECTOR' | 'REDIRECTOR_NON_USER_FACING' | 'PAGE_SLUG_RENAME';
+/** The request for adding bulk redirects */
+interface AddRedirectsRequest {
+    /**
+     * Capped at the Redirector's own bulk limit of 500, which is what this ends up calling. The
+     * service chunks larger batches, but an unbounded request array is a memory risk with no caller
+     * asking for it - and BulkCreateRedirects, which replaces this endpoint, already declares 500.
+     *
+     * No `minSize`: the service already rejects an empty array with its own message, and adding one
+     * here would add a second field violation to this deprecated endpoint's error payload.
+     * @maxSize 500
+     */
+    redirects?: Redirect[];
+    /** Extra options for adding bulk redirects */
+    options?: AddRedirectsOptions;
+}
+/** Add bulk extra options and configurations */
+interface AddRedirectsOptions {
+    /** Should be true if the domain will be included to the redirect */
+    requireDomain?: boolean;
+}
+/** The response for adding bulk redirects */
+interface AddRedirectsResponse {
+    /**
+     * Capped at the Redirector's own bulk limit of 500, which is what this ends up calling. The
+     * service chunks larger batches, but an unbounded request array is a memory risk with no caller
+     * asking for it - and BulkCreateRedirects, which replaces this endpoint, already declares 500.
+     *
+     * No `minSize`: the service already rejects an empty array with its own message, and adding one
+     * here would add a second field violation to this deprecated endpoint's error payload.
+     * @maxSize 500
+     */
+    redirects?: Redirect[];
+}
+/** The request for adding group redirects */
+interface AddGroupRedirectsRequest {
+    /**
+     * Capped at the Redirector's own bulk limit of 500, which is what this ends up calling. The
+     * service chunks larger batches, but an unbounded request array is a memory risk with no caller
+     * asking for it - and BulkCreateRedirects, which replaces this endpoint, already declares 500.
+     *
+     * No `minSize`: the service already rejects an empty array with its own message, and adding one
+     * here would add a second field violation to this deprecated endpoint's error payload.
+     * @maxSize 500
+     */
+    redirects?: Redirect[];
+    /** Extra options for adding group redirects */
+    options?: AddGroupRedirectsOptions;
+}
+/** Add group extra options and configurations */
+interface AddGroupRedirectsOptions {
+    /** Should be true if the domain will be included to the redirect */
+    requireDomain?: boolean;
+}
+/** The response for adding group redirects */
+interface AddGroupRedirectsResponse {
+    /**
+     * Capped at the Redirector's own bulk limit of 500, which is what this ends up calling. The
+     * service chunks larger batches, but an unbounded request array is a memory risk with no caller
+     * asking for it - and BulkCreateRedirects, which replaces this endpoint, already declares 500.
+     *
+     * No `minSize`: the service already rejects an empty array with its own message, and adding one
+     * here would add a second field violation to this deprecated endpoint's error payload.
+     * @maxSize 500
+     */
+    redirects?: Redirect[];
+}
+/**
+ * The request for deleting redirects in bulk.
+ *
+ * Redirects are addressed by id, but the Redirector matches redirects by path rather than by id, so
+ * the service resolves each id to the stored redirect before deleting it. A caller therefore sends
+ * ids and never has to reconstruct an entity.
+ *
+ * The 1-500 bound is the Redirector's own `maxRedirectsPerRequest`, not a number chosen here.
+ */
+interface BulkDeleteRedirectsRequest {
+    /**
+     * Unique identifiers of the redirects to delete
+     * @minSize 1
+     * @maxSize 500
+     * @format GUID
+     */
+    redirectIds: string[];
+}
+/**
+ * The response for deleting redirects in bulk.
+ *
+ * One result per requested id, in request order - `item_metadata.original_index` is the index in
+ * `redirect_ids`. Per-item semantics:
+ *
+ * - `success` true means the redirect was found and sent to the Redirector for deletion. It is not a
+ * confirmation that the redirect is gone: the Redirector's BulkRemove returns no per-item outcome,
+ * so there is nothing to confirm it against.
+ * - `success` false with `error.code` REDIRECT_NOT_FOUND means no redirect on this site carries that
+ * id. The call still succeeds and every other id is still sent to the Redirector, under the same
+ * `success` meaning as above.
+ *
+ * `item` is never populated - there is no created entity to return.
+ */
+interface BulkDeleteRedirectsResponse {
+    /**
+     * Per-item outcome, in request order
+     * @maxSize 500
+     */
+    results?: BulkRedirectResult[];
+    /** Totals for the bulk action: successes, failures and undetailed failures */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+/** The result of creating a single redirect within a bulk request */
+interface BulkRedirectResult {
+    /** Index, id and success/error details for this item */
+    itemMetadata?: ItemMetadata;
+    /** The created redirect. Only populated when return_full_entity is true */
+    item?: Redirect;
+}
+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;
+}
+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;
+}
+/** The request for listing the site's redirects */
+interface ListRedirectsRequest {
+}
+/**
+ * The response for listing the site's redirects.
+ *
+ * Unpaged, so there is no paging_metadata: the Redirector's Get returns every redirect for the
+ * site in a single response and offers no paging or filtering of its own. Paging here would mean
+ * reading the whole set and then slicing it, which costs the same and buys the caller nothing.
+ * Revisit if the Redirector ever gains real paging.
+ *
+ * Unbounded for the same reason, mirroring the Redirector's own GetResponse.redirects, which
+ * declares no maxSize. The 500 in the Redirector's protos bounds its bulk *write* requests
+ * (Upsert, Remove, Validate); it is not a ceiling on how many redirects a site can hold.
+ */
+interface ListRedirectsResponse {
+    /** The site's redirects */
+    redirects?: Redirect[];
+}
+/** The request for retrieving a single redirect by id */
+interface GetRedirectRequest {
+    /**
+     * Unique identifier of the redirect to retrieve
+     * @format GUID
+     */
+    redirectId: string;
+}
+/** The response for retrieving a single redirect */
+interface GetRedirectResponse {
+    /** The retrieved redirect */
+    redirect?: Redirect;
+}
+/**
+ * The request for creating redirects in bulk.
+ *
+ * Unlike the deprecated AddRedirects and AddGroupRedirects, the exact-versus-group choice is taken
+ * per redirect from `options.groupRedirect` rather than being fixed by the endpoint.
+ */
+interface BulkCreateRedirectsRequest {
+    /**
+     * The redirects to create
+     * @minSize 1
+     * @maxSize 500
+     */
+    redirects: Redirect[];
+    /** Set to true to return the created redirects, not just their metadata */
+    returnFullEntity?: boolean;
+    /** Extra options for creating redirects in bulk */
+    options?: BulkCreateRedirectsOptions;
+}
+/** Bulk create options and configurations */
+interface BulkCreateRedirectsOptions {
+    /** set to true to replace a conflicting redirect's from-url instead of failing that item */
+    forceReplace?: boolean;
+}
+/** The response for creating redirects in bulk */
+interface BulkCreateRedirectsResponse {
+    /**
+     * Per-item outcome, in request order
+     * @maxSize 500
+     */
+    results?: BulkRedirectResult[];
+    /** Totals for the bulk action: successes, failures and undetailed failures */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+/** The request for creating a redirect */
+interface CreateRedirectRequest {
+    /** The redirect to create */
+    redirect: Redirect;
+    /** Extra options for creating a redirect */
+    options?: CreateRedirectOptions;
+}
+/** Create redirect options and configurations */
+interface CreateRedirectOptions {
+    /** set to true when need to replace a conflicting redirect's from-url (if it exists) */
+    forceReplace?: boolean;
+}
+/** The response for creating a redirect */
+interface CreateRedirectResponse {
+    /** The created redirect */
+    redirect?: Redirect;
+}
+/** The request for deleting a single redirect by id */
+interface DeleteRedirectRequest {
+    /**
+     * Unique identifier of the redirect to delete
+     * @format GUID
+     */
+    redirectId: string;
+}
+/** The response for deleting a single redirect */
+interface DeleteRedirectResponse {
+}
+/** The request for removing a general (all languages) redirect */
+interface RemoveGeneralRedirectRequest {
+    /** general redirect to be removed. its language property should be empty */
+    redirect?: Redirect;
+    /**
+     * language for which this general redirect should be removed
+     * @minLength 2
+     * @maxLength 5
+     */
+    applicableLanguage?: string | null;
+    /** Extra options for removing general redirect */
+    options?: RemoveGeneralRedirectsOptions;
+}
+/** remove general (all languages) redirect options and configurations */
+interface RemoveGeneralRedirectsOptions {
+    /** Should be true if the domain will be included to the redirect */
+    requireDomain?: boolean;
+}
+/** The response for removing a general (all languages) redirect */
+interface RemoveGeneralRedirectResponse {
+    /** added redirects */
+    redirects?: Redirect[];
+}
+/** The request for getting http status */
+interface GetHttpStatusRequest {
+    /**
+     * url
+     * @maxLength 1000
+     */
+    url?: string | null;
+}
+/** The response for getting http status */
+interface GetHttpStatusResponse {
+    /** http status code */
+    status?: number | null;
+    /**
+     * http status text
+     * @maxLength 100
+     */
+    statusText?: string | null;
+}
+/** Request to delete all redirects scoped to a specific language code. */
+interface CleanupLanguageRedirectsRequest {
+    /**
+     * Language code of redirects to remove (e.g. "fr", "en-US").
+     * @minLength 2
+     * @maxLength 5
+     */
+    languageCode?: string;
+}
+/**
+ * Response with counts describing the cleanup outcome.
+ * found_count vs removed_count lets callers detect partial failures
+ * (a future per-batch failure-handling change may diverge the two).
+ */
+interface CleanupLanguageRedirectsResponse {
+    /** Number of redirects found for the given language before cleanup. */
+    foundCount?: number;
+    /** Number of redirects successfully removed for the given language. */
+    removedCount?: number;
+}
+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 GetRedirectApplicationErrors = {
+    code?: 'REDIRECT_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type CreateRedirectApplicationErrors = {
+    code?: 'FROM_URL_EXISTS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type DeleteRedirectApplicationErrors = {
+    code?: 'REDIRECT_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+};
+interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /** 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;
+    accountInfo?: AccountInfoMetadata;
+}
+interface AccountInfoMetadata {
+    /** ID of the Wix account associated with the event */
+    accountId: string;
+    /** ID of the Wix site associated with the event. Only included when the event is tied to a specific site. */
+    siteId?: string;
+    /** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
+    parentAccountId?: string;
+}
+interface RedirectCreatedEnvelope {
+    entity: Redirect;
+    metadata: EventMetadata;
+}
+/** @webhook
+ * @eventType wix.promote.seo.v1.redirect_created
+ * @serviceIdentifier com.wixpress.promote.seo.redirects.api.RedirectsService
+ * @slug created
+ * @documentationMaturity preview
+ */
+declare function onRedirectCreated(handler: (event: RedirectCreatedEnvelope) => void | Promise<void>): void;
+/**
+ * Deletes redirects in bulk, by id.
+ *
+ * An id that matches no redirect on the site fails only its own item - the batch proceeds and every
+ * other id is still sent. See BulkDeleteRedirectsResponse for what `success` does and does not
+ * promise: the Redirector's BulkRemove reports no per-item outcome, so a successful item means
+ * resolved-and-sent rather than confirmed-deleted.
+ *
+ * Language-scoped redirects are a known gap. The Redirector filters its stored-row delete to
+ * redirects without a language, so a language-scoped redirect loses its route but keeps its stored
+ * row. DeleteRedirect behaves identically - this is upstream behaviour rather than something this
+ * endpoint introduces.
+ *
+ * Example, with one unknown id:
+ *
+ * POST /v1/bulk/redirects/delete
+ * { "redirectIds": ["<a>", "<b>", "<unknown>"] }
+ *
+ * 200 {
+ * "results": [
+ * { "itemMetadata": { "id": "<a>", "originalIndex": 0, "success": true } },
+ * { "itemMetadata": { "id": "<b>", "originalIndex": 1, "success": true } },
+ * { "itemMetadata": { "id": "<unknown>", "originalIndex": 2, "success": false,
+ * "error": { "code": "REDIRECT_NOT_FOUND",
+ * "description": "Redirect <unknown> was not found" } } }
+ * ],
+ * "bulkActionMetadata": { "totalSuccesses": 2, "totalFailures": 1, "undetailedFailures": 0 }
+ * }
+ *
+ * Permission naming and domain events follow the rest of this service: `wix-seo.*` is what the
+ * Redirector itself checks, and no CUD event is emitted because this service owns no storage, so
+ * emitting one only here would leave consumers reading the absence of an event as the absence of a
+ * change.
+ * @param redirectIds - Unique identifiers of the redirects to delete
+ * @public
+ * @documentationMaturity preview
+ * @requiredField redirectIds
+ * @permissionId wix-seo.edit
+ * @applicableIdentity APP
+ * @returns The response for deleting redirects in bulk.
+ *
+ * One result per requested id, in request order - `item_metadata.original_index` is the index in
+ * `redirect_ids`. Per-item semantics:
+ *
+ * - `success` true means the redirect was found and sent to the Redirector for deletion. It is not a
+ * confirmation that the redirect is gone: the Redirector's BulkRemove returns no per-item outcome,
+ * so there is nothing to confirm it against.
+ * - `success` false with `error.code` REDIRECT_NOT_FOUND means no redirect on this site carries that
+ * id. The call still succeeds and every other id is still sent to the Redirector, under the same
+ * `success` meaning as above.
+ *
+ * `item` is never populated - there is no created entity to return.
+ * @fqn com.wixpress.promote.seo.redirects.api.RedirectsService.BulkDeleteRedirects
+ */
+declare function bulkDeleteRedirects(redirectIds: string[]): Promise<NonNullablePaths<BulkDeleteRedirectsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.from` | `results.${number}.item.to` | `results.${number}.item.options.groupRedirect` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
+/**
+ * Lists the site's redirects.
+ *
+ * Unpaged - see ListRedirectsResponse. Permission naming follows the rest of this service:
+ * `wix-seo.*` is what the Redirector itself checks.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId wix-seo.read
+ * @applicableIdentity APP
+ * @applicableIdentity MEMBER
+ * @returns The response for listing the site's redirects.
+ *
+ * Unpaged, so there is no paging_metadata: the Redirector's Get returns every redirect for the
+ * site in a single response and offers no paging or filtering of its own. Paging here would mean
+ * reading the whole set and then slicing it, which costs the same and buys the caller nothing.
+ * Revisit if the Redirector ever gains real paging.
+ *
+ * Unbounded for the same reason, mirroring the Redirector's own GetResponse.redirects, which
+ * declares no maxSize. The 500 in the Redirector's protos bounds its bulk *write* requests
+ * (Upsert, Remove, Validate); it is not a ceiling on how many redirects a site can hold.
+ * @fqn com.wixpress.promote.seo.redirects.api.RedirectsService.ListRedirects
+ */
+declare function listRedirects(): Promise<NonNullablePaths<ListRedirectsResponse, `redirects` | `redirects.${number}.from` | `redirects.${number}.to` | `redirects.${number}.options.groupRedirect`, 5>>;
+/**
+ * Retrieves a single redirect by id.
+ *
+ * Permission naming follows the rest of this service: `wix-seo.*` is what the Redirector itself
+ * checks.
+ * @param redirectId - Unique identifier of the redirect to retrieve
+ * @public
+ * @documentationMaturity preview
+ * @requiredField redirectId
+ * @permissionId wix-seo.read
+ * @applicableIdentity APP
+ * @applicableIdentity MEMBER
+ * @returns The retrieved redirect
+ * @fqn com.wixpress.promote.seo.redirects.api.RedirectsService.GetRedirect
+ */
+declare function getRedirect(redirectId: string): Promise<NonNullablePaths<Redirect, `from` | `to` | `options.groupRedirect`, 3> & {
+    __applicationErrorsType?: GetRedirectApplicationErrors;
+}>;
+/**
+ * Creates redirects in bulk. Replaces AddRedirects and AddGroupRedirects.
+ *
+ * Permission naming and domain events follow the rest of this service: `wix-seo.*` is what the
+ * Redirector itself checks, and no CUD event is emitted because this service owns no storage -
+ * the redirects live in the Redirector. Neither is changed here, since a service-wide convention
+ * should not be broken by a single endpoint.
+ * @param redirects - The redirects to create
+ * @public
+ * @documentationMaturity preview
+ * @requiredField redirects
+ * @permissionId wix-seo.edit
+ * @applicableIdentity APP
+ * @returns The response for creating redirects in bulk
+ * @fqn com.wixpress.promote.seo.redirects.api.RedirectsService.BulkCreateRedirects
+ */
+declare function bulkCreateRedirects(redirects: Redirect[], options?: BulkCreateRedirectsOptionsForRequest): Promise<NonNullablePaths<BulkCreateRedirectsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.from` | `results.${number}.item.to` | `results.${number}.item.options.groupRedirect` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
+interface BulkCreateRedirectsOptionsForRequest {
+    /** Set to true to return the created redirects, not just their metadata */
+    returnFullEntity?: boolean;
+    /** Extra options for creating redirects in bulk */
+    options?: BulkCreateRedirectsOptions;
+}
+/**
+ * Create a redirect with loop solving
+ * @param redirect - The redirect to create
+ * @public
+ * @documentationMaturity preview
+ * @requiredField redirect
+ * @permissionId wix-seo.edit
+ * @applicableIdentity APP
+ * @returns The created redirect
+ * @fqn com.wixpress.promote.seo.redirects.api.RedirectsService.CreateRedirect
+ */
+declare function createRedirect(redirect: Redirect, options?: CreateRedirectOptionsForRequest): Promise<NonNullablePaths<Redirect, `from` | `to` | `options.groupRedirect`, 3> & {
+    __applicationErrorsType?: CreateRedirectApplicationErrors;
+}>;
+interface CreateRedirectOptionsForRequest {
+    /** Extra options for creating a redirect */
+    options?: CreateRedirectOptions;
+}
+/**
+ * Deletes a single redirect by id.
+ *
+ * The Redirector's Remove takes the whole redirect rather than an id, because it locates the route
+ * by `id` when one is present and by matching on `from_path`, exact/group matching and `regex`
+ * when it is not. The redirect is therefore read back through the Redirector's own get-by-id first
+ * and handed over as-is, so the caller only has to know the id; see DeleteRedirectService.
+ *
+ * Permission naming follows the rest of this service: `wix-seo.*` is what the Redirector itself
+ * checks.
+ *
+ * No domain event is emitted - neither a CUD event nor the `wix.api.emits` the DELETE annotation
+ * asks for - because the redirects live in the Redirector, which owns the storage and does not
+ * emit through us. Emitting only here would publish a stream that is silently incomplete: every
+ * other write path (AddRedirects, BulkCreateRedirects, RemoveGeneralRedirect,
+ * CleanupLanguageRedirects) and every caller reaching the Redirector directly would stay silent,
+ * so a consumer would take the absence of an event as the absence of a change. Publishing redirect
+ * events is therefore a service-wide follow-up, not a per-endpoint one; BulkCreateRedirects above
+ * carries the same suppression for the same reason.
+ *
+ * CUSTOM_ACTION is not an alternative escape from the rule: with a top-level id field on the
+ * request, flynt requires this method to be annotated `method: DELETE`
+ * (`crud-add-delete-annotation`).
+ * @param redirectId - Unique identifier of the redirect to delete
+ * @public
+ * @documentationMaturity preview
+ * @requiredField redirectId
+ * @permissionId wix-seo.edit
+ * @applicableIdentity APP
+ * @returns The response for deleting a single redirect
+ * @fqn com.wixpress.promote.seo.redirects.api.RedirectsService.DeleteRedirect
+ */
+declare function deleteRedirect(redirectId: string): Promise<void & {
+    __applicationErrorsType?: DeleteRedirectApplicationErrors;
+}>;
+
+export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddGroupRedirectsOptions, type AddGroupRedirectsRequest, type AddGroupRedirectsResponse, type AddRedirectsOptions, type AddRedirectsRequest, type AddRedirectsResponse, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkCreateRedirectsOptions, type BulkCreateRedirectsOptionsForRequest, type BulkCreateRedirectsRequest, type BulkCreateRedirectsResponse, type BulkDeleteRedirectsRequest, type BulkDeleteRedirectsResponse, type BulkRedirectResult, type CleanupLanguageRedirectsRequest, type CleanupLanguageRedirectsResponse, type CreateRedirectApplicationErrors, type CreateRedirectOptions, type CreateRedirectOptionsForRequest, type CreateRedirectRequest, type CreateRedirectResponse, type DeleteRedirectApplicationErrors, type DeleteRedirectRequest, type DeleteRedirectResponse, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type GetHttpStatusRequest, type GetHttpStatusResponse, type GetRedirectApplicationErrors, type GetRedirectRequest, type GetRedirectResponse, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type ListRedirectsRequest, type ListRedirectsResponse, type MessageEnvelope, type Redirect, type RedirectCreatedEnvelope, type RedirectOptions, type RemoveGeneralRedirectRequest, type RemoveGeneralRedirectResponse, type RemoveGeneralRedirectsOptions, type RestoreInfo, Source, type SourceWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkCreateRedirects, bulkDeleteRedirects, createRedirect, deleteRedirect, getRedirect, listRedirects, onRedirectCreated };