docs: rename remoteLink and remoteQueryConfig (#10836)

* docs: rename remoteLink and remoteQueryConfig

* change version number
This commit is contained in:
Shahed Nasser
2025-01-07 14:43:12 +02:00
committed by GitHub
parent f5f4d417c0
commit 38223e5104
28 changed files with 223 additions and 212 deletions
@@ -65,19 +65,19 @@ const { data: apiKeys } = useQueryGraphStep({
</CodeTab>
</CodeTabs>
### Manage with Remote Link
### Manage with Link
To manage the sales channels of an API key, use [Remote Link](!docs!/learn/fundamentals/module-links/remote-link):
To manage the sales channels of an API key, use [Link](!docs!/learn/fundamentals/module-links/link):
<CodeTabs group="relation-link">
<CodeTab label="remoteLink.create" value="method">
<CodeTab label="link.create" value="method">
```ts
import { Modules } from "@medusajs/framework/utils"
// ...
await remoteLink.create({
await link.create({
[Modules.API_KEY]: {
api_key_id: "apk_123",
},
@@ -121,19 +121,19 @@ const { data: carts } = useQueryGraphStep({
</CodeTab>
</CodeTabs>
### Manage with Remote Link
### Manage with Link
To manage the order of a cart, use [Remote Link](!docs!/learn/fundamentals/module-links/remote-link):
To manage the order of a cart, use [Link](!docs!/learn/fundamentals/module-links/link):
<CodeTabs group="relation-link">
<CodeTab label="remoteLink.create" value="method">
<CodeTab label="link.create" value="method">
```ts
import { Modules } from "@medusajs/framework/utils"
// ...
await remoteLink.create({
await link.create({
[Modules.CART]: {
cart_id: "cart_123",
},
@@ -214,19 +214,19 @@ const { data: carts } = useQueryGraphStep({
</CodeTab>
</CodeTabs>
### Manage with Remote Link
### Manage with Link
To manage the payment collection of a cart, use [Remote Link](!docs!/learn/fundamentals/module-links/remote-link):
To manage the payment collection of a cart, use [Link](!docs!/learn/fundamentals/module-links/link):
<CodeTabs group="relation-link">
<CodeTab label="remoteLink.create" value="method">
<CodeTab label="link.create" value="method">
```ts
import { Modules } from "@medusajs/framework/utils"
// ...
await remoteLink.create({
await link.create({
[Modules.CART]: {
cart_id: "cart_123",
},
@@ -368,19 +368,19 @@ const { data: carts } = useQueryGraphStep({
</CodeTab>
</CodeTabs>
### Manage with Remote Link
### Manage with Link
To manage the promotions of a cart, use [Remote Link](!docs!/learn/fundamentals/module-links/remote-link):
To manage the promotions of a cart, use [Link](!docs!/learn/fundamentals/module-links/link):
<CodeTabs group="relation-link">
<CodeTab label="remoteLink.create" value="method">
<CodeTab label="link.create" value="method">
```ts
import { Modules } from "@medusajs/framework/utils"
// ...
await remoteLink.create({
await link.create({
[Modules.CART]: {
cart_id: "cart_123",
},
@@ -77,19 +77,19 @@ const { data: fulfillments } = useQueryGraphStep({
</CodeTab>
</CodeTabs>
### Manage with Remote Link
### Manage with Link
To manage the order of a cart, use [Remote Link](!docs!/learn/fundamentals/module-links/remote-link):
To manage the order of a cart, use [Link](!docs!/learn/fundamentals/module-links/link):
<CodeTabs group="relation-link">
<CodeTab label="remoteLink.create" value="method">
<CodeTab label="link.create" value="method">
```ts
import { Modules } from "@medusajs/framework/utils"
// ...
await remoteLink.create({
await link.create({
[Modules.ORDER]: {
order_id: "order_123",
},
@@ -170,19 +170,19 @@ const { data: shippingOptions } = useQueryGraphStep({
</CodeTab>
</CodeTabs>
### Manage with Remote Link
### Manage with Link
To manage the price set of a shipping option, use [Remote Link](!docs!/learn/fundamentals/module-links/remote-link):
To manage the price set of a shipping option, use [Link](!docs!/learn/fundamentals/module-links/link):
<CodeTabs group="relation-link">
<CodeTab label="remoteLink.create" value="method">
<CodeTab label="link.create" value="method">
```ts
import { Modules } from "@medusajs/framework/utils"
// ...
await remoteLink.create({
await link.create({
[Modules.FULFILLMENT]: {
shipping_option_id: "so_123",
},
@@ -273,19 +273,19 @@ const { data: fulfillmentSets } = useQueryGraphStep({
</CodeTab>
</CodeTabs>
### Manage with Remote Link
### Manage with Link
To manage the stock location of a fulfillment set, use [Remote Link](!docs!/learn/fundamentals/module-links/remote-link):
To manage the stock location of a fulfillment set, use [Link](!docs!/learn/fundamentals/module-links/link):
<CodeTabs group="relation-link">
<CodeTab label="remoteLink.create" value="method">
<CodeTab label="link.create" value="method">
```ts
import { Modules } from "@medusajs/framework/utils"
// ...
await remoteLink.create({
await link.create({
[Modules.STOCK_LOCATION]: {
stock_location_id: "sloc_123",
},
@@ -70,19 +70,19 @@ const { data: inventoryItems } = useQueryGraphStep({
</CodeTab>
</CodeTabs>
### Manage with Remote Link
### Manage with Link
To manage the variants of an inventory item, use [Remote Link](!docs!/learn/fundamentals/module-links/remote-link):
To manage the variants of an inventory item, use [Link](!docs!/learn/fundamentals/module-links/link):
<CodeTabs group="relation-link">
<CodeTab label="remoteLink.create" value="method">
<CodeTab label="link.create" value="method">
```ts
import { Modules } from "@medusajs/framework/utils"
// ...
await remoteLink.create({
await link.create({
[Modules.PRODUCT]: {
variant_id: "variant_123",
},
@@ -124,19 +124,19 @@ const { data: orders } = useQueryGraphStep({
</CodeTab>
</CodeTabs>
### Manage with Remote Link
### Manage with Link
To manage the cart of an order, use [Remote Link](!docs!/learn/fundamentals/module-links/remote-link):
To manage the cart of an order, use [Link](!docs!/learn/fundamentals/module-links/link):
<CodeTabs group="relation-link">
<CodeTab label="remoteLink.create" value="method">
<CodeTab label="link.create" value="method">
```ts
import { Modules } from "@medusajs/framework/utils"
// ...
await remoteLink.create({
await link.create({
[Modules.ORDER]: {
order_id: "order_123",
},
@@ -225,19 +225,19 @@ const { data: orders } = useQueryGraphStep({
</CodeTab>
</CodeTabs>
### Manage with Remote Link
### Manage with Link
To manage the fulfillments of an order, use [Remote Link](!docs!/learn/fundamentals/module-links/remote-link):
To manage the fulfillments of an order, use [Link](!docs!/learn/fundamentals/module-links/link):
<CodeTabs group="relation-link">
<CodeTab label="remoteLink.create" value="method">
<CodeTab label="link.create" value="method">
```ts
import { Modules } from "@medusajs/framework/utils"
// ...
await remoteLink.create({
await link.create({
[Modules.ORDER]: {
order_id: "order_123",
},
@@ -318,19 +318,19 @@ const { data: orders } = useQueryGraphStep({
</CodeTab>
</CodeTabs>
### Manage with Remote Link
### Manage with Link
To manage the payment collections of an order, use [Remote Link](!docs!/learn/fundamentals/module-links/remote-link):
To manage the payment collections of an order, use [Link](!docs!/learn/fundamentals/module-links/link):
<CodeTabs group="relation-link">
<CodeTab label="remoteLink.create" value="method">
<CodeTab label="link.create" value="method">
```ts
import { Modules } from "@medusajs/framework/utils"
// ...
await remoteLink.create({
await link.create({
[Modules.ORDER]: {
order_id: "order_123",
},
@@ -463,19 +463,19 @@ const { data: orders } = useQueryGraphStep({
</CodeTab>
</CodeTabs>
### Manage with Remote Link
### Manage with Link
To manage the promotion of an order, use [Remote Link](!docs!/learn/fundamentals/module-links/remote-link):
To manage the promotion of an order, use [Link](!docs!/learn/fundamentals/module-links/link):
<CodeTabs group="relation-link">
<CodeTab label="remoteLink.create" value="method">
<CodeTab label="link.create" value="method">
```ts
import { Modules } from "@medusajs/framework/utils"
// ...
await remoteLink.create({
await link.create({
[Modules.ORDER]: {
order_id: "order_123",
},
@@ -67,19 +67,19 @@ const { data: paymentCollections } = useQueryGraphStep({
</CodeTab>
</CodeTabs>
### Manage with Remote Link
### Manage with Link
To manage the payment collection of a cart, use [Remote Link](!docs!/learn/fundamentals/module-links/remote-link):
To manage the payment collection of a cart, use [Link](!docs!/learn/fundamentals/module-links/link):
<CodeTabs group="relation-link">
<CodeTab label="remoteLink.create" value="method">
<CodeTab label="link.create" value="method">
```ts
import { Modules } from "@medusajs/framework/utils"
// ...
await remoteLink.create({
await link.create({
[Modules.CART]: {
cart_id: "cart_123",
},
@@ -159,19 +159,19 @@ const { data: paymentCollections } = useQueryGraphStep({
</CodeTab>
</CodeTabs>
### Manage with Remote Link
### Manage with Link
To manage the payment collections of an order, use [Remote Link](!docs!/learn/fundamentals/module-links/remote-link):
To manage the payment collections of an order, use [Link](!docs!/learn/fundamentals/module-links/link):
<CodeTabs group="relation-link">
<CodeTab label="remoteLink.create" value="method">
<CodeTab label="link.create" value="method">
```ts
import { Modules } from "@medusajs/framework/utils"
// ...
await remoteLink.create({
await link.create({
[Modules.ORDER]: {
order_id: "order_123",
},
@@ -252,19 +252,19 @@ const { data: paymentProviders } = useQueryGraphStep({
</CodeTab>
</CodeTabs>
### Manage with Remote Link
### Manage with Link
To manage the payment providers in a region, use [Remote Link](!docs!/learn/fundamentals/module-links/remote-link):
To manage the payment providers in a region, use [Link](!docs!/learn/fundamentals/module-links/link):
<CodeTabs group="relation-link">
<CodeTab label="remoteLink.create" value="method">
<CodeTab label="link.create" value="method">
```ts
import { Modules } from "@medusajs/framework/utils"
// ...
await remoteLink.create({
await link.create({
[Modules.REGION]: {
region_id: "reg_123",
},
@@ -49,12 +49,12 @@ import {
// ...
// resolve the remote link
const remoteLink = container.resolve(
ContainerRegistrationKeys
// resolve Link
const link = container.resolve(
ContainerRegistrationKeys.LINK
)
remoteLink.create({
link.create({
[Modules.CART]: {
cart_id: "cart_123",
},
@@ -66,7 +66,7 @@ remoteLink.create({
<Note title="Tip">
Learn more about the remote link in [this documentation](!docs!/learn/fundamentals/module-links/remote-link).
Learn more about Link in [this documentation](!docs!/learn/fundamentals/module-links/link).
</Note>
@@ -64,19 +64,19 @@ const { data: priceSets } = useQueryGraphStep({
</CodeTab>
</CodeTabs>
### Manage with Remote Link
### Manage with Link
To manage the price set of a shipping option, use [Remote Link](!docs!/learn/fundamentals/module-links/remote-link):
To manage the price set of a shipping option, use [Link](!docs!/learn/fundamentals/module-links/link):
<CodeTabs group="relation-link">
<CodeTab label="remoteLink.create" value="method">
<CodeTab label="link.create" value="method">
```ts
import { Modules } from "@medusajs/framework/utils"
// ...
await remoteLink.create({
await link.create({
[Modules.FULFILLMENT]: {
shipping_option_id: "so_123",
},
@@ -161,19 +161,19 @@ const { data: priceSets } = useQueryGraphStep({
</CodeTab>
</CodeTabs>
### Manage with Remote Link
### Manage with Link
To manage the price set of a variant, use [Remote Link](!docs!/learn/fundamentals/module-links/remote-link):
To manage the price set of a variant, use [Link](!docs!/learn/fundamentals/module-links/link):
<CodeTabs group="relation-link">
<CodeTab label="remoteLink.create" value="method">
<CodeTab label="link.create" value="method">
```ts
import { Modules } from "@medusajs/framework/utils"
// ...
await remoteLink.create({
await link.create({
[Modules.PRODUCT]: {
variant_id: "variant_123",
},
@@ -129,19 +129,19 @@ const { data: variants } = useQueryGraphStep({
</CodeTab>
</CodeTabs>
### Manage with Remote Link
### Manage with Link
To manage the inventory items of a variant, use [Remote Link](!docs!/learn/fundamentals/module-links/remote-link):
To manage the inventory items of a variant, use [Link](!docs!/learn/fundamentals/module-links/link):
<CodeTabs group="relation-link">
<CodeTab label="remoteLink.create" value="method">
<CodeTab label="link.create" value="method">
```ts
import { Modules } from "@medusajs/framework/utils"
// ...
await remoteLink.create({
await link.create({
[Modules.PRODUCT]: {
variant_id: "variant_123",
},
@@ -278,19 +278,19 @@ const { data: variants } = useQueryGraphStep({
</CodeTab>
</CodeTabs>
### Manage with Remote Link
### Manage with Link
To manage the price set of a variant, use [Remote Link](!docs!/learn/fundamentals/module-links/remote-link):
To manage the price set of a variant, use [Link](!docs!/learn/fundamentals/module-links/link):
<CodeTabs group="relation-link">
<CodeTab label="remoteLink.create" value="method">
<CodeTab label="link.create" value="method">
```ts
import { Modules } from "@medusajs/framework/utils"
// ...
await remoteLink.create({
await link.create({
[Modules.PRODUCT]: {
variant_id: "variant_123",
},
@@ -371,19 +371,19 @@ const { data: products } = useQueryGraphStep({
</CodeTab>
</CodeTabs>
### Manage with Remote Link
### Manage with Link
To manage the sales channels of a product, use [Remote Link](!docs!/learn/fundamentals/module-links/remote-link):
To manage the sales channels of a product, use [Link](!docs!/learn/fundamentals/module-links/link):
<CodeTabs group="relation-link">
<CodeTab label="remoteLink.create" value="method">
<CodeTab label="link.create" value="method">
```ts
import { Modules } from "@medusajs/framework/utils"
// ...
await remoteLink.create({
await link.create({
[Modules.PRODUCT]: {
product_id: "prod_123",
},
@@ -77,19 +77,19 @@ const { data: promotions } = useQueryGraphStep({
</CodeTab>
</CodeTabs>
### Manage with Remote Link
### Manage with Link
To manage the promotions of a cart, use [Remote Link](!docs!/learn/fundamentals/module-links/remote-link):
To manage the promotions of a cart, use [Link](!docs!/learn/fundamentals/module-links/link):
<CodeTabs group="relation-link">
<CodeTab label="remoteLink.create" value="method">
<CodeTab label="link.create" value="method">
```ts
import { Modules } from "@medusajs/framework/utils"
// ...
await remoteLink.create({
await link.create({
[Modules.CART]: {
cart_id: "cart_123",
},
@@ -168,19 +168,19 @@ const { data: promotions } = useQueryGraphStep({
</CodeTab>
</CodeTabs>
### Manage with Remote Link
### Manage with Link
To manage the promotion of an order, use [Remote Link](!docs!/learn/fundamentals/module-links/remote-link):
To manage the promotion of an order, use [Link](!docs!/learn/fundamentals/module-links/link):
<CodeTabs group="relation-link">
<CodeTab label="remoteLink.create" value="method">
<CodeTab label="link.create" value="method">
```ts
import { Modules } from "@medusajs/framework/utils"
// ...
await remoteLink.create({
await link.create({
[Modules.ORDER]: {
order_id: "order_123",
},
@@ -161,19 +161,19 @@ const { data: regions } = useQueryGraphStep({
</CodeTab>
</CodeTabs>
### Manage with Remote Link
### Manage with Link
To manage the payment providers in a region, use [Remote Link](!docs!/learn/fundamentals/module-links/remote-link):
To manage the payment providers in a region, use [Link](!docs!/learn/fundamentals/module-links/link):
<CodeTabs group="relation-link">
<CodeTab label="remoteLink.create" value="method">
<CodeTab label="link.create" value="method">
```ts
import { Modules } from "@medusajs/framework/utils"
// ...
await remoteLink.create({
await link.create({
[Modules.REGION]: {
region_id: "reg_123",
},
@@ -73,19 +73,19 @@ const { data: salesChannels } = useQueryGraphStep({
</CodeTab>
</CodeTabs>
### Manage with Remote Link
### Manage with Link
To manage the sales channels of an API key, use [Remote Link](!docs!/learn/fundamentals/module-links/remote-link):
To manage the sales channels of an API key, use [Link](!docs!/learn/fundamentals/module-links/link):
<CodeTabs group="relation-link">
<CodeTab label="remoteLink.create" value="method">
<CodeTab label="link.create" value="method">
```ts
import { Modules } from "@medusajs/framework/utils"
// ...
await remoteLink.create({
await link.create({
[Modules.API_KEY]: {
api_key_id: "apk_123",
},
@@ -256,19 +256,19 @@ const { data: salesChannels } = useQueryGraphStep({
</CodeTab>
</CodeTabs>
### Manage with Remote Link
### Manage with Link
To manage the sales channels of a product, use [Remote Link](!docs!/learn/fundamentals/module-links/remote-link):
To manage the sales channels of a product, use [Link](!docs!/learn/fundamentals/module-links/link):
<CodeTabs group="relation-link">
<CodeTab label="remoteLink.create" value="method">
<CodeTab label="link.create" value="method">
```ts
import { Modules } from "@medusajs/framework/utils"
// ...
await remoteLink.create({
await link.create({
[Modules.PRODUCT]: {
product_id: "prod_123",
},
@@ -349,19 +349,19 @@ const { data: salesChannels } = useQueryGraphStep({
</CodeTab>
</CodeTabs>
### Manage with Remote Link
### Manage with Link
To manage the stock locations of a sales channel, use [Remote Link](!docs!/learn/fundamentals/module-links/remote-link):
To manage the stock locations of a sales channel, use [Link](!docs!/learn/fundamentals/module-links/link):
<CodeTabs group="relation-link">
<CodeTab label="remoteLink.create" value="method">
<CodeTab label="link.create" value="method">
```ts
import { Modules } from "@medusajs/framework/utils"
// ...
await remoteLink.create({
await link.create({
[Modules.SALES_CHANNEL]: {
sales_channel_id: "sc_123",
},
@@ -82,19 +82,19 @@ const { data: stockLocations } = useQueryGraphStep({
</CodeTab>
</CodeTabs>
### Manage with Remote Link
### Manage with Link
To manage the stock location of a fulfillment set, use [Remote Link](!docs!/learn/fundamentals/module-links/remote-link):
To manage the stock location of a fulfillment set, use [Link](!docs!/learn/fundamentals/module-links/link):
<CodeTabs group="relation-link">
<CodeTab label="remoteLink.create" value="method">
<CodeTab label="link.create" value="method">
```ts
import { Modules } from "@medusajs/framework/utils"
// ...
await remoteLink.create({
await link.create({
[Modules.STOCK_LOCATION]: {
stock_location_id: "sloc_123",
},
@@ -220,19 +220,19 @@ const { data: stockLocations } = useQueryGraphStep({
</CodeTab>
</CodeTabs>
### Manage with Remote Link
### Manage with Link
To manage the stock locations of a sales channel, use [Remote Link](!docs!/learn/fundamentals/module-links/remote-link):
To manage the stock locations of a sales channel, use [Link](!docs!/learn/fundamentals/module-links/link):
<CodeTabs group="relation-link">
<CodeTab label="remoteLink.create" value="method">
<CodeTab label="link.create" value="method">
```ts
import { Modules } from "@medusajs/framework/utils"
// ...
await remoteLink.create({
await link.create({
[Modules.SALES_CHANNEL]: {
sales_channel_id: "sc_123",
},