fix: broken ts docs links (#1502)

vuestorefront · Feb 26, 2024 · 02f8485 · 02f8485
1 parent fce1d87
commit 02f8485
Show file tree

Hide file tree

Showing 57 changed files with 226 additions and 226 deletions.
diff --git a/docs/content/5.api/magento-sdk.api.json b/docs/content/5.api/magento-sdk.api.json
diff --git a/packages/sdk/src/methods/addProductToWishList/index.ts b/packages/sdk/src/methods/addProductToWishList/index.ts
@@ -22,10 +22,10 @@ export type AddProductToWishListResponse<
  *
  * @remarks
  * This method sends a POST request to the
- * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.addProductToWishList | addProductToWishList} endpoint
+ * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/addProductToWishList | addProductToWishList} endpoint
  * of the Vue Storefront API Middleware.
  * The default GraphQL query used by this method can be found
- * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#addProductToWishListQuery | here}.
+ * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/addProductToWishListQuery | here}.
  *
  * @param params -
  * Parameter object which can be used with this method.
@@ -38,7 +38,7 @@ export type AddProductToWishListResponse<
  * @typeParam Res - Customizable response interface to be used with custom queries.
  *
  * @returns
- * Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#AddProductToWishListResponse}.
+ * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/AddProductToWishListResponse}.
  *
  * @example
  * ```ts

diff --git a/packages/sdk/src/methods/addProductsToCart/index.ts b/packages/sdk/src/methods/addProductsToCart/index.ts
@@ -21,10 +21,10 @@ export type AddProductsToCartResponse<T extends DeepPartial<AddProductsToCartMut
  *
  * @remarks
  * This method sends a POST request to the
- * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.addProductsToCart | addProductsToCart} endpoint
+ * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/addProductsToCart | addProductsToCart} endpoint
  * of the Vue Storefront API Middleware.
  * The default GraphQL query used by this method can be found
- * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#addProductsToCart | here}.
+ * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/addProductsToCart | here}.
  *
  * @param params -
  * Parameter object which can be used with this method.
@@ -37,7 +37,7 @@ export type AddProductsToCartResponse<T extends DeepPartial<AddProductsToCartMut
  * @typeParam Res - Customizable response interface to be used with custom queries.
  *
  * @returns
- * Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#AddProductsToCartResponse | AddProductsToCartResponse}.
+ * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/AddProductsToCartResponse | AddProductsToCartResponse}.
  *
  * @example
  * Simple usage:

diff --git a/packages/sdk/src/methods/applyCouponToCart/index.ts b/packages/sdk/src/methods/applyCouponToCart/index.ts
@@ -21,10 +21,10 @@ export type ApplyCouponToCartResponse<T extends DeepPartial<ApplyCouponToCartMut
  *
  * @remarks
  * This method sends a POST request to the
- * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.applyCouponToCart | applyCouponToCart} endpoint
+ * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/applyCouponToCart | applyCouponToCart} endpoint
  * of the Vue Storefront API Middleware.
  * The default GraphQL query used by this method can be found
- * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#applyCouponToCart | here}.
+ * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/applyCouponToCart | here}.
  *
  * @param params -
  * Parameter object which can be used with this method.
@@ -37,7 +37,7 @@ export type ApplyCouponToCartResponse<T extends DeepPartial<ApplyCouponToCartMut
  * @typeParam Res - Customizable response interface to be used with custom queries.
  *
  * @returns
- * Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApplyCouponToCartResponse | ApplyCouponToCartResponse}.
+ * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/ApplyCouponToCartResponse | ApplyCouponToCartResponse}.
  *
  * @example
  * Simple usage:

diff --git a/packages/sdk/src/methods/availableStores/index.ts b/packages/sdk/src/methods/availableStores/index.ts
@@ -21,10 +21,10 @@ export type AvailableStoresResponse<T extends DeepPartial<AvailableStoresQuery>
  *
  * @remarks
  * This method sends a GET request to the
- * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.availableStores | availableStores } endpoint
+ * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/availableStores | availableStores } endpoint
  * of the Vue Storefront API Middleware.
  * The default GraphQL query used by this method can be found
- * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#availableStores | here}.
+ * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/availableStores | here}.
  *
  * @param options -
  * Options that can be passed to additionally configure the request
@@ -33,7 +33,7 @@ export type AvailableStoresResponse<T extends DeepPartial<AvailableStoresQuery>
  * @typeParam Res - Customizable response interface to be used with custom queries.
  *
  * @returns
- * Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#AvailableStoresResponse | AvailableStoresResponse}.
+ * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/AvailableStoresResponse | AvailableStoresResponse}.
  *
  * @example
  * Simple usage:

diff --git a/packages/sdk/src/methods/cart/index.ts b/packages/sdk/src/methods/cart/index.ts
@@ -20,10 +20,10 @@ export type CartResponse<T extends DeepPartial<CartQuery> = CartQuery> = ApolloQ
  *
  * @remarks
  * This method sends a POST request to the
- * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.cart | cart} endpoint
+ * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/cart | cart} endpoint
  * of the Vue Storefront API Middleware.
  * The default GraphQL query used by this method can be found
- * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#cart | here}.
+ * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/cart | here}.
  *
  * @param params -
  * Parameter object which can be used with this method.
@@ -36,7 +36,7 @@ export type CartResponse<T extends DeepPartial<CartQuery> = CartQuery> = ApolloQ
  * @typeParam Res - Customizable response interface to be used with custom queries.
  *
  * @returns
- * Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#CartResponse | CartResponse}.
+ * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CartResponse | CartResponse}.
  *
  * @example
  * Simple usage:

diff --git a/packages/sdk/src/methods/cartTotalQty/index.ts b/packages/sdk/src/methods/cartTotalQty/index.ts
@@ -25,10 +25,10 @@ export type CartTotalQtyResponse<T extends CartTotalQtyQuery = CartTotalQtyQuery
  *
  * @remarks
  * This method sends a POST request to the
- * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.cartTotalQty | cartTotalQty } endpoint
+ * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/cartTotalQty | cartTotalQty } endpoint
  * of the Vue Storefront API Middleware.
  * The default GraphQL query used by this method can be found
- * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#cartTotalQty | here}.
+ * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/cartTotalQty | here}.
  *
  * @param params -
  * Parameter object which can be used with this method.
@@ -41,7 +41,7 @@ export type CartTotalQtyResponse<T extends CartTotalQtyQuery = CartTotalQtyQuery
  * @typeParam Res - Customizable response interface to be used with custom queries.
  *
  * @returns
- * Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#CartTotalQtyResponse | CartTotalQtyResponse}.
+ * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CartTotalQtyResponse | CartTotalQtyResponse}.
  *
  * @example
  * Simple usage:

diff --git a/packages/sdk/src/methods/categoryList/index.ts b/packages/sdk/src/methods/categoryList/index.ts
@@ -20,10 +20,10 @@ export type CategoryListResponse<T extends DeepPartial<CategoryListQuery> = Cate
  *
  * @remarks
  * This method sends a GET request to the
- * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.categoryList | categoryList} endpoint
+ * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/categoryList | categoryList} endpoint
  * of the Vue Storefront API Middleware.
  * The default GraphQL query used by this method can be found
- * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#categoryList | here}.
+ * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/categoryList | here}.
  *
  * @param params -
  * Parameter object which can be used with this method.
@@ -36,7 +36,7 @@ export type CategoryListResponse<T extends DeepPartial<CategoryListQuery> = Cate
  * @typeParam Res - Customizable response interface to be used with custom queries.
  *
  * @returns
- * Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#CategoryListResponse | CategoryListResponse}.
+ * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CategoryListResponse | CategoryListResponse}.
  *
  * @example
  * Simple usage:

diff --git a/packages/sdk/src/methods/categorySearch/index.ts b/packages/sdk/src/methods/categorySearch/index.ts
@@ -23,10 +23,10 @@ export type CategorySearchResponse<T extends DeepPartial<CategorySearchQuery> =
  *
  * @remarks
  * This method sends a GET request to the
- * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.categorySearch | categorySearch} endpoint
+ * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/categorySearch | categorySearch} endpoint
  * of the Vue Storefront API Middleware.
  * The default GraphQL query used by this method can be found
- * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#categorySearchQuery | here}.
+ * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/categorySearchQuery | here}.
  *
  * @param params -
  * Parameter object which can be used with this method.
@@ -39,7 +39,7 @@ export type CategorySearchResponse<T extends DeepPartial<CategorySearchQuery> =
  * @typeParam Res - Customizable response interface to be used with custom queries.
  *
  * @returns
- * Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#CategorySearchResponse | CategorySearchResponse}.
+ * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CategorySearchResponse | CategorySearchResponse}.
  *
  * @example
  * Simple usage without filters

diff --git a/packages/sdk/src/methods/changeCustomerPassword/index.ts b/packages/sdk/src/methods/changeCustomerPassword/index.ts
@@ -11,7 +11,7 @@ import { CustomQuery, MethodOptions } from '../../types';
 export type ChangeCustomerPasswordMutation = { changeCustomerPassword: Mutation['changeCustomerPassword'] };
 
 /**
- * Parameters for the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#changeCustomerPassword | changeCustomerPassword } method.
+ * Parameters for the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/changeCustomerPassword | changeCustomerPassword } method.
  */
 export type ChangeCustomerPasswordInput = { currentPassword: string; newPassword: string };
 
@@ -27,10 +27,10 @@ export type ChangeCustomerPasswordResponse<
  *
  * @remarks
  * This method sends a POST request to the
- * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.changeCustomerPassword | changeCustomerPassword } endpoint
+ * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/changeCustomerPassword | changeCustomerPassword } endpoint
  * of the Vue Storefront API Middleware.
  * The default GraphQL query used by this method can be found
- * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#changeCustomerPassword | here}.
+ * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/changeCustomerPassword | here}.
  *
  * @param params -
  * Parameter object which can be used with this method.
@@ -43,7 +43,7 @@ export type ChangeCustomerPasswordResponse<
  * @typeParam Res - Customizable response interface to be used with custom queries.
  *
  * @returns
- * Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ChangeCustomerPasswordResponse | ChangeCustomerPasswordResponse}.
+ * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/ChangeCustomerPasswordResponse | ChangeCustomerPasswordResponse}.
  *
  * @example
  * Simple usage, change customer password:

diff --git a/packages/sdk/src/methods/cmsBlocks/index.ts b/packages/sdk/src/methods/cmsBlocks/index.ts
@@ -20,10 +20,10 @@ export type CmsBlocksResponse<T extends DeepPartial<CmsBlockQuery> = CmsBlockQue
  *
  * @remarks
  * This method sends a GET request to the
- * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.cmsBlocks | cmsBlocks } endpoint
+ * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/cmsBlocks | cmsBlocks } endpoint
  * of the Vue Storefront API Middleware.
  * The default GraphQL query used by this method can be found
- * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#cmsBlocks | here}.
+ * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/cmsBlocks | here}.
  *
  * @param params -
  * Parameter object which can be used with this method.
@@ -36,7 +36,7 @@ export type CmsBlocksResponse<T extends DeepPartial<CmsBlockQuery> = CmsBlockQue
  * @typeParam Res - Customizable response interface to be used with custom queries.
  *
  * @returns
- * Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#CmsBlocksResponse | CmsBlocksResponse}.
+ * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CmsBlocksResponse | CmsBlocksResponse}.
  *
  * @example
  * Simple usage:

diff --git a/packages/sdk/src/methods/cmsPage/index.ts b/packages/sdk/src/methods/cmsPage/index.ts
@@ -20,10 +20,10 @@ export type CmsPageResponse<T extends DeepPartial<CmsPageQuery> = CmsPageQuery>
  *
  * @remarks
  * This method sends a GET request to the
- * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.cmsPage | cmsPage } endpoint
+ * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/cmsPage | cmsPage } endpoint
  * of the Vue Storefront API Middleware.
  * The default GraphQL query used by this method can be found
- * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#cmsPage | here}.
+ * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/cmsPage | here}.
  *
  * @param params -
  * Parameter object which can be used with this method.
@@ -36,7 +36,7 @@ export type CmsPageResponse<T extends DeepPartial<CmsPageQuery> = CmsPageQuery>
  * @typeParam Res - Customizable response interface to be used with custom queries.
  *
  * @returns
- * Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#CmsPageResponse | CmsPageResponse}.
+ * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CmsPageResponse | CmsPageResponse}.
  *
  * @example
  * Simple usage:

diff --git a/packages/sdk/src/methods/countries/index.ts b/packages/sdk/src/methods/countries/index.ts
@@ -20,10 +20,10 @@ export type CountriesResponse<T extends DeepPartial<CountriesQuery> = CountriesQ
  *
  * @remarks
  * This method sends a GET request to the
- * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.countries | countries } endpoint
+ * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/countries | countries } endpoint
  * of the Vue Storefront API Middleware.
  * The default GraphQL query used by this method can be found
- * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#countries | here}.
+ * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/countries | here}.
  *
  * @param options -
  * Options that can be passed to additionally configure the request
@@ -32,7 +32,7 @@ export type CountriesResponse<T extends DeepPartial<CountriesQuery> = CountriesQ
  * @typeParam Res - Customizable response interface to be used with custom queries.
  *
  * @returns
- * Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#CountriesResponse | CountriesResponse}.
+ * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CountriesResponse | CountriesResponse}.
  *
  * @example
  * Simple usage:

diff --git a/packages/sdk/src/methods/createCustomer/index.ts b/packages/sdk/src/methods/createCustomer/index.ts
@@ -21,10 +21,10 @@ export type CreateCustomerResponse<T extends DeepPartial<CreateCustomerMutation>
  *
  * @remarks
  * This method sends a POST request to the
- * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.createCustomer | createCustomer } endpoint
+ * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/createCustomer | createCustomer } endpoint
  * of the Vue Storefront API Middleware.
  * The default GraphQL query used by this method can be found
- * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#createCustomer | here}.
+ * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/createCustomer | here}.
  *
  * @param params -
  * Parameter object which can be used with this method.
@@ -37,7 +37,7 @@ export type CreateCustomerResponse<T extends DeepPartial<CreateCustomerMutation>
  * @typeParam Res - Customizable response interface to be used with custom queries.
  *
  * @returns
- * Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#CreateCustomerResponse | CreateCustomerResponse}.
+ * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CreateCustomerResponse | CreateCustomerResponse}.
  *
  * @example
  * Simple usage with basic customer data:

diff --git a/packages/sdk/src/methods/createCustomerAddress/index.ts b/packages/sdk/src/methods/createCustomerAddress/index.ts
@@ -22,10 +22,10 @@ export type CreateCustomerAddressResponse<
  *
  * @remarks
  * This method sends a POST request to the
- * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.createCustomerAddress | createCustomerAddress } endpoint
+ * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/createCustomerAddress | createCustomerAddress } endpoint
  * of the Vue Storefront API Middleware.
  * The default GraphQL query used by this method can be found
- * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#createCustomerAddress | here}.
+ * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/createCustomerAddress | here}.
  *
  * @param params -
  * Parameter object which can be used with this method.
@@ -38,7 +38,7 @@ export type CreateCustomerAddressResponse<
  * @typeParam Res - Customizable response interface to be used with custom queries.
  *
  * @returns
- * Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#CreateCustomerAddressResponse | CreateCustomerAddressResponse}.
+ * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CreateCustomerAddressResponse | CreateCustomerAddressResponse}.
  *
  * @example
  * Simple usage: