diff --git a/docs/content/5.api/magento-sdk.api.json b/docs/content/5.api/magento-sdk.api.json index cfdba6bb0..232032466 100644 --- a/docs/content/5.api/magento-sdk.api.json +++ b/docs/content/5.api/magento-sdk.api.json @@ -172,7 +172,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!addProductsToCart:function(1)", - "docComment": "/**\n * Method to add products to cart (returns cart)\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.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}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#AddProductsToCartResponse | AddProductsToCartResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // add products to cart with default parameters (returns cart)\n * const cart = await sdk.magento.addProductsToCart(\n * {\n * cartId: '123',\n * cartItems: [\n * {\n * sku: 'WSH12',\n * quantity: 1,\n * selected_options: [\n * // option IDs retrieved from product\n * 'Y29uZmlndXJhYmxlLzkzLzUz',\n * 'Y29uZmlndXJhYmxlLzE0NC8xNzE='\n * ]\n * }\n * ]\n * }\n * );\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for adding products to cart\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'add-products-to-cart-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation addProductsToCart($cartId: String!, $cartItems: [CartItemInput!]!) {\n * addProductsToCart(cartId: $cartId, cartItems: $cartItems) {\n * cart {\n * ${metadata.fields}\n * }\n * }\n * }`\n *\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to modify response containing the cart, which is sent as part of the adding product to cart mutation\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * cart: 'add-products-to-cart-custom-query',\n * metadata: {\n * fields: 'id items { uid }'\n * }\n * };\n *\n *\n * const cart = await sdk.magento.addProductsToCart(\n * {\n * cartId: '123',\n * cartItems: [\n * {\n * sku: 'WSH12',\n * quantity: 1,\n * selected_options: [\n * 'Y29uZmlndXJhYmxlLzkzLzUz',\n * 'Y29uZmlndXJhYmxlLzE0NC8xNzE='\n * ]\n * }\n * ]\n * },\n * { customQuery }\n * );\n *\n * // Result will contain only the fields specified in the custom query.\n * ```\n *\n */\n", + "docComment": "/**\n * Method to add products to cart (returns cart)\n *\n * @remarks\n *\n * This method sends a POST request to the {@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/integrations/magento/api/magento-api/addProductsToCart | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/AddProductsToCartResponse | AddProductsToCartResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // add products to cart with default parameters (returns cart)\n * const cart = await sdk.magento.addProductsToCart(\n * {\n * cartId: '123',\n * cartItems: [\n * {\n * sku: 'WSH12',\n * quantity: 1,\n * selected_options: [\n * // option IDs retrieved from product\n * 'Y29uZmlndXJhYmxlLzkzLzUz',\n * 'Y29uZmlndXJhYmxlLzE0NC8xNzE='\n * ]\n * }\n * ]\n * }\n * );\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for adding products to cart\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'add-products-to-cart-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation addProductsToCart($cartId: String!, $cartItems: [CartItemInput!]!) {\n * addProductsToCart(cartId: $cartId, cartItems: $cartItems) {\n * cart {\n * ${metadata.fields}\n * }\n * }\n * }`\n *\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to modify response containing the cart, which is sent as part of the adding product to cart mutation\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * cart: 'add-products-to-cart-custom-query',\n * metadata: {\n * fields: 'id items { uid }'\n * }\n * };\n *\n *\n * const cart = await sdk.magento.addProductsToCart(\n * {\n * cartId: '123',\n * cartItems: [\n * {\n * sku: 'WSH12',\n * quantity: 1,\n * selected_options: [\n * 'Y29uZmlndXJhYmxlLzkzLzUz',\n * 'Y29uZmlndXJhYmxlLzE0NC8xNzE='\n * ]\n * }\n * ]\n * },\n * { customQuery }\n * );\n *\n * // Result will contain only the fields specified in the custom query.\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -414,7 +414,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!addProductToWishList:function(1)", - "docComment": "/**\n * Method to add products to wishlist\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.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}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#AddProductToWishListResponse}.\n *\n * @example\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * const wishlist = await sdk.magento.addProductToWishList({\n * // Wishlist ID\n * id: '258',\n * // Products to add to wishlist with given ID\n * items: [{quantity: 1, sku: 'WSH12'}]\n * });\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for searching categories\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'add-product-to-wishlist-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation addProductsToWishlist($id: ID!, $items: [WishlistItemInput!]!) {\n * addProductsToWishlist(wishlistId: $id, wishlistItems: $items) {\n * wishlist {\n * ${metadata.fields}\n * }\n * }\n * }`\n * }),\n * },\n * }\n * }\n * }\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query (mutation) to add products to wishlist\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * const customQuery = {\n * addProductsToWishList: 'add-product-to-wishlist-custom-query',\n * metadata: {\n * fields: 'id items_count'\n * }\n * };\n *\n * const result = await sdk.magento.addProductToWishList({\n * id: '258',\n * items: [{ quantity: 1, sku: '258'}]\n * }, { customQuery });\n *\n * // Returned wishlist will contain only the fields specified in the custom query.\n * ```\n *\n */\n", + "docComment": "/**\n * Method to add products to wishlist\n *\n * @remarks\n *\n * This method sends a POST request to the {@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/integrations/magento/api/magento-api/addProductToWishListQuery | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/AddProductToWishListResponse}.\n *\n * @example\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * const wishlist = await sdk.magento.addProductToWishList({\n * // Wishlist ID\n * id: '258',\n * // Products to add to wishlist with given ID\n * items: [{quantity: 1, sku: 'WSH12'}]\n * });\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for searching categories\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'add-product-to-wishlist-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation addProductsToWishlist($id: ID!, $items: [WishlistItemInput!]!) {\n * addProductsToWishlist(wishlistId: $id, wishlistItems: $items) {\n * wishlist {\n * ${metadata.fields}\n * }\n * }\n * }`\n * }),\n * },\n * }\n * }\n * }\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query (mutation) to add products to wishlist\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * const customQuery = {\n * addProductsToWishList: 'add-product-to-wishlist-custom-query',\n * metadata: {\n * fields: 'id items_count'\n * }\n * };\n *\n * const result = await sdk.magento.addProductToWishList({\n * id: '258',\n * items: [{ quantity: 1, sku: '258'}]\n * }, { customQuery });\n *\n * // Returned wishlist will contain only the fields specified in the custom query.\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -588,7 +588,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!applyCouponToCart:function(1)", - "docComment": "/**\n * Method to apply coupon to cart\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.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}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApplyCouponToCartResponse | ApplyCouponToCartResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // apply coupon parameters\n * const params = {\n * cart_id: 'test-cart-id',\n * coupon_code: 'test-coupon-code'\n * };\n *\n * // The result of the coupon application\n * const result = await sdk.magento.applyCouponToCart(params);\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for getting cart\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'apply-coupon-to-cart-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation applyCouponToCart($input: ApplyCouponToCartInput) {\n * applyCouponToCart(input: $input) {\n * ${metadata.fields}\n * }\n * }`\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to fetch reduced amount of data\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * const customQuery = {\n * applyCouponToCart: 'apply-coupon-to-cart-custom-query',\n * metadata: {\n * fields: 'cart { applied_coupons { code } }'\n * }\n * };\n *\n * const params = {\n * cart_id: 'test-cart-id',\n * coupon_code: 'test-coupon-code'\n * };\n *\n * // The result will contain only fields configured in the custom query\n * const result = await sdk.magento.applyCouponToCart(params, { customQuery });\n * ```\n *\n */\n", + "docComment": "/**\n * Method to apply coupon to cart\n *\n * @remarks\n *\n * This method sends a POST request to the {@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/integrations/magento/api/magento-api/applyCouponToCart | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/ApplyCouponToCartResponse | ApplyCouponToCartResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // apply coupon parameters\n * const params = {\n * cart_id: 'test-cart-id',\n * coupon_code: 'test-coupon-code'\n * };\n *\n * // The result of the coupon application\n * const result = await sdk.magento.applyCouponToCart(params);\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for getting cart\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'apply-coupon-to-cart-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation applyCouponToCart($input: ApplyCouponToCartInput) {\n * applyCouponToCart(input: $input) {\n * ${metadata.fields}\n * }\n * }`\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to fetch reduced amount of data\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * const customQuery = {\n * applyCouponToCart: 'apply-coupon-to-cart-custom-query',\n * metadata: {\n * fields: 'cart { applied_coupons { code } }'\n * }\n * };\n *\n * const params = {\n * cart_id: 'test-cart-id',\n * coupon_code: 'test-coupon-code'\n * };\n *\n * // The result will contain only fields configured in the custom query\n * const result = await sdk.magento.applyCouponToCart(params, { customQuery });\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -796,7 +796,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!availableStores:function(1)", - "docComment": "/**\n * Method to fetch available stores\n *\n * @remarks\n *\n * This method sends a GET request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.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}.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#AvailableStoresResponse | AvailableStoresResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch available stores\n * const result = await sdk.magento.availableStores();\n *\n * // result.data.availableStores contains the available stores\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'available-stores-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query availableStores {\n * availableStores {\n * ${metadata?.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to reduce the amount of fields returned by the query\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * availableStores: 'available-stores-custom-query',\n * metadata: {\n * fields: 'code store_name'\n * }\n * };\n *\n * const result = await sdk.magento.availableStores({ customQuery });\n *\n * // result.data.availableStores contains the available stores with only the fields specified in the custom query\n * ```\n *\n */\n", + "docComment": "/**\n * Method to fetch available stores\n *\n * @remarks\n *\n * This method sends a GET request to the {@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/integrations/magento/api/magento-api/availableStores | here}.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/AvailableStoresResponse | AvailableStoresResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch available stores\n * const result = await sdk.magento.availableStores();\n *\n * // result.data.availableStores contains the available stores\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'available-stores-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query availableStores {\n * availableStores {\n * ${metadata?.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to reduce the amount of fields returned by the query\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * availableStores: 'available-stores-custom-query',\n * metadata: {\n * fields: 'code store_name'\n * }\n * };\n *\n * const result = await sdk.magento.availableStores({ customQuery });\n *\n * // result.data.availableStores contains the available stores with only the fields specified in the custom query\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -988,7 +988,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!cart:function(1)", - "docComment": "/**\n * Method to get cart\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.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}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#CartResponse | CartResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch cart with default parameters\n * const cart = await sdk.magento.cart({ cartId: '123' });\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for getting cart\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'cart-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query cart($cartId: String!) {\n * cart(cart_id:$cartId) {\n * ${metadata.fields}\n * }\n * }`\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to fetch cart\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * cart: 'cart-custom-query',\n * metadata: {\n * fields: 'id items { uid }'\n * }\n * };\n *\n * const cart = await sdk.magento.cart({ cartId: '123'}, { customQuery });\n *\n * // Cart will contain only the fields specified in the custom query.\n * ```\n *\n */\n", + "docComment": "/**\n * Method to get cart\n *\n * @remarks\n *\n * This method sends a POST request to the {@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/integrations/magento/api/magento-api/cart | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CartResponse | CartResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch cart with default parameters\n * const cart = await sdk.magento.cart({ cartId: '123' });\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for getting cart\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'cart-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query cart($cartId: String!) {\n * cart(cart_id:$cartId) {\n * ${metadata.fields}\n * }\n * }`\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to fetch cart\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * cart: 'cart-custom-query',\n * metadata: {\n * fields: 'id items { uid }'\n * }\n * };\n *\n * const cart = await sdk.magento.cart({ cartId: '123'}, { customQuery });\n *\n * // Cart will contain only the fields specified in the custom query.\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -1196,7 +1196,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!cartTotalQty:function(1)", - "docComment": "/**\n * Method to resolve cart total quantity This method is optimized to fetch only total quantity of the cart and not the whole cart object. Do not use `cart` query inf you want to fetch only total quantity of the cart.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.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}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#CartTotalQtyResponse | CartTotalQtyResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch total quantity of the cart\n * const { data } await sdk.magento.cartTotalQty({cartId: 'some_cart_id' });\n *\n * // total quantity of the cart available in data.cart.total_quantity\n * ```\n *\n */\n", + "docComment": "/**\n * Method to resolve cart total quantity This method is optimized to fetch only total quantity of the cart and not the whole cart object. Do not use `cart` query inf you want to fetch only total quantity of the cart.\n *\n * @remarks\n *\n * This method sends a POST request to the {@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/integrations/magento/api/magento-api/cartTotalQty | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CartTotalQtyResponse | CartTotalQtyResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch total quantity of the cart\n * const { data } await sdk.magento.cartTotalQty({cartId: 'some_cart_id' });\n *\n * // total quantity of the cart available in data.cart.total_quantity\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -1373,7 +1373,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!categoryList:function(1)", - "docComment": "/**\n * Method to list of all categories without filters\n *\n * @remarks\n *\n * This method sends a GET request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.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}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#CategoryListResponse | CategoryListResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch list of categories with default parameters\n * const categoryList = await sdk.magento.categoryList({});\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for adding product details.\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'category-list-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query categoryList {\n * categories {\n * ${metadata.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to fetch product details.\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * const customQuery = {\n * categoryList: 'category-list-custom-query',\n * metadata: {\n * fields: 'items { uid name }'\n * }\n * };\n *\n * const categoryList = await sdk.magento.categoryList({}, { customQuery });\n *\n * // Category list will contain only the fields specified in the custom query.\n * ```\n *\n */\n", + "docComment": "/**\n * Method to list of all categories without filters\n *\n * @remarks\n *\n * This method sends a GET request to the {@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/integrations/magento/api/magento-api/categoryList | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CategoryListResponse | CategoryListResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch list of categories with default parameters\n * const categoryList = await sdk.magento.categoryList({});\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for adding product details.\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'category-list-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query categoryList {\n * categories {\n * ${metadata.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to fetch product details.\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * const customQuery = {\n * categoryList: 'category-list-custom-query',\n * metadata: {\n * fields: 'items { uid name }'\n * }\n * };\n *\n * const categoryList = await sdk.magento.categoryList({}, { customQuery });\n *\n * // Category list will contain only the fields specified in the custom query.\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -1581,7 +1581,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!categorySearch:function(1)", - "docComment": "/**\n * Method to search categories\n *\n * @remarks\n *\n * This method sends a GET request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.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}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#CategorySearchResponse | CategorySearchResponse}.\n *\n * @example\n *\n * Simple usage without filters\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch list of categories with default parameters\n * const categories = await sdk.magento.categorySearch();\n * ```\n *\n * @example\n *\n * Usage with filters\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // make a request to fetch list of categories with custom parameters\n * const details = await sdk.magento.categorySearch({\n * filters: {\n * category_uid: {\n * in: ['MjA=']\n * }\n * }\n * });\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for searching categories\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'category-search-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query categorySearch($filters: CategoryFilterInput) {\n * categoryList(filters: $filters) {\n * ${metadata.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to search categories.\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * const customQuery = {\n * categorySearch: 'category-search-custom-query',\n * metadata: {\n * fields: 'children_count products { total_count }'\n * }\n * };\n *\n * const result = await sdk.magento.categorySearch({\n * filter: {\n * category_uid: {\n * in: ['=MjA']\n * }\n * }\n * }, { customQuery });\n *\n * // Details will contain only the fields specified in the custom query.\n * ```\n *\n */\n", + "docComment": "/**\n * Method to search categories\n *\n * @remarks\n *\n * This method sends a GET request to the {@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/integrations/magento/api/magento-api/categorySearchQuery | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CategorySearchResponse | CategorySearchResponse}.\n *\n * @example\n *\n * Simple usage without filters\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch list of categories with default parameters\n * const categories = await sdk.magento.categorySearch();\n * ```\n *\n * @example\n *\n * Usage with filters\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // make a request to fetch list of categories with custom parameters\n * const details = await sdk.magento.categorySearch({\n * filters: {\n * category_uid: {\n * in: ['MjA=']\n * }\n * }\n * });\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for searching categories\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'category-search-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query categorySearch($filters: CategoryFilterInput) {\n * categoryList(filters: $filters) {\n * ${metadata.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to search categories.\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * const customQuery = {\n * categorySearch: 'category-search-custom-query',\n * metadata: {\n * fields: 'children_count products { total_count }'\n * }\n * };\n *\n * const result = await sdk.magento.categorySearch({\n * filter: {\n * category_uid: {\n * in: ['=MjA']\n * }\n * }\n * }, { customQuery });\n *\n * // Details will contain only the fields specified in the custom query.\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -1789,7 +1789,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!changeCustomerPassword:function(1)", - "docComment": "/**\n * Method to change customer password.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.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}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ChangeCustomerPasswordResponse | ChangeCustomerPasswordResponse}.\n *\n * @example\n *\n * Simple usage, change customer password:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * const result = await sdk.magento.changeCustomerPassword({\n * currentPassword: 'currentPassword',\n * newPassword: 'newPassword'\n * });\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for changeCustomerPassword:\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'change-customer-password-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation changeCustomerPassword($currentPassword: String!, $newPassword: String!) {\n * changeCustomerPassword(\n * currentPassword: $currentPassword\n * newPassword: $newPassword\n * ) {\n * ${metadata.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to narrow down the response data:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * changeCustomerPassword: 'change-customer-password-custom-query',\n * metadata: {\n * fields: 'email'\n * }\n * };\n *\n * const result = await sdk.magento.changeCustomerPassword({\n * currentPassword: 'currentPassword',\n * newPassword: 'newPassword'\n * }, { customQuery });\n * ```\n *\n */\n", + "docComment": "/**\n * Method to change customer password.\n *\n * @remarks\n *\n * This method sends a POST request to the {@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/integrations/magento/api/magento-api/changeCustomerPassword | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/ChangeCustomerPasswordResponse | ChangeCustomerPasswordResponse}.\n *\n * @example\n *\n * Simple usage, change customer password:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * const result = await sdk.magento.changeCustomerPassword({\n * currentPassword: 'currentPassword',\n * newPassword: 'newPassword'\n * });\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for changeCustomerPassword:\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'change-customer-password-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation changeCustomerPassword($currentPassword: String!, $newPassword: String!) {\n * changeCustomerPassword(\n * currentPassword: $currentPassword\n * newPassword: $newPassword\n * ) {\n * ${metadata.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to narrow down the response data:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * changeCustomerPassword: 'change-customer-password-custom-query',\n * metadata: {\n * fields: 'email'\n * }\n * };\n *\n * const result = await sdk.magento.changeCustomerPassword({\n * currentPassword: 'currentPassword',\n * newPassword: 'newPassword'\n * }, { customQuery });\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -1889,7 +1889,7 @@ { "kind": "TypeAlias", "canonicalReference": "@vue-storefront/magento-sdk!ChangeCustomerPasswordInput:type", - "docComment": "/**\n * Parameters for the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#changeCustomerPassword | changeCustomerPassword} method.\n */\n", + "docComment": "/**\n * Parameters for the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/changeCustomerPassword | changeCustomerPassword} method.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -2056,7 +2056,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!cmsBlocks:function(1)", - "docComment": "/**\n * Method to fetch cms blocks.\n *\n * @remarks\n *\n * This method sends a GET request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.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}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#CmsBlocksResponse | CmsBlocksResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch few cms blocks by their identifiers\n * const { data } = await sdk.magento.cmsBlocks({\n * identifiers: ['id1', 'id2']\n * });\n *\n * // result will contain cms blocks with the specified identifiers\n * data.cmsBlocks.items.forEach(block => console.log(block.identifier));\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'cms-blocks-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query cmsBlock($identifiers: [String]) {\n * cmsBlocks(identifiers: $identifiers) {\n * items {\n * ${metadata.fields}\n * }\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to reduce the amount of fields returned by the query\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * // fetch only title\n * const customQuery = {\n * cmsBlocks: 'cms-blocks-custom-query',\n * metadata: {\n * fields: 'title'\n * }\n * };\n *\n * const { data } = await sdk.magento.cmsBlocks({\n * identifiers: ['id1', 'id2']\n * }, { customQuery });\n *\n * // data will contain only block titles\n * ```\n *\n */\n", + "docComment": "/**\n * Method to fetch cms blocks.\n *\n * @remarks\n *\n * This method sends a GET request to the {@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/integrations/magento/api/magento-api/cmsBlocks | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CmsBlocksResponse | CmsBlocksResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch few cms blocks by their identifiers\n * const { data } = await sdk.magento.cmsBlocks({\n * identifiers: ['id1', 'id2']\n * });\n *\n * // result will contain cms blocks with the specified identifiers\n * data.cmsBlocks.items.forEach(block => console.log(block.identifier));\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'cms-blocks-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query cmsBlock($identifiers: [String]) {\n * cmsBlocks(identifiers: $identifiers) {\n * items {\n * ${metadata.fields}\n * }\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to reduce the amount of fields returned by the query\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * // fetch only title\n * const customQuery = {\n * cmsBlocks: 'cms-blocks-custom-query',\n * metadata: {\n * fields: 'title'\n * }\n * };\n *\n * const { data } = await sdk.magento.cmsBlocks({\n * identifiers: ['id1', 'id2']\n * }, { customQuery });\n *\n * // data will contain only block titles\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -2230,7 +2230,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!cmsPage:function(1)", - "docComment": "/**\n * Method to fetch CMS page\n *\n * @remarks\n *\n * This method sends a GET request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.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}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#CmsPageResponse | CmsPageResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch home page by the page identifier\n * const result = await sdk.magento.cmsPage({\n * identifier: 'home'\n * });\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'cms-page-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query cmsPage($identifier: String) {\n * cmsPage(identifier:$identifier) {\n * ${metadata?.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to reduce the amount of fields returned by the query\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields to only the content and title\n * const customQuery = {\n * cmsPage: 'cms-page-custom-query',\n * metadata: {\n * fields: 'title content'\n * }\n * };\n *\n * const result = await sdk.magento.cmsPage({\n * identifier: 'home'\n * }, { customQuery });\n *\n * // result will only contain the title and content fields\n * ```\n *\n */\n", + "docComment": "/**\n * Method to fetch CMS page\n *\n * @remarks\n *\n * This method sends a GET request to the {@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/integrations/magento/api/magento-api/cmsPage | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CmsPageResponse | CmsPageResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch home page by the page identifier\n * const result = await sdk.magento.cmsPage({\n * identifier: 'home'\n * });\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'cms-page-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query cmsPage($identifier: String) {\n * cmsPage(identifier:$identifier) {\n * ${metadata?.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to reduce the amount of fields returned by the query\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields to only the content and title\n * const customQuery = {\n * cmsPage: 'cms-page-custom-query',\n * metadata: {\n * fields: 'title content'\n * }\n * };\n *\n * const result = await sdk.magento.cmsPage({\n * identifier: 'home'\n * }, { customQuery });\n *\n * // result will only contain the title and content fields\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -2438,7 +2438,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!countries:function(1)", - "docComment": "/**\n * Method to fetch list of countries\n *\n * @remarks\n *\n * This method sends a GET request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.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}.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#CountriesResponse | CountriesResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch list of countries\n * const result = await sdk.magento.countries();\n *\n * // result.data.countries is an array of countries\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'countries-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query countriesList {\n * countries {\n * ${metadata?.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to reduce the amount of fields returned by the query\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * countries: 'countries-custom-query',\n * metadata: {\n * fields: 'full_name_english'\n * }\n * };\n *\n * const result = await sdk.magento.countries({ customQuery });\n *\n * // result.data.countries will only contain the full_name_english field\n * ```\n *\n */\n", + "docComment": "/**\n * Method to fetch list of countries\n *\n * @remarks\n *\n * This method sends a GET request to the {@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/integrations/magento/api/magento-api/countries | here}.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CountriesResponse | CountriesResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch list of countries\n * const result = await sdk.magento.countries();\n *\n * // result.data.countries is an array of countries\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'countries-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query countriesList {\n * countries {\n * ${metadata?.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to reduce the amount of fields returned by the query\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * countries: 'countries-custom-query',\n * metadata: {\n * fields: 'full_name_english'\n * }\n * };\n *\n * const result = await sdk.magento.countries({ customQuery });\n *\n * // result.data.countries will only contain the full_name_english field\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -2630,7 +2630,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!createCustomer:function(1)", - "docComment": "/**\n * Method to create a new customer.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.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}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#CreateCustomerResponse | CreateCustomerResponse}.\n *\n * @example\n *\n * Simple usage with basic customer data:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * const params = {\n * email: 'john.doe@gmail.com'\n * firstname: 'John',\n * lastname: 'Doe',\n * }\n *\n * const result = await sdk.magento.createCustomer(params);\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for creating a customer\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'create-customer-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query customer {\n * customer {\n * ${metadata.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to fetch customer\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n *\n * const customQuery = {\n * customer: 'create customer-custom-query',\n * metadata: {\n * fields: 'email firstname lastname'\n * }\n * };\n *\n * const params = {\n * email: 'john.doe@gmail.com'\n * firstname: 'John',\n * lastname: 'Doe',\n * }\n *\n * const result = await sdk.magento.createCustomer(params, { customQuery }\n *\n * // result will contain only the fields specified in the custom query.\n * ```\n *\n */\n", + "docComment": "/**\n * Method to create a new customer.\n *\n * @remarks\n *\n * This method sends a POST request to the {@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/integrations/magento/api/magento-api/createCustomer | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CreateCustomerResponse | CreateCustomerResponse}.\n *\n * @example\n *\n * Simple usage with basic customer data:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * const params = {\n * email: 'john.doe@gmail.com'\n * firstname: 'John',\n * lastname: 'Doe',\n * }\n *\n * const result = await sdk.magento.createCustomer(params);\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for creating a customer\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'create-customer-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query customer {\n * customer {\n * ${metadata.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to fetch customer\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n *\n * const customQuery = {\n * customer: 'create customer-custom-query',\n * metadata: {\n * fields: 'email firstname lastname'\n * }\n * };\n *\n * const params = {\n * email: 'john.doe@gmail.com'\n * firstname: 'John',\n * lastname: 'Doe',\n * }\n *\n * const result = await sdk.magento.createCustomer(params, { customQuery }\n *\n * // result will contain only the fields specified in the custom query.\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -2730,7 +2730,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!createCustomerAddress:function(1)", - "docComment": "/**\n * Method to create a customer address.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.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}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#CreateCustomerAddressResponse | CreateCustomerAddressResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * const address: CustomerAddressInput = {\n * city: 'some city',\n * country_code: CountryCodeEnum.Us,\n * default_billing: false,\n * default_shipping: false,\n * firstname: 'John',\n * lastname: 'Doe',\n * postcode: '08701',\n * street: ['street'],\n * telephone: '123123123',\n * region: {\n * region_code: 'NJ',\n * region_id: 41,\n * region: 'New Jersey'\n * }\n * };\n *\n * // customer address will be created for the currently logged in customer\n * await sdk.magento.createCustomerAddress(address);\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'create-customer-address-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation createCustomerAddress($input: CustomerAddressInput!) {\n * createCustomerAddress(input: $input) {\n * ${metadata.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to reduce the amount of data returned by the API\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * createCustomerAddress: 'create-customer-address-custom-query',\n * metadata: {\n * fields: 'id city'\n * }\n * };\n *\n * // address parameter is the same as in the simple usage example\n * const result = await sdk.magento.createCustomerAddress(address, { customQuery });\n *\n * result.data.createCustomerAddress.city; // 'some city'\n * ```\n *\n */\n", + "docComment": "/**\n * Method to create a customer address.\n *\n * @remarks\n *\n * This method sends a POST request to the {@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/integrations/magento/api/magento-api/createCustomerAddress | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CreateCustomerAddressResponse | CreateCustomerAddressResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * const address: CustomerAddressInput = {\n * city: 'some city',\n * country_code: CountryCodeEnum.Us,\n * default_billing: false,\n * default_shipping: false,\n * firstname: 'John',\n * lastname: 'Doe',\n * postcode: '08701',\n * street: ['street'],\n * telephone: '123123123',\n * region: {\n * region_code: 'NJ',\n * region_id: 41,\n * region: 'New Jersey'\n * }\n * };\n *\n * // customer address will be created for the currently logged in customer\n * await sdk.magento.createCustomerAddress(address);\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'create-customer-address-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation createCustomerAddress($input: CustomerAddressInput!) {\n * createCustomerAddress(input: $input) {\n * ${metadata.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to reduce the amount of data returned by the API\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * createCustomerAddress: 'create-customer-address-custom-query',\n * metadata: {\n * fields: 'id city'\n * }\n * };\n *\n * // address parameter is the same as in the simple usage example\n * const result = await sdk.magento.createCustomerAddress(address, { customQuery });\n *\n * result.data.createCustomerAddress.city; // 'some city'\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3046,7 +3046,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!createEmptyCart:function(1)", - "docComment": "/**\n * Method to create an empty cart.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.createEmptyCart | createEmptyCart} 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#createEmptyCart | here}.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#CreateEmptyCartResponse | CreateEmptyCartResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // create an empty cart\n * const cart = await sdk.magento.createEmptyCart();\n *\n * // cart id can be accessed from the response\n * const cartId = cart.data.createEmptyCart;\n * ```\n *\n */\n", + "docComment": "/**\n * Method to create an empty cart.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/createEmptyCart | createEmptyCart} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/createEmptyCart | here}.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CreateEmptyCartResponse | CreateEmptyCartResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // create an empty cart\n * const cart = await sdk.magento.createEmptyCart();\n *\n * // cart id can be accessed from the response\n * const cartId = cart.data.createEmptyCart;\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3225,7 +3225,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!createProductReview:function(1)", - "docComment": "/**\n * Method to create product review\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.createProductReview | createProductReview} 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#createProductReview | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#CreateProductReviewResponse | CreateProductReviewResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // create review data structure\n * const review = {\n * sku: 'some-sku',\n * nickname: 'john.doe',\n * summary: 'awesome thing, whatever it is!',\n * text: 'this is a test review',\n * ratings: [{\n * id: 'NA==', // base64 encoded id\n * value_id: 'MjA=' // base64 encoded value_id\n * }]\n * };\n *\n * const result = await sdk.magento.createProductReview(review);\n *\n * // result will contain the created review and summary data\n * ```\n *\n */\n", + "docComment": "/**\n * Method to create product review\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/createProductReview | createProductReview} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/createProductReview | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CreateProductReviewResponse | CreateProductReviewResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // create review data structure\n * const review = {\n * sku: 'some-sku',\n * nickname: 'john.doe',\n * summary: 'awesome thing, whatever it is!',\n * text: 'this is a test review',\n * ratings: [{\n * id: 'NA==', // base64 encoded id\n * value_id: 'MjA=' // base64 encoded value_id\n * }]\n * };\n *\n * const result = await sdk.magento.createProductReview(review);\n *\n * // result will contain the created review and summary data\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3420,7 +3420,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!currency:function(1)", - "docComment": "/**\n * Method to fetch available currencies in a store.\n *\n * @remarks\n *\n * This method sends a GET request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.currency | currency} 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#currency | here}.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#CurrencyResponse | CurrencyResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch available currencies\n * const result = await sdk.magento.currency();\n *\n * // result would be something like:\n * // {\n * // \"data\": {\n * // \"currency\": {\n * // \"_currency_code\": \"EUR\",\n * // \"_currency_symbol\": \"€\",\n * // \"default_display_currency_code\": \"EUR\",\n * // \"default_display_currency_symbol\": \"€\",\n * // \"available_currency_codes\": [\n * // \"EUR\",\n * // \"USD\"\n * // ],\n * // \"exchange_rates\": [\n * // {\n * // \"currency_to\": \"EUR\",\n * // \"rate\": 1\n * // },\n * // {\n * // \"currency_to\": \"USD\",\n * // \"rate\": 1.2\n * // }\n * // ]\n * // }\n * // }\n * // }\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'currency-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query currency {\n * currency{\n * ${metadata?.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to fetch a list of currencies with limited number of fields\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * currency: 'currency-custom-query',\n * metadata: {\n * fields: '_currency_code'\n * }\n * };\n *\n * const result = await sdk.magento.currency({ customQuery });\n *\n * // result will contain only the _currency_code field\n * ```\n *\n */\n", + "docComment": "/**\n * Method to fetch available currencies in a store.\n *\n * @remarks\n *\n * This method sends a GET request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/currency | currency} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/currency | here}.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CurrencyResponse | CurrencyResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch available currencies\n * const result = await sdk.magento.currency();\n *\n * // result would be something like:\n * // {\n * // \"data\": {\n * // \"currency\": {\n * // \"_currency_code\": \"EUR\",\n * // \"_currency_symbol\": \"€\",\n * // \"default_display_currency_code\": \"EUR\",\n * // \"default_display_currency_symbol\": \"€\",\n * // \"available_currency_codes\": [\n * // \"EUR\",\n * // \"USD\"\n * // ],\n * // \"exchange_rates\": [\n * // {\n * // \"currency_to\": \"EUR\",\n * // \"rate\": 1\n * // },\n * // {\n * // \"currency_to\": \"USD\",\n * // \"rate\": 1.2\n * // }\n * // ]\n * // }\n * // }\n * // }\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'currency-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query currency {\n * currency{\n * ${metadata?.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to fetch a list of currencies with limited number of fields\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * currency: 'currency-custom-query',\n * metadata: {\n * fields: '_currency_code'\n * }\n * };\n *\n * const result = await sdk.magento.currency({ customQuery });\n *\n * // result will contain only the _currency_code field\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3612,7 +3612,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!customer:function(1)", - "docComment": "/**\n * Method to get current customer information\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.customer | customer} 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#customer | here}.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#CustomerResponse | CustomerResponse}.\n *\n * @example\n *\n * The `customer()` returns the currently active user. This means that the request needs to contain an authorization token, which will tell Magento whose customer data should be fetched.\n *\n * If your browser has a VSF customer cookie saved, you can just call `customer()` without any parameters - the token will be attached automatically on every request to the middleware.\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch customer\n * const customer = await sdk.magento.customer();\n * ```\n *\n * @example\n *\n * If you're calling `customer()` in a non-browser context (for example in integration tests) where it's not possible to save a cookie, you can attach the token manually using `customHeaders`\n *\n * Usage with manual authorization:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * const token = '123'\n * const customHeaders = { Authorization: `Bearer {token}` }\n *\n * // fetch customer\n * const customer = await sdk.magento.customer({ customHeaders });\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for fetching customer\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'customer-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query customer {\n * customer {\n * ${metadata.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to fetch customer\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * customer: 'customer-custom-query',\n * metadata: {\n * fields: 'email firstname lastname'\n * }\n * };\n *\n * const customer = await sdk.magento.customer({ customQuery });\n *\n * // customer will contain only the fields specified in the custom query.\n * ```\n *\n */\n", + "docComment": "/**\n * Method to get current customer information\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/customer | customer} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/customer | here}.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CustomerResponse | CustomerResponse}.\n *\n * @example\n *\n * The `customer()` returns the currently active user. This means that the request needs to contain an authorization token, which will tell Magento whose customer data should be fetched.\n *\n * If your browser has a VSF customer cookie saved, you can just call `customer()` without any parameters - the token will be attached automatically on every request to the middleware.\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch customer\n * const customer = await sdk.magento.customer();\n * ```\n *\n * @example\n *\n * If you're calling `customer()` in a non-browser context (for example in integration tests) where it's not possible to save a cookie, you can attach the token manually using `customHeaders`\n *\n * Usage with manual authorization:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * const token = '123'\n * const customHeaders = { Authorization: `Bearer {token}` }\n *\n * // fetch customer\n * const customer = await sdk.magento.customer({ customHeaders });\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for fetching customer\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'customer-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query customer {\n * customer {\n * ${metadata.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to fetch customer\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * customer: 'customer-custom-query',\n * metadata: {\n * fields: 'email firstname lastname'\n * }\n * };\n *\n * const customer = await sdk.magento.customer({ customQuery });\n *\n * // customer will contain only the fields specified in the custom query.\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -3764,7 +3764,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!customerCart:function(1)", - "docComment": "/**\n * Method to fetch customer cart\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.customerCart | customerCart} 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#customerCart | here}.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#CustomerCartResponse | CustomerCartResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch customer cart\n * const { data } = await sdk.magento.customerCart();\n *\n * // data contains cart details\n * const email = data?.customerCart?.email;\n *\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for customerCart\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'customer-cart-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query customerCart {\n * customerCart {\n * ${metadata.fields}\n * }\n * }`\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to reduce the amount of fields returned by the query, when compared to the default query\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * customerCart: 'customer-cart-custom-query',\n * metadata: {\n * fields: 'id email items { id sku }\n * }\n * };\n *\n * const result = await sdk.magento.customerCart({ customQuery });\n *\n * // result contains cart details with only the fields specified in the custom query\n * ```\n *\n */\n", + "docComment": "/**\n * Method to fetch customer cart\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/customerCart | customerCart} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/customerCart | here}.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CustomerCartResponse | CustomerCartResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch customer cart\n * const { data } = await sdk.magento.customerCart();\n *\n * // data contains cart details\n * const email = data?.customerCart?.email;\n *\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for customerCart\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'customer-cart-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query customerCart {\n * customerCart {\n * ${metadata.fields}\n * }\n * }`\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to reduce the amount of fields returned by the query, when compared to the default query\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * customerCart: 'customer-cart-custom-query',\n * metadata: {\n * fields: 'id email items { id sku }\n * }\n * };\n *\n * const result = await sdk.magento.customerCart({ customQuery });\n *\n * // result contains cart details with only the fields specified in the custom query\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -4098,7 +4098,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!customMutation:function(1)", - "docComment": "/**\n * Method to send an arbitrary GraphQL mutation to the Magento GraphQL endpoint For sending query, please see {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#customQuery | customQuery}.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link @vue-storefront/magento-api#ApiMethods.customMutation | customMutation} endpoint of the Vue Storefront API Middleware.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam RES - Set response type of passed query\n *\n * @typeParam INPUT - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#CustomQueryResponse | CustomQueryResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // Prepare custom mutation\n * // Do not use gql-tag (gql``) here.\n * // For syntax highlighting (provided by respective IDE extensions), add the `#graphql` comment at the start of the template string\n * const mutation = `#graphql\n * mutation generateCustomerToken($email: String!, $password: String!) {\n * generateCustomerToken(email: $email, password: $password) {\n * token\n * }\n * }\n * `;\n *\n * // Prepare mutation variables\n * const mutationVariables: GenerateCustomerTokenInput = {\n * email: TEST_USER_EMAIL,\n * password: TEST_USER_PASSWORD\n * };\n *\n * // use custom mutation and variables to fetch response adjusted to your needs\n * const result = await sdk.magento.customMutation, CustomMutationInput>({\n * mutation,\n * mutationVariables\n * });\n * ```\n *\n */\n", + "docComment": "/**\n * Method to send an arbitrary GraphQL mutation to the Magento GraphQL endpoint For sending query, please see {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/customQuery | customQuery}.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link @vue-storefront/magento-api#ApiMethods.customMutation | customMutation} endpoint of the Vue Storefront API Middleware.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam RES - Set response type of passed query\n *\n * @typeParam INPUT - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CustomQueryResponse | CustomQueryResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // Prepare custom mutation\n * // Do not use gql-tag (gql``) here.\n * // For syntax highlighting (provided by respective IDE extensions), add the `#graphql` comment at the start of the template string\n * const mutation = `#graphql\n * mutation generateCustomerToken($email: String!, $password: String!) {\n * generateCustomerToken(email: $email, password: $password) {\n * token\n * }\n * }\n * `;\n *\n * // Prepare mutation variables\n * const mutationVariables: GenerateCustomerTokenInput = {\n * email: TEST_USER_EMAIL,\n * password: TEST_USER_PASSWORD\n * };\n *\n * // use custom mutation and variables to fetch response adjusted to your needs\n * const result = await sdk.magento.customMutation, CustomMutationInput>({\n * mutation,\n * mutationVariables\n * });\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -4302,7 +4302,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!customQuery:function(1)", - "docComment": "/**\n * Method to send an arbitrary GraphQL query to the Magento GraphQL endpoint For sending mutation, please see {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#customMutation | customMutation}.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link @vue-storefront/magento-api#ApiMethods.customQuery | customQuery} endpoint of the Vue Storefront API Middleware.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam RES - Set response type of passed query\n *\n * @typeParam INPUT - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#CustomQueryResponse | CustomQueryResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // Do not use gql-tag (gql``) here.\n * // For syntax highlighting (provided by respective IDE extensions), add the `#graphql` comment at the start of the template string\n *\n * const query = `#graphql\n * query($search: String!) {\n * products(search: $search) {\n * items {\n * name\n * }\n * }\n * }\n * `;\n *\n * const queryVariables: GetProductSearchParams = { search: \"t-shirt\" };\n *\n * // fetch query response\n * const customQueryResult = await sdk.magento.customQuery, CustomQueryInput>({\n * query: query,\n * queryVariables\n * });\n * ```\n *\n * @example\n *\n * If you want the method to send a GET instead of a POST request, use the `options.clientConfig` parameter.\n * ```ts\n * const customQueryResult = await sdk.magento.customQuery(\n * {\n * query,\n * queryVariables\n * },\n * {\n * clientConfig: {\n * method: 'GET'\n * }\n * }\n * );\n * ```\n *\n */\n", + "docComment": "/**\n * Method to send an arbitrary GraphQL query to the Magento GraphQL endpoint For sending mutation, please see {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/customMutation | customMutation}.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link @vue-storefront/magento-api#ApiMethods.customQuery | customQuery} endpoint of the Vue Storefront API Middleware.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam RES - Set response type of passed query\n *\n * @typeParam INPUT - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CustomQueryResponse | CustomQueryResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // Do not use gql-tag (gql``) here.\n * // For syntax highlighting (provided by respective IDE extensions), add the `#graphql` comment at the start of the template string\n *\n * const query = `#graphql\n * query($search: String!) {\n * products(search: $search) {\n * items {\n * name\n * }\n * }\n * }\n * `;\n *\n * const queryVariables: GetProductSearchParams = { search: \"t-shirt\" };\n *\n * // fetch query response\n * const customQueryResult = await sdk.magento.customQuery, CustomQueryInput>({\n * query: query,\n * queryVariables\n * });\n * ```\n *\n * @example\n *\n * If you want the method to send a GET instead of a POST request, use the `options.clientConfig` parameter.\n * ```ts\n * const customQueryResult = await sdk.magento.customQuery(\n * {\n * query,\n * queryVariables\n * },\n * {\n * clientConfig: {\n * method: 'GET'\n * }\n * }\n * );\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -4561,7 +4561,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!deleteCustomerAddress:function(1)", - "docComment": "/**\n * Method to delete a customer address.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.deleteCustomerAddress | deleteCustomerAddress} 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#deleteCustomerAddress | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#DeleteCustomerAddressResponse | DeleteCustomerAddressResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * const addressId = 12;\n * // customer address will be remove for the currently logged in customer\n * const response = await sdk.magento.deleteCustomerAddress({ id: addressId });\n * // response.data?.deleteCustomerAddress - result is stored here, it's boolean\n * ```\n *\n */\n", + "docComment": "/**\n * Method to delete a customer address.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/deleteCustomerAddress | deleteCustomerAddress} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/deleteCustomerAddress | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/DeleteCustomerAddressResponse | DeleteCustomerAddressResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * const addressId = 12;\n * // customer address will be remove for the currently logged in customer\n * const response = await sdk.magento.deleteCustomerAddress({ id: addressId });\n * // response.data?.deleteCustomerAddress - result is stored here, it's boolean\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -4756,7 +4756,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!generateCustomerToken:function(1)", - "docComment": "/**\n * Method to generate customer token\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.generateCustomerToken | generateCustomerToken} 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#generateCustomerToken | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#GenerateCustomerTokenResponse | GenerateCustomerTokenResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch token\n * const result = await sdk.magento.generateCustomerToken({\n * email: 'some-email',\n * password: 'some-password'\n * });\n *\n * // Token is now available in result.data.generateCustomerToken.token\n * ```\n *\n */\n", + "docComment": "/**\n * Method to generate customer token\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/generateCustomerToken | generateCustomerToken} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/generateCustomerToken | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/GenerateCustomerTokenResponse | GenerateCustomerTokenResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch token\n * const result = await sdk.magento.generateCustomerToken({\n * email: 'some-email',\n * password: 'some-password'\n * });\n *\n * // Token is now available in result.data.generateCustomerToken.token\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -4976,7 +4976,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!getAvailableCustomerPaymentMethods:function(1)", - "docComment": "/**\n * Method to fetch available payment methods for a logged in customer.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.getAvailableCustomerPaymentMethods | getAvailableCustomerPaymentMethods} 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#getAvailableCustomerPaymentMethods | here}.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#GetAvailableCustomerPaymentMethodsResponse | GetAvailableCustomerPaymentMethodsResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch available payment methods for a logged in customer\n * const result = await sdk.magento.getAvailableCustomerPaymentMethods();\n *\n * // example result\n * {\n * \"data\": {\n * \"cart\": {\n * \"__typename\": \"Cart\",\n * \"available_payment_methods\": [\n * {\n * \"__typename\": \"AvailablePaymentMethod\",\n * \"code\": \"checkmo\",\n * \"title\": \"Check / Money order\"\n * }\n * ]\n * }\n * },\n * \"loading\": false,\n * \"networkStatus\": 7\n * }\n * ```\n *\n */\n", + "docComment": "/**\n * Method to fetch available payment methods for a logged in customer.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/getAvailableCustomerPaymentMethods | getAvailableCustomerPaymentMethods} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/getAvailableCustomerPaymentMethods | here}.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/GetAvailableCustomerPaymentMethodsResponse | GetAvailableCustomerPaymentMethodsResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch available payment methods for a logged in customer\n * const result = await sdk.magento.getAvailableCustomerPaymentMethods();\n *\n * // example result\n * {\n * \"data\": {\n * \"cart\": {\n * \"__typename\": \"Cart\",\n * \"available_payment_methods\": [\n * {\n * \"__typename\": \"AvailablePaymentMethod\",\n * \"code\": \"checkmo\",\n * \"title\": \"Check / Money order\"\n * }\n * ]\n * }\n * },\n * \"loading\": false,\n * \"networkStatus\": 7\n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -5121,7 +5121,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!getAvailableCustomerShippingMethods:function(1)", - "docComment": "/**\n * Method to fetch available shipping methods for current customer. Customer must be logged in.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.getAvailableCustomerShippingMethods | getAvailableCustomerShippingMethods} 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#getAvailableCustomerShippingMethods | here}.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#GetAvailableCustomerShippingMethodsResponse | GetAvailableCustomerShippingMethodsResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch available shipping methods for current customer\n * const result = await sdk.magento.getAvailableCustomerShippingMethods();\n * // e.g. output:\n * // {\n * // \"data\": {\n * // \"customerCart\": {\n * // \"shipping_addresses\": [\n * // address1: {\n * // \"available_shipping_methods\": [...]\n * // },\n * // ]\n * // }\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'get-available-customer-shipping-methods-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query CustomerAvailableShippingMethods {\n * customerCart {\n * ${metadata?.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to reduce the amount of data returned by the API\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n *\n * const customQuery = {\n * getAvailableCustomerShippingMethods: 'get-available-customer-shipping-methods-custom-query',\n * metadata: {\n * fields: 'shipping_addresses { available_shipping_methods { available method_title } }'\n * }\n * };\n *\n * const result = await sdk.magento.getAvailableCustomerShippingMethods({ customQuery });\n *\n * // the result will contain only the data defined in the custom query\n * ```\n *\n */\n", + "docComment": "/**\n * Method to fetch available shipping methods for current customer. Customer must be logged in.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/getAvailableCustomerShippingMethods | getAvailableCustomerShippingMethods} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/getAvailableCustomerShippingMethods | here}.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/GetAvailableCustomerShippingMethodsResponse | GetAvailableCustomerShippingMethodsResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch available shipping methods for current customer\n * const result = await sdk.magento.getAvailableCustomerShippingMethods();\n * // e.g. output:\n * // {\n * // \"data\": {\n * // \"customerCart\": {\n * // \"shipping_addresses\": [\n * // address1: {\n * // \"available_shipping_methods\": [...]\n * // },\n * // ]\n * // }\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'get-available-customer-shipping-methods-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query CustomerAvailableShippingMethods {\n * customerCart {\n * ${metadata?.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to reduce the amount of data returned by the API\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n *\n * const customQuery = {\n * getAvailableCustomerShippingMethods: 'get-available-customer-shipping-methods-custom-query',\n * metadata: {\n * fields: 'shipping_addresses { available_shipping_methods { available method_title } }'\n * }\n * };\n *\n * const result = await sdk.magento.getAvailableCustomerShippingMethods({ customQuery });\n *\n * // the result will contain only the data defined in the custom query\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -5279,7 +5279,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!getAvailablePaymentMethods:function(1)", - "docComment": "/**\n * Method to get available payment methods for the received guest cart. To get available customer payment methods use {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#getAvailableCustomerPaymentMethods | getAvailableCustomerPaymentMethods}.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.getAvailablePaymentMethods | getAvailablePaymentMethods} 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#getAvailablePaymentMethods | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#GetAvailablePaymentMethodsResponse | GetAvailablePaymentMethodsResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch guest available payment methods\n * const result = await sdk.magento.getAvailablePaymentMethods({\n * cartId: 'masked-cart-id'\n * });\n *\n * // example result\n * {\n * \"data\": {\n * \"cart\": {\n * \"__typename\": \"Cart\",\n * \"available_payment_methods\": [\n * {\n * \"__typename\": \"AvailablePaymentMethod\",\n * \"code\": \"checkmo\",\n * \"title\": \"Check / Money order\"\n * }\n * ]\n * }\n * },\n * \"loading\": false,\n * \"networkStatus\": 7\n * }\n * ```\n *\n */\n", + "docComment": "/**\n * Method to get available payment methods for the received guest cart. To get available customer payment methods use {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/getAvailableCustomerPaymentMethods | getAvailableCustomerPaymentMethods}.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/getAvailablePaymentMethods | getAvailablePaymentMethods} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/getAvailablePaymentMethods | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/GetAvailablePaymentMethodsResponse | GetAvailablePaymentMethodsResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch guest available payment methods\n * const result = await sdk.magento.getAvailablePaymentMethods({\n * cartId: 'masked-cart-id'\n * });\n *\n * // example result\n * {\n * \"data\": {\n * \"cart\": {\n * \"__typename\": \"Cart\",\n * \"available_payment_methods\": [\n * {\n * \"__typename\": \"AvailablePaymentMethod\",\n * \"code\": \"checkmo\",\n * \"title\": \"Check / Money order\"\n * }\n * ]\n * }\n * },\n * \"loading\": false,\n * \"networkStatus\": 7\n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -5440,7 +5440,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!getAvailableShippingMethods:function(1)", - "docComment": "/**\n * Method to fetch guest's available shipping methods\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.getAvailableShippingMethods | getAvailableShippingMethods} 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#getAvailableShippingMethods | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#GetAvailableShippingMethodsResponse | GetAvailableShippingMethodsResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch guest's available shipping methods\n * const result = await sdk.magento.getAvailableShippingMethods({\n * cart_id: TEST_CART_ID\n * });\n * // array of available shipping methods for selected shipping address:\n * result.data.cart.shipping_addresses[0].available_shipping_methods[0];\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for fetching only what's requested from shipping methods\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'get-available-shipping-methods-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query GuestAvailableShippingMethods($cart_id: String!) {\n * cart(cart_id:$cart_id) {\n * shipping_addresses {\n * available_shipping_methods {\n * ${metadata.fields}\n * }\n * }\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to fetch only method_title field\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * shippingMethods: 'get-available-shipping-methods-custom-query',\n * metadata: {\n * fields: 'method_title'\n * }\n * };\n *\n * const result = await sdk.magento.getAvailableShippingMethods({ cart_id: '123'}, { customQuery });\n *\n * // result contains the customer addresses with only the city method_title. Of course, it has same shape as in the \"simple usage\" example.\n * ```\n *\n */\n", + "docComment": "/**\n * Method to fetch guest's available shipping methods\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/getAvailableShippingMethods | getAvailableShippingMethods} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/getAvailableShippingMethods | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/GetAvailableShippingMethodsResponse | GetAvailableShippingMethodsResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch guest's available shipping methods\n * const result = await sdk.magento.getAvailableShippingMethods({\n * cart_id: TEST_CART_ID\n * });\n * // array of available shipping methods for selected shipping address:\n * result.data.cart.shipping_addresses[0].available_shipping_methods[0];\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for fetching only what's requested from shipping methods\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'get-available-shipping-methods-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query GuestAvailableShippingMethods($cart_id: String!) {\n * cart(cart_id:$cart_id) {\n * shipping_addresses {\n * available_shipping_methods {\n * ${metadata.fields}\n * }\n * }\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to fetch only method_title field\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * shippingMethods: 'get-available-shipping-methods-custom-query',\n * metadata: {\n * fields: 'method_title'\n * }\n * };\n *\n * const result = await sdk.magento.getAvailableShippingMethods({ cart_id: '123'}, { customQuery });\n *\n * // result contains the customer addresses with only the city method_title. Of course, it has same shape as in the \"simple usage\" example.\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -5614,7 +5614,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!getCustomerAddresses:function(1)", - "docComment": "/**\n * Method to get customer addresses. Customer must be logged in before calling this method.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.getCustomerAddresses | getCustomerAddresses} 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#getCustomerAddresses | here}.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#GetCustomerAddressesResponse | GetCustomerAddressesResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch customer addresses if customer is logged in\n * const { data } = await sdk.magento.getCustomerAddresses();\n *\n * // data contains the customer addresses\n * data.customer.addresses; // array of customer addresses\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'get-customer-addresses-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query getCustomerAddresses {\n * customer {\n * addresses {\n * ${metadata.fields}\n * }\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to reduce the amount of data returned by the query\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * getCustomerAddresses: 'get-customer-addresses-custom-query',\n * metadata: {\n * fields: 'city'\n * }\n * };\n *\n * const { data } = await sdk.magento.getCustomerAddresses({ customQuery });\n *\n * // data contains the customer addresses with only the city field\n * ```\n *\n */\n", + "docComment": "/**\n * Method to get customer addresses. Customer must be logged in before calling this method.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/getCustomerAddresses | getCustomerAddresses} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/getCustomerAddresses | here}.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/GetCustomerAddressesResponse | GetCustomerAddressesResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch customer addresses if customer is logged in\n * const { data } = await sdk.magento.getCustomerAddresses();\n *\n * // data contains the customer addresses\n * data.customer.addresses; // array of customer addresses\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'get-customer-addresses-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query getCustomerAddresses {\n * customer {\n * addresses {\n * ${metadata.fields}\n * }\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to reduce the amount of data returned by the query\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * getCustomerAddresses: 'get-customer-addresses-custom-query',\n * metadata: {\n * fields: 'city'\n * }\n * };\n *\n * const { data } = await sdk.magento.getCustomerAddresses({ customQuery });\n *\n * // data contains the customer addresses with only the city field\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -5874,7 +5874,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!mergeCarts:function(1)", - "docComment": "/**\n * Method to merge carts\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.mergeCarts | mergeCarts} 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#mergeCarts | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#MergeCartsResponse | MergeCartsResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * const params = {\n * sourceCartId: 'pCS0ykep1l3wGlPKSyWLJq5fb1DxIQcp',\n * // this cart needs to have been created by a logged in user\n * destinationCartId: 'xiYYh2ep0l3xGtPsz2WLJf5f31DxBJx0'\n * }\n *\n * // merge carts and return the result (cart)\n * const mergedCart = await sdk.magento.mergeCarts(params);\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for merging carts\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'merge-carts-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation mergeCarts($sourceCartId: String!, $destinationCartId: String!) {\n * mergeCarts(source_cart_id: $sourceCartId, destination_cart_id: $destinationCartId) {\n * ${metadata.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to merge carts\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * cart: 'merge-carts-custom-query',\n * metadata: {\n * fields: 'id items { product { name } }'\n * }\n * };\n *\n * const params = {\n * sourceCartId: 'pCS0ykep1l3wGlPKSyWLJq5fb1DxIQcp',\n * destinationCartId: 'xiYYh2ep0l3xGtPsz2WLJf5f31DxBJx0'\n * }\n * const mergedCart = await sdk.magento.mergeCarts(params, { customQuery });\n *\n * // Merged cart will contain only the fields specified in the custom query.\n * ```\n *\n */\n", + "docComment": "/**\n * Method to merge carts\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/mergeCarts | mergeCarts} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/mergeCarts | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/MergeCartsResponse | MergeCartsResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * const params = {\n * sourceCartId: 'pCS0ykep1l3wGlPKSyWLJq5fb1DxIQcp',\n * // this cart needs to have been created by a logged in user\n * destinationCartId: 'xiYYh2ep0l3xGtPsz2WLJf5f31DxBJx0'\n * }\n *\n * // merge carts and return the result (cart)\n * const mergedCart = await sdk.magento.mergeCarts(params);\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for merging carts\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'merge-carts-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation mergeCarts($sourceCartId: String!, $destinationCartId: String!) {\n * mergeCarts(source_cart_id: $sourceCartId, destination_cart_id: $destinationCartId) {\n * ${metadata.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to merge carts\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * cart: 'merge-carts-custom-query',\n * metadata: {\n * fields: 'id items { product { name } }'\n * }\n * };\n *\n * const params = {\n * sourceCartId: 'pCS0ykep1l3wGlPKSyWLJq5fb1DxIQcp',\n * destinationCartId: 'xiYYh2ep0l3xGtPsz2WLJf5f31DxBJx0'\n * }\n * const mergedCart = await sdk.magento.mergeCarts(params, { customQuery });\n *\n * // Merged cart will contain only the fields specified in the custom query.\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -6236,7 +6236,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!placeOrder:function(1)", - "docComment": "/**\n * Method to place an order.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.placeOrder | placeOrder} 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#placeOrder | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#PlaceOrderResponse | PlaceOrderResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // place an order\n * const result = await sdk.magento.placeOrder({cart_id: 'some-cart-id'});\n *\n * // example result:\n * {\n * \"data\": {\n * \"placeOrder\": {\n * \"__typename\": \"PlaceOrderOutput\",\n * \"order\": {\n * \"__typename\": \"Order\",\n * \"order_number\": \"000000522\"\n * }\n * }\n * }\n * }\n * ```\n *\n * @example\n *\n * The complete flow of placing an order for a guest user:\n *\n * ```ts const emptyCart = await sdk.magento.createEmptyCart(); // create an empty cart const cartId = emptyCart?.data?.createEmptyCart || ''; // get cart id from the response\n *\n * // set guest email on the cart await sdk.magento.setGuestEmailOnCart({ cart_id: cartId, email: 'john.doe+test@vuestorefront.io' });\n *\n * // add products to the cart await sdk.magento.addProductsToCart({ cartId, cartItems: [ { quantity: 1, sku: 'some-sku', // size and color selected_options: ['Y29uZmlndXJhYmxlLzkzLzUz', 'Y29uZmlndXJhYmxlLzE0NC8xNzE='] } ] });\n *\n * const address = { firstname: 'John', lastname: 'Doe', city: 'New York', country_code: 'US', street: ['Street 1', 'Street 2'], telephone: '123 123 123', region: 'AL', postcode: '10001', save_in_address_book: false }\n *\n * // set shipping and billing address await sdk.magento.setShippingAddressesOnCart({ cart_id: cartId, shipping_addresses: [{ address }] }); await sdk.magento.setBillingAddressOnCart({ cart_id: cartId, billing_address: { address } });\n *\n * // await sdk.magento.setShippingMethodsOnCart({ cart_id: cartId, shipping_methods: [{ carrier_code: 'flatrate', method_code: 'flatrate' }] }); await sdk.magento.setPaymentMethodOnCart({ cart_id: cartId, payment_method: { code: 'checkmo' } });\n *\n * // place the order const result = await sdk.magento.placeOrder({ cart_id: cartId });\n */\n", + "docComment": "/**\n * Method to place an order.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/placeOrder | placeOrder} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/placeOrder | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/PlaceOrderResponse | PlaceOrderResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // place an order\n * const result = await sdk.magento.placeOrder({cart_id: 'some-cart-id'});\n *\n * // example result:\n * {\n * \"data\": {\n * \"placeOrder\": {\n * \"__typename\": \"PlaceOrderOutput\",\n * \"order\": {\n * \"__typename\": \"Order\",\n * \"order_number\": \"000000522\"\n * }\n * }\n * }\n * }\n * ```\n *\n * @example\n *\n * The complete flow of placing an order for a guest user:\n *\n * ```ts const emptyCart = await sdk.magento.createEmptyCart(); // create an empty cart const cartId = emptyCart?.data?.createEmptyCart || ''; // get cart id from the response\n *\n * // set guest email on the cart await sdk.magento.setGuestEmailOnCart({ cart_id: cartId, email: 'john.doe+test@vuestorefront.io' });\n *\n * // add products to the cart await sdk.magento.addProductsToCart({ cartId, cartItems: [ { quantity: 1, sku: 'some-sku', // size and color selected_options: ['Y29uZmlndXJhYmxlLzkzLzUz', 'Y29uZmlndXJhYmxlLzE0NC8xNzE='] } ] });\n *\n * const address = { firstname: 'John', lastname: 'Doe', city: 'New York', country_code: 'US', street: ['Street 1', 'Street 2'], telephone: '123 123 123', region: 'AL', postcode: '10001', save_in_address_book: false }\n *\n * // set shipping and billing address await sdk.magento.setShippingAddressesOnCart({ cart_id: cartId, shipping_addresses: [{ address }] }); await sdk.magento.setBillingAddressOnCart({ cart_id: cartId, billing_address: { address } });\n *\n * // await sdk.magento.setShippingMethodsOnCart({ cart_id: cartId, shipping_methods: [{ carrier_code: 'flatrate', method_code: 'flatrate' }] }); await sdk.magento.setPaymentMethodOnCart({ cart_id: cartId, payment_method: { code: 'checkmo' } });\n *\n * // place the order const result = await sdk.magento.placeOrder({ cart_id: cartId });\n */\n", "excerptTokens": [ { "kind": "Content", @@ -6444,7 +6444,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!productDetails:function(1)", - "docComment": "/**\n * Method to get products details\n *\n * @remarks\n *\n * This method sends a GET request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.productDetails | productDetails} 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#productDetailsQuery | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ProductDetailsResponse | ProductDetailsResponse}.\n *\n * @example\n *\n * Simple usage without filters, sorting or pagination:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch list of products with default parameters\n * const details = await sdk.magento.productDetails({});\n * ```\n *\n * @example\n *\n * Usage with filters, sorting and pagination:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // make a request to fetch list of products with custom parameters\n * const details = await sdk.magento.productDetails({\n * pageSize: 20,\n * currentPage: 1,\n * filter: {\n * sku: {\n * eq: PRODUCT_SKU\n * }\n * }\n * });\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for adding product details.\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'product-details-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query productDetails(\n * $search: String = \"\",\n * $filter: ProductAttributeFilterInput,\n * $pageSize: Int = 10,\n * $currentPage: Int = 1,\n * $sort: ProductAttributeSortInput\n * ) {\n * products(search: $search, filter: $filter, sort: $sort, pageSize: $pageSize, currentPage: $currentPage) {\n * ${metadata.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to fetch product details.\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * const customQuery = {\n * productDetails: 'product-details-custom-query',\n * metadata: {\n * fields: 'items { sku name }'\n * }\n * };\n *\n * const details = await sdk.magento.productDetails({\n * filter: {\n * sku: {\n * eq: 'some-sku' // optional SKU filter\n * }\n * }\n * }, { customQuery });\n *\n * // Details will contain only the fields specified in the custom query.\n * ```\n *\n */\n", + "docComment": "/**\n * Method to get products details\n *\n * @remarks\n *\n * This method sends a GET request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/productDetails | productDetails} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/productDetailsQuery | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/ProductDetailsResponse | ProductDetailsResponse}.\n *\n * @example\n *\n * Simple usage without filters, sorting or pagination:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch list of products with default parameters\n * const details = await sdk.magento.productDetails({});\n * ```\n *\n * @example\n *\n * Usage with filters, sorting and pagination:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // make a request to fetch list of products with custom parameters\n * const details = await sdk.magento.productDetails({\n * pageSize: 20,\n * currentPage: 1,\n * filter: {\n * sku: {\n * eq: PRODUCT_SKU\n * }\n * }\n * });\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for adding product details.\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'product-details-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query productDetails(\n * $search: String = \"\",\n * $filter: ProductAttributeFilterInput,\n * $pageSize: Int = 10,\n * $currentPage: Int = 1,\n * $sort: ProductAttributeSortInput\n * ) {\n * products(search: $search, filter: $filter, sort: $sort, pageSize: $pageSize, currentPage: $currentPage) {\n * ${metadata.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to fetch product details.\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * const customQuery = {\n * productDetails: 'product-details-custom-query',\n * metadata: {\n * fields: 'items { sku name }'\n * }\n * };\n *\n * const details = await sdk.magento.productDetails({\n * filter: {\n * sku: {\n * eq: 'some-sku' // optional SKU filter\n * }\n * }\n * }, { customQuery });\n *\n * // Details will contain only the fields specified in the custom query.\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -6652,7 +6652,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!productReview:function(1)", - "docComment": "/**\n * Method to fetch product reviews\n *\n * @remarks\n *\n * This method sends a GET request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.productReview | productReview} 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#productReview | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ProductReviewResponse | ProductReviewResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch all products reviews (default pagination limit is 10)\n * const result = await sdk.magento.productReview({});\n * ```\n *\n * @example\n *\n * Fetching reviews for a specific product:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * const result = await sdk.magento.productReview({ filter: { sku: { eq: '24-MB01' } );\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'product-review-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query productReview($search: String = \"\", $filter: ProductAttributeFilterInput, $pageSize: Int = 10, $currentPage: Int = 1, $sort: ProductAttributeSortInput) {\n * products(search: $search, filter: $filter, sort: $sort) {\n * items {\n * review_count\n * reviews(pageSize: $pageSize, currentPage: $currentPage) {\n * items {\n * ${metadata?.fields}\n * }\n * }\n * }\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to change the amount of fields returned by the query:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * productReview: 'product-review-custom-query',\n * metadata: {\n * fields: 'average_rating'\n * }\n * };\n *\n * const result = await sdk.magento.productReview({}, { customQuery });\n *\n * // result.data.products.items[0].reviews.items[0] will only contain the average_rating field\n * ```\n *\n */\n", + "docComment": "/**\n * Method to fetch product reviews\n *\n * @remarks\n *\n * This method sends a GET request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/productReview | productReview} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/productReview | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/ProductReviewResponse | ProductReviewResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch all products reviews (default pagination limit is 10)\n * const result = await sdk.magento.productReview({});\n * ```\n *\n * @example\n *\n * Fetching reviews for a specific product:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * const result = await sdk.magento.productReview({ filter: { sku: { eq: '24-MB01' } );\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'product-review-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query productReview($search: String = \"\", $filter: ProductAttributeFilterInput, $pageSize: Int = 10, $currentPage: Int = 1, $sort: ProductAttributeSortInput) {\n * products(search: $search, filter: $filter, sort: $sort) {\n * items {\n * review_count\n * reviews(pageSize: $pageSize, currentPage: $currentPage) {\n * items {\n * ${metadata?.fields}\n * }\n * }\n * }\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to change the amount of fields returned by the query:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * productReview: 'product-review-custom-query',\n * metadata: {\n * fields: 'average_rating'\n * }\n * };\n *\n * const result = await sdk.magento.productReview({}, { customQuery });\n *\n * // result.data.products.items[0].reviews.items[0] will only contain the average_rating field\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -6786,7 +6786,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!productReviewRatingsMetadata:function(1)", - "docComment": "/**\n * Method to get the active ratings attributes and the values each rating can have.\n *\n * @remarks\n *\n * This method sends a GET request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.productReviewRatingsMetadata | productReviewRatingsMetadata} 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#productReviewRatingsMetadata | here}.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ProductReviewRatingsMetadataResponse | ProductReviewRatingsMetadataResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch the active ratings attributes and the values each rating can have\n * const { data } = await sdk.magento.productReviewRatingsMetadata();\n *\n * data.productReviewRatingsMetadata.items; // array of review's attributes\n * data.productReviewRatingsMetadata.items[0].values; // array of possible values of the review's attributes\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'product-review-ratings-metadata-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query productReviewRatingsMetadata {\n * productReviewRatingsMetadata {\n * items {\n * ${metadata.fields}\n * }\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to reduce the amount of data returned by the query\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * productReviewRatingsMetadata: 'product-review-ratings-metadata-custom-query',\n * metadata: {\n * fields: `\n * name\n * values {\n * value\n * }\n * `\n * }\n * };\n *\n * const { data } = await sdk.magento.productReviewRatingsMetadata({ customQuery });\n *\n * // data.productReviewRatingsMetadata.items[0] will contain only the fields specified in the custom query.\n * ```\n *\n */\n", + "docComment": "/**\n * Method to get the active ratings attributes and the values each rating can have.\n *\n * @remarks\n *\n * This method sends a GET request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/productReviewRatingsMetadata | productReviewRatingsMetadata} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/productReviewRatingsMetadata | here}.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/ProductReviewRatingsMetadataResponse | ProductReviewRatingsMetadataResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch the active ratings attributes and the values each rating can have\n * const { data } = await sdk.magento.productReviewRatingsMetadata();\n *\n * data.productReviewRatingsMetadata.items; // array of review's attributes\n * data.productReviewRatingsMetadata.items[0].values; // array of possible values of the review's attributes\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'product-review-ratings-metadata-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query productReviewRatingsMetadata {\n * productReviewRatingsMetadata {\n * items {\n * ${metadata.fields}\n * }\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to reduce the amount of data returned by the query\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * productReviewRatingsMetadata: 'product-review-ratings-metadata-custom-query',\n * metadata: {\n * fields: `\n * name\n * values {\n * value\n * }\n * `\n * }\n * };\n *\n * const { data } = await sdk.magento.productReviewRatingsMetadata({ customQuery });\n *\n * // data.productReviewRatingsMetadata.items[0] will contain only the fields specified in the custom query.\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -7052,7 +7052,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!products:function(1)", - "docComment": "/**\n * Method to get products\n *\n * @remarks\n *\n * This method sends a GET request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.products | products} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link @vue-storefront/magento-types#productsListQuery | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ProductsListResponse | ProductsListResponse}.\n *\n * @example\n *\n * Simple usage without filters, sorting or pagination:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch list of products with default parameters\n * const details = await sdk.magento.products({});\n * ```\n *\n * @example\n *\n * Usage with filters, sorting and pagination:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // make a request to fetch list of products with custom parameters\n * const details = await sdk.magento.products({\n * pageSize: 20,\n * currentPage: 1,\n * filter: {\n * sku: {\n * eq: PRODUCT_SKU\n * }\n * }\n * });\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for fetching products.\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'products-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query productsList(\n * $search: String = \"\",\n * $filter: ProductAttributeFilterInput,\n * $pageSize: Int = 10,\n * $currentPage: Int = 1,\n * $sort: ProductAttributeSortInput\n * ) {\n * products(search: $search, filter: $filter, sort: $sort, pageSize: $pageSize, currentPage: $currentPage) {\n * ${metadata.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to fetch products list.\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * const customQuery = {\n * products: 'products-custom-query',\n * metadata: {\n * fields: 'items { sku name }'\n * }\n * };\n *\n * const products = await sdk.magento.products({\n * filter: {\n * sku: {\n * eq: 'some-sku' // optional SKU filter\n * }\n * }\n * }, { customQuery });\n *\n * // Products will contain only the fields specified in the custom query.\n * ```\n *\n */\n", + "docComment": "/**\n * Method to get products\n *\n * @remarks\n *\n * This method sends a GET request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/products | products} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link @vue-storefront/magento-types#productsListQuery | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/ProductsListResponse | ProductsListResponse}.\n *\n * @example\n *\n * Simple usage without filters, sorting or pagination:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch list of products with default parameters\n * const details = await sdk.magento.products({});\n * ```\n *\n * @example\n *\n * Usage with filters, sorting and pagination:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // make a request to fetch list of products with custom parameters\n * const details = await sdk.magento.products({\n * pageSize: 20,\n * currentPage: 1,\n * filter: {\n * sku: {\n * eq: PRODUCT_SKU\n * }\n * }\n * });\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for fetching products.\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'products-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query productsList(\n * $search: String = \"\",\n * $filter: ProductAttributeFilterInput,\n * $pageSize: Int = 10,\n * $currentPage: Int = 1,\n * $sort: ProductAttributeSortInput\n * ) {\n * products(search: $search, filter: $filter, sort: $sort, pageSize: $pageSize, currentPage: $currentPage) {\n * ${metadata.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to fetch products list.\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * const customQuery = {\n * products: 'products-custom-query',\n * metadata: {\n * fields: 'items { sku name }'\n * }\n * };\n *\n * const products = await sdk.magento.products({\n * filter: {\n * sku: {\n * eq: 'some-sku' // optional SKU filter\n * }\n * }\n * }, { customQuery });\n *\n * // Products will contain only the fields specified in the custom query.\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -7260,7 +7260,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!relatedProducts:function(1)", - "docComment": "/**\n * Method to get related products\n *\n * @remarks\n *\n * This method sends a GET request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.relatedProduct | relatedProduct} 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#relatedProduct | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#RelatedProductsResponse | RelatedProductsResponse}.\n *\n * @example\n *\n * Simple usage without filters, sorting or pagination:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // Fetch list of products filtered by the SKU\n * // Only the parent product is affected by filters\n * const products = await sdk.magento.relatedProduct({\n * pageSize: 1,\n * filter: {\n * sku: {\n * eq: PRODUCT_SKU\n * }\n * }\n * });\n * ```\n *\n * @example\n *\n * Usage with filters, sorting and pagination:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // make a request to fetch list of products with custom parameters\n * const products = await sdk.magento.relatedProduct({\n * pageSize: 20,\n * currentPage: 1,\n * filter: {\n * sku: {\n * eq: PRODUCT_SKU\n * }\n * }\n * });\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query getting related products.\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'related-product-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query relatedProduct(\n * $search: String = \"\",\n * $filter: ProductAttributeFilterInput,\n * $pageSize: Int = 10,\n * $currentPage: Int = 1,\n * $sort: ProductAttributeSortInput\n * ) {\n * products(search: $search, filter: $filter, sort: $sort, pageSize: $pageSize, currentPage: $currentPage) {\n * ${metadata.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to fetch related products.\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * const customQuery = {\n * relatedProduct: 'related-product-custom-query',\n * metadata: {\n * fields: 'items { related_products { uid __typename } }'\n * }\n * };\n *\n * const result = await sdk.magento.relatedProduct({\n * filter: {\n * sku: {\n * eq: 'some-sku' // optional SKU filter\n * }\n * }\n * }, { customQuery });\n *\n * // Result will contain only the fields specified in the custom query.\n * ```\n *\n */\n", + "docComment": "/**\n * Method to get related products\n *\n * @remarks\n *\n * This method sends a GET request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/relatedProduct | relatedProduct} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/relatedProduct | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/RelatedProductsResponse | RelatedProductsResponse}.\n *\n * @example\n *\n * Simple usage without filters, sorting or pagination:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // Fetch list of products filtered by the SKU\n * // Only the parent product is affected by filters\n * const products = await sdk.magento.relatedProduct({\n * pageSize: 1,\n * filter: {\n * sku: {\n * eq: PRODUCT_SKU\n * }\n * }\n * });\n * ```\n *\n * @example\n *\n * Usage with filters, sorting and pagination:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // make a request to fetch list of products with custom parameters\n * const products = await sdk.magento.relatedProduct({\n * pageSize: 20,\n * currentPage: 1,\n * filter: {\n * sku: {\n * eq: PRODUCT_SKU\n * }\n * }\n * });\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query getting related products.\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'related-product-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query relatedProduct(\n * $search: String = \"\",\n * $filter: ProductAttributeFilterInput,\n * $pageSize: Int = 10,\n * $currentPage: Int = 1,\n * $sort: ProductAttributeSortInput\n * ) {\n * products(search: $search, filter: $filter, sort: $sort, pageSize: $pageSize, currentPage: $currentPage) {\n * ${metadata.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to fetch related products.\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * const customQuery = {\n * relatedProduct: 'related-product-custom-query',\n * metadata: {\n * fields: 'items { related_products { uid __typename } }'\n * }\n * };\n *\n * const result = await sdk.magento.relatedProduct({\n * filter: {\n * sku: {\n * eq: 'some-sku' // optional SKU filter\n * }\n * }\n * }, { customQuery });\n *\n * // Result will contain only the fields specified in the custom query.\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -7468,7 +7468,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!removeCouponFromCart:function(1)", - "docComment": "/**\n * Method to remove coupon from cart\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.removeCouponFromCart | removeCouponFromCart} 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#removeCouponFromCart | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#RemoveCouponFromCartResponse | RemoveCouponFromCartResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // assuming that the coupon code is already applied to the cart\n * const params = {\n * cart_id: 'test-cart-id',\n * };\n *\n * // Remove coupon from cart\n * const result = await sdk.magento.removeCouponFromCart(params);\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for getting cart\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'remove-coupon-from-cart-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation removeCouponFromCart($input: RemoveCouponFromCartInput) {\n * removeCouponFromCart(input: $input) {\n * ${metadata.fields}\n * }\n * }`\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to fetch reduced amount of data\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * const customQuery = {\n * removeCouponFromCart: 'remove-coupon-from-cart-custom-query',\n * metadata: {\n * fields: 'cart { applied_coupons { code } }'\n * }\n * };\n *\n * // The only required parameter is cart_id\n * const params = {\n * cart_id: 'test-cart-id',\n * };\n *\n * // The result will contain only fields configured in the custom query\n * const result = await sdk.magento.removeCouponFromCart(params, { customQuery });\n * ```\n *\n */\n", + "docComment": "/**\n * Method to remove coupon from cart\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/removeCouponFromCart | removeCouponFromCart} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/removeCouponFromCart | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/RemoveCouponFromCartResponse | RemoveCouponFromCartResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // assuming that the coupon code is already applied to the cart\n * const params = {\n * cart_id: 'test-cart-id',\n * };\n *\n * // Remove coupon from cart\n * const result = await sdk.magento.removeCouponFromCart(params);\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for getting cart\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'remove-coupon-from-cart-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation removeCouponFromCart($input: RemoveCouponFromCartInput) {\n * removeCouponFromCart(input: $input) {\n * ${metadata.fields}\n * }\n * }`\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to fetch reduced amount of data\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * const customQuery = {\n * removeCouponFromCart: 'remove-coupon-from-cart-custom-query',\n * metadata: {\n * fields: 'cart { applied_coupons { code } }'\n * }\n * };\n *\n * // The only required parameter is cart_id\n * const params = {\n * cart_id: 'test-cart-id',\n * };\n *\n * // The result will contain only fields configured in the custom query\n * const result = await sdk.magento.removeCouponFromCart(params, { customQuery });\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -7676,7 +7676,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!removeItemFromCart:function(1)", - "docComment": "/**\n * Method to remove item from cart.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.removeItemFromCart | removeItemFromCart} 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#removeItemFromCart | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#RemoveItemFromCartResponse | RemoveItemFromCartResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // Assumes that the cart has an item with the UID 'MY='.\n * // Configure method parameters\n * const params = { cart_id: TEST_CART_ID, cart_item_uid: 'MY=' }\n *\n * const result = await sdk.magento.removeItemFromCart(params);\n *\n * // result will contain the updated cart.\n * // you can look at the cart items to see that the item with the UID 'MY=' has been removed.\n * const hasItem = result.data?.removeItemFromCart!.cart!.items!.find(item => item!.uid === 'MY=');\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for manipulating the cart response data.\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'remove-item-from-cart-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation removeItemFromCart($input: RemoveItemFromCartInput) {\n * removeItemFromCart(input: $input) {\n * cart {\n * ${metadata.fields}\n * }\n * }\n * }`\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query created in the previous example.\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * // this will reduce the amount of data transferred from the server to the client.\n *\n * // All we need is the cart ID and the email address of the customer.\n * const customQuery = {\n * cart: 'remove-item-from-cart-custom-query',\n * metadata: {\n * fields: 'id email'\n * }\n * };\n *\n * // Assumes that the cart has an item with the UID 'MY='.\n * // Uses params from the previous example and the custom query.\n * const result = await sdk.magento.removeItemFromCart(params, { customQuery });\n *\n * // result will contain only the fields specified in the custom query.\n * ```\n *\n */\n", + "docComment": "/**\n * Method to remove item from cart.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/removeItemFromCart | removeItemFromCart} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/removeItemFromCart | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/RemoveItemFromCartResponse | RemoveItemFromCartResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // Assumes that the cart has an item with the UID 'MY='.\n * // Configure method parameters\n * const params = { cart_id: TEST_CART_ID, cart_item_uid: 'MY=' }\n *\n * const result = await sdk.magento.removeItemFromCart(params);\n *\n * // result will contain the updated cart.\n * // you can look at the cart items to see that the item with the UID 'MY=' has been removed.\n * const hasItem = result.data?.removeItemFromCart!.cart!.items!.find(item => item!.uid === 'MY=');\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for manipulating the cart response data.\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'remove-item-from-cart-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation removeItemFromCart($input: RemoveItemFromCartInput) {\n * removeItemFromCart(input: $input) {\n * cart {\n * ${metadata.fields}\n * }\n * }\n * }`\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query created in the previous example.\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * // this will reduce the amount of data transferred from the server to the client.\n *\n * // All we need is the cart ID and the email address of the customer.\n * const customQuery = {\n * cart: 'remove-item-from-cart-custom-query',\n * metadata: {\n * fields: 'id email'\n * }\n * };\n *\n * // Assumes that the cart has an item with the UID 'MY='.\n * // Uses params from the previous example and the custom query.\n * const result = await sdk.magento.removeItemFromCart(params, { customQuery });\n *\n * // result will contain only the fields specified in the custom query.\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -7884,7 +7884,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!removeProductsFromWishlist:function(1)", - "docComment": "/**\n * Method to remove products from wishlist Customer must be logged in to perform this operation. (token in headers)\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.removeProductsFromWishlist | removeProductsFromWishlist} 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#removeProductsFromWishlist | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#RemoveProductsFromWishlistResponse | RemoveProductsFromWishlistResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // remove\n * const result = await sdk.magento.removeProductsFromWishlist({\n * id: 'some-wishlist-id',\n * items: ['some-product-id']\n * });\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'remove-products-from-wishlist-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation removeProductsFromWishlist($id: ID!, $items: [ID!]!) {\n * removeProductsFromWishlist(wishlistId: $id, wishlistItemsIds: $items) {\n * wishlist {\n * ${metadata.fields}\n * }\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to reduce the amount of data returned by the API\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * removeProductsFromWishlist: 'remove-products-from-wishlist-custom-query',\n * metadata: {\n * fields: 'id'\n * }\n * };\n *\n * const result = await sdk.magento.removeProductsFromWishlist({\n * id: 'some-wishlist-id',\n * items: ['item-id-1', 'item-id-2']\n * }, { customQuery });\n *\n * // result should be narrowed to only contain the `id` field\n * ```\n *\n */\n", + "docComment": "/**\n * Method to remove products from wishlist Customer must be logged in to perform this operation. (token in headers)\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/removeProductsFromWishlist | removeProductsFromWishlist} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/removeProductsFromWishlist | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/RemoveProductsFromWishlistResponse | RemoveProductsFromWishlistResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // remove\n * const result = await sdk.magento.removeProductsFromWishlist({\n * id: 'some-wishlist-id',\n * items: ['some-product-id']\n * });\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'remove-products-from-wishlist-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation removeProductsFromWishlist($id: ID!, $items: [ID!]!) {\n * removeProductsFromWishlist(wishlistId: $id, wishlistItemsIds: $items) {\n * wishlist {\n * ${metadata.fields}\n * }\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to reduce the amount of data returned by the API\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * removeProductsFromWishlist: 'remove-products-from-wishlist-custom-query',\n * metadata: {\n * fields: 'id'\n * }\n * };\n *\n * const result = await sdk.magento.removeProductsFromWishlist({\n * id: 'some-wishlist-id',\n * items: ['item-id-1', 'item-id-2']\n * }, { customQuery });\n *\n * // result should be narrowed to only contain the `id` field\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -8092,7 +8092,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!requestPasswordResetEmail:function(1)", - "docComment": "/**\n * Method to request password reset email\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.requestPasswordResetEmail | requestPasswordResetEmail} 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#requestPasswordResetEmail | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#RequestPasswordResetEmailResponse | RequestPasswordResetEmailResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // trigger sending of password reset email\n * const result = await sdk.magento.requestPasswordResetEmail({ email: 'john.doe@gmail.com'});\n *\n * // result.data.requestPasswordResetEmail contains the boolean response from the API\n * ```\n *\n */\n", + "docComment": "/**\n * Method to request password reset email\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/requestPasswordResetEmail | requestPasswordResetEmail} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/requestPasswordResetEmail | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/RequestPasswordResetEmailResponse | RequestPasswordResetEmailResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // trigger sending of password reset email\n * const result = await sdk.magento.requestPasswordResetEmail({ email: 'john.doe@gmail.com'});\n *\n * // result.data.requestPasswordResetEmail contains the boolean response from the API\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -8192,7 +8192,7 @@ { "kind": "TypeAlias", "canonicalReference": "@vue-storefront/magento-sdk!RequestPasswordResetEmailInput:type", - "docComment": "/**\n * Parameter object for the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#requestPasswordResetEmail | requestPasswordResetEmail} method.\n */\n", + "docComment": "/**\n * Parameter object for the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/requestPasswordResetEmail | requestPasswordResetEmail} method.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -8325,7 +8325,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!resetPassword:function(1)", - "docComment": "/**\n * Method to reset customer password.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.resetPassword | resetPassword} 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#resetPassword | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ResetPasswordResponse | ResetPasswordResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch resetPassword\n * const await sdk.magento.resetPassword({\n * email: 'customer.email@gmail.com'\n * newPassword: 'newPassword',\n * resetPasswordToken: 'resetPasswordToken' // token obtained from email {@link @vue-storefront/magento-sdk#requestPasswordResetEmail}\n * });\n * ```\n *\n */\n", + "docComment": "/**\n * Method to reset customer password.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/resetPassword | resetPassword} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/resetPassword | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/ResetPasswordResponse | ResetPasswordResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch resetPassword\n * const await sdk.magento.resetPassword({\n * email: 'customer.email@gmail.com'\n * newPassword: 'newPassword',\n * resetPasswordToken: 'resetPasswordToken' // token obtained from email {@link @vue-storefront/magento-sdk#requestPasswordResetEmail}\n * });\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -8520,7 +8520,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!reviews:function(1)", - "docComment": "/**\n * Method to fetch customer reviews\n *\n * @remarks\n *\n * This method sends a GET request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.reviews | reviews} 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#reviews | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#reviewsResponse | reviewsResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch reviews, customer must be logged in\n * const result = await sdk.magento.reviews();\n *\n * // log all reviews\n * result?.data?.customer?.reviews?.items.forEach(review => console.log(review));\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'customer-product-review-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query reviews($pageSize: Int = 10, $currentPage: Int = 1) {\n * customer {\n * reviews(pageSize: $pageSize, currentPage: $currentPage) {\n * ${metadata?.fields}\n * }\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to reduce the amount of fields returned by the query\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * // fetch only text\n *\n * const customQuery = {\n * reviews: 'customer-product-review-custom-query',\n * metadata: {\n * fields: 'items { text }'\n * }\n * };\n *\n * const result = await sdk.magento.reviews({}, { customQuery });\n *\n * // result will only contain the text of the reviews\n * result?.data?.customer?.reviews?.items.forEach(review => console.log(review.text));\n * ```\n *\n */\n", + "docComment": "/**\n * Method to fetch customer reviews\n *\n * @remarks\n *\n * This method sends a GET request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/reviews | reviews} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/reviews | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/reviewsResponse | reviewsResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch reviews, customer must be logged in\n * const result = await sdk.magento.reviews();\n *\n * // log all reviews\n * result?.data?.customer?.reviews?.items.forEach(review => console.log(review));\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'customer-product-review-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query reviews($pageSize: Int = 10, $currentPage: Int = 1) {\n * customer {\n * reviews(pageSize: $pageSize, currentPage: $currentPage) {\n * ${metadata?.fields}\n * }\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to reduce the amount of fields returned by the query\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * // fetch only text\n *\n * const customQuery = {\n * reviews: 'customer-product-review-custom-query',\n * metadata: {\n * fields: 'items { text }'\n * }\n * };\n *\n * const result = await sdk.magento.reviews({}, { customQuery });\n *\n * // result will only contain the text of the reviews\n * result?.data?.customer?.reviews?.items.forEach(review => console.log(review.text));\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -8694,7 +8694,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!revokeCustomerToken:function(1)", - "docComment": "/**\n * Method to revoke customer token. It is used to log out the current customer.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.revokeCustomerToken | revokeCustomerToken} 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#revokeCustomerToken | here}.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#RevokeCustomerTokenResponse | RevokeCustomerTokenResponse}.\n *\n * @example\n *\n * Simple usage if the customer is logged in and the token is valid:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // token will be invalidated and the customer will be logged out\n * await sdk.magento.revokeCustomerToken();\n * ```\n *\n */\n", + "docComment": "/**\n * Method to revoke customer token. It is used to log out the current customer.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/revokeCustomerToken | revokeCustomerToken} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/revokeCustomerToken | here}.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/RevokeCustomerTokenResponse | RevokeCustomerTokenResponse}.\n *\n * @example\n *\n * Simple usage if the customer is logged in and the token is valid:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // token will be invalidated and the customer will be logged out\n * await sdk.magento.revokeCustomerToken();\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -8873,7 +8873,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!route:function(1)", - "docComment": "/**\n * Method to resolve a route object data\n *\n * @remarks\n *\n * This method sends a GET request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.route | route} 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#route | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#RouteResponse | RouteResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch route object data\n * const result = await sdk.magento.route({\n * url: 'aether-gym-pant.html'\n * });\n *\n * // Example result:\n * {\n * data: {\n * route: { type: 'PRODUCT', sku: 'MP11', __typename: 'ConfigurableProduct' }\n * },\n * loading: false,\n * networkStatus: 7\n * }\n * ```\n *\n */\n", + "docComment": "/**\n * Method to resolve a route object data\n *\n * @remarks\n *\n * This method sends a GET request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/route | route} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/route | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/RouteResponse | RouteResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch route object data\n * const result = await sdk.magento.route({\n * url: 'aether-gym-pant.html'\n * });\n *\n * // Example result:\n * {\n * data: {\n * route: { type: 'PRODUCT', sku: 'MP11', __typename: 'ConfigurableProduct' }\n * },\n * loading: false,\n * networkStatus: 7\n * }\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -9068,7 +9068,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!setBillingAddressOnCart:function(1)", - "docComment": "/**\n * Method to set billing address on the cart\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.setBillingAddressOnCart | setBillingAddressOnCart} 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#setBillingAddressOnCart | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#SetBillingAddressOnCartResponse | SetBillingAddressOnCartResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // Prepare parameters\n * const params = {\n * cart_id: 'some-cart-id',\n * billing_address: {\n * address: {\n * firstname: 'John',\n * lastname: 'Doe',\n * city: 'New York',\n * country_code: 'US',\n * street: ['Street 1', 'Street 2'],\n * telephone: '123 123 123',\n * region: 'AL',\n * postcode: '10001',\n * save_in_address_book: false\n * },\n * }\n * };\n *\n * // Set shipping address on the cart\n * await sdk.magento.setBillingAddressOnCart(params);\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for reducing the amount of fields returned by the query, when compared to the default query.\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'set-billing-address-on-cart-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation setBillingAddressOnCart($input: SetBillingAddressOnCartInput) {\n * setBillingAddressOnCart(input: $input) {\n * cart {\n * ${metadata.fields}\n * }\n * }\n * }`\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query created in the previous example.\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * setBillingAddressOnCart: 'set-billing-address-on-cart-custom-query',\n * metadata: {\n * fields: 'billing_address { city }'\n * }\n * };\n *\n * // data will contain only the fields specified in the custom query.\n * const { data } = await sdk.magento.setBillingAddressOnCart(params, { customQuery });\n * ```\n *\n */\n", + "docComment": "/**\n * Method to set billing address on the cart\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/setBillingAddressOnCart | setBillingAddressOnCart} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/setBillingAddressOnCart | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/SetBillingAddressOnCartResponse | SetBillingAddressOnCartResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // Prepare parameters\n * const params = {\n * cart_id: 'some-cart-id',\n * billing_address: {\n * address: {\n * firstname: 'John',\n * lastname: 'Doe',\n * city: 'New York',\n * country_code: 'US',\n * street: ['Street 1', 'Street 2'],\n * telephone: '123 123 123',\n * region: 'AL',\n * postcode: '10001',\n * save_in_address_book: false\n * },\n * }\n * };\n *\n * // Set shipping address on the cart\n * await sdk.magento.setBillingAddressOnCart(params);\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for reducing the amount of fields returned by the query, when compared to the default query.\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'set-billing-address-on-cart-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation setBillingAddressOnCart($input: SetBillingAddressOnCartInput) {\n * setBillingAddressOnCart(input: $input) {\n * cart {\n * ${metadata.fields}\n * }\n * }\n * }`\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query created in the previous example.\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * setBillingAddressOnCart: 'set-billing-address-on-cart-custom-query',\n * metadata: {\n * fields: 'billing_address { city }'\n * }\n * };\n *\n * // data will contain only the fields specified in the custom query.\n * const { data } = await sdk.magento.setBillingAddressOnCart(params, { customQuery });\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -9276,7 +9276,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!setGuestEmailOnCart:function(1)", - "docComment": "/**\n * Method to set the guest user email on the cart\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.setGuestEmailOnCart | setGuestEmailOnCart} 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#setGuestEmailOnCart | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#SetGuestEmailOnCartResponse | SetGuestEmailOnCartResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // set an email on the cart\n * const result = await sdk.magento.setGuestEmailOnCart({ cart_id: 'some-cart-id', email: 'some-email' });\n *\n * // new email will be set on the cart\n * // data.setGuestEmailOnCart.cart.email will contain the email address\n * ```\n *\n */\n", + "docComment": "/**\n * Method to set the guest user email on the cart\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/setGuestEmailOnCart | setGuestEmailOnCart} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/setGuestEmailOnCart | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/SetGuestEmailOnCartResponse | SetGuestEmailOnCartResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // set an email on the cart\n * const result = await sdk.magento.setGuestEmailOnCart({ cart_id: 'some-cart-id', email: 'some-email' });\n *\n * // new email will be set on the cart\n * // data.setGuestEmailOnCart.cart.email will contain the email address\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -9471,7 +9471,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!setPaymentMethodOnCart:function(1)", - "docComment": "/**\n * Method to set payment method on cart.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.setPaymentMethodOnCart | setPaymentMethodOnCart} 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#setPaymentMethodOnCart | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#SetPaymentMethodOnCartResponse | SetPaymentMethodOnCartResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * const params = {\n * cart_id: 'some-cart-id'\n * payment_method: {\n * code: 'checkmo'\n * }\n * };\n *\n * // sets payment method on cart and return payment information\n * // data contains properties like `available_payment_methods` and `selected_payment_method`\n * const { data } = await sdk.magento.setPaymentMethodOnCart(params);\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for configuring the response data structure\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'set-payment-method-on-cart-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation setPaymentMethodOnCart($input: SetPaymentMethodOnCartInput) {\n * setPaymentMethodOnCart(input: $input) {\n * cart {\n * ${metadata.fields}\n * }\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query created with the `set-payment-method-on-cart-custom-query` in the previous example\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * setPaymentMethodOnCart: 'set-payment-method-on-cart-custom-query',\n * metadata: {\n * fields: 'available_payment_methods { code title }'\n * }\n * };\n *\n * // Params and options are the same as in the previous example\n * const { data } = await sdk.magento.setPaymentMethodOnCart(params, { customQuery });\n *\n * // data contains only the properties selected in the custom query\n * ```\n *\n */\n", + "docComment": "/**\n * Method to set payment method on cart.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/setPaymentMethodOnCart | setPaymentMethodOnCart} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/setPaymentMethodOnCart | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/SetPaymentMethodOnCartResponse | SetPaymentMethodOnCartResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * const params = {\n * cart_id: 'some-cart-id'\n * payment_method: {\n * code: 'checkmo'\n * }\n * };\n *\n * // sets payment method on cart and return payment information\n * // data contains properties like `available_payment_methods` and `selected_payment_method`\n * const { data } = await sdk.magento.setPaymentMethodOnCart(params);\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for configuring the response data structure\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'set-payment-method-on-cart-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation setPaymentMethodOnCart($input: SetPaymentMethodOnCartInput) {\n * setPaymentMethodOnCart(input: $input) {\n * cart {\n * ${metadata.fields}\n * }\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query created with the `set-payment-method-on-cart-custom-query` in the previous example\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * setPaymentMethodOnCart: 'set-payment-method-on-cart-custom-query',\n * metadata: {\n * fields: 'available_payment_methods { code title }'\n * }\n * };\n *\n * // Params and options are the same as in the previous example\n * const { data } = await sdk.magento.setPaymentMethodOnCart(params, { customQuery });\n *\n * // data contains only the properties selected in the custom query\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -9679,7 +9679,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!setShippingAddressesOnCart:function(1)", - "docComment": "/**\n * Method to set shipping addresses on the cart It should be used to set single or multiple shipping addresses on the cart.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.setShippingAddressOnCart | setShippingAddressOnCart} 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#setShippingAddressOnCart | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#SetShippingAddressesOnCartResponse | SetShippingAddressesOnCartResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // Prepare parameters\n * const params = {\n * cart_id: 'some-cart-id',\n * shipping_addresses: [\n * {\n * address: {\n * firstname: 'John',\n * lastname: 'Doe',\n * city: 'New York',\n * country_code: 'US',\n * street: ['Street 1', 'Street 2'],\n * telephone: '123 123 123',\n * region: 'AL',\n * postcode: '10001',\n * save_in_address_book: false\n * },\n * }\n * ]\n * };\n *\n * // Set shipping address on the cart\n * await sdk.magento.setShippingAddressesOnCart(params);\n * ```\n *\n * @example\n *\n * You can also use the `setShippingAddressesOnCart` method to set multiple shipping addresses on the cart.\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // Prepare parameters\n * const params = {\n * cart_id: 'some-cart-id',\n * shipping_addresses: [\n * {\n * address: address1, // address1 is an object with address details\n * },\n * {\n * address: address2, // address2 is an object with address details\n * }\n * ];\n *\n * // This will set address1 and address2 on the cart\n * await sdk.magento.setShippingAddressesOnCart(params);\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for reducing the amount of fields returned by the query, when compared to the default query.\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'set-shipping-addresses-on-cart-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation setShippingAddressesOnCart($input: SetShippingAddressesOnCartInput) {\n * setShippingAddressesOnCart(input: $input) {\n * cart {\n * ${metadata.fields}\n * }\n * }\n * }`\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query created in the previous example.\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * cart: 'set-shipping-addresses-on-cart-custom-query',\n * metadata: {\n * fields: 'shipping_addresses { city }'\n * }\n * };\n *\n * // data will contain only the fields specified in the custom query.\n * const { data } = await sdk.magento.setShippingAddressesOnCart(params, { customQuery });\n * ```\n *\n */\n", + "docComment": "/**\n * Method to set shipping addresses on the cart It should be used to set single or multiple shipping addresses on the cart.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/setShippingAddressOnCart | setShippingAddressOnCart} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/setShippingAddressOnCart | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/SetShippingAddressesOnCartResponse | SetShippingAddressesOnCartResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // Prepare parameters\n * const params = {\n * cart_id: 'some-cart-id',\n * shipping_addresses: [\n * {\n * address: {\n * firstname: 'John',\n * lastname: 'Doe',\n * city: 'New York',\n * country_code: 'US',\n * street: ['Street 1', 'Street 2'],\n * telephone: '123 123 123',\n * region: 'AL',\n * postcode: '10001',\n * save_in_address_book: false\n * },\n * }\n * ]\n * };\n *\n * // Set shipping address on the cart\n * await sdk.magento.setShippingAddressesOnCart(params);\n * ```\n *\n * @example\n *\n * You can also use the `setShippingAddressesOnCart` method to set multiple shipping addresses on the cart.\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // Prepare parameters\n * const params = {\n * cart_id: 'some-cart-id',\n * shipping_addresses: [\n * {\n * address: address1, // address1 is an object with address details\n * },\n * {\n * address: address2, // address2 is an object with address details\n * }\n * ];\n *\n * // This will set address1 and address2 on the cart\n * await sdk.magento.setShippingAddressesOnCart(params);\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for reducing the amount of fields returned by the query, when compared to the default query.\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'set-shipping-addresses-on-cart-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation setShippingAddressesOnCart($input: SetShippingAddressesOnCartInput) {\n * setShippingAddressesOnCart(input: $input) {\n * cart {\n * ${metadata.fields}\n * }\n * }\n * }`\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query created in the previous example.\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * cart: 'set-shipping-addresses-on-cart-custom-query',\n * metadata: {\n * fields: 'shipping_addresses { city }'\n * }\n * };\n *\n * // data will contain only the fields specified in the custom query.\n * const { data } = await sdk.magento.setShippingAddressesOnCart(params, { customQuery });\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -9887,7 +9887,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!setShippingMethodsOnCart:function(1)", - "docComment": "/**\n * Method to set shipping methods on cart. Before using this method, you need to set shipping address on cart.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.setShippingMethodsOnCart | setShippingMethodsOnCart} 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#setShippingMethodsOnCart | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#SetShippingMethodsOnCartResponse | SetShippingMethodsOnCartResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // Assuming that shipping address is already set on cart.\n * // if not, you need to set shipping address on cart first.\n *\n * const params = {\n * cart_id: 'some-cart-id',\n * shipping_methods: [\n * {\n * carrier_code: 'flatrate',\n * method_code: 'flatrate'\n * }\n * ]\n * };\n *\n * const { data } = await sdk.magento.setShippingMethodsOnCart(params);\n *\n * // you can get set shipping methods on cart response from\n * // data?.setShippingMethodsOnCart?.cart?.shipping_addresses?.[0]?.selected_shipping_method?.method_code\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query to change the amount of fields returned by the query, when compared to the default query\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'set-shipping-methods-on-cart-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation setShippingMethodsOnCart($input: SetShippingMethodsOnCartInput) {\n * setShippingMethodsOnCart(input: $input) {\n * cart {\n * ${metadata.fields}\n * }\n * }\n * }`\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query created in the previous example\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * // you will get only selected_shipping_method.method_code field\n *\n * const customQuery = {\n * setShippingMethodsOnCart: 'set-shipping-methods-on-cart-custom-query',\n * metadata: {\n * fields: 'shipping_addresses { selected_shipping_method { method_code } }'\n * }\n * };\n *\n * const params = {\n * cart_id: 'some-cart-id',\n * shipping_methods: [\n * {\n * carrier_code: 'flatrate',\n * method_code: 'flatrate'\n * }\n * ]\n * };\n *\n * const { data } = await sdk.magento.setShippingMethodsOnCart(params, { customQuery });\n *\n * // data will contain only the fields specified in the custom query.\n * ```\n *\n */\n", + "docComment": "/**\n * Method to set shipping methods on cart. Before using this method, you need to set shipping address on cart.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/setShippingMethodsOnCart | setShippingMethodsOnCart} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/setShippingMethodsOnCart | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/SetShippingMethodsOnCartResponse | SetShippingMethodsOnCartResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // Assuming that shipping address is already set on cart.\n * // if not, you need to set shipping address on cart first.\n *\n * const params = {\n * cart_id: 'some-cart-id',\n * shipping_methods: [\n * {\n * carrier_code: 'flatrate',\n * method_code: 'flatrate'\n * }\n * ]\n * };\n *\n * const { data } = await sdk.magento.setShippingMethodsOnCart(params);\n *\n * // you can get set shipping methods on cart response from\n * // data?.setShippingMethodsOnCart?.cart?.shipping_addresses?.[0]?.selected_shipping_method?.method_code\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query to change the amount of fields returned by the query, when compared to the default query\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'set-shipping-methods-on-cart-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation setShippingMethodsOnCart($input: SetShippingMethodsOnCartInput) {\n * setShippingMethodsOnCart(input: $input) {\n * cart {\n * ${metadata.fields}\n * }\n * }\n * }`\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query created in the previous example\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * // you will get only selected_shipping_method.method_code field\n *\n * const customQuery = {\n * setShippingMethodsOnCart: 'set-shipping-methods-on-cart-custom-query',\n * metadata: {\n * fields: 'shipping_addresses { selected_shipping_method { method_code } }'\n * }\n * };\n *\n * const params = {\n * cart_id: 'some-cart-id',\n * shipping_methods: [\n * {\n * carrier_code: 'flatrate',\n * method_code: 'flatrate'\n * }\n * ]\n * };\n *\n * const { data } = await sdk.magento.setShippingMethodsOnCart(params, { customQuery });\n *\n * // data will contain only the fields specified in the custom query.\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -10095,7 +10095,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!storeConfig:function(1)", - "docComment": "/**\n * Method to fetch store configuration\n *\n * @remarks\n *\n * This method sends a GET request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.storeConfig | storeConfig} 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#storeConfig | here}.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#StoreConfigResponse | StoreConfigResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch store configuration\n * const result = await sdk.magento.storeConfig();\n *\n * // result?.data?.storeConfig contains the store configuration\n * ```\n *\n * @example\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'store-config-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query storeConfig {\n * storeConfig {\n * ${metadata?.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to select only the fields you need\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // we want to fetch only logo related data\n * const customQuery = {\n * storeConfig: 'store-config-custom-query',\n * metadata: {\n * fields: 'logo_alt logo_height logo_width'\n * }\n * };\n *\n * const result = await sdk.magento.storeConfig({ customQuery });\n * ```\n *\n */\n", + "docComment": "/**\n * Method to fetch store configuration\n *\n * @remarks\n *\n * This method sends a GET request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/storeConfig | storeConfig} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/storeConfig | here}.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/StoreConfigResponse | StoreConfigResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch store configuration\n * const result = await sdk.magento.storeConfig();\n *\n * // result?.data?.storeConfig contains the store configuration\n * ```\n *\n * @example\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'store-config-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query storeConfig {\n * storeConfig {\n * ${metadata?.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to select only the fields you need\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // we want to fetch only logo related data\n * const customQuery = {\n * storeConfig: 'store-config-custom-query',\n * metadata: {\n * fields: 'logo_alt logo_height logo_width'\n * }\n * };\n *\n * const result = await sdk.magento.storeConfig({ customQuery });\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -10287,7 +10287,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!subscribeEmailToNewsletter:function(1)", - "docComment": "/**\n * Method allows guests and registered customers to sign up to receive newsletters.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.subscribeEmailToNewsletter | subscribeEmailToNewsletter} 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#subscribeEmailToNewsletter | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#SubscribeEmailToNewsletterResponse | SubscribeEmailToNewsletterResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // subscribe an email in the newsletter. * const email = 'somemail@vsf.local';\n * const result = await sdk.magento.subscribeEmailToNewsletter({ email });\n *\n * result.data?.subscribeEmailToNewsletter?.status; // status of the operation. Possible values: https://developer.adobe.com/commerce/webapi/graphql/schema/customer/mutations/subscribe-email-to-newsletter/#subscriptionstatusesenum\n * ```\n *\n */\n", + "docComment": "/**\n * Method allows guests and registered customers to sign up to receive newsletters.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/subscribeEmailToNewsletter | subscribeEmailToNewsletter} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/subscribeEmailToNewsletter | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/SubscribeEmailToNewsletterResponse | SubscribeEmailToNewsletterResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // subscribe an email in the newsletter. * const email = 'somemail@vsf.local';\n * const result = await sdk.magento.subscribeEmailToNewsletter({ email });\n *\n * result.data?.subscribeEmailToNewsletter?.status; // status of the operation. Possible values: https://developer.adobe.com/commerce/webapi/graphql/schema/customer/mutations/subscribe-email-to-newsletter/#subscriptionstatusesenum\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -10482,7 +10482,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!updateCartItems:function(1)", - "docComment": "/**\n * Method to update items in the cart\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.updateCartItems | updateCartItems} 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#updateCartItems | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#UpdateCartItemsResponse | UpdateCartItemsResponse}.\n *\n * @example\n *\n * Simple usage, updating the quantity of a cart item:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // update the quantity of a cart item\n * const result = await sdk.magento.updateCartItems({\n * cart_id: 'some-cart-id'\n * cart_items: [{\n * cart_item_uid: 'MY=',\n * quantity: 10 // update the quantity to 10\n * }]\n * });\n *\n * // result will contain the updated cart.\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for manipulating the cart response data.\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'update-cart-items-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation updateCartItems($input: UpdateCartItemsInput) {\n * updateCartItems(input: $input) {\n * cart {\n * ${metadata.fields}\n * }\n * }\n * }`\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query created in the previous example. Note that the custom query must be passed to the `customQuery` property of the `options` parameter. The `metadata` property of the `options` parameter can be used to pass additional data to the custom query.\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * updateCartItems: 'update-cart-items-custom-query',\n * metadata: {\n * fields: 'id items { uid quantity product { uid sku }}'\n * }\n * };\n *\n * // update the quantity of a cart item with params and custom query\n * // Params are the same as in the previous example.\n * const result = await sdk.magento.updateCartItems(params, { customQuery });\n * ```\n *\n */\n", + "docComment": "/**\n * Method to update items in the cart\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/updateCartItems | updateCartItems} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/updateCartItems | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/UpdateCartItemsResponse | UpdateCartItemsResponse}.\n *\n * @example\n *\n * Simple usage, updating the quantity of a cart item:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // update the quantity of a cart item\n * const result = await sdk.magento.updateCartItems({\n * cart_id: 'some-cart-id'\n * cart_items: [{\n * cart_item_uid: 'MY=',\n * quantity: 10 // update the quantity to 10\n * }]\n * });\n *\n * // result will contain the updated cart.\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for manipulating the cart response data.\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'update-cart-items-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation updateCartItems($input: UpdateCartItemsInput) {\n * updateCartItems(input: $input) {\n * cart {\n * ${metadata.fields}\n * }\n * }\n * }`\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query created in the previous example. Note that the custom query must be passed to the `customQuery` property of the `options` parameter. The `metadata` property of the `options` parameter can be used to pass additional data to the custom query.\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * updateCartItems: 'update-cart-items-custom-query',\n * metadata: {\n * fields: 'id items { uid quantity product { uid sku }}'\n * }\n * };\n *\n * // update the quantity of a cart item with params and custom query\n * // Params are the same as in the previous example.\n * const result = await sdk.magento.updateCartItems(params, { customQuery });\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -10690,7 +10690,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!updateCustomer:function(1)", - "docComment": "/**\n * Method to update customer data. Customer data is updated based on the current customer token.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.updateCustomer | updateCustomer} 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#updateCustomer | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#UpdateCustomerResponse | UpdateCustomerResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // Updates customer first name\n * const result = await sdk.magento.updateCustomer({\n * firstname: 'New John'\n * });\n *\n * // result contains updated customer data\n * console.log(result); // result.data.updateCustomerV2.customer.firstname === 'New John'\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'update-customer-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation updateCustomer($input: CustomerUpdateInput!) {\n * updateCustomerV2(input: $input) {\n * customer {\n * ${metadata.fields}\n * }\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to reduce the amount of data returned by the query\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * updateCustomer: 'update-customer-custom-query',\n * metadata: {\n * fields: 'firstname lastname'\n * }\n * };\n *\n * const result = await sdk.magento.updateCustomer({\n * firstname: 'New John'\n * lastname: 'New Doe'\n * }, { customQuery });\n *\n * // result contains only the fields specified in the custom query\n * // result.data.updateCustomerV2.customer.firstname === 'New John'\n * // result.data.updateCustomerV2.customer.lastname === 'New Doe'\n * console.log(result); // result.data.updateCustomerV2.customer.firstname === 'New John'\n * ```\n *\n */\n", + "docComment": "/**\n * Method to update customer data. Customer data is updated based on the current customer token.\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/updateCustomer | updateCustomer} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/updateCustomer | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/UpdateCustomerResponse | UpdateCustomerResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // Updates customer first name\n * const result = await sdk.magento.updateCustomer({\n * firstname: 'New John'\n * });\n *\n * // result contains updated customer data\n * console.log(result); // result.data.updateCustomerV2.customer.firstname === 'New John'\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'update-customer-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation updateCustomer($input: CustomerUpdateInput!) {\n * updateCustomerV2(input: $input) {\n * customer {\n * ${metadata.fields}\n * }\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to reduce the amount of data returned by the query\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * updateCustomer: 'update-customer-custom-query',\n * metadata: {\n * fields: 'firstname lastname'\n * }\n * };\n *\n * const result = await sdk.magento.updateCustomer({\n * firstname: 'New John'\n * lastname: 'New Doe'\n * }, { customQuery });\n *\n * // result contains only the fields specified in the custom query\n * // result.data.updateCustomerV2.customer.firstname === 'New John'\n * // result.data.updateCustomerV2.customer.lastname === 'New Doe'\n * console.log(result); // result.data.updateCustomerV2.customer.firstname === 'New John'\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -10790,7 +10790,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!updateCustomerAddress:function(1)", - "docComment": "/**\n * Method to update customer address The user needs to be logged in in order to send this request\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.updateCustomerAddress | updateCustomerAddress} 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#updateCustomerAddress | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#UpdateCustomerAddressResponse | UpdateCustomerAddressResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch updated customer address\n * const result = await sdk.magento.updateCustomerAddress();\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for updating customer address\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'update-customer-address-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation updateCustomerAddress($id: Int!, $input: CustomerAddressInput) {\n * updateCustomerAddress(id: $id, input: $input) {\n * ${metadata.fields}\n * }\n * }\n * `\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to update customer address\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * updateCustomerAddress: 'update-customer-address-custom-query',\n * metadata: {\n * fields: 'id city company'\n * }\n * };\n *\n * const result = await sdk.magento.updateCustomerAddress({ id: 308, input: { city: \"Warsaw\" } }, { customQuery });\n *\n * // result will contain only the fields specified in the custom query.\n * ```\n *\n */\n", + "docComment": "/**\n * Method to update customer address The user needs to be logged in in order to send this request\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/updateCustomerAddress | updateCustomerAddress} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/updateCustomerAddress | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/UpdateCustomerAddressResponse | UpdateCustomerAddressResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch updated customer address\n * const result = await sdk.magento.updateCustomerAddress();\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for updating customer address\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'update-customer-address-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation updateCustomerAddress($id: Int!, $input: CustomerAddressInput) {\n * updateCustomerAddress(id: $id, input: $input) {\n * ${metadata.fields}\n * }\n * }\n * `\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to update customer address\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * updateCustomerAddress: 'update-customer-address-custom-query',\n * metadata: {\n * fields: 'id city company'\n * }\n * };\n *\n * const result = await sdk.magento.updateCustomerAddress({ id: 308, input: { city: \"Warsaw\" } }, { customQuery });\n *\n * // result will contain only the fields specified in the custom query.\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -10998,7 +10998,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!updateCustomerEmail:function(1)", - "docComment": "/**\n * Method to update customer email\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.updateCustomerEmail | updateCustomerEmail} 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#updateCustomerEmail | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#UpdateCustomerEmailResponse | UpdateCustomerEmailResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // update customer\n * const result = await sdk.magento.updateCustomerEmail({ email: \"johndoe@example.com\", password: \"hunter2\" });\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for updating customer\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'update-customer-email-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation updateCustomerEmail($email: String!, $password: String!) {\n * updateCustomerEmail(email: $email, password: $password){\n * customer {\n * ${metadata.fields}\n * }\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to update customer\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * updateCustomerEmail: 'update-customer-email-custom-query',\n * metadata: {\n * fields: 'email firstname'\n * }\n * };\n *\n * const result = await sdk.magento.updateCustomerEmail({ email: \"johndoe@example.com\", password: \"hunter2\" }, { customQuery });\n *\n * // Result will contain only the fields specified in the custom query.\n * ```\n *\n */\n", + "docComment": "/**\n * Method to update customer email\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/updateCustomerEmail | updateCustomerEmail} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/updateCustomerEmail | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/UpdateCustomerEmailResponse | UpdateCustomerEmailResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // update customer\n * const result = await sdk.magento.updateCustomerEmail({ email: \"johndoe@example.com\", password: \"hunter2\" });\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for updating customer\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'update-customer-email-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * mutation updateCustomerEmail($email: String!, $password: String!) {\n * updateCustomerEmail(email: $email, password: $password){\n * customer {\n * ${metadata.fields}\n * }\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to update customer\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * // reduce the amount of fields returned by the query, when compared to the default query\n * const customQuery = {\n * updateCustomerEmail: 'update-customer-email-custom-query',\n * metadata: {\n * fields: 'email firstname'\n * }\n * };\n *\n * const result = await sdk.magento.updateCustomerEmail({ email: \"johndoe@example.com\", password: \"hunter2\" }, { customQuery });\n *\n * // Result will contain only the fields specified in the custom query.\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -11314,7 +11314,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!upsellProducts:function(1)", - "docComment": "/**\n * Method to get upsell products for a given product.\n *\n * @remarks\n *\n * This method sends a GET request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.upsellProducts | upsellProducts} 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#upsellProductQuery | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#UpsellProductsResponse | UpsellProductsResponse}.\n *\n * @example\n *\n * Simple usage without filters, sorting or pagination:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch list of upsell-products with default parameters\n * const upsellProducts = await sdk.magento.upsellProducts({});\n * ```\n *\n * @example\n *\n * Usage with filters, sorting and pagination:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // make a request to fetch list of products with upsell products\n * const upsellProducts = await sdk.magento.upsellProducts({\n * pageSize: 20,\n * currentPage: 1,\n * filter: {\n * sku: {\n * eq: PRODUCT_SKU\n * }\n * }\n * });\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for getting upsellProducts.\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'upsell-products-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query upsellProducts(\n * $search: String = \"\",\n * $filter: ProductAttributeFilterInput,\n * $pageSize: Int = 10,\n * $currentPage: Int = 1,\n * $sort: ProductAttributeSortInput\n * ) {\n * products(search: $search, filter: $filter, sort: $sort, pageSize: $pageSize, currentPage: $currentPage) {\n * ${metadata.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to fetch upsell-products.\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * const customQuery = {\n * upsellProducts: 'upsell-products-custom-query',\n * metadata: {\n * fields: 'items { sku name upsell_products { sku } }'\n * }\n * };\n *\n * const upsellProducts = await sdk.magento.upsellProducts({\n * filter: {\n * sku: {\n * eq: 'some-sku' // optional SKU filter\n * }\n * }\n * }, { customQuery });\n *\n * // upsellProducts will contain only the fields specified in the custom query.\n * ```\n *\n */\n", + "docComment": "/**\n * Method to get upsell products for a given product.\n *\n * @remarks\n *\n * This method sends a GET request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/upsellProducts | upsellProducts} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/upsellProductQuery | here}.\n *\n * @param params - Parameter object which can be used with this method. Refer to its type definition to learn about possible properties.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/UpsellProductsResponse | UpsellProductsResponse}.\n *\n * @example\n *\n * Simple usage without filters, sorting or pagination:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // fetch list of upsell-products with default parameters\n * const upsellProducts = await sdk.magento.upsellProducts({});\n * ```\n *\n * @example\n *\n * Usage with filters, sorting and pagination:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // make a request to fetch list of products with upsell products\n * const upsellProducts = await sdk.magento.upsellProducts({\n * pageSize: 20,\n * currentPage: 1,\n * filter: {\n * sku: {\n * eq: PRODUCT_SKU\n * }\n * }\n * });\n * ```\n *\n * @example\n *\n * Creating a custom GraphQL query for getting upsellProducts.\n * ```ts\n * module.exports = {\n * integrations: {\n * magento: {\n * customQueries: {\n * 'upsell-products-custom-query': ({ variables, metadata }) => ({\n * variables,\n * query: `\n * query upsellProducts(\n * $search: String = \"\",\n * $filter: ProductAttributeFilterInput,\n * $pageSize: Int = 10,\n * $currentPage: Int = 1,\n * $sort: ProductAttributeSortInput\n * ) {\n * products(search: $search, filter: $filter, sort: $sort, pageSize: $pageSize, currentPage: $currentPage) {\n * ${metadata.fields}\n * }\n * }\n * `\n * }),\n * },\n * }\n * }\n * };\n * ```\n *\n * @example\n *\n * Using a custom GraphQL query to fetch upsell-products.\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n * const customQuery = {\n * upsellProducts: 'upsell-products-custom-query',\n * metadata: {\n * fields: 'items { sku name upsell_products { sku } }'\n * }\n * };\n *\n * const upsellProducts = await sdk.magento.upsellProducts({\n * filter: {\n * sku: {\n * eq: 'some-sku' // optional SKU filter\n * }\n * }\n * }, { customQuery });\n *\n * // upsellProducts will contain only the fields specified in the custom query.\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", @@ -11522,7 +11522,7 @@ { "kind": "Function", "canonicalReference": "@vue-storefront/magento-sdk!wishlistItemsCount:function(1)", - "docComment": "/**\n * Method to count items in the wishlist\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.wishlistItemsCount | wishlistItemsCount} 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#wishlist | here}.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#WishlistItemsCountResponse | WishlistItemsCountResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // returns items counter of each wishlist for currently logged in customer\n * const response = await sdk.magento.wishlistItemsCount();\n * // response.data?.customer!.wishlists - array with object containing items counter.\n * // response.data?.customer!.wishlists[X]!.items_count - items_counter for each selected wishlist.\n * // index of element in the array isn't equal wishlist's id in the magento.\n * ```\n *\n */\n", + "docComment": "/**\n * Method to count items in the wishlist\n *\n * @remarks\n *\n * This method sends a POST request to the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/wishlistItemsCount | wishlistItemsCount} endpoint of the Vue Storefront API Middleware. The default GraphQL query used by this method can be found {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/wishlist | here}.\n *\n * @param options - Options that can be passed to additionally configure the request or customize the logic in a plugin.\n *\n * @typeParam Res - Customizable response interface to be used with custom queries.\n *\n * @returns Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/WishlistItemsCountResponse | WishlistItemsCountResponse}.\n *\n * @example\n *\n * Simple usage:\n * ```ts\n * import { sdk } from '~/sdk.config.ts';\n *\n * // returns items counter of each wishlist for currently logged in customer\n * const response = await sdk.magento.wishlistItemsCount();\n * // response.data?.customer!.wishlists - array with object containing items counter.\n * // response.data?.customer!.wishlists[X]!.items_count - items_counter for each selected wishlist.\n * // index of element in the array isn't equal wishlist's id in the magento.\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", diff --git a/packages/sdk/src/methods/addProductToWishList/index.ts b/packages/sdk/src/methods/addProductToWishList/index.ts index 66172706e..232baff10 100644 --- 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 index 30927e939..7d040cf52 100644 --- a/packages/sdk/src/methods/addProductsToCart/index.ts +++ b/packages/sdk/src/methods/addProductsToCart/index.ts @@ -21,10 +21,10 @@ export type AddProductsToCartResponse * * @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 * @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 index efadcc35c..4eb5a9900 100644 --- a/packages/sdk/src/methods/cart/index.ts +++ b/packages/sdk/src/methods/cart/index.ts @@ -20,10 +20,10 @@ export type CartResponse = 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 = 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 index eb687e8c8..8db5fe59f 100644 --- a/packages/sdk/src/methods/cartTotalQty/index.ts +++ b/packages/sdk/src/methods/cartTotalQty/index.ts @@ -25,10 +25,10 @@ export type CartTotalQtyResponse = 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 = 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 index 9fcdef05a..e816732d7 100644 --- a/packages/sdk/src/methods/categorySearch/index.ts +++ b/packages/sdk/src/methods/categorySearch/index.ts @@ -23,10 +23,10 @@ export type CategorySearchResponse = * * @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 = * @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 index 8dcf99036..88a299357 100644 --- 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 index 8b1c2ef92..01fdb007e 100644 --- a/packages/sdk/src/methods/cmsBlocks/index.ts +++ b/packages/sdk/src/methods/cmsBlocks/index.ts @@ -20,10 +20,10 @@ export type CmsBlocksResponse = 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 = 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 index 917e1be8f..d1e8c7a77 100644 --- a/packages/sdk/src/methods/cmsPage/index.ts +++ b/packages/sdk/src/methods/cmsPage/index.ts @@ -20,10 +20,10 @@ export type CmsPageResponse = 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 = 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 index 4f47dba03..70c69d5f8 100644 --- a/packages/sdk/src/methods/countries/index.ts +++ b/packages/sdk/src/methods/countries/index.ts @@ -20,10 +20,10 @@ export type CountriesResponse = 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 = 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 index e549a173d..096952a3e 100644 --- a/packages/sdk/src/methods/createCustomer/index.ts +++ b/packages/sdk/src/methods/createCustomer/index.ts @@ -21,10 +21,10 @@ export type CreateCustomerResponse * * @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 * @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 index 722e368ef..ef0bac8d2 100644 --- 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: diff --git a/packages/sdk/src/methods/createEmptyCart/index.ts b/packages/sdk/src/methods/createEmptyCart/index.ts index bbbafae3d..ab22d53c0 100644 --- a/packages/sdk/src/methods/createEmptyCart/index.ts +++ b/packages/sdk/src/methods/createEmptyCart/index.ts @@ -21,10 +21,10 @@ export type CreateEmptyCartResponse = CurrencyQuer * * @remarks * This method sends a GET request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.currency | currency } endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/currency | currency } 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#currency | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/currency | here}. * * @param options - * Options that can be passed to additionally configure the request @@ -32,7 +32,7 @@ export type CurrencyResponse = CurrencyQuer * @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#CurrencyResponse | CurrencyResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CurrencyResponse | CurrencyResponse}. * * @example * Simple usage: diff --git a/packages/sdk/src/methods/customMutation/index.ts b/packages/sdk/src/methods/customMutation/index.ts index b0a22ec6f..c174fcdb3 100644 --- a/packages/sdk/src/methods/customMutation/index.ts +++ b/packages/sdk/src/methods/customMutation/index.ts @@ -20,7 +20,7 @@ export type CustomMutationInput = { /** * Method to send an arbitrary GraphQL mutation to the Magento GraphQL endpoint - * For sending query, please see {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#customQuery | customQuery}. + * For sending query, please see {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/customQuery | customQuery}. * * @remarks * This method sends a POST request to the @@ -39,7 +39,7 @@ export type CustomMutationInput = { * @typeParam INPUT - 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#CustomQueryResponse | CustomQueryResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CustomQueryResponse | CustomQueryResponse}. * * @example * Simple usage: diff --git a/packages/sdk/src/methods/customQuery/index.ts b/packages/sdk/src/methods/customQuery/index.ts index bd8630684..a6024c030 100644 --- a/packages/sdk/src/methods/customQuery/index.ts +++ b/packages/sdk/src/methods/customQuery/index.ts @@ -19,7 +19,7 @@ export type CustomQueryInput = { /** * Method to send an arbitrary GraphQL query to the Magento GraphQL endpoint - * For sending mutation, please see {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#customMutation | customMutation}. + * For sending mutation, please see {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/customMutation | customMutation}. * * @remarks * This method sends a POST request to the @@ -38,7 +38,7 @@ export type CustomQueryInput = { * @typeParam INPUT - 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#CustomQueryResponse | CustomQueryResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CustomQueryResponse | CustomQueryResponse}. * * @example * Simple usage: diff --git a/packages/sdk/src/methods/customer/index.ts b/packages/sdk/src/methods/customer/index.ts index edb53caf2..d3dc68a6a 100644 --- a/packages/sdk/src/methods/customer/index.ts +++ b/packages/sdk/src/methods/customer/index.ts @@ -20,10 +20,10 @@ export type CustomerResponse = CustomerQuer * * @remarks * This method sends a POST request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.customer | customer } endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/customer | customer } 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#customer | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/customer | here}. * * @param options - * Options that can be passed to additionally configure the request @@ -32,7 +32,7 @@ export type CustomerResponse = CustomerQuer * @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#CustomerResponse | CustomerResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CustomerResponse | CustomerResponse}. * * @example * The `customer()` returns the currently active user. diff --git a/packages/sdk/src/methods/customerCart/index.ts b/packages/sdk/src/methods/customerCart/index.ts index 0aeadd350..f131f9cad 100644 --- a/packages/sdk/src/methods/customerCart/index.ts +++ b/packages/sdk/src/methods/customerCart/index.ts @@ -19,10 +19,10 @@ export type CustomerCartResponse = Cust * Method to fetch customer cart * @remarks * This method sends a POST request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.customerCart | customerCart } endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/customerCart | customerCart } 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#customerCart | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/customerCart | here}. * * @param options - * Options that can be passed to additionally configure the request @@ -31,7 +31,7 @@ export type CustomerCartResponse = Cust * @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#CustomerCartResponse | CustomerCartResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/CustomerCartResponse | CustomerCartResponse}. * * @example * Simple usage: diff --git a/packages/sdk/src/methods/deleteCustomerAddress/index.ts b/packages/sdk/src/methods/deleteCustomerAddress/index.ts index 3f01fdd59..123fa742d 100644 --- a/packages/sdk/src/methods/deleteCustomerAddress/index.ts +++ b/packages/sdk/src/methods/deleteCustomerAddress/index.ts @@ -22,10 +22,10 @@ export type DeleteCustomerAddressResponse< * * @remarks * This method sends a POST request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.deleteCustomerAddress | deleteCustomerAddress } endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/deleteCustomerAddress | deleteCustomerAddress } 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#deleteCustomerAddress | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/deleteCustomerAddress | here}. * * @param params - * Parameter object which can be used with this method. @@ -38,7 +38,7 @@ export type DeleteCustomerAddressResponse< * @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#DeleteCustomerAddressResponse | DeleteCustomerAddressResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/DeleteCustomerAddressResponse | DeleteCustomerAddressResponse}. * * @example * Simple usage: diff --git a/packages/sdk/src/methods/generateCustomerToken/index.ts b/packages/sdk/src/methods/generateCustomerToken/index.ts index a4515272f..4db4b8828 100644 --- a/packages/sdk/src/methods/generateCustomerToken/index.ts +++ b/packages/sdk/src/methods/generateCustomerToken/index.ts @@ -29,10 +29,10 @@ export type GenerateCustomerTokenResponse< * * @remarks * This method sends a POST request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.generateCustomerToken | generateCustomerToken } endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/generateCustomerToken | generateCustomerToken } 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#generateCustomerToken | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/generateCustomerToken | here}. * * @param params - * Parameter object which can be used with this method. @@ -45,7 +45,7 @@ export type GenerateCustomerTokenResponse< * @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#GenerateCustomerTokenResponse | GenerateCustomerTokenResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/GenerateCustomerTokenResponse | GenerateCustomerTokenResponse}. * * @example * Simple usage: diff --git a/packages/sdk/src/methods/getAvailableCustomerPaymentMethods/index.ts b/packages/sdk/src/methods/getAvailableCustomerPaymentMethods/index.ts index 574f35126..573fb23ad 100644 --- a/packages/sdk/src/methods/getAvailableCustomerPaymentMethods/index.ts +++ b/packages/sdk/src/methods/getAvailableCustomerPaymentMethods/index.ts @@ -22,10 +22,10 @@ export type GetAvailableCustomerPaymentMethodsResponse< * * @remarks * This method sends a POST request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.getAvailableCustomerPaymentMethods | getAvailableCustomerPaymentMethods } endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/getAvailableCustomerPaymentMethods | getAvailableCustomerPaymentMethods } 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#getAvailableCustomerPaymentMethods | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/getAvailableCustomerPaymentMethods | here}. * * @param options - * Options that can be passed to additionally configure the request @@ -34,7 +34,7 @@ export type GetAvailableCustomerPaymentMethodsResponse< * @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#GetAvailableCustomerPaymentMethodsResponse | GetAvailableCustomerPaymentMethodsResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/GetAvailableCustomerPaymentMethodsResponse | GetAvailableCustomerPaymentMethodsResponse}. * * @example * Simple usage: diff --git a/packages/sdk/src/methods/getAvailableCustomerShippingMethods/index.ts b/packages/sdk/src/methods/getAvailableCustomerShippingMethods/index.ts index d73b48207..e7ba0b837 100644 --- a/packages/sdk/src/methods/getAvailableCustomerShippingMethods/index.ts +++ b/packages/sdk/src/methods/getAvailableCustomerShippingMethods/index.ts @@ -23,10 +23,10 @@ export type GetAvailableCustomerShippingMethodsResponse< * * @remarks * This method sends a POST request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.getAvailableCustomerShippingMethods | getAvailableCustomerShippingMethods } endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/getAvailableCustomerShippingMethods | getAvailableCustomerShippingMethods } 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#getAvailableCustomerShippingMethods | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/getAvailableCustomerShippingMethods | here}. * * @param options - * Options that can be passed to additionally configure the request @@ -35,7 +35,7 @@ export type GetAvailableCustomerShippingMethodsResponse< * @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#GetAvailableCustomerShippingMethodsResponse | GetAvailableCustomerShippingMethodsResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/GetAvailableCustomerShippingMethodsResponse | GetAvailableCustomerShippingMethodsResponse}. * * @example * Simple usage: diff --git a/packages/sdk/src/methods/getAvailablePaymentMethods/index.ts b/packages/sdk/src/methods/getAvailablePaymentMethods/index.ts index c178fc833..bba540609 100644 --- a/packages/sdk/src/methods/getAvailablePaymentMethods/index.ts +++ b/packages/sdk/src/methods/getAvailablePaymentMethods/index.ts @@ -19,14 +19,14 @@ export type GetAvailablePaymentMethodsResponse< /** * Method to get available payment methods for the received guest cart. - * To get available customer payment methods use {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#getAvailableCustomerPaymentMethods | getAvailableCustomerPaymentMethods }. + * To get available customer payment methods use {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/getAvailableCustomerPaymentMethods | getAvailableCustomerPaymentMethods }. * * @remarks * This method sends a POST request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.getAvailablePaymentMethods | getAvailablePaymentMethods } endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/getAvailablePaymentMethods | getAvailablePaymentMethods } 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#getAvailablePaymentMethods | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/getAvailablePaymentMethods | here}. * * @param params - * Parameter object which can be used with this method. @@ -39,7 +39,7 @@ export type GetAvailablePaymentMethodsResponse< * @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#GetAvailablePaymentMethodsResponse | GetAvailablePaymentMethodsResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/GetAvailablePaymentMethodsResponse | GetAvailablePaymentMethodsResponse}. * * @example * Simple usage: diff --git a/packages/sdk/src/methods/getAvailableShippingMethods/index.ts b/packages/sdk/src/methods/getAvailableShippingMethods/index.ts index 7501bf507..91b97308e 100644 --- a/packages/sdk/src/methods/getAvailableShippingMethods/index.ts +++ b/packages/sdk/src/methods/getAvailableShippingMethods/index.ts @@ -22,10 +22,10 @@ export type GetAvailableShippingMethodsResponse< * * @remarks * This method sends a POST request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.getAvailableShippingMethods | getAvailableShippingMethods } endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/getAvailableShippingMethods | getAvailableShippingMethods } 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#getAvailableShippingMethods | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/getAvailableShippingMethods | here}. * * @param params - * Parameter object which can be used with this method. @@ -38,7 +38,7 @@ export type GetAvailableShippingMethodsResponse< * @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#GetAvailableShippingMethodsResponse | GetAvailableShippingMethodsResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/GetAvailableShippingMethodsResponse | GetAvailableShippingMethodsResponse}. * * @example * Simple usage: diff --git a/packages/sdk/src/methods/getCustomerAddresses/index.ts b/packages/sdk/src/methods/getCustomerAddresses/index.ts index 3aafe0d8f..780a3a9e9 100644 --- a/packages/sdk/src/methods/getCustomerAddresses/index.ts +++ b/packages/sdk/src/methods/getCustomerAddresses/index.ts @@ -22,10 +22,10 @@ export type GetCustomerAddressesResponse = Merge * * @remarks * This method sends a POST request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.mergeCarts | mergeCarts } endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/mergeCarts | mergeCarts } 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#mergeCarts | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/mergeCarts | here}. * * @param params - * Parameter object which can be used with this method. @@ -36,7 +36,7 @@ export type MergeCartsResponse = Merge * @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#MergeCartsResponse | MergeCartsResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/MergeCartsResponse | MergeCartsResponse}. * * @example * Simple usage: diff --git a/packages/sdk/src/methods/placeOrder/index.ts b/packages/sdk/src/methods/placeOrder/index.ts index 09498406d..31d1fa496 100644 --- a/packages/sdk/src/methods/placeOrder/index.ts +++ b/packages/sdk/src/methods/placeOrder/index.ts @@ -20,10 +20,10 @@ export type PlaceOrderResponse = Place * * @remarks * This method sends a POST request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.placeOrder | placeOrder } endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/placeOrder | placeOrder } 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#placeOrder | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/placeOrder | here}. * * @param params - * Parameter object which can be used with this method. @@ -36,7 +36,7 @@ export type PlaceOrderResponse = Place * @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#PlaceOrderResponse | PlaceOrderResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/PlaceOrderResponse | PlaceOrderResponse}. * * @example * Simple usage: diff --git a/packages/sdk/src/methods/productDetails/index.ts b/packages/sdk/src/methods/productDetails/index.ts index 839ef05b3..01fa2dcde 100644 --- a/packages/sdk/src/methods/productDetails/index.ts +++ b/packages/sdk/src/methods/productDetails/index.ts @@ -21,10 +21,10 @@ export type ProductDetailsResponse = * * @remarks * This method sends a GET request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.productDetails | productDetails} endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/productDetails | productDetails} 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#productDetailsQuery | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/productDetailsQuery | here}. * * @param params - * Parameter object which can be used with this method. @@ -37,7 +37,7 @@ export type ProductDetailsResponse = * @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#ProductDetailsResponse | ProductDetailsResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/ProductDetailsResponse | ProductDetailsResponse}. * * @example * Simple usage without filters, sorting or pagination: diff --git a/packages/sdk/src/methods/productReview/index.ts b/packages/sdk/src/methods/productReview/index.ts index 2f0fac97c..a0e3a4bd7 100644 --- a/packages/sdk/src/methods/productReview/index.ts +++ b/packages/sdk/src/methods/productReview/index.ts @@ -21,10 +21,10 @@ export type ProductReviewResponse = Pr * * @remarks * This method sends a GET request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.productReview | productReview } endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/productReview | productReview } 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#productReview | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/productReview | here}. * * @param params - * Parameter object which can be used with this method. @@ -37,7 +37,7 @@ export type ProductReviewResponse = Pr * @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#ProductReviewResponse | ProductReviewResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/ProductReviewResponse | ProductReviewResponse}. * * @example * Simple usage: diff --git a/packages/sdk/src/methods/productReviewRatingsMetadata/index.ts b/packages/sdk/src/methods/productReviewRatingsMetadata/index.ts index 17cc9b1d2..da4380058 100644 --- a/packages/sdk/src/methods/productReviewRatingsMetadata/index.ts +++ b/packages/sdk/src/methods/productReviewRatingsMetadata/index.ts @@ -22,10 +22,10 @@ export type ProductReviewRatingsMetadataResponse< * * @remarks * This method sends a GET request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.productReviewRatingsMetadata | productReviewRatingsMetadata } endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/productReviewRatingsMetadata | productReviewRatingsMetadata } 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#productReviewRatingsMetadata | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/productReviewRatingsMetadata | here}. * * @param options - * Options that can be passed to additionally configure the request @@ -34,7 +34,7 @@ export type ProductReviewRatingsMetadataResponse< * @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#ProductReviewRatingsMetadataResponse | ProductReviewRatingsMetadataResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/ProductReviewRatingsMetadataResponse | ProductReviewRatingsMetadataResponse}. * * @example * Simple usage: diff --git a/packages/sdk/src/methods/products/index.ts b/packages/sdk/src/methods/products/index.ts index 2cf6636f3..c1f26bf51 100644 --- a/packages/sdk/src/methods/products/index.ts +++ b/packages/sdk/src/methods/products/index.ts @@ -21,7 +21,7 @@ export type ProductsListResponse = Prod * * @remarks * This method sends a GET request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.products | products} endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/products | products} endpoint * of the Vue Storefront API Middleware. * The default GraphQL query used by this method can be found * {@link @vue-storefront/magento-types#productsListQuery | here}. @@ -37,7 +37,7 @@ export type ProductsListResponse = Prod * @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#ProductsListResponse | ProductsListResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/ProductsListResponse | ProductsListResponse}. * * @example * Simple usage without filters, sorting or pagination: diff --git a/packages/sdk/src/methods/relatedProducts/index.ts b/packages/sdk/src/methods/relatedProducts/index.ts index 8104d3fb3..51f41d936 100644 --- a/packages/sdk/src/methods/relatedProducts/index.ts +++ b/packages/sdk/src/methods/relatedProducts/index.ts @@ -21,10 +21,10 @@ export type RelatedProductsResponse * * @remarks * This method sends a GET request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.relatedProduct | relatedProduct} endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/relatedProduct | relatedProduct} 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#relatedProduct | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/relatedProduct | here}. * * @param params - * Parameter object which can be used with this method. @@ -37,7 +37,7 @@ export type RelatedProductsResponse * @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#RelatedProductsResponse | RelatedProductsResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/RelatedProductsResponse | RelatedProductsResponse}. * * @example * Simple usage without filters, sorting or pagination: diff --git a/packages/sdk/src/methods/removeCouponFromCart/index.ts b/packages/sdk/src/methods/removeCouponFromCart/index.ts index 750ca0183..198ee087f 100644 --- a/packages/sdk/src/methods/removeCouponFromCart/index.ts +++ b/packages/sdk/src/methods/removeCouponFromCart/index.ts @@ -22,10 +22,10 @@ export type RemoveCouponFromCartResponse< * * @remarks * This method sends a POST request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.removeCouponFromCart | removeCouponFromCart} endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/removeCouponFromCart | removeCouponFromCart} 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#removeCouponFromCart | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/removeCouponFromCart | here}. * * @param params - * Parameter object which can be used with this method. @@ -38,7 +38,7 @@ export type RemoveCouponFromCartResponse< * @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#RemoveCouponFromCartResponse | RemoveCouponFromCartResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/RemoveCouponFromCartResponse | RemoveCouponFromCartResponse}. * * @example * Simple usage: diff --git a/packages/sdk/src/methods/removeItemFromCart/index.ts b/packages/sdk/src/methods/removeItemFromCart/index.ts index 5b92540b4..72c6c1dad 100644 --- a/packages/sdk/src/methods/removeItemFromCart/index.ts +++ b/packages/sdk/src/methods/removeItemFromCart/index.ts @@ -21,10 +21,10 @@ export type RemoveItemFromCartResponse = * * @remarks * This method sends a POST request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.resetPassword | resetPassword } endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/resetPassword | resetPassword } 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#resetPassword | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/resetPassword | here}. * * @param params - * Parameter object which can be used with this method. @@ -37,7 +37,7 @@ export type ResetPasswordResponse = * @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#ResetPasswordResponse | ResetPasswordResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/ResetPasswordResponse | ResetPasswordResponse}. * * @example * Simple usage: diff --git a/packages/sdk/src/methods/reviews/index.ts b/packages/sdk/src/methods/reviews/index.ts index 2dc70bffe..0cd1b4b18 100644 --- a/packages/sdk/src/methods/reviews/index.ts +++ b/packages/sdk/src/methods/reviews/index.ts @@ -21,10 +21,10 @@ export type ReviewsResponse = * * @remarks * This method sends a GET request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.reviews | reviews } endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/reviews | reviews } 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#reviews | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/reviews | here}. * * @param params - * Parameter object which can be used with this method. @@ -37,7 +37,7 @@ export type ReviewsResponse = * @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#reviewsResponse | reviewsResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/reviewsResponse | reviewsResponse}. * * @example * Simple usage: diff --git a/packages/sdk/src/methods/revokeCustomerToken/index.ts b/packages/sdk/src/methods/revokeCustomerToken/index.ts index 45b853545..5a0495309 100644 --- a/packages/sdk/src/methods/revokeCustomerToken/index.ts +++ b/packages/sdk/src/methods/revokeCustomerToken/index.ts @@ -23,10 +23,10 @@ export type RevokeCustomerTokenResponse< * * @remarks * This method sends a POST request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.revokeCustomerToken | revokeCustomerToken } endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/revokeCustomerToken | revokeCustomerToken } 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#revokeCustomerToken | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/revokeCustomerToken | here}. * * @param options - * Options that can be passed to additionally configure the request @@ -35,7 +35,7 @@ export type RevokeCustomerTokenResponse< * @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#RevokeCustomerTokenResponse | RevokeCustomerTokenResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/RevokeCustomerTokenResponse | RevokeCustomerTokenResponse}. * * @example * Simple usage if the customer is logged in and the token is valid: diff --git a/packages/sdk/src/methods/route/index.ts b/packages/sdk/src/methods/route/index.ts index 0703ea698..0ce009e61 100644 --- a/packages/sdk/src/methods/route/index.ts +++ b/packages/sdk/src/methods/route/index.ts @@ -20,10 +20,10 @@ export type RouteResponse = RouteQuery> = Apol * * @remarks * This method sends a GET request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.route | route } endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/route | route } 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#route | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/route | here}. * * @param params - * Parameter object which can be used with this method. @@ -36,7 +36,7 @@ export type RouteResponse = RouteQuery> = Apol * @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#RouteResponse | RouteResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/RouteResponse | RouteResponse}. * * @example * Simple usage: diff --git a/packages/sdk/src/methods/setBillingAddressOnCart/index.ts b/packages/sdk/src/methods/setBillingAddressOnCart/index.ts index ae76bd2c7..b44937cba 100644 --- a/packages/sdk/src/methods/setBillingAddressOnCart/index.ts +++ b/packages/sdk/src/methods/setBillingAddressOnCart/index.ts @@ -22,10 +22,10 @@ export type SetBillingAddressOnCartResponse< * * @remarks * This method sends a POST request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.setBillingAddressOnCart | setBillingAddressOnCart } endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/setBillingAddressOnCart | setBillingAddressOnCart } 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#setBillingAddressOnCart | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/setBillingAddressOnCart | here}. * * @param params - * Parameter object which can be used with this method. @@ -38,7 +38,7 @@ export type SetBillingAddressOnCartResponse< * @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#SetBillingAddressOnCartResponse | SetBillingAddressOnCartResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/SetBillingAddressOnCartResponse | SetBillingAddressOnCartResponse}. * * @example * Simple usage: diff --git a/packages/sdk/src/methods/setGuestEmailOnCart/index.ts b/packages/sdk/src/methods/setGuestEmailOnCart/index.ts index db820bbac..cda1aeafa 100644 --- a/packages/sdk/src/methods/setGuestEmailOnCart/index.ts +++ b/packages/sdk/src/methods/setGuestEmailOnCart/index.ts @@ -22,10 +22,10 @@ export type SetGuestEmailOnCartResponse< * * @remarks * This method sends a POST request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.setGuestEmailOnCart | setGuestEmailOnCart } endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/setGuestEmailOnCart | setGuestEmailOnCart } 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#setGuestEmailOnCart | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/setGuestEmailOnCart | here}. * * @param params - * Parameter object which can be used with this method. @@ -38,7 +38,7 @@ export type SetGuestEmailOnCartResponse< * @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#SetGuestEmailOnCartResponse | SetGuestEmailOnCartResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/SetGuestEmailOnCartResponse | SetGuestEmailOnCartResponse}. * * @example * Simple usage: diff --git a/packages/sdk/src/methods/setPaymentMethodOnCart/index.ts b/packages/sdk/src/methods/setPaymentMethodOnCart/index.ts index 78a611aca..3f3491b06 100644 --- a/packages/sdk/src/methods/setPaymentMethodOnCart/index.ts +++ b/packages/sdk/src/methods/setPaymentMethodOnCart/index.ts @@ -22,10 +22,10 @@ export type SetPaymentMethodOnCartResponse< * * @remarks * This method sends a POST request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.setPaymentMethodOnCart | setPaymentMethodOnCart } endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/setPaymentMethodOnCart | setPaymentMethodOnCart } 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#setPaymentMethodOnCart | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/setPaymentMethodOnCart | here}. * * @param params - * Parameter object which can be used with this method. @@ -38,7 +38,7 @@ export type SetPaymentMethodOnCartResponse< * @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#SetPaymentMethodOnCartResponse | SetPaymentMethodOnCartResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/SetPaymentMethodOnCartResponse | SetPaymentMethodOnCartResponse}. * * @example * Simple usage: diff --git a/packages/sdk/src/methods/setShippingAddressesOnCart/index.ts b/packages/sdk/src/methods/setShippingAddressesOnCart/index.ts index 991ef4d15..202cc68a3 100644 --- a/packages/sdk/src/methods/setShippingAddressesOnCart/index.ts +++ b/packages/sdk/src/methods/setShippingAddressesOnCart/index.ts @@ -23,10 +23,10 @@ export type SetShippingAddressesOnCartResponse< * * @remarks * This method sends a POST request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.setShippingAddressOnCart | setShippingAddressOnCart } endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/setShippingAddressOnCart | setShippingAddressOnCart } 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#setShippingAddressOnCart | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/setShippingAddressOnCart | here}. * * @param params - * Parameter object which can be used with this method. @@ -39,7 +39,7 @@ export type SetShippingAddressesOnCartResponse< * @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#SetShippingAddressesOnCartResponse | SetShippingAddressesOnCartResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/SetShippingAddressesOnCartResponse | SetShippingAddressesOnCartResponse}. * * @example * Simple usage: diff --git a/packages/sdk/src/methods/setShippingMethodsOnCart/index.ts b/packages/sdk/src/methods/setShippingMethodsOnCart/index.ts index 63f26a658..54710e0b5 100644 --- a/packages/sdk/src/methods/setShippingMethodsOnCart/index.ts +++ b/packages/sdk/src/methods/setShippingMethodsOnCart/index.ts @@ -23,10 +23,10 @@ export type SetShippingMethodsOnCartResponse< * * @remarks * This method sends a POST request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.setShippingMethodsOnCart | setShippingMethodsOnCart } endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/setShippingMethodsOnCart | setShippingMethodsOnCart } 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#setShippingMethodsOnCart | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/setShippingMethodsOnCart | here}. * * @param params - * Parameter object which can be used with this method. @@ -39,7 +39,7 @@ export type SetShippingMethodsOnCartResponse< * @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#SetShippingMethodsOnCartResponse | SetShippingMethodsOnCartResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/SetShippingMethodsOnCartResponse | SetShippingMethodsOnCartResponse}. * * @example * Simple usage: diff --git a/packages/sdk/src/methods/storeConfig/index.ts b/packages/sdk/src/methods/storeConfig/index.ts index 5089de4b1..34394300e 100644 --- a/packages/sdk/src/methods/storeConfig/index.ts +++ b/packages/sdk/src/methods/storeConfig/index.ts @@ -20,10 +20,10 @@ export type StoreConfigResponse = StoreC * * @remarks * This method sends a GET request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.storeConfig | storeConfig } endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/storeConfig | storeConfig } 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#storeConfig | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/storeConfig | here}. * * @param options - * Options that can be passed to additionally configure the request @@ -32,7 +32,7 @@ export type StoreConfigResponse = StoreC * @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#StoreConfigResponse | StoreConfigResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/StoreConfigResponse | StoreConfigResponse}. * * @example * Simple usage: diff --git a/packages/sdk/src/methods/subscribeEmailToNewsletter/index.ts b/packages/sdk/src/methods/subscribeEmailToNewsletter/index.ts index 89bd33043..f3cbd9e1b 100644 --- a/packages/sdk/src/methods/subscribeEmailToNewsletter/index.ts +++ b/packages/sdk/src/methods/subscribeEmailToNewsletter/index.ts @@ -22,10 +22,10 @@ export type SubscribeEmailToNewsletterResponse< * * @remarks * This method sends a POST request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.subscribeEmailToNewsletter | subscribeEmailToNewsletter } endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/subscribeEmailToNewsletter | subscribeEmailToNewsletter } 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#subscribeEmailToNewsletter | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/subscribeEmailToNewsletter | here}. * * @param params - * Parameter object which can be used with this method. @@ -38,7 +38,7 @@ export type SubscribeEmailToNewsletterResponse< * @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#SubscribeEmailToNewsletterResponse | SubscribeEmailToNewsletterResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/SubscribeEmailToNewsletterResponse | SubscribeEmailToNewsletterResponse}. * * @example * Simple usage: diff --git a/packages/sdk/src/methods/updateCartItems/index.ts b/packages/sdk/src/methods/updateCartItems/index.ts index 7db2826dd..8acafaddc 100644 --- a/packages/sdk/src/methods/updateCartItems/index.ts +++ b/packages/sdk/src/methods/updateCartItems/index.ts @@ -21,10 +21,10 @@ export type UpdateCartItemsResponse * * @remarks * This method sends a POST request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.updateCustomer | updateCustomer } endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/updateCustomer | updateCustomer } 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#updateCustomer | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/updateCustomer | here}. * * @param params - * Parameter object which can be used with this method. @@ -38,7 +38,7 @@ export type UpdateCustomerResponse * @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#UpdateCustomerResponse | UpdateCustomerResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/UpdateCustomerResponse | UpdateCustomerResponse}. * * @example * Simple usage: diff --git a/packages/sdk/src/methods/updateCustomerAddress/index.ts b/packages/sdk/src/methods/updateCustomerAddress/index.ts index deb2a2143..ab301aad0 100644 --- a/packages/sdk/src/methods/updateCustomerAddress/index.ts +++ b/packages/sdk/src/methods/updateCustomerAddress/index.ts @@ -23,10 +23,10 @@ export type UpdateCustomerAddressResponse< * * @remarks * This method sends a POST request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.updateCustomerAddress | updateCustomerAddress } endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/updateCustomerAddress | updateCustomerAddress } 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#updateCustomerAddress | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/updateCustomerAddress | here}. * * @param params - * Parameter object which can be used with this method. @@ -39,7 +39,7 @@ export type UpdateCustomerAddressResponse< * @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#UpdateCustomerAddressResponse | UpdateCustomerAddressResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/UpdateCustomerAddressResponse | UpdateCustomerAddressResponse}. * * @example * Simple usage: diff --git a/packages/sdk/src/methods/updateCustomerEmail/index.ts b/packages/sdk/src/methods/updateCustomerEmail/index.ts index a06861318..dd203766f 100644 --- a/packages/sdk/src/methods/updateCustomerEmail/index.ts +++ b/packages/sdk/src/methods/updateCustomerEmail/index.ts @@ -22,10 +22,10 @@ export type UpdateCustomerEmailResponse< * * @remarks * This method sends a POST request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.updateCustomerEmail | updateCustomerEmail } endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/updateCustomerEmail | updateCustomerEmail } 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#updateCustomerEmail | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/updateCustomerEmail | here}. * * @param params - * Parameter object which can be used with this method. @@ -38,7 +38,7 @@ export type UpdateCustomerEmailResponse< * @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#UpdateCustomerEmailResponse | UpdateCustomerEmailResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/UpdateCustomerEmailResponse | UpdateCustomerEmailResponse}. * * @example * Simple usage: diff --git a/packages/sdk/src/methods/upsellProducts/index.ts b/packages/sdk/src/methods/upsellProducts/index.ts index 1deb877f2..49c5134f4 100644 --- a/packages/sdk/src/methods/upsellProducts/index.ts +++ b/packages/sdk/src/methods/upsellProducts/index.ts @@ -21,10 +21,10 @@ export type UpsellProductsResponse = * * @remarks * This method sends a GET request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.upsellProducts | upsellProducts} endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/upsellProducts | upsellProducts} 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#upsellProductQuery | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/upsellProductQuery | here}. * * @param params - * Parameter object which can be used with this method. @@ -37,7 +37,7 @@ export type UpsellProductsResponse = * @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#UpsellProductsResponse | UpsellProductsResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/UpsellProductsResponse | UpsellProductsResponse}. * * @example * Simple usage without filters, sorting or pagination: diff --git a/packages/sdk/src/methods/wishlistItemsCount/index.ts b/packages/sdk/src/methods/wishlistItemsCount/index.ts index 8ddb9ea28..c149af541 100644 --- a/packages/sdk/src/methods/wishlistItemsCount/index.ts +++ b/packages/sdk/src/methods/wishlistItemsCount/index.ts @@ -15,10 +15,10 @@ export type WishlistItemsCountResponse = Wi * * @remarks * This method sends a POST request to the - * {@link https://docs.vuestorefront.io/sdk-magento2/reference/api/magento-api#ApiMethods.wishlistItemsCount | wishlistItemsCount } endpoint + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/wishlistItemsCount | wishlistItemsCount } 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#wishlist | here}. + * {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/wishlist | here}. * * @param options - * Options that can be passed to additionally configure the request @@ -27,7 +27,7 @@ export type WishlistItemsCountResponse = Wi * @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#WishlistItemsCountResponse | WishlistItemsCountResponse}. + * Returns a representation of the {@link https://docs.vuestorefront.io/integrations/magento/api/magento-api/WishlistItemsCountResponse | WishlistItemsCountResponse}. * * @example * Simple usage: