@wix/auto_sdk_seo_redirects 1.0.0 → 1.0.1

package/build/cjs/index.d.ts

@@ -5,62 +5,36 @@ export { AccountInfo, AccountInfoMetadata, ActionEvent, AddGroupRedirectsOptions
 declare function bulkDeleteRedirects$1(httpClient: HttpClient): BulkDeleteRedirectsSignature;
 interface BulkDeleteRedirectsSignature {
     /**
-     * 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 - Unique identifiers of the redirects to delete
-     * @returns The response for deleting redirects in bulk.
+     * Deletes up to 500 redirects by ID.
+     *
+     * Each ID succeeds or fails on its own. An ID that matches no redirect on the site fails with
+     * `REDIRECT_NOT_FOUND` while the rest of the request goes ahead. Read those failures from
+     * `results[].itemMetadata.error` in a successful response, matched to the request by
+     * `results[].itemMetadata.originalIndex`. A malformed request, such as an empty `redirectIds`
+     * list, is rejected as a whole and returns no results.
      *
-     * One result per requested id, in request order - `item_metadata.original_index` is the index in
-     * `redirect_ids`. Per-item semantics:
+     * A successful item means the redirect was found and its deletion was sent, not that the deletion
+     * is confirmed. Call [List Redirects](https://dev.wix.com/docs/api-reference/business-management/seo/redirects/redirect-v1/list-redirects) if you need to confirm the outcome.
      *
-     * - `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.
+     * A redirect scoped to a language stops taking effect but can still appear in [List Redirects](https://dev.wix.com/docs/api-reference/business-management/seo/redirects/redirect-v1/list-redirects).
+     * [Delete Redirect](https://dev.wix.com/docs/api-reference/business-management/seo/redirects/redirect-v1/delete-redirect) behaves the same way.
      *
-     * `item` is never populated - there is no created entity to return.
+     * To delete a single redirect, call [Delete Redirect](https://dev.wix.com/docs/api-reference/business-management/seo/redirects/redirect-v1/delete-redirect).
+     * @param - IDs of the redirects to delete.
+     * @returns The response for deleting redirects in bulk.
      */
     (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>>;
 }
 declare function listRedirects$1(httpClient: HttpClient): ListRedirectsSignature;
 interface ListRedirectsSignature {
     /**
-     * Lists the site's redirects.
+     * Retrieves every redirect on the site.
+     *
+     * The response isn't paged and the method takes no filter or sort, so filter the returned list on
+     * your side. A site with no redirects returns an empty list.
      *
-     * Unpaged - see ListRedirectsResponse. Permission naming follows the rest of this service:
-     * `wix-seo.*` is what the Redirector itself checks.
+     * A redirect that Wix created on the site owner's behalf, such as when a page's URL slug is
+     * renamed in the editor, is returned alongside the ones created through this API.
      * @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
@@ -77,12 +51,13 @@ interface ListRedirectsSignature {
 declare function getRedirect$1(httpClient: HttpClient): GetRedirectSignature;
 interface GetRedirectSignature {
     /**
-     * Retrieves a single redirect by id.
+     * Retrieves a redirect by ID.
      *
-     * Permission naming follows the rest of this service: `wix-seo.*` is what the Redirector itself
-     * checks.
-     * @param - Unique identifier of the redirect to retrieve
-     * @returns The retrieved redirect
+     * Call this method before [Delete Redirect](https://dev.wix.com/docs/api-reference/business-management/seo/redirects/redirect-v1/delete-redirect) and [Create Redirect](https://dev.wix.com/docs/api-reference/business-management/seo/redirects/redirect-v1/create-redirect) when changing an existing redirect,
+     * and keep the response: the create fills any field you omit with its default rather than with the
+     * redirect's previous value.
+     * @param - ID of the redirect to retrieve.
+     * @returns Retrieved redirect.
      */
     (redirectId: string): Promise<NonNullablePaths<Redirect, `from` | `to` | `options.groupRedirect`, 3> & {
         __applicationErrorsType?: GetRedirectApplicationErrors;
@@ -91,13 +66,25 @@ interface GetRedirectSignature {
 declare function bulkCreateRedirects$1(httpClient: HttpClient): BulkCreateRedirectsSignature;
 interface BulkCreateRedirectsSignature {
     /**
-     * Creates redirects in bulk. Replaces AddRedirects and AddGroupRedirects.
+     * Creates up to 500 redirects.
      *
-     * 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 - The redirects to create
+     * Each redirect succeeds or fails on its own. A redirect whose `from` path is already taken fails
+     * with `FROM_URL_EXISTS`, and one that closes a loop with an earlier redirect in the same request
+     * fails with `REDIRECT_LOOP`, while the rest of the request goes ahead. Read those failures from
+     * `results[].itemMetadata.error` in a successful response, matched to the request by
+     * `results[].itemMetadata.originalIndex`. A malformed request, such as an empty `redirects` list,
+     * is rejected as a whole and returns no results.
+     *
+     * A redirect that already exists with the same `from`, `to`, and `options.groupRedirect` is
+     * reported as a success with no `id`, and nothing is written for it.
+     *
+     * A redirect that closes a loop with a redirect already on the site is created, and the
+     * loop-closing redirect is deleted. `options.forceReplace` does the same for a `from` path that's
+     * already taken by a redirect on the site, instead of failing that redirect. Neither deletion can
+     * be undone, so retrieve those redirects first if you need to restore them.
+     *
+     * To create a single redirect, call [Create Redirect](https://dev.wix.com/docs/api-reference/business-management/seo/redirects/redirect-v1/create-redirect).
+     * @param - Redirects to create.
      * @returns The response for creating redirects in bulk
      */
     (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>>;
@@ -105,9 +92,29 @@ interface BulkCreateRedirectsSignature {
 declare function createRedirect$1(httpClient: HttpClient): CreateRedirectSignature;
 interface CreateRedirectSignature {
     /**
-     * Create a redirect with loop solving
-     * @param - The redirect to create
-     * @returns The created redirect
+     * Creates a redirect.
+     *
+     * The `from` path can't be the site root, and can't already belong to another redirect unless
+     * `options.forceReplace` is `true`. With `options.forceReplace`, the redirect that holds the path
+     * is deleted and the new one is created in its place.
+     *
+     * If the redirect would close a loop, meaning an existing redirect starts at the path this one
+     * points to, the redirect that closes the loop is deleted and the create proceeds. Both a
+     * conflicting redirect replaced this way and a loop-closing redirect are gone for good, so
+     * retrieve them first if you need to restore them.
+     *
+     * Creating a redirect that already exists with the same `from`, `to`, and `options.groupRedirect`
+     * changes nothing and returns the redirect from the request, without an `id` or a `createdDate`.
+     *
+     * To create multiple redirects in a single API call, call [Bulk Create Redirects](https://dev.wix.com/docs/api-reference/business-management/seo/redirects/redirect-v1/bulk-create-redirects). Note the
+     * difference in how the two handle problems: this method resolves loops and, with
+     * `options.forceReplace`, conflicts, while [Bulk Create Redirects](https://dev.wix.com/docs/api-reference/business-management/seo/redirects/redirect-v1/bulk-create-redirects) fails the individual redirect
+     * instead.
+     * @param - Redirect to create.
+     * @returns Created redirect.
+     *
+     * `createdDate` isn't returned. When the site already has an identical redirect, the redirect from
+     * the request is returned as is, without an `id`.
      */
     (redirect: Redirect, options?: CreateRedirectOptionsForRequest): Promise<NonNullablePaths<Redirect, `from` | `to` | `options.groupRedirect`, 3> & {
         __applicationErrorsType?: CreateRedirectApplicationErrors;
@@ -116,29 +123,15 @@ interface CreateRedirectSignature {
 declare function deleteRedirect$1(httpClient: HttpClient): DeleteRedirectSignature;
 interface DeleteRedirectSignature {
     /**
-     * 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 - Unique identifier of the redirect to delete
+     * Deletes a redirect by ID.
+     *
+     * The response is empty. Deleting a redirect can't be undone, so retrieve it first if you might
+     * need to recreate it.
+     *
+     * A redirect scoped to a language stops taking effect but can still appear in [List Redirects](https://dev.wix.com/docs/api-reference/business-management/seo/redirects/redirect-v1/list-redirects).
+     *
+     * To delete multiple redirects in a single API call, call [Bulk Delete Redirects](https://dev.wix.com/docs/api-reference/business-management/seo/redirects/redirect-v1/bulk-delete-redirects).
+     * @param - ID of the redirect to delete.
      * @returns The response for deleting a single redirect
      */
     (redirectId: string): Promise<void & {

package/build/cjs/index.js

@@ -91,6 +91,12 @@ function resolveComWixpressPromoteSeoRedirectsApiRedirectsServiceUrl(opts) {
         srcPath: "/seo-redirects-service",
         destPath: ""
       }
+    ],
+    _: [
+      {
+        srcPath: "/_api/seo-redirects-service",
+        destPath: ""
+      }
     ]
   };
   return (0, import_rest_modules2.resolveUrl)(Object.assign(opts, { domainToMappings }));