docs: generate references manually for 2.12.3 (#14340)
This commit is contained in:
1 parent
52e965f411
commit
1c4c4b8e9a
1080 files changed
+394731
-361464
No files matched your search
+4
-4
@@ -9,9 +9,9 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `createRemoteLinkStep` step. It belongs to the `@medusajs/medusa/core-flows` package.
|
||||
|
||||
This step creates remote links between two records of linked data models.
|
||||
This step creates links between two records of linked data models.
|
||||
|
||||
Learn more in the [Remote Link documentation.](https://docs.medusajs.com/learn/fundamentals/module-links/remote-link#create-link).
|
||||
Learn more in the [Link documentation.](https://docs.medusajs.com/learn/fundamentals/module-links/link#create-link).
|
||||
|
||||
## Example
|
||||
|
||||
@@ -20,8 +20,8 @@ createRemoteLinkStep([{
|
||||
[Modules.PRODUCT]: {
|
||||
product_id: "prod_123",
|
||||
},
|
||||
"helloModuleService": {
|
||||
my_custom_id: "mc_123",
|
||||
blog: {
|
||||
post_id: "post_123",
|
||||
},
|
||||
}])
|
||||
```
|
||||
|
||||
+4
-4
@@ -9,9 +9,9 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `dismissRemoteLinkStep` step. It belongs to the `@medusajs/medusa/core-flows` package.
|
||||
|
||||
This step removes remote links between two records of linked data models.
|
||||
This step removes links between two records of linked data models.
|
||||
|
||||
Learn more in the [Remote Link documentation.](https://docs.medusajs.com/learn/fundamentals/module-links/remote-link#dismiss-link).
|
||||
Learn more in the [Link documentation.](https://docs.medusajs.com/learn/fundamentals/module-links/link#dismiss-link).
|
||||
|
||||
## Example
|
||||
|
||||
@@ -20,8 +20,8 @@ dismissRemoteLinkStep([{
|
||||
[Modules.PRODUCT]: {
|
||||
product_id: "prod_123",
|
||||
},
|
||||
"helloModuleService": {
|
||||
my_custom_id: "mc_123",
|
||||
blog: {
|
||||
post_id: "post_123",
|
||||
},
|
||||
}])
|
||||
```
|
||||
|
||||
+41
@@ -0,0 +1,41 @@
|
||||
---
|
||||
slug: /references/helper-steps/getTranslatedLineItemsStep
|
||||
sidebar_label: getTranslatedLineItemsStep
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# getTranslatedLineItemsStep - Helper Steps API Reference
|
||||
|
||||
This documentation provides a reference to the `getTranslatedLineItemsStep` step. It belongs to the `@medusajs/medusa/core-flows` package.
|
||||
|
||||
This step translates cart line items based on their associated variant and product IDs.
|
||||
It fetches translations for the product (title, description, subtitle) and variant (title),
|
||||
then applies them to the corresponding line item fields.
|
||||
|
||||
```ts title="src/workflows/my-workflow.ts"
|
||||
import { createWorkflow } from "@medusajs/framework/workflows-sdk"
|
||||
import { getTranslatedLineItemsStep } from "@medusajs/medusa/core-flows"
|
||||
|
||||
const myWorkflow = createWorkflow(
|
||||
"my-workflow",
|
||||
() => {
|
||||
const data = getTranslatedLineItemsStep({
|
||||
"items": "{value}",
|
||||
"variants": [
|
||||
"{value}"
|
||||
],
|
||||
"locale": "{value}"
|
||||
})
|
||||
}
|
||||
)
|
||||
```
|
||||
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"GetTranslatedLineItemsStepInput","type":"[GetTranslatedLineItemsStepInput](../../interfaces/helper_steps.GetTranslatedLineItemsStepInput/page.mdx)<T>","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="getTranslatedLineItemsStep"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"T[]","type":"T[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" openedLevel={1} sectionTitle="getTranslatedLineItemsStep"/>
|
||||
+2
-2
@@ -9,9 +9,9 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `removeRemoteLinkStep` step. It belongs to the `@medusajs/medusa/core-flows` package.
|
||||
|
||||
This step deletes linked records of a record.
|
||||
This step deletes linked records of a record if cascade deletion is enabled.
|
||||
|
||||
Learn more in the [Remote Link documentation](https://docs.medusajs.com/learn/fundamentals/module-links/remote-link#cascade-delete-linked-records)
|
||||
Learn more in the [Link documentation](https://docs.medusajs.com/learn/fundamentals/module-links/link#cascade-delete-linked-records)
|
||||
|
||||
## Example
|
||||
|
||||
|
||||
+5
-4
@@ -9,9 +9,10 @@ import { TypeList } from "docs-ui"
|
||||
|
||||
This documentation provides a reference to the `updateRemoteLinksStep` step. It belongs to the `@medusajs/medusa/core-flows` package.
|
||||
|
||||
This step updates remote links between two records of linked data models.
|
||||
This step updates links between two records of linked data models. This is useful to update
|
||||
links with additional data such as metadata.
|
||||
|
||||
Learn more in the [Remote Link documentation.](https://docs.medusajs.com/learn/fundamentals/module-links/remote-link#create-link).
|
||||
Learn more in the [Link documentation.](https://docs.medusajs.com/learn/fundamentals/module-links/link#update-links).
|
||||
|
||||
## Example
|
||||
|
||||
@@ -21,8 +22,8 @@ const data = updateRemoteLinksStep([
|
||||
[Modules.PRODUCT]: {
|
||||
product_id: "prod_321",
|
||||
},
|
||||
"helloModuleService": {
|
||||
my_custom_id: "mc_321",
|
||||
blog: {
|
||||
post_id: "post_321",
|
||||
},
|
||||
data: {
|
||||
metadata: {
|
||||
|
||||
+9
@@ -0,0 +1,9 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# GetTranslatedLineItemsStepInput
|
||||
|
||||
## Type parameters
|
||||
|
||||
<TypeList types={[{"name":"T","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="GetTranslatedLineItemsStepInput"/>
|
||||
|
||||
<TypeList types={[{"name":"items","type":"`undefined` \\| T[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"Partial<[ProductVariantDTO](../../../product/interfaces/product.ProductVariantDTO/page.mdx)>[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"locale","type":"`undefined` \\| `null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="GetTranslatedLineItemsStepInput"/>
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# getTranslatedLineItemsStepId
|
||||
|
||||
`Const` **getTranslatedLineItemsStepId**: `"get-translated-line-items"`
|
||||
Reference in new issue
Block a user